]> granicus.if.org Git - python/commitdiff
Fix closes Issue12315 - Updates to http.client documentation.
authorSenthil Kumaran <senthil@uthcode.com>
Sun, 19 Jun 2011 23:56:49 +0000 (16:56 -0700)
committerSenthil Kumaran <senthil@uthcode.com>
Sun, 19 Jun 2011 23:56:49 +0000 (16:56 -0700)
Doc/library/http.client.rst

index 704585b525706515ce375ea8b6d239d5229ad9c1..d16b80814ba8316389b7b5c25f70a8acde43f51e 100644 (file)
@@ -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)