whatsnew: ipaddress is_global

Also tweaked the docs a bit and added the missing entry for
the ipv6 is_global.
This commit is contained in:
R David Murray 2014-03-06 11:51:37 -05:00
parent 5dda12491e
commit 6674ac0873
2 changed files with 17 additions and 5 deletions

View File

@ -154,16 +154,16 @@ write code that handles both IP versions correctly.
.. attribute:: is_private .. attribute:: is_private
``True`` if the address is allocated for private networks. See ``True`` if the address is allocated for private networks. See
iana-ipv4-special-registry (for IPv4) or iana-ipv6-special-registry iana-ipv4-special-registry_ (for IPv4) or iana-ipv6-special-registry_
(for IPv6). (for IPv6).
.. attribute:: is_global .. attribute:: is_global
``True`` if the address is allocated for public networks. See ``True`` if the address is allocated for public networks. See
iana-ipv4-special-registry (for IPv4) or iana-ipv6-special-registry iana-ipv4-special-registry_ (for IPv4) or iana-ipv6-special-registry_
(for IPv6). (for IPv6).
.. versionadded:: 3.4 .. versionadded:: 3.4
.. attribute:: is_unspecified .. attribute:: is_unspecified
@ -184,6 +184,9 @@ write code that handles both IP versions correctly.
``True`` if the address is reserved for link-local usage. See ``True`` if the address is reserved for link-local usage. See
:RFC:`3927`. :RFC:`3927`.
.. _iana-ipv4-special-registry: http://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
.. _iana-ipv6-special-registry: http://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
.. class:: IPv6Address(address) .. class:: IPv6Address(address)
@ -218,18 +221,23 @@ write code that handles both IP versions correctly.
The long form of the address representation, with all leading zeroes and The long form of the address representation, with all leading zeroes and
groups consisting entirely of zeroes included. groups consisting entirely of zeroes included.
For the following attributes, see the corresponding documention of the
:class:`IPv4Address` class:
.. attribute:: packed .. attribute:: packed
.. attribute:: version .. attribute:: version
.. attribute:: max_prefixlen .. attribute:: max_prefixlen
.. attribute:: is_multicast .. attribute:: is_multicast
.. attribute:: is_private .. attribute:: is_private
.. attribute:: is_global
.. attribute:: is_unspecified .. attribute:: is_unspecified
.. attribute:: is_reserved .. attribute:: is_reserved
.. attribute:: is_loopback .. attribute:: is_loopback
.. attribute:: is_link_local .. attribute:: is_link_local
Refer to the corresponding attribute documentation in .. versionadded:: 3.4
:class:`IPv4Address` is_global
.. attribute:: is_site_local .. attribute:: is_site_local

View File

@ -901,6 +901,10 @@ has been removed: :mod:`ipaddress` is now considered a stable API, covered
by the normal standard library requirements to maintain backwards by the normal standard library requirements to maintain backwards
compatibility. compatibility.
A new :attr:`~ipaddress.IPv4Address.is_global` property is ``True`` if
an address is globally routeable. (Contributed by Peter Moody in
:issue:`17400`.)
logging logging
------- -------