[Python-checkins] cpython: Issue #22797: Synchronize urlopen() doc string with RST documentation

Sat Jun 4 01:31:32 EDT 2016

https://hg.python.org/cpython/rev/2d69d0419879
changeset: 101683:2d69d0419879
user: Martin Panter <vadmium+py at gmail.com>
date: Sat Jun 04 05:06:34 2016 +0000
summary:
 Issue #22797: Synchronize urlopen() doc string with RST documentation
files:
 Lib/urllib/request.py | 19 ++++++++++++-------
 1 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/Lib/urllib/request.py b/Lib/urllib/request.py
--- a/Lib/urllib/request.py
+++ b/Lib/urllib/request.py
@@ -172,8 +172,8 @@
 
 The *cadefault* parameter is ignored.
 
- For http and https urls, this function returns a http.client.HTTPResponse
- object which has the following HTTPResponse Objects methods:
+ 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
@@ -185,12 +185,17 @@
 * getcode() - return the HTTP status code of the response. Raises URLError
 on errors.
 
- For ftp, file, and data urls and requests explicitly handled by legacy
+ For HTTP and HTTPS URLs, this function returns a http.client.HTTPResponse
+ object slightly modified. In addition to the three new methods above, the
+ msg attribute contains the same information as the reason attribute ---
+ the reason phrase returned by the server --- instead of the response
+ headers as it is specified in the documentation for HTTPResponse.
+
+ For FTP, file, and data URLs and requests explicitly handled by legacy
 URLopener and FancyURLopener classes, this function returns a
- urllib.response.addinfourl object which can work as a context manager and
- also support the geturl(), info(), getcode() methods listed above.
-
- Note that *None& may be returned if no handler handles the request (though
+ urllib.response.addinfourl object.
+
+ Note that None may be returned if no handler handles the request (though
 the default installed global OpenerDirector uses UnknownHandler to ensure
 this never happens).
 
-- 
Repository URL: https://hg.python.org/cpython
