feat(proxy): add ProxySettings model and Requests-compatible proxies mapping #103
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mapping
- Introduces typed ProxySettings with fields: address, port (optional), username (optional), password (optional)
- Adds to_proxies() that returns {"http": "...", "https": "..."} usable by requests
- Ensures clean output when port is omitted (no trailing colon)
- Adds parameterized pytest coverage for typical usage
- Updates docs (Proxy configuration) and changelog
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new ProxySettings model to support HTTP proxy configuration in the HTTP client. The implementation provides a typed data model with fields for address, port, username, and password, along with a method to generate Requests-compatible proxy dictionaries.
- Adds
ProxySettingsclass with typed fields and URL encoding support - Integrates proxy settings into
HttpClientConfiguration - Provides comprehensive test coverage for various proxy configuration scenarios
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
apimatic_core/http/configurations/proxy_settings.py |
New ProxySettings model with address sanitization and Requests-compatible output |
apimatic_core/http/configurations/http_client_configuration.py |
Integration of proxy_settings parameter and property |
tests/apimatic_core/configuration/test_proxy_settings.py |
Comprehensive test suite covering URL formatting, encoding, and edge cases |
apimatic_core/http/configurations/__init__.py |
Export of new proxy_settings module |
README.md |
Documentation updates for HTTP configurations section |
setup.py |
Version bump to 0.2.22 |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This PR
Why
To support the data model for proxy settings to be shared via http client configuration
Closes #102
Type of change
Select multiple if applicable.
Dependency Change
If a new dependency is being added, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Policy-of-adding-new-dependencies-in-the-core-libraries
Breaking change
If the PR is introducing a breaking change, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Guidelines-for-maintaining-core-libraries
Testing
List the steps that were taken to test the changes
Checklist