summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSenthil Kumaran <senthil@uthcode.com>2011-06-19 23:56:49 (GMT)
committerSenthil Kumaran <senthil@uthcode.com>2011-06-19 23:56:49 (GMT)
commitce9b596c04626c734993106acf4ccebd517a71d8 (patch)
tree812295be8d3a1bda3bf63e4178adc06c0e4874f7
parent206cd1c284c2bdce943470a4c489012f37831959 (diff)
downloadcpython-ce9b596c04626c734993106acf4ccebd517a71d8.zip
cpython-ce9b596c04626c734993106acf4ccebd517a71d8.tar.gz
cpython-ce9b596c04626c734993106acf4ccebd517a71d8.tar.bz2
Fix closes Issue12315 - Updates to http.client documentation.
-rw-r--r--Doc/library/http.client.rst13
1 files changed, 12 insertions, 1 deletions
diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst
index 704585b..d16b808 100644
--- a/Doc/library/http.client.rst
+++ b/Doc/library/http.client.rst
@@ -543,6 +543,9 @@ statement.
A debugging hook. If :attr:`debuglevel` is greater than zero, messages
will be printed to stdout as the response is read and parsed.
+.. attribute:: HTTPResponse.closed
+
+ Is True if the stream is closed.
Examples
--------
@@ -555,7 +558,15 @@ Here is an example session that uses the ``GET`` method::
>>> r1 = conn.getresponse()
>>> print(r1.status, r1.reason)
200 OK
- >>> data1 = r1.read()
+ >>> data1 = r1.read() # This will return entire content.
+ >>> # The following example demonstrates reading data in chunks.
+ >>> conn.request("GET", "/index.html")
+ >>> r1 = conn.getresponse()
+ >>> while not r1.closed:
+ ... print(r1.read(200)) # 200 bytes
+ b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"...
+ ...
+ >>> # Example of an invalid request
>>> conn.request("GET", "/parrot.spam")
>>> r2 = conn.getresponse()
>>> print(r2.status, r2.reason)