Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-31 04:23:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.14] gh-136752: Clarify documentation for `IPv{N}Address.is_reserved` (GH-136794) (#136827)

Browse source 
gh-136752: Clarify documentation for ``IPv{N}Address.is_reserved`` (GH-136794)
(cherry picked from commit 6293d8a1a6)

Co-authored-by: Matthieu Lienart <50069805+mlnrt@users.noreply.github.com>
Co-authored-by: Matthieu Lienart <matthieu.lienart@axians.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2025-07-19 16:50:30 +02:00 • committed by GitHub
parent 8d063f3d92
commit f8af7cb723
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/library/ipaddress.rst
View file

@ -240,7 +240,16 @@ 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 noted as reserved by the IETF.
For IPv4, this is only ``240.0.0.0/4``, the ``Reserved`` address block.
For IPv6, this is all addresses `allocated <iana-ipv6-address-space_>`__ as
``Reserved by IETF`` for future use.
.. note:: For IPv4, ``is_reserved`` is not related to the address block value of the
``Reserved-by-Protocol`` column in iana-ipv4-special-registry_.
.. caution:: For IPv6, ``fec0::/10`` a former Site-Local scoped address prefix is
currently excluded from that list (see :attr:`~IPv6Address.is_site_local` & :rfc:`3879`).
.. attribute:: is_loopback
@ -261,6 +270,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)