requests: Allow passing None header values #11370
Merged
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
This comment has been minimized.
This comment has been minimized.
python#7773 changed `requests.session.Session` methods to accept None for header values, but didn't do quite the same for the functions in `requests.api`. I think this was a mistake. The functions in `requests.api` just pass through the `headers` argument without doing anything in particular to it. Furthermore, it's useful to be able to pass None as a header value: because `requests.utils.default_headers` sets an `Accept-Encoding` header by default, the easiest way to send a request with no `Accept-Encoding` header is something like `requests.get(url, headers={"Accept-Encoding": None})`. It's annoying to have to construct a `Session` just to pass type-checking. It's a little confusing for the type alias to be called `_HeadersUpdateMapping` in `requests.sessions` but `_HeadersMapping` in `requests.api`; this is because the latter name was already used in other type stubs (`tensorflow.keras.callbacks`), so it seemed best to avoid breaking API.
cjwatson
force-pushed
the
requests-api-headers-None
branch
from
623346c to
ec55ac8
Compare
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
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.
#7773 changed
requests.session.Sessionmethods to accept None for header values, but didn't do quite the same for the functions inrequests.api. I think this was a mistake. The functions inrequests.apijust pass through theheadersargument without doing anything in particular to it.Furthermore, it's useful to be able to pass None as a header value: because
requests.utils.default_headerssets anAccept-Encodingheader by default, the easiest way to send a request with noAccept-Encodingheader is something likerequests.get(url, headers={"Accept-Encoding": None}). It's annoying to have to construct aSessionjust to pass type-checking.It's a little confusing for the type alias to be called
_HeadersUpdateMappinginrequests.sessionsbut_HeadersMappinginrequests.api; this is because the latter name was already used in other type stubs (tensorflow.keras.callbacks), so it seemed best to avoid breaking API.