Skip to content

gh-48241: Clarify URL needs to be encoded when provided to urlopen and Request #103855

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.

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
merged 4 commits into from
Apr 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions Doc/library/urllib.request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The :mod:`urllib.request` module defines the following functions:

.. function:: urlopen(url, data=None[, timeout], *, cafile=None, capath=None, cadefault=False, context=None)

Open the URL *url*, which can be either a string or a
:class:`Request` object.
Open *url*, which can be either a string containing a valid, properly
encoded URL, or a :class:`Request` object.

*data* must be an object specifying additional data to be sent to the
server, or ``None`` if no such data is needed. See :class:`Request`
Expand Down Expand Up @@ -192,7 +192,7 @@ The following classes are provided:

This class is an abstraction of a URL request.

*url* should be a string containing a valid URL.
*url* should be a string containing a valid, properly encoded URL.

*data* must be an object specifying additional data to send to the
server, or ``None`` if no such data is needed. Currently HTTP
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarifying documentation about the url parameter to urllib.request.urlopen and urllib.request.Requst needing to be encoded properly.