docs: clarify gzip decompression behavior when using stream=True#7181
Open
AhamadAlii wants to merge 1 commit intopsf:mainfrom
Open
docs: clarify gzip decompression behavior when using stream=True#7181AhamadAlii wants to merge 1 commit intopsf:mainfrom
AhamadAlii wants to merge 1 commit intopsf:mainfrom
Conversation
Author
|
This documents the behavior discussed in #2155 and related issues. |
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
1 participant
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.
When using stream=True, Requests does not automatically decompress gzip-encoded
responses when accessing Response.raw. This behavior is intentional but not
clearly documented and has caused repeated confusion.
This PR adds a note in the advanced documentation explaining the behavior and
shows how to enable decompression manually:
This documents the intended behavior discussed in #2155 and related issues.