summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorLysandros Nikolaou <lisandrosnik@gmail.com>2018-11-01 02:49:10 +0100
committerXiang Zhang <angwerzx@126.com>2018-11-01 09:49:10 +0800
commitaa39c1ab6de6d3fb0204741efdde9b7eed25b093 (patch)
tree9957aa7cb4691bfb019afd954b725d47dfbcde0e /Doc
parent05acd44ad6b61adb24571eb0203de7b25c7e869b (diff)
downloadcpython-git-aa39c1ab6de6d3fb0204741efdde9b7eed25b093.tar.gz
[2.7] bpo-32804: Include the context parameter in urlretrieve documentation (GH-10203)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/urllib.rst17
1 files changed, 15 insertions, 2 deletions
diff --git a/Doc/library/urllib.rst b/Doc/library/urllib.rst
index c24f4375e9..084d567e5e 100644
--- a/Doc/library/urllib.rst
+++ b/Doc/library/urllib.rst
@@ -147,14 +147,15 @@ High-level interface
:envvar:`no_proxy` environment variable.
.. versionchanged:: 2.7.9
- The *context* parameter was added. All the neccessary certificate and hostname checks are done by default.
+ The *context* parameter was added. All the neccessary certificate and hostname
+ checks are done by default.
.. deprecated:: 2.6
The :func:`urlopen` function has been removed in Python 3 in favor
of :func:`urllib2.urlopen`.
-.. function:: urlretrieve(url[, filename[, reporthook[, data]]])
+.. function:: urlretrieve(url[, filename[, reporthook[, data[, context]]]])
Copy a network object denoted by a URL to a local file, if necessary. If the URL
points to a local file, or a valid cached copy of the object exists, the object
@@ -179,6 +180,10 @@ High-level interface
:mimetype:`application/x-www-form-urlencoded` format; see the :func:`urlencode`
function below.
+ The *context* parameter may be set to a :class:`ssl.SSLContext` instance to
+ configure the SSL settings that are used if :func:`urlretrieve` makes a HTTPS
+ connection.
+
.. versionchanged:: 2.5
:func:`urlretrieve` will raise :exc:`ContentTooShortError` when it detects that
the amount of data available was less than the expected amount (which is the
@@ -196,6 +201,10 @@ High-level interface
the size of the data it has downloaded, and just returns it. In this case you
just have to assume that the download was successful.
+ .. versionchanged:: 2.7.9
+ The *context* parameter was added. All the neccessary certificate and hostname
+ checks are done by default.
+
.. data:: _urlopener
@@ -349,6 +358,10 @@ URL Opener objects
:class:`URLopener` objects will raise an :exc:`IOError` exception if the server
returns an error code.
+ .. versionchanged:: 2.7.9
+ The *context* parameter was added. All the neccessary certificate and hostname
+ checks are done by default.
+
.. method:: open(fullurl[, data])
Open *fullurl* using the appropriate protocol. This method sets up cache and