Skip to content

gh-130283: update deprecated links and examples in urllib.request docs #130284

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
picnixz merged 7 commits into from
Mar 23, 2025
Merged

gh-130283: update deprecated links and examples in urllib.request docs #130284

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
061cba8
gh-130283: update deprecated links and examples in `urllib.request` docs
Mr-Sunglasses Feb 18, 2025
48ce606
Merge branch 'main' into fix/deprecated-examples-urllib.request
Mr-Sunglasses Mar 9, 2025
2b066f7
docs: fix the ". ::" sentences and merge them into "::" directly
Mr-Sunglasses Mar 9, 2025
29c53e7
docs: Add the reference of HTML spec document and W3C document
Mr-Sunglasses Mar 9, 2025
6eee248
Merge branch 'main' into fix/deprecated-examples-urllib.request
picnixz Mar 23, 2025
0c4d55e
Apply suggestions from code review
picnixz Mar 23, 2025
6c60d90
Update Doc/library/urllib.request.rst
picnixz Mar 23, 2025
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
28 changes: 14 additions & 14 deletions Doc/library/urllib.request.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1213,45 +1213,45 @@ In addition to the examples below, more examples are given in
:ref:`urllib-howto`.

This example gets the python.org main page and displays the first 300 bytes of
it. ::
it::

>>> import urllib.request
>>> with urllib.request.urlopen('http://www.python.org/') as f:
... print(f.read(300))
...
b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n
<meta http-equiv="content-type" content="text/html; charset=utf-8" />\n
<title>Python Programming '
b'<!doctype html>\n<!--[if lt IE 7]> <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9"> <![endif]-->\n<!--[if IE 7]> <html class="no-js ie7 lt-ie8 lt-ie9"> <![endif]-->\n<!--[if IE 8]> <html class="no-js ie8 lt-ie9">

Note that urlopen returns a bytes object. This is because there is no way
for urlopen to automatically determine the encoding of the byte stream
it receives from the HTTP server. In general, a program will decode
the returned bytes object to string once it determines or guesses
the appropriate encoding.

The following W3C document, https://www.w3.org/International/O-charset\ , lists
the various ways in which an (X)HTML or an XML document could have specified its
The following HTML spec document, https://html.spec.whatwg.org/#charset\ , lists
Comment thread
picnixz marked this conversation as resolved.
Outdated
the various ways in which an HTML document could have specified its
Copy link
Copy Markdown
Member

@picnixz picnixz Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

XML is still covered by the document but they explicitly don't say "XHTML".

Comment thread
picnixz marked this conversation as resolved.
Outdated
encoding information.

For additional information, see the W3C document: https://www.w3.org/International/questions/qa-html-encoding-declarations\ .
Comment thread
picnixz marked this conversation as resolved.
Outdated
Comment thread
picnixz marked this conversation as resolved.
Outdated

As the python.org website uses *utf-8* encoding as specified in its meta tag, we
will use the same for decoding the bytes object. ::
will use the same for decoding the bytes object::

>>> with urllib.request.urlopen('http://www.python.org/') as f:
... print(f.read(100).decode('utf-8'))
...
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtm
<!doctype html>
<!--[if lt IE 7]> <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9"> <![endif]-->
<!-

It is also possible to achieve the same result without using the
Comment thread
picnixz marked this conversation as resolved.
:term:`context manager` approach. ::
:term:`context manager` approach::

>>> import urllib.request
>>> f = urllib.request.urlopen('http://www.python.org/')
>>> print(f.read(100).decode('utf-8'))
Comment thread
picnixz marked this conversation as resolved.
Outdated
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtm
<!doctype html>
<!--[if lt IE 7]> <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9"> <![endif]-->
<!--

In the following example, we are sending a data-stream to the stdin of a CGI
and reading the data it returns to us. Note that this example will only work
Expand Down