a
i < @ s d Z dZddlZdZdZG dd deZG dd d eZd
d Zd=d
dZ dd Z
dd Z dd Z dd Z
dd Zdd Zdd Zd d Zd d Zd!d" ZG d#d$ d$ZdaejG d%d& d&eZejG d'd( d(eZG d)d* d*ZG d+d, d,eeZG d-d. d.eZG d/d0 d0eeZ G d1d2 d2Z e e_ G d3d4 d4Z G d5d6 d6e eZ G d7d8 d8e Z!G d9d: d:e eZ"G d;d< d<Z#e#e _ dS )>zA fast, lightweight IPv4/IPv6 manipulation library in Python.
This library is used to create/poke/manipulate IPv4 and IPv6 addresses
and networks.
z1.0 N c @ s e Zd ZdZdS )AddressValueErrorz%A Value Error related to the address.N__name__
__module__ __qualname____doc__ r
r
!/usr/lib64/python3.9/ipaddress.pyr s r c @ s e Zd ZdZdS )NetmaskValueErrorz%A Value Error related to the netmask.Nr r
r
r
r r s r c C sV z
t | W S ttfy Y n0 z
t| W S ttfyB Y n0 t| ddS )a Take an IP string/int and return an object of the correct type.
Args:
address: A string or integer, the IP address. Either IPv4 or
IPv6 addresses may be supplied; integers less than 2**32 will
be considered to be IPv4 by default.
Returns:
An IPv4Address or IPv6Address object.
Raises:
ValueError: if the *address* passed isn't either a v4 or a v6
address
z. does not appear to be an IPv4 or IPv6 addressN) IPv4Addressr r IPv6Address
ValueErroraddressr
r
r
ip_address s
r Tc C sZ z t | |W S ttfy" Y n0 z t| |W S ttfyF Y n0 t| ddS )a Take an IP string/int and return an object of the correct type.
Args:
address: A string or integer, the IP network. Either IPv4 or
IPv6 networks may be supplied; integers less than 2**32 will
be considered to be IPv4 by default.
Returns:
An IPv4Network or IPv6Network object.
Raises:
ValueError: if the string passed isn't either a v4 or a v6
address. Or if the network has host bits set.
z. does not appear to be an IPv4 or IPv6 networkN) IPv4Networkr r IPv6Networkr )r strictr
r
r
ip_network8 s r c C sV z
t | W S ttfy Y n0 z
t| W S ttfyB Y n0 t| ddS )ag Take an IP string/int and return an object of the correct type.
Args:
address: A string or integer, the IP address. Either IPv4 or
IPv6 addresses may be supplied; integers less than 2**32 will
be considered to be IPv4 by default.
Returns:
An IPv4Interface or IPv6Interface object.
Raises:
ValueError: if the string passed isn't either a v4 or a v6
address.
Notes:
The IPv?Interface classes describe an Address on a particular
Network, so they're basically a combination of both the Address
and Network classes.
z0 does not appear to be an IPv4 or IPv6 interfaceN)
IPv4Interfacer r
IPv6Interfacer r r
r
r ip_interfaceU s
r c C s. z| ddW S ty( tdY n0 dS )a` Represent an address as 4 packed bytes in network (big-endian) order.
Args:
address: An integer representation of an IPv4 IP address.
Returns:
The integer address packed as 4 bytes in network (big-endian) order.
Raises:
ValueError: If the integer is negative or too large to be an
IPv4 IP address.
bigz&Address negative or too large for IPv4Nto_bytes
OverflowErrorr r r
r
r v4_int_to_packedw s r c C s. z| ddW S ty( tdY n0 dS )zRepresent an address as 16 packed bytes in network (big-endian) order.
Args:
address: An integer representation of an IPv6 IP address.
Returns:
The integer address packed as 16 bytes in network (big-endian) order.
r z&Address negative or too large for IPv6Nr r r
r
r v6_int_to_packed s
r! c C s, t | d}t|dkr(td| |S )zAHelper to split the netmask and raise AddressValueError if needed/ zOnly one '/' permitted in )strsplitlenr )r addrr
r
r _split_optional_netmask s r( c c sN t | }t| }}|D ]&}|j|jd kr:||fV |}|}q||fV dS )zFind a sequence of sorted deduplicated IPv#Address.
Args:
addresses: a list of IPv#Address objects.
Yields:
A tuple containing the first and last IP addresses in the sequence.
N)iternext_ip) addressesitfirstlastipr
r
r _find_address_range s
r2 c C s$ | dkr |S t || | d @ S )zCount the number of zero bits on the right hand side.
Args:
number: an integer.
bits: maximum number of bits to count.
Returns:
The number of zero bits on the right hand side of the number.
r r) )min
bit_length)numberbitsr
r
r _count_righthand_zero_bits s r7 c c s t | trt |ts td| j|jkr8td| |f | |krHtd| jdkrXt}n| jdkrht}ntd| j}| j}|j}||krt t
|||| d d }|||| f}|V |d|> 7 }|d |j krqqdS ) a Summarize a network range given the first and last IP addresses.
Example:
>>> list(summarize_address_range(IPv4Address('192.0.2.0'),
... IPv4Address('192.0.2.130')))
... #doctest: +NORMALIZE_WHITESPACE
[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'),
IPv4Network('192.0.2.130/32')]
Args:
first: the first IPv4Address or IPv6Address in the range.
last: the last IPv4Address or IPv6Address in the range.
Returns:
An iterator of the summarized IPv(4|6) network objects.
Raise:
TypeError:
If the first and last objects are not IP addresses.
If the first and last objects are not the same version.
ValueError:
If the last object is not greater than the first.
If the version of the first address is not 4 or 6.
z1first and last must be IP addresses, not networks%%s and %s are not of the same versionz*last IP address must be greater than firstr zunknown IP versionr) N)
isinstance _BaseAddress TypeErrorversionr r r _max_prefixlenr, r3 r7 r4 _ALL_ONES)r/ r0 r1 ip_bits first_intlast_intnbitsnetr
r
r summarize_address_range s6
rE c c s t | }i }|rV| }| }||}|du r<|||< q ||kr ||= || q d}t| D ]$}|dur|j|jkrqf|V |}qfdS )au Loops through the addresses, collapsing concurrent netblocks.
Example:
ip1 = IPv4Network('192.0.2.0/26')
ip2 = IPv4Network('192.0.2.64/26')
ip3 = IPv4Network('192.0.2.128/26')
ip4 = IPv4Network('192.0.2.192/26')
_collapse_addresses_internal([ip1, ip2, ip3, ip4]) ->
[IPv4Network('192.0.2.0/24')]
This shouldn't be called directly; it is called via
collapse_addresses([]).
Args:
addresses: A list of IPv4Network's or IPv6Network's
Returns:
A list of IPv4Network's or IPv6Network's depending on what we were
passed.
N)listpopsupernetgetappendsortedvaluesbroadcast_address)r- to_mergesubnetsrD rH existingr0 r
r
r _collapse_addresses_internal s$
rQ c C s. g }g }g }| D ]}t |trR|rF|d j|jkrFtd||d f || q|j|jkr|r|d j|jkrtd||d f z||j W q ty ||j Y q0 q|r|d j|jkrtd||d f || qt
t |}|r"t |D ]\}}|
t|| qt|| S )a Collapse a list of IP objects.
Example:
collapse_addresses([IPv4Network('192.0.2.0/25'),
IPv4Network('192.0.2.128/25')]) ->
[IPv4Network('192.0.2.0/24')]
Args:
addresses: An iterable of IPv4Network or IPv6Network objects.
Returns:
An iterator of the collapsed IPv(4|6)Network objects.
Raises:
TypeError: If passed a list of mixed version objects.
r8 )r: r; _versionr< rJ
_prefixlenr> r1 AttributeErrornetwork_addressrK setr2 extendrE rQ )r- addrsipsnetsr1 r/ r0 r
r
r collapse_addresses/ s:
r\ c C s( t | tr| S t | tr$| S tS )a2 Return a key suitable for sorting between networks and addresses.
Address and Network objects are not sortable by default; they're
fundamentally different so the expression
IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')
doesn't make any sense. There are some times however, where you may wish
to have ipaddress sort these for you anyway. If you need to do this, you
can use this function as the key= argument to sorted().
Args:
obj: either a Network or Address object.
Returns:
appropriate key.
)r: _BaseNetwork_get_networks_keyr; _get_address_keyNotImplemented)objr
r
r get_mixed_type_keye s
rb c @ s e Zd ZdZdZedd Zedd Zedd Zed d
Z d d Z
d
d Z e dd Z
e dd Ze dd Ze dd Ze dd Ze dd Zdd Zd S ) _IPAddressBasezThe mother class.r
c C s | S )z:Return the longhand version of the IP address as a string.) _explode_shorthand_ip_stringselfr
r
r exploded s z_IPAddressBase.explodedc C s t | S )z;Return the shorthand version of the IP address as a string.r$ re r
r
r
compressed s z_IPAddressBase.compressedc C s | S )aI The name of the reverse DNS pointer for the IP address, e.g.:
>>> ipaddress.ip_address("127.0.0.1").reverse_pointer
'1.0.0.127.in-addr.arpa'
>>> ipaddress.ip_address("2001:db8::1").reverse_pointer
'1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa'
)_reverse_pointerre r
r
r reverse_pointer s z _IPAddressBase.reverse_pointerc C s dt | f }t|d S )Nz %200s has no version specifiedtypeNotImplementedErrorrf msgr
r
r r= s z_IPAddressBase.versionc C sF |dk r d}t ||| jf || jkrBd}t ||| j| jf d S )Nr z-%d (< 0) is not permitted as an IPv%d addressz2%d (>= 2**%d) is not permitted as an IPv%d address)r rS r? r> )rf r rp r
r
r _check_int_address s
z!_IPAddressBase._check_int_addressc C s. t |}||kr*d}t||||| jf d S )Nz6%r (len %d != %d) is not permitted as an IPv%d address)r& r rS )rf r expected_len address_lenrp r
r
r _check_packed_address s z$_IPAddressBase._check_packed_addressc C s | j | j |? A S )zTurn the prefix length into a bitwise netmask
Args:
prefixlen: An integer, the prefix length.
Returns:
An integer.
)r? )cls prefixlenr
r
r _ip_int_from_prefix s z"_IPAddressBase._ip_int_from_prefixc C s\ t || j}| j| }||? }d|> d }||krX| jd }||d}d}t|| |S )a Return prefix length from the bitwise netmask.
Args:
ip_int: An integer, the netmask in expanded bitwise format
Returns:
An integer, the prefix length.
Raises:
ValueError: If the input intermingles zeroes & ones
r) r z&Netmask pattern %r mixes zeroes & ones)r7 r> r r ) ru ip_inttrailing_zeroesrv leading_onesall_onesbyteslendetailsrp r
r
r _prefix_from_ip_int s
z"_IPAddressBase._prefix_from_ip_intc C s d| }t |d d S )Nz%r is not a valid netmask)r )ru netmask_strrp r
r
r _report_invalid_netmask s z&_IPAddressBase._report_invalid_netmaskc C sj | r| s| | z t|}W n tyB | | Y n0 d| krZ| jksfn | | |S )a Return prefix length from a numeric string
Args:
prefixlen_str: The string to be converted
Returns:
An integer, the prefix length.
Raises:
NetmaskValueError: If the input is not a valid netmask
r )isasciiisdigitr intr r> )ru
prefixlen_strrv r
r
r _prefix_from_prefix_string s
z)_IPAddressBase._prefix_from_prefix_stringc C s z| |}W n ty* | | Y n0 z | |W S tyJ Y n0 || jN }z | |W S ty~ | | Y n0 dS )a Turn a netmask/hostmask string into a prefix length
Args:
ip_str: The netmask/hostmask to be converted
Returns:
An integer, the prefix length.
Raises:
NetmaskValueError: If the input is not a valid netmask/hostmask
N)_ip_int_from_stringr r r r r? )ru ip_strry r
r
r _prefix_from_ip_string s
z%_IPAddressBase._prefix_from_ip_stringc C sH t |ttfr|| jfS t |ts*t|}t|dkr:|S |d | jfS )zHelper function to parse address of Network/Interface.
Arg:
address: Argument of Network/Interface.
Returns:
(addr, prefix) tuple.
r) r )r: bytesr r> tupler( r& )ru r r
r
r _split_addr_prefix s
z!_IPAddressBase._split_addr_prefixc C s | j t| ffS N) __class__r$ re r
r
r
__reduce__, s z_IPAddressBase.__reduce__N)r r r r __slots__propertyrg ri rk r= rq rt classmethodrw r r r r r r r
r
r
r rc ~ s2
!
rc c st e Zd ZdZdZdd Zdd Zdd Zd d
Zd d Z d
d Z
dd Z dd Z dd Z
dd Z fddZ ZS )r; zA generic IP object.
This IP class contains the version independent methods which are
used by single IP addresses.
r
c C s | j S r )r, re r
r
r __int__= s z_BaseAddress.__int__c C s6 z| j |j ko| j|jkW S ty0 t Y S 0 d S r )r, rS rU r` rf otherr
r
r __eq__@ s
z_BaseAddress.__eq__c C sF t |tstS | j|jkr*td| |f | j|jkrB| j|jk S dS Nr8 F)r: r; r` rS r< r, r r
r
r __lt__G s
z_BaseAddress.__lt__c C s t |tstS | t| | S r r: r r` r r r
r
r __add__S s
z_BaseAddress.__add__c C s t |tstS | t| | S r r r r
r
r __sub__X s
z_BaseAddress.__sub__c C s d| j jt| f S Nz%s(%r)r r r$ re r
r
r __repr__] s z_BaseAddress.__repr__c C s t | | jS r )r$ _string_from_ip_intr, re r
r
r __str__` s z_BaseAddress.__str__c C s t tt| jS r )hashhexr r, re r
r
r __hash__c s z_BaseAddress.__hash__c C s
| j | fS r rS re r
r
r r_ f s z _BaseAddress._get_address_keyc C s | j | jffS r )r r, re r
r
r r i s z_BaseAddress.__reduce__c s |r|d dkr t t| |S tdu r8ddl}|dat|}|sRt |S | \}}}|dkr|| j dkrxd}nd }|dkr| j
}n
| j
d }|r||d d
7 }|r|d 7 }t t | | d | | | S )
a Returns an IP address as a formatted string.
Supported presentation types are:
's': returns the IP address as a string (default)
'b': converts to binary and returns a zero-padded string
'X' or 'x': converts to upper- or lower-case hex and returns a zero-padded string
'n': the same as 'b' for IPv4 and 'x' for IPv6
For binary and hex presentation types, the alternate form specifier
'#' and the grouping option '_' are supported.
rR sNr z(#?)(_?)([xbnX])nr bxr) r# 0) formatr$ _address_fmt_rerecompile fullmatchsuper
__format__groupsrS r> r )rf fmtr m alternategroupingfmt_basepadlenr r
r r l s*
z_BaseAddress.__format__)r r r r r r r r r r r r r r_ r r
__classcell__r
r
r r r; 2 s r; c @ s` e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dd Z dd Z dd Z
ejdd Zejdd Zedd Zed d Zed d Zed d! Zed"d# Zed$d% Zd&d' Zd(d) Zd*d+ ZdFd.d/Z dGd0d1Z ed2d3 Z e d4d5 Z d6d7 Z!d8d9 Z"ed:d; Z#ed