]> granicus.if.org Git - python/commitdiff
Fix Issue17069: Document getcode method in urllib.request.rst
authorSenthil Kumaran <senthil@uthcode.com>
Thu, 7 Feb 2013 08:47:01 +0000 (00:47 -0800)
committerSenthil Kumaran <senthil@uthcode.com>
Thu, 7 Feb 2013 08:47:01 +0000 (00:47 -0800)
Doc/library/urllib.request.rst

index b4764cc2bdb274b1219d89f5e6d11f6df4dd640f..ff5dd62f7acfb96b56689634331ddbcbd2e9c69e 100644 (file)
@@ -57,16 +57,24 @@ The :mod:`urllib.request` module defines the following functions:
       If neither *cafile* nor *capath* is specified, an HTTPS request
       will not do any verification of the server's certificate.
 
-   This function returns a file-like object that works as a :term:`context manager`,
-   with two additional methods from the :mod:`urllib.response` module
+   For http and https urls, this function returns a
+   :class:`http.client.HTTPResponse` object which has the following
+   :ref:`httpresponse-objects` methods.
 
-   * :meth:`geturl` --- return the URL of the resource retrieved,
+   For ftp, file, data urls and requests are explicity handled by legacy
+   :class:`URLopener` and :class:`FancyURLopener` class, this function returns
+   an :class:`urllib.response.addinfourl` object which can work as
+   :term:`context manager` and has methods such as
+
+   * :meth:`~urllib.response.addinfourl.geturl` --- return the URL of the resource retrieved,
      commonly used to determine if a redirect was followed
 
-   * :meth:`info` --- return the meta-information of the page, such as headers,
+   * :meth:`~urllib.response.addinfourl.info` --- return the meta-information of the page, such as headers,
      in the form of an :func:`email.message_from_string` instance (see
      `Quick Reference to HTTP Headers <http://www.cs.tut.fi/~jkorpela/http.html>`_)
 
+   * :meth:`~urllib.response.addinfourl.getcode` -- return the HTTP status code of the response.
+
    Raises :exc:`URLError` on errors.
 
    Note that ``None`` may be returned if no handler handles the request (though