Document Response.iter_lines() reentrancy issues

This commit is contained in:
Priit Laes
2015-03-07 11:04:43 +02:00
parent 62200cb07e
commit 4497a26c37
2 changed files with 15 additions and 0 deletions
+13
View File
@@ -399,6 +399,19 @@ set ``stream`` to ``True`` and iterate over the response with
if line:
print(json.loads(line))
.. warning::
:class:`~requests.Response.iter_lines()` is not reentrant safe.
Calling this method multiple times causes some of the received data
being lost. In case you need to call it from multiple places, use
the resulting iterator object instead::
lines = r.iter_lines()
# Save the first line for later or just skip it
first_line = next(lines)
for line in lines:
print(line)
.. _proxies:
Proxies
+2
View File
@@ -688,6 +688,8 @@ class Response(object):
"""Iterates over the response data, one line at a time. When
stream=True is set on the request, this avoids reading the
content at once into memory for large responses.
.. note:: This method is not reentrant safe.
"""
pending = None