Commit aa39c1ab authored by Lysandros Nikolaou's avatar Lysandros Nikolaou Committed by Xiang Zhang

[2.7] bpo-32804: Include the context parameter in urlretrieve documentation (GH-10203)

parent 05acd44a
...@@ -147,14 +147,15 @@ High-level interface ...@@ -147,14 +147,15 @@ High-level interface
:envvar:`no_proxy` environment variable. :envvar:`no_proxy` environment variable.
.. versionchanged:: 2.7.9 .. 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 .. deprecated:: 2.6
The :func:`urlopen` function has been removed in Python 3 in favor The :func:`urlopen` function has been removed in Python 3 in favor
of :func:`urllib2.urlopen`. 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 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 points to a local file, or a valid cached copy of the object exists, the object
...@@ -179,6 +180,10 @@ High-level interface ...@@ -179,6 +180,10 @@ High-level interface
:mimetype:`application/x-www-form-urlencoded` format; see the :func:`urlencode` :mimetype:`application/x-www-form-urlencoded` format; see the :func:`urlencode`
function below. 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 .. versionchanged:: 2.5
:func:`urlretrieve` will raise :exc:`ContentTooShortError` when it detects that :func:`urlretrieve` will raise :exc:`ContentTooShortError` when it detects that
the amount of data available was less than the expected amount (which is the the amount of data available was less than the expected amount (which is the
...@@ -196,6 +201,10 @@ High-level interface ...@@ -196,6 +201,10 @@ High-level interface
the size of the data it has downloaded, and just returns it. In this case you 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. 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 .. data:: _urlopener
...@@ -349,6 +358,10 @@ URL Opener objects ...@@ -349,6 +358,10 @@ URL Opener objects
:class:`URLopener` objects will raise an :exc:`IOError` exception if the server :class:`URLopener` objects will raise an :exc:`IOError` exception if the server
returns an error code. 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]) .. method:: open(fullurl[, data])
Open *fullurl* using the appropriate protocol. This method sets up cache and Open *fullurl* using the appropriate protocol. This method sets up cache and
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment