Skip to content

gh-136752: Clarify documentation for IPv{N}Address.is_reserved #136794

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
AA-Turner merged 17 commits into from
Jul 19, 2025
Merged

gh-136752: Clarify documentation for IPv{N}Address.is_reserved #136794

Changes from 11 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
defdace
gh-136752: clarify ipaddress documentation of the is_reserved property
Jul 19, 2025
84c6210
Merge branch 'main' into fix-doc-issue-136752
mlnrt Jul 19, 2025
505ee34
Merge branch 'main' into fix-doc-issue-136752
mlnrt Jul 19, 2025
94fb99d
add clarification to the ipaddress is_reserved property
Jul 19, 2025
bbbd14e
Merge branch 'fix-doc-issue-136752' of https://github.com/mlnrt/cpyth…
Jul 19, 2025
d5d369e
Merge branch 'main' into fix-doc-issue-136752
mlnrt Jul 19, 2025
132dc9d
fix trailing space
Jul 19, 2025
9f0e91e
gh-136752: clarify ipaddress documentation of the is_reserved property
Jul 19, 2025
19cfff2
Merge branch 'fix-doc-issue-136752' of https://github.com/mlnrt/cpyth…
Jul 19, 2025
40bf8d2
gh-136752: clarify ipaddress documentation of the is_reserved property
Jul 19, 2025
256028e
Merge branch 'fix-doc-issue-136752' of https://github.com/mlnrt/cpyth…
Jul 19, 2025
0c23c09
Update Doc/library/ipaddress.rst
mlnrt Jul 19, 2025
6ad13b1
homogenize references to address blocks tables
Jul 19, 2025
9bae029
add mention about IPv6 former site-local address block.
Jul 19, 2025
5a0b8e1
make use of note and caution markers
Jul 19, 2025
34b8de3
fix linting
Jul 19, 2025
350417d
RFC
AA-Turner Jul 19, 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
7 changes: 6 additions & 1 deletion Doc/library/ipaddress.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,11 @@ write code that handles both IP versions correctly. Address objects are

.. attribute:: is_reserved

``True`` if the address is otherwise IETF reserved.
``True`` if the address is *labelled* as reserved by the IETF:

* IPv4 address ``240.0.0.0/4`` named ``Reserved``. This attribute is not related to the
``Reserved-by-Protocol`` value in iana-ipv4-special-registry_
* IPv6 addresses allocated as ``Reserved by IETF`` for future use (see iana-ipv6-address-space_)

.. attribute:: is_loopback

Expand All @@ -261,6 +265,7 @@ write code that handles both IP versions correctly. Address objects are

.. _iana-ipv4-special-registry: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
.. _iana-ipv6-special-registry: https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
.. _iana-ipv6-address-space: https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml

.. method:: IPv4Address.__format__(fmt)

Expand Down
Loading