Docs update: warn that Session.verify is ignored if REQUESTS_CA_BUNDLE is set #6696
Conversation
This file contains 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
Add docs warning to indicate that setting REQUESTS_CA_BUNDLE or CURL_CA_BUNDLE causes Session.verify to be ignored.
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.
Issue #3829 tracks that Session.verify is ignored whenever
REQUESTS_CA_BUNDLESorCURL_CA_BUNDLESis set. The underlying behavior will apparently be changed in 3.x, but in the meantime it would be helpful to call out the behavior in the docs to avoid catching people out (the issue has been locked due to a large number of comments).I'm happy to rework this PR as needed, but it'd be great to get something in the docs about this in one form or another to help prevent people hitting this.
Thanks in advance for your thoughts!
Change Details
warning::callout to the relevant section of the docs.Alternate Approaches Considered
I initially wrote out a longer section detailing the semantics for how the various options interact — but all the other interactions are very intuitive, so this felt like overkill. Let me know if you'd prefer that approach.
This section of the docs is also a bit callout heavy, so I'm happy to inline the text rather than put it in a callout, if you prefer.