File: //proc/self/root/lib/python3.6/site-packages/netaddr/ip/__pycache__/__init__.cpython-36.pyc
3
��]� � @ s@ d Z ddlZddlmZmZmZmZmZm Z m
Z
m Z m Z m
Z
ddlmZmZ ddlmZmZmZmZmZ G dd� de�ZG dd � d e�ZG d
d � d e�Z dUd
d�Z G dd� dee �Z G dd� dee �Z dd� Z dd� Z!dd� Z"dd� Z#dd � Z$d d � Z%dVd d!�Z&d"d#� Z'd$d%� Z(d&d'� Z)d(d)� Z*e d*�Z+e d+�e d,�e d-�e d.�e d/�e d0�e d1d2�fZ,e d3�Z-e d4�Z.e d5�Z/e d6�e d7�e d8�e d9�e d:�e d;�e d<d=�e d>d?�fe+e/f Z0ed@�Z1e dA�e dB�fZ2e dC�Z3e dD�Z4e dE�e dF�e dG�e dH�e dI�e dJ�e dK�e dL�e dM�e dN�e dO�e dP�e dQ�e dR�e dS�e dT�fZ5dS )Wz9Routines for IPv4 and IPv6 addresses, subnets and ranges.� N)
�AddrFormatError�AddrConversionError�num_bits�
DictDotLookup�NOHOST�N� INET_PTON�P�ZEROFILL�Z)�ipv4�ipv6)� _sys_maxint� _iter_range�_is_str� _int_type� _str_typec @ s� e Zd ZdZd3Zdd� Zdd� Zedd � ed
d �Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zed.d/� �Zed0d1� �Zd2S )4�BaseIPzi
An abstract base class for common operations shared between various IP
related subclasses.
�_value�_modulec C s d| _ d| _dS )z Constructor.N)r r )�self� r � /usr/lib/python3.6/__init__.py�__init__ s zBaseIP.__init__c C sP t |t�stdt|� ��d| ko0| jjkn sFtd| jj ��|| _d S )Nz int argument expected, not %sr z&value out of bounds for an %s address!) �
isinstancer � TypeError�typer �max_intr � family_namer )r �valuer r r �
_set_value s
zBaseIP._set_valuec C s | j S )N)r )r r r r �<lambda>( s zBaseIP.<lambda>z?a positive integer representing the value of IP address/subnet.)�docc C s t S )zP
:return: a key tuple that uniquely identifies this IP address.
)�NotImplemented)r r r r �key+ s z
BaseIP.keyc C s t S )zg
:return: A key tuple used to compare and sort this `IPAddress`
correctly.
)r# )r r r r �sort_key1 s zBaseIP.sort_keyc C s t | j� �S )zM
:return: A hash value uniquely indentifying this IP object.
)�hashr$ )r r r r �__hash__8 s zBaseIP.__hash__c C s. y| j � |j � kS ttfk
r( tS X dS )z�
:param other: an `IPAddress` or `IPNetwork` object.
:return: ``True`` if this `IPAddress` or `IPNetwork` object is
equivalent to ``other``, ``False`` otherwise.
N)r$ �AttributeErrorr r# )r �otherr r r �__eq__> s z
BaseIP.__eq__c C s. y| j � |j � kS ttfk
r( tS X dS )z�
:param other: an `IPAddress` or `IPNetwork` object.
:return: ``True`` if this `IPAddress` or `IPNetwork` object is
not equivalent to ``other``, ``False`` otherwise.
N)r$ r( r r# )r r) r r r �__ne__J s z
BaseIP.__ne__c C s. y| j � |j � k S ttfk
r( tS X dS )z�
:param other: an `IPAddress` or `IPNetwork` object.
:return: ``True`` if this `IPAddress` or `IPNetwork` object is
less than ``other``, ``False`` otherwise.
N)r% r( r r# )r r) r r r �__lt__V s z
BaseIP.__lt__c C s. y| j � |j � kS ttfk
r( tS X dS )z�
:param other: an `IPAddress` or `IPNetwork` object.
:return: ``True`` if this `IPAddress` or `IPNetwork` object is
less than or equal to ``other``, ``False`` otherwise.
N)r% r( r r# )r r) r r r �__le__b s z
BaseIP.__le__c C s. y| j � |j � kS ttfk
r( tS X dS )z�
:param other: an `IPAddress` or `IPNetwork` object.
:return: ``True`` if this `IPAddress` or `IPNetwork` object is
greater than ``other``, ``False`` otherwise.
N)r% r( r r# )r r) r r r �__gt__n s z
BaseIP.__gt__c C s. y| j � |j � kS ttfk
r( tS X dS )z�
:param other: an `IPAddress` or `IPNetwork` object.
:return: ``True`` if this `IPAddress` or `IPNetwork` object is
greater than or equal to ``other``, ``False`` otherwise.
N)r% r( r r# )r r) r r r �__ge__z s z
BaseIP.__ge__c C s
| j � S )z<:return: ``True`` if this IP is unicast, ``False`` otherwise)� is_multicast)r r r r �
is_unicast� s zBaseIP.is_unicastc C s( | j tkr| tkS | j tkr$| tkS dS )z>:return: ``True`` if this IP is multicast, ``False`` otherwiseN)r �_ipv4�IPV4_MULTICAST�_ipv6�IPV6_MULTICAST)r r r r r0 � s
zBaseIP.is_multicastc C s, | j jdkr| tkS | j jdkr(| tkS dS )z�
:return: ``True`` if this IP is loopback address (not for network
transmission), ``False`` otherwise.
References: RFC 3330 and 4291.
� � N)r �version�
IPV4_LOOPBACK�
IPV6_LOOPBACK)r r r r � is_loopback� s zBaseIP.is_loopbackc C s^ | j jdkr(x@tD ]}| |krdS qW n&| j jdkrNxtD ]}| |kr:dS q:W | j� rZdS dS )z�
:return: ``True`` if this IP is for internal/private use only
(i.e. non-public), ``False`` otherwise. Reference: RFCs 1918,
3330, 4193, 3879 and 2365.
r6 Tr7 F)r r8 � IPV4_PRIVATE� IPV6_PRIVATE�
is_link_local)r �cidrr r r �
is_private� s
zBaseIP.is_privatec C s, | j jdkr| tkS | j jdkr(| tkS dS )z�
:return: ``True`` if this IP is link-local address ``False`` otherwise.
Reference: RFCs 3927 and 4291.
r6 r7 N)r r8 �IPV4_LINK_LOCAL�IPV6_LINK_LOCAL)r r r r r> � s zBaseIP.is_link_localc C sR | j jdkr(x@tD ]}| |krdS qW n&| j jdkrNxtD ]}| |kr:dS q:W dS )z�
:return: ``True`` if this IP is in IANA reserved range, ``False``
otherwise. Reference: RFCs 3330 and 3171.
r6 Tr7 F)r r8 �
IPV4_RESERVED�
IPV6_RESERVED)r r? r r r � is_reserved� s
zBaseIP.is_reservedc C s | j jdko| jd? dkS )zp
:return: ``True`` if this IP is IPv4-compatible IPv6 address, ``False``
otherwise.
r7 � i�� )r r8 r )r r r r �is_ipv4_mapped� s zBaseIP.is_ipv4_mappedc C s | j jdko| jd? dkS )zl
:return: ``True`` if this IP is IPv4-mapped IPv6 address, ``False``
otherwise.
r7 rF r )r r8 r )r r r r �is_ipv4_compat� s zBaseIP.is_ipv4_compatc C s ddl m} t|| ��S )z~
A record dict containing IANA registration details for this IP address
if available, None otherwise.
r )�query)Znetaddr.ip.ianarI r )r rI r r r �info� s z BaseIP.infoc C s | j jS )z6the IP protocol version represented by this IP object.)r r8 )r r r r r8 � s zBaseIP.versionN)r r ) �__name__�
__module__� __qualname__�__doc__� __slots__r r �propertyr r$ r% r' r* r+ r, r- r. r/ r1 r0 r; r@ r> rE rG rH rJ r8 r r r r r s2
r c sL e Zd ZdZf ZdI� fdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
e
Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� ZdJd(d)�Zed*d+� �Zed,d-� �Zed.d/� �Z ed0d1� �Z d2d3� Z dKd5d6�Z dLd7d8�Z d9d:� Z!d;d<� Z"d=d>� Z#d?d@� Z$dAdB� Z%dCdD� Z&e&Z'dEdF� Z(dGdH� Z)� Z*S )M� IPAddressz�
An individual IPv4 or IPv6 address without a net mask or subnet prefix.
To support these and other network based operations, see `IPNetwork`.
Nr c s t t| �j� t|t�rH|dk r4||jjkr4td��|j| _|j| _�n�|dk r||dkr`t | _n |dkrpt
| _n td| ��t |�r�d|kr�td| j j
��| jdk�r�t|t��r6yhdt|� ko�t jkn r�t|�| _t | _n4t jt|� k �ot
jkn �rt|�| _t
| _W n tk
�r2 Y nX n@x>t t
fD ]2}y|j||�| _W n �w@Y n
X || _P �q@W | jdk�rtd | ��n�t |��r�y| jj||�| _W n* tk
�r� td
|| jjf ��Y nX n<dt|� k�o�| jjkn �r t|�| _n td | ��dS ) a�
Constructor.
:param addr: an IPv4 or IPv6 address which may be represented in an
accepted string format, as an unsigned integer or as another
IPAddress object (copy construction).
:param version: (optional) optimizes version detection if specified
and distinguishes between IPv4 and IPv6 for addresses with an
equivalent integer value.
:param flags: (optional) decides which rules are applied to the
interpretation of the addr value. Supported constants are
INET_PTON and ZEROFILL. See the netaddr.core docs for further
details.
Nz1cannot switch IP versions using copy constructor!r6 r7 z %r is an invalid IP version!�/zQ%s() does not support netmasks or subnet prefixes! See documentation for details.r z+failed to detect a valid IP address from %rz base address %r is not IPv%dzbad address format: %r)�superrQ r r r r r8 �
ValueErrorr r2 r4 r � __class__rK r �intr Z
str_to_intr )r �addrr8 �flags�module)rU r r r � sZ
$
$ zIPAddress.__init__c C s | j | jjfS )z1:returns: Pickled state of an `IPAddress` object.)r r r8 )r r r r � __getstate__A s zIPAddress.__getstate__c C sB |\}}|| _ |dkr t| _n |dkr.t| _ntdt|� ��dS )zT
:param state: data used to unpickle a pickled `IPAddress` object.
r6 r7 z&unpickling failed for object state: %sN)r r2 r r4 rT �str)r �stater r8 r r r � __setstate__E s zIPAddress.__setstate__c C s� | j � s| jjS | jdkr dS | j}d}x*|dkrR|d@ dkr@P |d7 }|dL }q*W | jj| }d| kov| jjkn s�td| ��|S )z�
@return: If this IP is a valid netmask, the number of non-zero
bits are returned, otherwise it returns the width in bits for
the IP address version.
r � z+Unexpected mask length %d for address type!)�
is_netmaskr �widthr rT )r Zi_val�numbitsZ mask_lengthr r r � netmask_bitsV s
zIPAddress.netmask_bitsc C s | j d }||d @ dkS )zV
:return: ``True`` if this IP address host mask, ``False`` otherwise.
r^ r )r )r �int_valr r r � is_hostmasku s
zIPAddress.is_hostmaskc C s" | j | jjA d }||d @ dkS )zY
:return: ``True`` if this IP address network mask, ``False`` otherwise.
r^ r )r r r )r rc r r r r_ | s zIPAddress.is_netmaskc C s@ t | j| �}d| ko$| jjkn r4|| _| S td��dS )z�
Increases the numerical value of this IPAddress by num.
An IndexError is raised if result exceeds maximum IP address value or
is less than zero.
:param num: size of IP address increment.
r z)result outside valid IP address boundary!N)rV r r r �
IndexError)r �num� new_valuer r r �__iadd__� s
zIPAddress.__iadd__c C s@ t | j| �}d| ko$| jjkn r4|| _| S td��dS )z�
Decreases the numerical value of this IPAddress by num.
An IndexError is raised if result is less than zero or exceeds maximum
IP address value.
:param num: size of IP address decrement.
r z)result outside valid IP address boundary!N)rV r r r re )r rf rg r r r �__isub__� s
zIPAddress.__isub__c C sF t | j| �}d| ko$| jjkn r:| j|| jj�S td��dS )a
Add the numerical value of this IP address to num and provide the
result as a new IPAddress object.
:param num: size of IP address increase.
:return: a new IPAddress object with its numerical value increased by num.
r z)result outside valid IP address boundary!N)rV r r r rU r8 re )r rf rg r r r �__add__� s zIPAddress.__add__c C sF t | j| �}d| ko$| jjkn r:| j|| jj�S td��dS )a
Subtract the numerical value of this IP address from num providing
the result as a new IPAddress object.
:param num: size of IP address decrease.
:return: a new IPAddress object with its numerical value decreased by num.
r z)result outside valid IP address boundary!N)rV r r r rU r8 re )r rf rg r r r �__sub__� s zIPAddress.__sub__c C sF t || j �}d| ko$| jjkn r:| j|| jj�S td��dS )a
Subtract num (lvalue) from the numerical value of this IP address
(rvalue) providing the result as a new IPAddress object.
:param num: size of IP address decrease.
:return: a new IPAddress object with its numerical value decreased by num.
r z)result outside valid IP address boundary!N)rV r r r rU r8 re )r rf rg r r r �__rsub__� s zIPAddress.__rsub__c C s | j j| jfS )zP
:return: a key tuple that uniquely identifies this IP address.
)r r8 r )r r r r r$ � s z
IPAddress.keyc C s | j j| j| j jfS )zI:return: A key tuple used to compare and sort this `IPAddress` correctly.)r r8 r r` )r r r r r% � s zIPAddress.sort_keyc C s | j S )z<:return: the value of this IP address as an unsigned integer)r )r r r r �__int__� s zIPAddress.__int__c C s | j S )z<:return: the value of this IP address as an unsigned integer)r )r r r r �__long__� s zIPAddress.__long__c C s | j dkrdS d| j S )z;:return: an octal string representation of this IP address.r �0z0%o)r )r r r r �__oct__� s
zIPAddress.__oct__c C s
d| j S )z@:return: a hexadecimal string representation of this IP address.z0x%x)r )r r r r �__hex__� s zIPAddress.__hex__c C s | j S )zx
:return: return the integer value of this IP address when called by hex(), oct() or bin().
)r )r r r r � __index__� s zIPAddress.__index__c C s | j j| j|�S )z�
:param word_sep: (optional) the separator to insert between words.
Default: None - use default separator for address type.
:return: the value of this IP address as a binary digit string.)r Z int_to_bitsr )r Zword_sepr r r �bits� s zIPAddress.bitsc C s | j j| j�S )z7The value of this IP address as a packed binary string.)r Z
int_to_packedr )r r r r �packed� s zIPAddress.packedc C s | j j| j�S )zx
A list of unsigned integer words (octets for IPv4, hextets for IPv6)
found in this IP address.
)r Z int_to_wordsr )r r r r �words s zIPAddress.wordsc C s | j j| j�S )z�
The value of this IP adddress in standard Python binary
representational form (0bxxx). A back port of the format provided by
the builtin bin() function found in Python 2.6.x and higher.
)r Z
int_to_binr )r r r r �bin s z
IPAddress.binc C s | j j| j�S )z1The reverse DNS lookup record for this IP address)r Z int_to_arpar )r r r r � reverse_dns s zIPAddress.reverse_dnsc C s� d}| j }| jjdkr$|| jd�}np| jjdkr�d| j koFtjkn rZ|| jd�}n:tj| j kopdkn r�|| jd d�}n td| ��|S )z�
Raises an `AddrConversionError` if IPv6 address cannot be converted
to IPv4.
:return: A numerically equivalent version 4 `IPAddress` object.
Nr6 r7 r l ��� l � z2IPv6 address %s unsuitable for conversion to IPv4!)rU r r8 r r2 r r )r �ip�klassr r r r s zIPAddress.ipv4Fc C s� d}| j }| jjdkrT|rFd| j ko.dkn rF|| jd d�}q�|| jd�}n,| jjdkr�|| jd�}|s�|d| j d�}|S )a�
.. note:: The IPv4-mapped IPv6 address format is now considered deprecated. See RFC 4291 or later for details.
:param ipv4_compatible: If ``True`` returns an IPv4-mapped address
(::ffff:x.x.x.x), an IPv4-compatible (::x.x.x.x) address
otherwise. Default: False (IPv4-mapped).
:return: A numerically equivalent version 6 `IPAddress` object.
Nr7 l � l ��� r6 )rU r r8 r )r �ipv4_compatiblerx ry r r r r
/ s zIPAddress.ipv6c C s, |dk rt |d�std��| jj| j|d�S )z�
Only relevant for IPv6 addresses. Has no effect for IPv4.
:param dialect: An ipv6_* dialect class.
:return: an alternate string representation for this IP address.
NZword_fmtz-custom dialects should subclass ipv6_verbose!)�dialect)�hasattrr r �
int_to_strr )r r{ r r r �formatL s
zIPAddress.formatc C s | j | jt|�B | jj�S )z�
:param other: An `IPAddress` object (or other int-like object).
:return: bitwise OR (x | y) between the integer value of this IP
address and ``other``.
)rU r rV r r8 )r r) r r r �__or__Z s zIPAddress.__or__c C s | j | jt|�@ | jj�S )z�
:param other: An `IPAddress` object (or other int-like object).
:return: bitwise AND (x & y) between the integer value of this IP
address and ``other``.
)rU r rV r r8 )r r) r r r �__and__c s zIPAddress.__and__c C s | j | jt|�A | jj�S )z�
:param other: An `IPAddress` object (or other int-like object).
:return: bitwise exclusive OR (x ^ y) between the integer value of
this IP address and ``other``.
)rU r rV r r8 )r r) r r r �__xor__l s zIPAddress.__xor__c C s | j | j|> | jj�S )z�
:param numbits: size of bitwise shift.
:return: an `IPAddress` object based on this one with its integer
value left shifted by ``numbits``.
)rU r r r8 )r ra r r r �
__lshift__u s zIPAddress.__lshift__c C s | j | j|? | jj�S )z�
:param numbits: size of bitwise shift.
:return: an `IPAddress` object based on this one with its integer
value right shifted by ``numbits``.
)rU r r r8 )r ra r r r �
__rshift__~ s zIPAddress.__rshift__c C s
t | j�S )zi:return: ``True`` if the numerical value of this IP address is not zero, ``False`` otherwise.)�boolr )r r r r � __nonzero__� s zIPAddress.__nonzero__c C s | j j| j�S )z,:return: IP address in presentational format)r r} r )r r r r �__str__� s zIPAddress.__str__c C s d| j j| f S )z8:return: Python statement to create an equivalent objectz%s('%s'))rU rK )r r r r �__repr__� s zIPAddress.__repr__)Nr )N)F)N)+rK rL rM rN rO r rZ r] rb rd r_ rh ri rj �__radd__rk rl r$ r% rm rn rp rq rr rs rP rt ru rv rw r r
r~ r r� r� r� r� r� �__bool__r� r� �
__classcell__r r )rU r rQ � sL Q
rQ c @ sL e Zd ZdZf Zdd� Zedd� �Zdd� Zdd � Z d
d � Z
d d
� Z e Z dS )� IPListMixinzu
A mixin class providing shared list-like functionality to classes
representing groups of IP addresses.
c C s* t | j| jj�}t | j| jj�}t||�S )z�
:return: An iterator providing access to all `IPAddress` objects
within range represented by this ranged IP object.
)rQ �firstr r8 �last� iter_iprange)r �start_ip�end_ipr r r �__iter__� s zIPListMixin.__iter__c C s t | j| j d �S )zP
The total number of IP addresses within this ranged IP object.
r^ )rV r� r� )r r r r �size� s zIPListMixin.sizec C s | j }|tkrtdt ��|S )z�
:return: the number of IP addresses in this ranged IP object. Raises
an `IndexError` if size > system max int (a Python 2.x
limitation). Use the .size property for subnets of any size.
zVrange contains more than %d (sys.maxint) IP addresses! Use the .size property instead.)r� r re )r r� r r r �__len__� s
zIPListMixin.__len__c C sB d}t |d�r�| jjdkr"td��|j| j�\}}}|| dk sH||kr`tt| j| jj�g�}n8t| j| | jj�}t| j| | | jj�}t |||�}n�y�t
|�}| j | ko�dk n r�t| j | d | jj�}n>d| ko�| jd kn �rt| j| | jj�}nt d��W n" t
k
�r< td| ��Y nX |S ) z�
:return: The IP address(es) in this `IPNetwork` object referenced by
index or slice. As slicing can produce large sequences of objects
an iterator is returned instead of the more usual `list`.
N�indicesr7 z IPv6 slices are not supported!r r^ z'index out range for address range size!zunsupported index type %r!)r| r r8 r r� r� �iterrQ r� r� rV r� re rT )r �index�item�start�stop�stepr� r� r r r � __getitem__� s(
zIPListMixin.__getitem__c C sd t |t�rX| jj|jjkr dS t |t�r@|j| jko>|j| jkS |j| jkoV|j| jkS t|�| kS )z�
:param other: an `IPAddress` or ranged IP object.
:return: ``True`` if other falls within the boundary of this one,
``False`` otherwise.
F)r r r r8 rQ r r� r� )r r) r r r � __contains__� s
zIPListMixin.__contains__c C s dS )z�
Ranged IP objects always represent a sequence of at least one IP
address and are therefore always True in the boolean context.
Tr )r r r r r� � s zIPListMixin.__nonzero__N)
rK rL rM rN rO r� rP r� r� r� r� r� r� r r r r r� � s %r� Fc C s t |t�r�t|�dkr$td| j ��|\}}d| ko@| jkn sTtd| j ��d| koh| jkn s|td| j ���nrt |t��r�|r�t|�}d|kr�|j dd�\}}n|}d }yt
|| j t d�}W nJ tk
�r | j d k�rt
j|�} t
| | j t d�}n td
| ��Y nX |j}y t|�}W n� tk
�rR |d k�rN| j}Y nb tk
�r� t
|| j t d�}
|
j� �r�| j|
j }n$|
j� �r�| j|
j }n td | ��Y nX d| k�o�| jkn �s�td | j ��ntd
t|� ��|t@ �r| j| } || @ }||fS )N� zinvalid %s tuple!r z#invalid address value for %s tuple!z invalid prefix for %s tuple!rR r^ )rX r6 z invalid IPNetwork address %s!z!addr %r is not a valid IPNetwork!z invalid prefix for %s address!z unexpected type %s for addr arg)r �tuple�lenr r r r` r �cidr_abbrev_to_verbose�splitrQ r8 r r2 Zexpand_partial_addressr rV r rT r_ Znetmask_to_prefixrd Zhostmask_to_prefixr r Zprefix_to_netmask) rY rW �implicit_prefixrX r � prefixlenZval1Zval2rx Z
expanded_addr�mask�netmaskr r r �parse_ip_network� s\
r� c sB e Zd ZdZdCZdD� fdd� Zdd � Zd
d � Zd d
� Ze dd� edd�Z
e dd� �Z e dd� �Z e dd� �Z
e dd� �Ze dd� �Ze d d � �Ze d d � �Ze d d!� �Ze d"d#� �Ze d$d%� �Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� Zd0d1� ZdEd2d3�ZdFd5d6�Z dGd7d8�Z dHd9d:�Z dId;d<�Z d=d>� Z d?d@� Z!dAdB� Z"� Z#S )J� IPNetworkaf
An IPv4 or IPv6 network or subnet.
A combination of an IP address and a network mask.
Accepts CIDR and several related variants :
a) Standard CIDR::
x.x.x.x/y -> 192.0.2.0/24
x::/y -> fe80::/10
b) Hybrid CIDR format (netmask address instead of prefix), where 'y' address represent a valid netmask::
x.x.x.x/y.y.y.y -> 192.0.2.0/255.255.255.0
x::/y:: -> fe80::/ffc0::
c) ACL hybrid CIDR format (hostmask address instead of prefix like Cisco's ACL bitmasks), where 'y' address represent a valid netmask::
x.x.x.x/y.y.y.y -> 192.0.2.0/0.0.0.255
x::/y:: -> fe80::/3f:ffff:ffff:ffff:ffff:ffff:ffff:ffff
d) Abbreviated CIDR format (as of netaddr 0.7.x this requires the optional constructor argument ``implicit_prefix=True``)::
x -> 192
x/y -> 10/8
x.x/y -> 192.168/16
x.x.x/y -> 192.168.0/24
which are equivalent to::
x.0.0.0/y -> 192.0.0.0/24
x.0.0.0/y -> 10.0.0.0/8
x.x.0.0/y -> 192.168.0.0/16
x.x.x.0/y -> 192.168.0.0/24
�
_prefixlenFNr c s< t t| �j� d \}}}t|d�r6|j}|j}|j}n�t|d�rT|j}|j}|j}n�|dkrvtt |||d�\}}t }n�|dkr�tt
|||d�\}}t
}n�|dk r�t d| ��yt }t||||�\}}W n^ t k
�r$ yt
}t||||�\}}W n t k
�r Y nX |dk�r t d| ��Y nX || _|| _|| _dS )
a�
Constructor.
:param addr: an IPv4 or IPv6 address with optional CIDR prefix,
netmask or hostmask. May be an IP address in presentation
(string) format, an tuple containing and integer address and a
network prefix, or another IPAddress/IPNetwork object (copy
construction).
:param implicit_prefix: (optional) if True, the constructor uses
classful IPv4 rules to select a default prefix when one is not
provided. If False it uses the length of the IP address version.
(default: False)
:param version: (optional) optimizes version detection if specified
and distinguishes between IPv4 and IPv6 for addresses with an
equivalent integer value.
:param flags: (optional) decides which rules are applied to the
interpretation of the addr value. Currently only supports the
NOHOST option. See the netaddr.core docs for further details.
Nr� r r6 )r� rX r7 z %r is an invalid IP version!zinvalid IPNetwork %s)NNN)
rS r� r r| r r r� r` r� r2 r4 rT r )r rW r� r8 rX r r� rY )rU r r r l sH
zIPNetwork.__init__c C s | j | j| jjfS )z0:return: Pickled state of an `IPNetwork` object.)r r� r r8 )r r r r rZ � s zIPNetwork.__getstate__c C sx |\}}}|| _ |dkr t| _n |dkr0t| _ntdt|� ��d| koV| jjkn rd|| _ntdt|� ��dS )zT
:param state: data used to unpickle a pickled `IPNetwork` object.
r6 r7 z%unpickling failed for object state %sr N)r r2 r r4 rT r[ r` r� )r r\ r r� r8 r r r r] � s
zIPNetwork.__setstate__c C sP t |t�stdt|� ��d| ko0| jjkn sFtd| jj ��|| _d S )Nz int argument expected, not %sr z!invalid prefix for an %s address!) r r r r r r` r r r� )r r r r r �_set_prefixlen� s
zIPNetwork._set_prefixlenc C s | j S )N)r� )r r r r r! � s zIPNetwork.<lambda>zCsize of the bitmask used to separate the network from the host bits)r" c C s t | j| jj�S )z�
The IP address of this `IPNetwork` object. This is may or may not be
the same as the network IP address which varies according to the value
of the CIDR subnet prefix.
)rQ r r r8 )r r r r rx � s z IPNetwork.ipc C s t | j| j@ | jj�S )z/The network address of this `IPNetwork` object.)rQ r � _netmask_intr r8 )r r r r �network� s zIPNetwork.networkc C s< | j jdkr"| j j| j dkr"dS t| j| jB | j j�S dS )z0The broadcast address of this `IPNetwork` objectr6 r^ N)r r8 r` r� rQ r �
_hostmask_int)r r r r � broadcast� s zIPNetwork.broadcastc C s | j | jj| jA @ S )ze
The integer value of first IP address found within this `IPNetwork`
object.
)r r r r� )r r r r r� � s zIPNetwork.firstc C s d| j j| j > d }| j|B S )zd
The integer value of last IP address found within this `IPNetwork`
object.
r^ )r r` r� r )r �hostmaskr r r r� � s zIPNetwork.lastc C s | j j| jA }t|| j j�S )z+The subnet mask of this `IPNetwork` object.)r r r� rQ r8 )r r� r r r r� � s zIPNetwork.netmaskc C s | j j| jA S )z+Same as self.netmask, but in integer format)r r r� )r r r r r� s zIPNetwork._netmask_intc C s$ d| j j| j > d }t|| j j�S )z)The host mask of this `IPNetwork` object.r^ )r r` r� rQ r8 )r r� r r r r� s zIPNetwork.hostmaskc C s d| j j| j > d S )z,Same as self.hostmask, but in integer formatr^ )r r` r� )r r r r r� s zIPNetwork._hostmask_intc C s t | j| j@ | jf| jjd�S )z�
The true CIDR address for this `IPNetwork` object which omits any
host bits to the right of the CIDR subnet prefix.
)r8 )r� r r� r� r r8 )r r r r r? s zIPNetwork.cidrc C sL t | j�| j| }|| jd | jjkr2td��|dk rBtd��|| _| S )aP
Increases the value of this `IPNetwork` object by the current size
multiplied by ``num``.
An `IndexError` is raised if result exceeds maximum IP address value
or is less than zero.
:param num: (optional) number of `IPNetwork` blocks to increment this IPNetwork's value by.
r^ z#increment exceeds address boundary!r z increment is less than zero!)rV r� r� r r re r )r rf rg r r r rh s zIPNetwork.__iadd__c C sL t | j�| j| }|dk r$td��|| jd | jjkrBtd��|| _| S )aP
Decreases the value of this `IPNetwork` object by the current size
multiplied by ``num``.
An `IndexError` is raised if result is less than zero or exceeds
maximum IP address value.
:param num: (optional) number of `IPNetwork` blocks to decrement this IPNetwork's value by.
r z decrement is less than zero!r^ z#decrement exceeds address boundary!)rV r� r� re r r r )r rf rg r r r ri 2 s zIPNetwork.__isub__c C s� t |t�r�| jj|jjkr dS | jj| j }| j|? }t |t�rd||> |jjkob|d |> |j jkS |j|? }t |t
�r�||kS t |t �r�||ko�| j|jkS t
|�| kS )z�
:param other: an `IPAddress` or ranged IP object.
:return: ``True`` if other falls within the boundary of this one,
``False`` otherwise.
Fr^ ) r r r r8 r` r� r �IPRange�_start�_endrQ r� )r r) �
shiftwidthZself_netZ other_netr r r r� G s
zIPNetwork.__contains__c C s | j j| j| jfS )zR
:return: A key tuple used to uniquely identify this `IPNetwork`.
)r r8 r� r� )r r r r r$ e s z
IPNetwork.keyc C s8 | j d }| j| jj| jA @ }| j| }| jj|||fS )z[
:return: A key tuple used to compare and sort this `IPNetwork` correctly.
r^ )r� r r r r� r8 )r Z
net_size_bitsr� Z host_bitsr r r r% k s
zIPNetwork.sort_keyc C s� d}| j }| jjdkr,|d| j| jf �}n�| jjdkr�d| j koNtjkn rxtj| j�}|d|| jd f �}nPtj| j ko�dkn r�tj| jd �}|d|| jd f �}n t d | ��|S )
z�
:return: A numerically equivalent version 4 `IPNetwork` object. Raises an `AddrConversionError` if IPv6 address cannot be converted to IPv4.
Nr6 z%s/%dr7 r �` l ��� l � z2IPv6 address %s unsuitable for conversion to IPv4!)
rU r r8 rx r� r r2 r r} r )r rx ry rW r r r r t s zIPNetwork.ipv4c C s� d}| j }| jjdkrd|rNd| j ko.dkn rN|| jd | jfdd�}q�|| j| jfdd�}nF| jjdkr�|r�|| j| jd fdd�}n |d| j | jd fdd�}|S )a�
.. note:: the IPv4-mapped IPv6 address format is now considered deprecated. See RFC 4291 or later for details.
:param ipv4_compatible: If ``True`` returns an IPv4-mapped address
(::ffff:x.x.x.x), an IPv4-compatible (::x.x.x.x) address
otherwise. Default: False (IPv4-mapped).
:return: A numerically equivalent version 6 `IPNetwork` object.
Nr7 l � l ��� )r8 r6 r� )rU r r8 r r� )r rz rx ry r r r r
� s
zIPNetwork.ipv6r^ c C s( | j d| j| jf | jj�}||8 }|S )z�
:param step: the number of IP subnets between this `IPNetwork` object
and the expected subnet. Default: 1 (the previous IP subnet).
:return: The adjacent subnet preceding this `IPNetwork` object.
z%s/%d)rU r� r� r r8 )r r� �ip_copyr r r �previous� s
zIPNetwork.previousc C s( | j d| j| jf | jj�}||7 }|S )z�
:param step: the number of IP subnets between this `IPNetwork` object
and the expected subnet. Default: 1 (the next IP subnet).
:return: The adjacent subnet succeeding this `IPNetwork` object.
z%s/%d)rU r� r� r r8 )r r� r� r r r �next� s
zIPNetwork.nextc C sp d| ko| j jkn s0td|| j jf ��g }| j}||_x*|j| jkrj|j|j� | jd7 _qBW |S )ab
Provides a list of supernets for this `IPNetwork` object between the
size of the current prefix and (if specified) an endpoint prefix.
:param prefixlen: (optional) a CIDR prefix for the maximum supernet.
Default: 0 - returns all possible supernets.
:return: a tuple of supernet `IPNetwork` objects.
r z"CIDR prefix /%d invalid for IPv%d!r^ )r r` rT r8 r? r� �append)r r� Z supernets�supernetr r r r� � s
zIPNetwork.supernetc c s� d| j ko| jjkn s2td|| jjf ��| j |ks@t�| jj}d|| j d|| }|dkrn|}d| ko�|kn s�td��| jj| j�}d}xL||k r�| jd||f | jj�}| j |j
| 7 _ ||_ |d7 }|V q�W dS )a�
A generator that divides up this IPNetwork's subnet into smaller
subnets based on a specified CIDR prefix.
:param prefixlen: a CIDR prefix indicating size of subnets to be
returned.
:param count: (optional) number of consecutive IP subnets to be
returned.
:return: an iterator containing IPNetwork subnet objects.
r z"CIDR prefix /%d invalid for IPv%d!r� Nr^ z,count outside of current IP subnet boundary!z%s/%d) r� r r` rT r8 �
StopIterationr} r� rU r r� ) r r� �countZfmtr` Z max_subnetsZ base_subnet�i�subnetr r r r� � s(
zIPNetwork.subnetc C s� t g �}| jjdkrn| jdkrJtt| jd | jj�t| jd | jj��}q�tt| j| jj�t| j| jj��}n0| jdkr�tt| jd | jj�t| j| jj��}|S )a
A generator that provides all the IP addresses that can be assigned
to hosts within the range of this IP object's subnet.
- for IPv4, the network and broadcast addresses are always excluded. for subnets that contains less than 4 IP addresses /31 and /32 report in a manner per RFC 3021
- for IPv6, only the unspecified address '::' or Subnet-Router anycast address (first address in the network) is excluded.
:return: an IPAddress iterator
r6 r^ r� )r� r r8 r� r� rQ r� r� )r Zit_hostsr r r �
iter_hosts s
zIPNetwork.iter_hostsc C s | j j| j�}d|| jf S )z&:return: this IPNetwork in CIDR formatz%s/%s)r r} r r� )r rW r r r r� ( s zIPNetwork.__str__c C s d| j j| f S )z8:return: Python statement to create an equivalent objectz%s('%s'))rU rK )r r r r r� - s zIPNetwork.__repr__)r� )FNr )F)r^ )r^ )r )NN)$rK rL rM rN rO r rZ r] r� rP r� rx r� r� r� r� r� r� r� r� r? rh ri r� r$ r% r r
r� r� r� r� r� r� r� r� r r )rU r r� A s@ (D
)%r� c @ sv e Zd ZdZd Zd dd�Zdd� Zd d
� Zd d � Ze d
d� �Z
e dd� �Z dd� Z dd� Z
dd� Zdd� Zdd� ZdS ) r� z�
An arbitrary IPv4 or IPv6 address range.
Formed from a lower and upper bound IP address. The upper bound IP cannot
be numerically smaller than the lower bound and the IP version of both
must match.
r� r� r c C sL t ||d�| _| jj| _t || jj|d�| _t| j�t| j�krHtd��dS )a�
Constructor.
:param start: an IPv4 or IPv6 address that forms the lower
boundary of this IP range.
:param end: an IPv4 or IPv6 address that forms the upper
boundary of this IP range.
:param flags: (optional) decides which rules are applied to the
interpretation of the start and end values. Supported constants
are INET_PTON and ZEROFILL. See the netaddr.core docs for further
details.
)rX z(lower bound IP greater than upper bound!N)rQ r� r r8 r� rV r )r r� �endrX r r r r = s
zIPRange.__init__c C s | j j| jj| jjfS )z.:return: Pickled state of an `IPRange` object.)r� r r� r r8 )r r r r rZ S s zIPRange.__getstate__c C s0 |\}}}t ||�| _| jj| _t ||�| _dS )zQ
:param state: data used to unpickle a pickled `IPRange` object.
N)rQ r� r r� )r r\ r� r� r8 r r r r] W s
zIPRange.__setstate__c C s� t |t�r�| jj|jjkr dS t |t�rD| jj|jkoB| jj|jkS t |t�rn| jj|jjkol| jj|jjkS t |t �r�|jj
|j }|j|? |> }|d|> }| jj|ko�| jj|kS t|�| kS )NFr^ ) r r r r8 rQ r� r r� r� r� r` r� )r r) r� Z other_startZother_next_startr r r r� a s
zIPRange.__contains__c C s
t | j�S )z?The integer value of first IP address in this `IPRange` object.)rV r� )r r r r r� w s z
IPRange.firstc C s
t | j�S )z>The integer value of last IP address in this `IPRange` object.)rV r� )r r r r r� | s z IPRange.lastc C s | j j| j| jfS )zP
:return: A key tuple used to uniquely identify this `IPRange`.
)r r8 r� r� )r r r r r$ � s z IPRange.keyc C s$ | j jt| j� }| j j| jj|fS )zY
:return: A key tuple used to compare and sort this `IPRange` correctly.
)r r` r r� r8 r� r )r Zskeyr r r r% � s zIPRange.sort_keyc C s t | j| j�S )zx
The list of CIDR addresses found within the lower and upper bound
addresses of this `IPRange`.
)�iprange_to_cidrsr� r� )r r r r �cidrs� s z
IPRange.cidrsc C s d| j | jf S )z<:return: this `IPRange` in a common representational format.z%s-%s)r� r� )r r r r r� � s zIPRange.__str__c C s d| j j| j| jf S )z8:return: Python statement to create an equivalent objectz%s('%s', '%s'))rU rK r� r� )r r r r r� � s zIPRange.__repr__N)r� r� )r )rK rL rM rN rO r rZ r] r� rP r� r� r$ r% r� r� r� r r r r r� 2 s
r� c g s* x$t | �D ]}x|D ]
}|V qW q
W dS )z�
:param args: A list of IP addresses and subnets passed in as arguments.
:return: A generator that flattens out IP subnets, yielding unique
individual IP addresses (no duplicates).
N)�
cidr_merge)�argsr? rx r r r �iter_unique_ips� s
r� c C sR dd� }t | �r$d| ks | dkr$| S yt| �}d|||�f S tk
�r4 d| kr�| jdd�\}}y,dt|� ko~d kn s�td
| ��W q� tk
r� | S X n| }d }|jd �}t|�d
kr�| S x"td
t|� �D ]}|jd� q�W |d k�r"y||d �}W n tk
�r | S X dd j|�|f S tt fk
�rL | S X d S )a�
A function that converts abbreviated IPv4 CIDRs to their more verbose
equivalent.
:param abbrev_cidr: an abbreviated CIDR.
Uses the old-style classful IP address rules to decide on a default
subnet prefix if one is not explicitly provided.
Only supports IPv4 addresses.
Examples ::
10 - 10.0.0.0/8
10/16 - 10.0.0.0/16
128 - 128.0.0.0/16
128/8 - 128.0.0.0/8
192.168 - 192.168.0.0/16
:return: A verbose CIDR from an abbreviated CIDR or old-style classful network address. The original value if it was not recognised as a supported abbreviation.
c S s� t | �} d| kodkn s,td| ��d| ko>dkn rHdS d| koZdkn rddS d | kovd
kn r�d S d | ko�d
kn r�dS dS )Nr � zInvalid octet: %r!� � � � � � �� � �� �� r6 rF )rV re )Zoctetr r r �classful_prefix� s z/cidr_abbrev_to_verbose.<locals>.classful_prefix�:� z %s.0.0.0/%srR r^ r rF z.prefixlen in address %r out of range for IPv4!N�.r6 ro z%s/%s)
r rV rT r� r� �ranger� �joinr re )Z abbrev_cidrr� r� Z part_addr�prefix�tokensr r r r� � s>
r� c
C sX t | d�std��g }x,| D ]$}t|�}|j|j|j|j|f� q W |j� t|�d }x�|dkr�|| d ||d d kr�|| d d ||d d kr�|| d || d t ||d d || d �f||d < ||= |d8 }qZW g }xb|D ]Z}t|�dk�r|j|d � q�|d }t
|d |d�}t
|d |d�} |j t || �� q�W |S ) a
A function that accepts an iterable sequence of IP addresses and subnets
merging them into the smallest possible list of CIDRs. It merges adjacent
subnets where possible, those contained within others and also removes
any duplicates.
:param ip_addrs: an iterable sequence of IP addresses and subnets.
:return: a summarized list of `IPNetwork` objects.
r� z#A sequence or iterator is expected!r^ r r� r6 � )r8 )
r| rT r� r� r8 r� r� �sortr� �minrQ �extendr� )
�ip_addrsZrangesrx r? r� ZmergedZ range_tupler8 Z range_startZ
range_stopr r r r� � s,
<<
r� c C s t | |�\}}}|| S )a
Removes an exclude IP address or subnet from target IP subnet.
:param target: the target IP address or subnet to be divided up.
:param exclude: the IP address or subnet to be removed from target.
:return: list of `IPNetwork` objects remaining after exclusion.
)�cidr_partition)�target�exclude�left�_�rightr r r � cidr_exclude+ s
r� c C s$ t | �} t |�}|j| jk r*g g | jgfS | j|jk rD| jgg g fS | j|jkr\g | gg fS g }g }| jd }| jj}| j}|j}|}|d|| } xv|j|k�r |j| kr�|jt ||f|d�� | }
n|jt | |f|d�� |}
|d7 }||kr�P |
}|
d|| } q�W ||g|ddd� fS )ac
Partitions a target IP subnet on an exclude IP address.
:param target: the target IP address or subnet to be divided up.
:param exclude: the IP address or subnet to partition on
:return: list of `IPNetwork` objects before, the partition and after, sorted.
Adding the three lists returns the equivalent of the original subnet.
r^ r� )r8 N���) r� r� r� r? r� r r` r8 r� ) r� r� r� r� Z
new_prefixlenZtarget_module_widthZ target_firstr8 Zi_lowerZi_upperZmatchedr r r r� 9 s8
r� c C s� t dd� | D ��}t|�dks&td��|d }|d }|j|jkrJtd��|j}|j}|j}|jj }x.|dkr�||kr�|d8 }|d|| > M }qfW t
||f|jd�S ) aO
Function that accepts a sequence of IP addresses and subnets returning
a single `IPNetwork` subnet that is large enough to span the lower and
upper bound IP addresses with a possible overlap on either end.
:param ip_addrs: sequence of IP addresses and subnets.
:return: a single spanning `IPNetwork` subnet.
c S s g | ] }t |��qS r )r� )�.0rx r r r �
<listcomp>� s z!spanning_cidr.<locals>.<listcomp>r^ z-IP sequence must contain at least 2 elements!r z.IP sequence cannot contain both IPv4 and IPv6!)r8 r� ) �sortedr� rT r8 r r� r� r� r r` r� )r� Z
sorted_ipsZ lowest_ipZ
highest_ipZipnumr� Z lowest_ipnumr` r r r �
spanning_cidru s
r� r^ c c s� t | �} t |�}| j|jkr$td��| j}t|�}|dkrBtd��t| �} t|�}d}|dk rbd}| | }x2||7 }|r�||ks�P n
||ks�P t ||�V qlW dS )a�
A generator that produces IPAddress objects between an arbitrary start
and stop IP address with intervals of step between them. Sequences
produce are inclusive of boundary IPs.
:param start: start IP address.
:param end: end IP address.
:param step: (optional) size of step between IP addresses. Default: 1
:return: an iterator of one or more `IPAddress` objects.
z(start and stop IP versions do not match!r z step argument cannot be zeroFTN)rQ r8 r rV rT )r� r� r� r8 r� Z
negative_stepr� r r r r� � s, r� c C s� g }t | �} t |�}| j|jg}t| |g�}| jj}|j|d k rrt |d d |f| jd�}t||�d }|j� }|j|d kr�t |d d |f| jd�}|t||�d 7 }n
|j |� |S )a`
A function that accepts an arbitrary start and end IP address or subnet
and returns a list of CIDR subnets that fit exactly between the boundaries
of the two with no overlap.
:param start: the start IP address or subnet.
:param end: the end IP address or subnet.
:return: a list of one or more IP addresses and subnets.
r r^ )r8 r� )
r� r� r� r� r r` r8 r� �popr� )r� r� Z cidr_listZiprangeZ cidr_spanr` r� r r r r� � s
r� c C sd d}t |d�std| ��t| �} x<tdd� |D ��D ]&}| |krH|}q6|dk r6|j|kr6P q6W |S )ab
Matches an IP address or subnet against a given sequence of IP addresses
and subnets.
:param ip: a single IP address or subnet.
:param cidrs: a sequence of IP addresses and/or subnets.
:return: the smallest (most specific) matching IPAddress or IPNetwork
object from the provided sequence, None if there was no match.
Nr� z,IP address/subnet sequence expected, not %r!c S s g | ] }t |��qS r )r� )r� r? r r r r� � s z*smallest_matching_cidr.<locals>.<listcomp>)r| r rQ r� r� )rx r� �matchr? r r r �smallest_matching_cidr� s
r� c C sP d}t |d�std| ��t| �} x(tdd� |D ��D ]}| |kr6|}P q6W |S )ab
Matches an IP address or subnet against a given sequence of IP addresses
and subnets.
:param ip: a single IP address or subnet.
:param cidrs: a sequence of IP addresses and/or subnets.
:return: the largest (least specific) matching IPAddress or IPNetwork
object from the provided sequence, None if there was no match.
Nr� z,IP address/subnet sequence expected, not %r!c S s g | ] }t |��qS r )r� )r� r? r r r r� s z)largest_matching_cidr.<locals>.<listcomp>)r| r rQ r� )rx r� r� r? r r r �largest_matching_cidr s
r� c C sj g }t |d�std| ��t| �} xBtdd� |D ��D ],}| |krN|j|� q6|r6|j|d kr6P q6W |S )aM
Matches an IP address or subnet against a given sequence of IP addresses
and subnets.
:param ip: a single IP address.
:param cidrs: a sequence of IP addresses and/or subnets.
:return: all matching IPAddress and/or IPNetwork objects from the provided
sequence, an empty list if there was no match.
r� z,IP address/subnet sequence expected, not %r!c S s g | ] }t |��qS r )r� )r� r? r r r r� 5 s z&all_matching_cidrs.<locals>.<listcomp>r^ r� )r| r rQ r� r� r� )rx r� Zmatchesr? r r r �all_matching_cidrs" s
r� z 127.0.0.0/8z
10.0.0.0/8z
100.64.0.0/10z
172.16.0.0/12z 192.0.0.0/24z192.168.0.0/16z
198.18.0.0/15z 239.0.0.0z239.255.255.255z169.254.0.0/16z 224.0.0.0/4z192.88.99.0/24z 0.0.0.0/8z 192.0.2.0/24z 240.0.0.0/4z198.51.100.0/24z203.0.113.0/24z233.252.0.0/24z 234.0.0.0z238.255.255.255z 225.0.0.0z231.255.255.255z::1zfc00::/7z fec0::/10z fe80::/10zff00::/8z ff00::/12z::/8z0100::/8z0200::/7z0400::/6z0800::/5z1000::/4z4000::/3z6000::/3z8000::/3zA000::/3zC000::/3zE000::/4zF000::/5zF800::/6zFE00::/9)Fr )r^ )6rN �sys�_sysZ netaddr.corer r r r r r r r r
r Znetaddr.strategyr r2 r
r4 Znetaddr.compatr r r r r �objectr rQ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r9 r< rA r3 Z IPV4_6TO4rC r: r= rB r5 rD r r r r �<module> sz 0 U 4e
D tm T,<"
/$