Skip to content

[2.7] bpo-32804: Include the context parameter in urlretrieve documentation #10203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhangyangyu merged 3 commits into from
Nov 1, 2018
Merged

[2.7] bpo-32804: Include the context parameter in urlretrieve documentation #10203

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
354e13a
Update urllib documentation to include the context parameter in urlre…
lysnikolaou Oct 28, 2018
63cbcae
Wrap line around column #79 as is done throughout the file
lysnikolaou Oct 29, 2018
0e60144
Two spaces after period, versionchanged in URLopener
lysnikolaou Oct 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions Doc/library/urllib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down