Skip to content

gh-110462: Document that urllib.request does not serialize data #158106

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

Open
vasiliyk wants to merge 4 commits into
base: main
Choose a base branch
from
+5 −0
Open

gh-110462: Document that urllib.request does not serialize data #158106

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44b5b3c
gh-110462: Reject mapping data in urllib.request with a clear TypeError
vasiliyk Sep 24, 2026
c15c092
Add NEWS entry
vasiliyk Sep 24, 2026
b9f43a3
Review fixes: use collections.abc, restore comment, document mapping …
vasiliyk Sep 24, 2026
c0a1276
Rework as a docs-only change
vasiliyk Oct 13, 2026
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
5 changes: 5 additions & 0 deletions Doc/library/urllib.request.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,11 @@ The following classes are provided:
bytes objects, while ``Transfer-Encoding: chunked`` as specified in
:rfc:`7230`, Section 3.3.1 will be used to send files and other iterables.

*data* is not serialized before it is sent: the elements of an iterable
are sent as is, so a :class:`dict` yields only its keys. Structured
data such as a JSON object must be encoded to bytes first, for example
with :func:`json.dumps`.

For an HTTP POST request method, *data* should be a buffer in the
standard :mimetype:`application/x-www-form-urlencoded` format. The
:func:`urllib.parse.urlencode` function takes a mapping or sequence
Expand Down
Loading