From d2367c651ec5e0955d1d27ccec94f060efb246aa Mon Sep 17 00:00:00 2001 From: R David Murray Date: Fri, 3 Jun 2016 20:16:06 -0400 Subject: [PATCH] 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. --- Lib/urllib/request.py | 12 ++++++------ Misc/ACKS | 1 + 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/Lib/urllib/request.py b/Lib/urllib/request.py index 4a3daec5d0..333c3f245c 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). diff --git a/Misc/ACKS b/Misc/ACKS index 84378050f8..ee67e2737c 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -884,6 +884,7 @@ Eric Lindvall Gregor Lingl Everett Lipman Mirko Liss +Alexander Liu Nick Lockwood Stephanie Lockwood Martin von Löwis -- 2.40.0