psf / requests

A simple, yet elegant, HTTP library.
https://requests.readthedocs.io/en/latest/
Apache License 2.0
52.19k stars 9.33k forks source link

Docs update: warn that Session.verify is ignored if REQUESTS_CA_BUNDLE is set #6696

Open StefanKopieczek opened 6 months ago

StefanKopieczek commented 6 months ago

Issue #3829 tracks that Session.verify is ignored whenever REQUESTS_CA_BUNDLES or CURL_CA_BUNDLES is 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

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.