]> granicus.if.org Git - python/commitdiff
whatsnew: ipaddress is_global
authorR David Murray <rdmurray@bitdance.com>
Thu, 6 Mar 2014 16:51:37 +0000 (11:51 -0500)
committerR David Murray <rdmurray@bitdance.com>
Thu, 6 Mar 2014 16:51:37 +0000 (11:51 -0500)
Also tweaked the docs a bit and added the missing entry for
the ipv6 is_global.

Doc/library/ipaddress.rst
Doc/whatsnew/3.4.rst

index aedf5c22b5c6421351e63f7d00d05512e1075a74..9625e71b0422bcf114ece03a0157f1e6db6550b3 100644 (file)
@@ -154,16 +154,16 @@ write code that handles both IP versions correctly.
    .. attribute:: is_private
 
       ``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).
 
    .. attribute:: is_global
 
       ``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).
 
-   .. versionadded:: 3.4
+      .. versionadded:: 3.4
 
    .. 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
       :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)
 
@@ -218,18 +221,23 @@ write code that handles both IP versions correctly.
    The long form of the address representation, with all leading zeroes and
    groups consisting entirely of zeroes included.
 
+
+   For the following attributes, see the corresponding documention of the
+   :class:`IPv4Address` class:
+
    .. attribute:: packed
    .. attribute:: version
    .. attribute:: max_prefixlen
    .. attribute:: is_multicast
    .. attribute:: is_private
+   .. attribute:: is_global
    .. attribute:: is_unspecified
    .. attribute:: is_reserved
    .. attribute:: is_loopback
    .. attribute:: is_link_local
 
-      Refer to the corresponding attribute documentation in
-      :class:`IPv4Address`
+      .. versionadded:: 3.4
+         is_global
 
    .. attribute:: is_site_local
 
index 69246b79c864800583b1e2ec02e4821037fe79b9..8623c30d5788ba1af9c329225eea2c52ad233b06 100644 (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
 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
 -------