diff options
author | Senthil Kumaran <senthil@uthcode.com> | 2013-02-07 08:50:02 (GMT) |
---|---|---|
committer | Senthil Kumaran <senthil@uthcode.com> | 2013-02-07 08:50:02 (GMT) |
commit | b36f7d7b7e6e1c7d98592d25ebf3dd3f6945e60f (patch) | |
tree | a3ae31a169b9f6d6982468b733562a62dad68620 /Doc/library/urllib.request.rst | |
parent | 59cf23ab076b60474b4906d31774c9cb727b6e3f (diff) | |
parent | 599ac4ba2dd6af6549dcafe4d948595001dec2f5 (diff) | |
download | cpython-b36f7d7b7e6e1c7d98592d25ebf3dd3f6945e60f.zip cpython-b36f7d7b7e6e1c7d98592d25ebf3dd3f6945e60f.tar.gz cpython-b36f7d7b7e6e1c7d98592d25ebf3dd3f6945e60f.tar.bz2 |
Fix Issue17069: Document getcode method in urllib.request.rst
Diffstat (limited to 'Doc/library/urllib.request.rst')
-rw-r--r-- | Doc/library/urllib.request.rst | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index d5f3f2c..7b72aa3 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -63,16 +63,24 @@ The :mod:`urllib.request` module defines the following functions: 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 |