From 6a24eb6d20c6747669ecd6d8bda3924a384d4648 Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Sun, 20 Oct 2013 12:29:43 -0500 Subject: [PATCH] Add bit to docs about iter_content --- docs/user/quickstart.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 4313ac2..cd1a5ea 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -152,6 +152,18 @@ server, you can access ``r.raw``. If you want to do this, make sure you set >>> r.raw.read(10) '\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03' +In general, however, you should use a pattern like this to save what is being +streamed to a file:: + + with open(filename, 'wb') as fd: + for chunk in r.iter_content(chunk_size): + fd.write(chunk) + +Using ``Response.iter_content`` will handle a lot of what you would otherwise +have to handle when using ``Response.raw`` directly. When streaming a +download, the above is the preferred and recommended way to retrieve the +content. + Custom Headers -------------- -- 2.34.1