bpo-12707: deprecate info(), geturl(), getcode() methods in favor of headers, url, and status properties for HTTPResponse and addinfourl

Doc/library/http.client.rst

@@ -460,6 +460,14 @@ statement.
 
    HTTP protocol version used by server.  10 for HTTP/1.0, 11 for HTTP/1.1.
 
+.. attribute:: HTTPResponse.url
+
+   URL of the resource retrieved, commonly used to determine if a redirect was followed
+
+.. attribute:: HTTPResponse.headers
+
+   Headers of the response in the form of an :meth:`email.message_from_string` instance
+
 .. attribute:: HTTPResponse.status
 
    Status code returned by server.
@@ -477,6 +485,18 @@ statement.
 
    Is ``True`` if the stream is closed.
 
+.. method:: HTTPResponse.geturl()
+
+   Returns the URL of the resource retrieved. Recommended to use *HTTPResponse.url* instead.
+
+.. method:: HTTPResponse.info()
+
+   Returns the response headers. Recommended to use *HTTPResponse.headers* instead.
+
+.. method:: HTTPResponse.getstatus()
+
+   Returns the status. Recommended to use *HTTPResponse.status* instead.
+
 Examples
 --------
 

Doc/library/urllib.request.rst

@@ -55,16 +55,8 @@ The :mod:`urllib.request` module defines the following functions:
    The *cadefault* parameter is ignored.
 
    This function always returns an object which can work as a
-   :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:`~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://jkorpela.fi/http.html>`_)
-
-   * :meth:`~urllib.response.addinfourl.getcode` -- return the HTTP status code of the response.
+   :term:`context manager` and has the properties `url`, `headers`, and `status`.
+   See :class:`urllib.response.addinfourl` for more detail on these properties.
 
    For HTTP and HTTPS URLs, this function returns a
    :class:`http.client.HTTPResponse` object slightly modified. In addition
@@ -1557,9 +1549,38 @@ some point in the future.
    :synopsis: Response classes used by urllib.
 
 The :mod:`urllib.response` module defines functions and classes which define a
-minimal file like interface, including ``read()`` and ``readline()``. The
-typical response object is an addinfourl instance, which defines an ``info()``
-method and that returns headers and a ``geturl()`` method that returns the url.
-Functions defined by this module are used internally by the
-:mod:`urllib.request` module.
+minimal file-like interface, including ``read()`` and ``readline()``.
+Functions defined by this module are used internally by the :mod:`urllib.request` module.
+The typical response object is a :class:`urllib.response.addinfourl` instance:
+
+.. class:: urllib.response.addinfourl
+
+.. attribute:: addinfourl.url
+
+   URL of the resource retrieved, commonly used to determine if a redirect was followed
+
+.. attribute:: addinfourl.headers
+
+   Returns 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://jkorpela.fi/http.html>`_)
+
+.. attribute:: addinfourl.code
+
+   Status code returned by server.
+
+.. attribute:: addinfourl.status
+
+   Status code returned by server. Recommended to use *addinfourl.status* instead.
+
+.. method:: addinfourl.geturl()
+
+   Returns the URL of the resource retrieved. Recommended to use *addinfourl.url* instead.
+
+.. method:: addinfourl.info()
+
+   Returns the response headers. Recommended to use *addinfourl.headers* instead.
+
+.. method:: addinfourl.getstatus()
 
+   Returns the status. Recommended to use *addinfourl.status* instead.

Lib/test/test_urllib.py

@@ -187,12 +187,15 @@ def test_close(self):
 
     def test_info(self):
         self.assertIsInstance(self.returned_obj.info(), email.message.Message)
+        self.assertIsInstance(self.returned_obj.headers, email.message.Message)
 
     def test_geturl(self):
         self.assertEqual(self.returned_obj.geturl(), self.pathname)
+        self.assertEqual(self.returned_obj.url, self.pathname)
 
     def test_getcode(self):
         self.assertIsNone(self.returned_obj.getcode())
+        self.assertIsNone(self.returned_obj.status)
 
     def test_iter(self):
         # Test iterator

Lib/test/test_urllib_response.py

@@ -42,6 +42,7 @@ def closehook():
     def test_addinfo(self):
         info = urllib.response.addinfo(self.fp, self.test_headers)
         self.assertEqual(info.info(), self.test_headers)
+        self.assertEqual(info.headers, self.test_headers)
 
     def test_addinfourl(self):
         url = "http://www.python.org"
@@ -51,6 +52,9 @@ def test_addinfourl(self):
         self.assertEqual(infourl.info(), self.test_headers)
         self.assertEqual(infourl.geturl(), url)
         self.assertEqual(infourl.getcode(), code)
+        self.assertEqual(infourl.headers, self.test_headers)
+        self.assertEqual(infourl.url, url)
+        self.assertEqual(infourl.status, code)
 
     def tearDown(self):
         self.sock.close()

Lib/urllib/request.py

@@ -163,18 +163,10 @@ def urlopen(url, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
 
     The *cadefault* parameter is ignored.
 
-    This function always returns an object which can work as a context
-    manager and has methods such as
 
-    * geturl() - return the URL of the resource retrieved, commonly used to
-      determine if a redirect was followed
-
-    * info() - return the meta-information of the page, such as headers, in the
-      form of an email.message_from_string() instance (see Quick Reference to
-      HTTP Headers)
-
-    * getcode() - return the HTTP status code of the response.  Raises URLError
-      on errors.
+   This function always returns an object which can work as a
+   :term:`context manager` and has the properties `url`, `headers`, and `status`.
+   See `urllib.response.addinfourl` for more detail on these properties.
 
     For HTTP and HTTPS URLs, this function returns a http.client.HTTPResponse
     object slightly modified. In addition to the three new methods above, the

Lib/urllib/response.py

@@ -64,7 +64,6 @@ def __init__(self, fp, headers):
     def info(self):
         return self.headers
 
-
 class addinfourl(addinfo):
     """class to add info() and geturl() methods to an open file."""
 
@@ -73,6 +72,10 @@ def __init__(self, fp, headers, url, code=None):
         self.url = url
         self.code = code
 
+    @property
+    def status(self):
+        return self.code
+
     def getcode(self):
         return self.code