From 7cc3d8dc6a24975617e388e674d93251c74749f1 Mon Sep 17 00:00:00 2001 From: Dave Shawley Date: Fri, 17 Nov 2017 16:37:08 -0500 Subject: [PATCH] docs/quickstart: clarify raw response reading. --- docs/user/quickstart.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index b5288ea3..6829d592 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -189,6 +189,14 @@ download, the above is the preferred and recommended way to retrieve the content. Note that ``chunk_size`` can be freely adjusted to a number that may better fit your use cases. +.. note:: + + An important note about using ``Response.iter_content`` versus ``Response.raw``. + ``Response.iter_content`` will automatically decode the ``gzip`` and ``deflate`` + transfer-encodings. ``Response.raw`` is a raw stream of bytes -- it does not + transform the response content. If you really need access to the bytes as they + were returned, use ``Response.raw``. + Custom Headers --------------