diff options
author | R David Murray <rdmurray@bitdance.com> | 2016-06-04 00:16:06 (GMT) |
---|---|---|
committer | R David Murray <rdmurray@bitdance.com> | 2016-06-04 00:16:06 (GMT) |
commit | d2367c651ec5e0955d1d27ccec94f060efb246aa (patch) | |
tree | bc4a423e63e1bab329edf1527955a8a3d8cf1b80 | |
parent | 13ee7d15e3073ca1e602c655ede660a9b1dac01e (diff) | |
download | cpython-d2367c651ec5e0955d1d27ccec94f060efb246aa.zip cpython-d2367c651ec5e0955d1d27ccec94f060efb246aa.tar.gz cpython-d2367c651ec5e0955d1d27ccec94f060efb246aa.tar.bz2 |
Clean up urlopen doc string.
Clarifies what is returned when and that the methods are common between the two.
Patch by Alexander Liu as part of #22797.
-rw-r--r-- | Lib/urllib/request.py | 12 | ||||
-rw-r--r-- | Misc/ACKS | 1 |
2 files changed, 7 insertions, 6 deletions
diff --git a/Lib/urllib/request.py b/Lib/urllib/request.py index 4a3daec..333c3f2 100644 --- a/Lib/urllib/request.py +++ b/Lib/urllib/request.py @@ -173,12 +173,7 @@ def urlopen(url, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, 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. - - 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 context manager and has - methods such as: + object which has the following HTTPResponse Objects methods: * geturl() - return the URL of the resource retrieved, commonly used to determine if a redirect was followed @@ -190,6 +185,11 @@ def urlopen(url, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, * 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 + URLopener and FancyURLopener classes, this function returns a + urllib.response.addinfourl object which can work as 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 the default installed global OpenerDirector uses UnknownHandler to ensure this never happens). @@ -884,6 +884,7 @@ Eric Lindvall Gregor Lingl Everett Lipman Mirko Liss +Alexander Liu Nick Lockwood Stephanie Lockwood Martin von Löwis |