]> granicus.if.org Git - python/commitdiff
Clean up urlopen doc string.
authorR David Murray <rdmurray@bitdance.com>
Sat, 4 Jun 2016 00:16:06 +0000 (20:16 -0400)
committerR David Murray <rdmurray@bitdance.com>
Sat, 4 Jun 2016 00:16:06 +0000 (20:16 -0400)
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
Misc/ACKS

index 4a3daec5d0beae4dd0f56da8d1b742717a63f30d..333c3f245c541f2f93ed05082de7afddf8b9e6ad 100644 (file)
@@ -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).
index 84378050f8198178b603b1e239edb7091ee94808..ee67e2737caf31ffe0bdec877194e45cf7bf8b99 100644 (file)
--- 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