Skip to content

docs: clarify gzip decompression behavior when using stream=True #7181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AhamadAlii wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify gzip decompression behavior when using stream=True #7181

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/user/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,17 @@ Alternatively, you can read the undecoded body from the underlying
urllib3 :class:`urllib3.HTTPResponse <urllib3.response.HTTPResponse>` at
:attr:`Response.raw <requests.Response.raw>`.

.. note::

When using ``stream=True``, Requests does not automatically decompress
responses with ``Content-Encoding: gzip`` when accessing
:attr:`Response.raw <requests.Response.raw>`. This is intentional.

If you need decompression while streaming, enable it manually::

r = requests.get(url, stream=True)
r.raw.decode_content = True

If you set ``stream`` to ``True`` when making a request, Requests cannot
release the connection back to the pool unless you consume all the data or call
:meth:`Response.close <requests.Response.close>`. This can lead to
Expand Down