Document request(unbuffered=True), add to example

Fixes twisted#116.
twm · Dec 9, 2016 · d4c7725 · d4c7725
1 parent 961a38c
commit d4c7725
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/examples/download_file.py b/docs/examples/download_file.py
@@ -5,7 +5,7 @@
 
 def download_file(reactor, url, destination_filename):
     destination = open(destination_filename, 'wb')
-    d = treq.get(url)
+    d = treq.get(url, unbuffered=True)
     d.addCallback(treq.collect, destination.write)
     d.addBoth(lambda _: destination.close())
     return d

diff --git a/treq/api.py b/treq/api.py
@@ -101,6 +101,9 @@ def request(method, url, **kwargs):
         (i.e. Ignore  RFC2616 section 10.3 and follow redirects from
         POST requests).  Default: ``False``
 
+    :param bool unbuffered: Pass ``True`` to to disable response buffering.  By
+        default treq buffers the entire response body in memory.
+
     :rtype: Deferred that fires with an IResponse provider.
 
     """