Repository navigation
Conversation
When HTTPS_PROXY, https_proxy, HTTP_PROXY, or http_proxy environment variables are set, use urllib3.ProxyManager instead of PoolManager. This enables the client to work in environments that require proxy configuration, such as corporate networks, CI/CD pipelines, and sandboxed development environments. The behavior is backward compatible - when no proxy environment variables are set, PoolManager is used as before.
kevinchiu
force-pushed
the
feature/http-proxy-support
branch
from
August 3, 2026 21:04
cd5027c to
3d2a238
Compare
kevinchiu
requested review from
jbonzo,
kschoche,
lukeoleson,
mmoghaddam385 and
suever
as code owners
August 3, 2026 21:04
justinpolygon
added a commit
that referenced
this pull request
Oct 16, 2026
Combines the community PRs that change how the REST client builds its urllib3 pool (#968, #1008, #1026, #1033, #1034). - CA bundle: both clients verify TLS with ca_certs if given, then the SSL_CERT_FILE or REQUESTS_CA_BUNDLE environment variable, then certifi (#998). - RESTClient(maxsize=10): connections kept per host. urllib3 defaults to 1, so threaded clients kept opening new TLS connections. - RESTClient(connection_pool_kw=...): other urllib3 pool options, merged over the defaults (#1009). - RESTClient(proxy=...): explicit proxy URL, with credentials from the URL. Proxy environment variables aren't read, so existing traffic doesn't change route. The WebSocket client already uses the system proxy via websockets. Co-authored-by: SACHU JAMES <142034811+SachuJames@users.noreply.github.com> Co-authored-by: Mohd Quamar Tyagi <104281681+Tyagiquamar@users.noreply.github.com> Co-authored-by: jakobovski-arb <201493996+jakobovski-arb@users.noreply.github.com> Co-authored-by: Roman Zydyk <31843161+romanzdk@users.noreply.github.com> Co-authored-by: Kevin Chiu <2712+kevinchiu@users.noreply.github.com>
justinpolygon
added a commit
that referenced
this pull request
Oct 16, 2026
Adds connection options to the clients, combining #968, #1008, #1026, #1033 and #1034 (contributors are credited as co-authors). - **Custom CA:** `ca_certs=` on `RESTClient` and `WebSocketClient`, defaulting to `SSL_CERT_FILE` / `REQUESTS_CA_BUNDLE`, then certifi. Closes #998. - **Pool size:** `RESTClient(maxsize=10)`. urllib3 defaults to 1 connection per host. - **Pool options:** `RESTClient(connection_pool_kw={...})`, merged over the defaults. Closes #1009. - **Proxy:** `RESTClient(proxy="http://user:pass@host:port")`. Proxy env vars aren't read, so nobody's traffic changes route. The README has a new **Network Configuration** section with examples for each case (custom CA, proxy, threads, other pool options). All new parameters are optional and added at the end of the signatures. The one behavior change: if `SSL_CERT_FILE` or `REQUESTS_CA_BUNDLE` points to a file, it's now used instead of certifi (as `requests` and Python do). If it points to a file that doesn't exist, it's skipped with a warning, so a stale value doesn't break anyone. Verified against the live API through a local TLS-inspecting proxy (mitmproxy with auth): REST and WebSocket connect with the proxy's CA (argument or env var) and fail certificate verification without it; wrong proxy credentials get 407. Under 16 threads, `maxsize=10` opened 16 TLS connections vs 57–70 with urllib3's default. --------- Co-authored-by: SACHU JAMES <142034811+SachuJames@users.noreply.github.com> Co-authored-by: Mohd Quamar Tyagi <104281681+Tyagiquamar@users.noreply.github.com> Co-authored-by: jakobovski-arb <201493996+jakobovski-arb@users.noreply.github.com> Co-authored-by: Roman Zydyk <31843161+romanzdk@users.noreply.github.com> Co-authored-by: Kevin Chiu <2712+kevinchiu@users.noreply.github.com>
Collaborator
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Automatically use
urllib3.ProxyManagerwhenHTTPS_PROXY/HTTP_PROXYenvironment variables are set.Enables the client to work in proxy-required environments (corporate networks, CI/CD, sandboxed dev environments) without code changes. Follows the same convention as the
requestslibrary.Fully backward compatible - uses
PoolManagerwhen no proxy vars are set.