Repository navigation
[SPT-1668] Add proxy, custom CA, and connection pool options - #1040
Merged
Merged
Conversation
justinpolygon
marked this pull request as ready for review
October 16, 2026 19:27
justinpolygon
requested review from
jbonzo,
kschoche,
lukeoleson,
mmoghaddam385 and
suever
as code owners
October 16, 2026 19:27
lukeoleson
approved these changes
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>
If SSL_CERT_FILE or REQUESTS_CA_BUNDLE is set to a path that doesn't exist, log a warning and fall back to the next option instead of failing, so a stale value doesn't break existing setups. An explicit ca_certs argument is still used as given. RESTClient resolves the path once so it warns once for both the main and vx clients.
justinpolygon
force-pushed
the
justin/connection-options
branch
from
October 16, 2026 19:58
7b55e5f to
e36245e
Compare
This was referenced Oct 16, 2026
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.
Adds connection options to the clients, combining #968, #1008, #1026, #1033 and #1034 (contributors are credited as co-authors).
ca_certs=onRESTClientandWebSocketClient, defaulting toSSL_CERT_FILE/REQUESTS_CA_BUNDLE, then certifi. Closes SDK does not respect SSL_CERT_FILE or REQUESTS_CA_BUNDLE environment variables #998.RESTClient(maxsize=10). urllib3 defaults to 1 connection per host.RESTClient(connection_pool_kw={...}), merged over the defaults. Closes urllib connection pool kwargs #1009.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_FILEorREQUESTS_CA_BUNDLEpoints to a file, it's now used instead of certifi (asrequestsand 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=10opened 16 TLS connections vs 57–70 with urllib3's default.