Source code:Lib/ipaddress.py
Note
Theipaddress module has been included in the standard library on aprovisional basis. Backwards incompatiblechanges (up to and including removal of the package) may occur if deemednecessary by the core developers.
ipaddress provides the capabilities to create, manipulate andoperate on IPv4 and IPv6 addresses and networks.
The functions and classes in this module make it straightforward to handlevarious tasks related to IP addresses, including checking whether or not twohosts are on the same subnet, iterating over all hosts in a particularsubnet, checking whether or not a string represents a valid IP address ornetwork definition, and so on.
This is the full module API reference - for an overview and introduction,seeAn introduction to the ipaddress module.
New in version 3.3.
Theipaddress module provides factory functions to conveniently createIP addresses, networks and interfaces:
Return anIPv4Address orIPv6Address object depending onthe IP address passed as argument. Either IPv4 or IPv6 addresses may besupplied; integers less than 2**32 will be considered to be IPv4 by default.AValueError is raised ifaddress does not represent a valid IPv4or IPv6 address.
>>>ipaddress.ip_address('192.168.0.1')IPv4Address('192.168.0.1')>>>ipaddress.ip_address('2001:db8::')IPv6Address('2001:db8::')
Return anIPv4Network orIPv6Network object depending onthe IP address passed as argument.address is a string or integerrepresenting the IP network. Either IPv4 or IPv6 networks may be supplied;integers less than 2**32 will be considered to be IPv4 by default.strictis passed toIPv4Network orIPv6Network constructor. AValueError is raised ifaddress does not represent a valid IPv4 orIPv6 address, or if the network has host bits set.
>>>ipaddress.ip_network('192.168.0.0/28')IPv4Network('192.168.0.0/28')
Return anIPv4Interface orIPv6Interface object dependingon the IP address passed as argument.address is a string or integerrepresenting the IP address. Either IPv4 or IPv6 addresses may be supplied;integers less than 2**32 will be considered to be IPv4 by default. AValueError is raised ifaddress does not represent a valid IPv4 orIPv6 address.
One downside of these convenience functions is that the need to handle bothIPv4 and IPv6 formats means that error messages provide minimalinformation on the precise error, as the functions don’t know whether theIPv4 or IPv6 format was intended. More detailed error reporting can beobtained by calling the appropriate version specific class constructorsdirectly.
TheIPv4Address andIPv6Address objects share a lot of commonattributes. Some attributes that are only meaningful for IPv6 addresses arealso implemented byIPv4Address objects, in order to make it easier towrite code that handles both IP versions correctly.
Construct an IPv4 address. AnAddressValueError is raised ifaddress is not a valid IPv4 address.
The following constitutes a valid IPv4 address:
>>>ipaddress.IPv4Address('192.168.0.1')IPv4Address('192.168.0.1')>>>ipaddress.IPv4Address(3232235521)IPv4Address('192.168.0.1')>>>ipaddress.IPv4Address(b'\xC0\xA8\x00\x01')IPv4Address('192.168.0.1')
The appropriate version number:4 for IPv4,6 for IPv6.
The total number of bits in the address representation for thisversion:32 for IPv4,128 for IPv6.
The prefix defines the number of leading bits in an address thatare compared to determine whether or not an address is part of anetwork.
The string representation in dotted decimal notation. Leading zeroesare never included in the representation.
As IPv4 does not define a shorthand notation for addresses with octetsset to zero, these two attributes are always the same asstr(addr)for IPv4 addresses. Exposing these attributes makes it easier towrite display code that can handle both IPv4 and IPv6 addresses.
The binary representation of this address - abytes object ofthe appropriate length (most significant octet first). This is 4 bytesfor IPv4 and 16 bytes for IPv6.
True if the address is reserved for multicast use. SeeRFC 3171 (for IPv4) orRFC 2373 (for IPv6).
True if the address is allocated for private networks. SeeRFC 1918 (for IPv4) orRFC 4193 (for IPv6).
True if the address is otherwise IETF reserved.
Construct an IPv6 address. AnAddressValueError is raised ifaddress is not a valid IPv6 address.
The following constitutes a valid IPv6 address:
>>>ipaddress.IPv6Address('2001:db8::1000')IPv6Address('2001:db8::1000')
The short form of the address representation, with leading zeroes ingroups omitted and the longest sequence of groups consisting entirely ofzeroes collapsed to a single empty group.
This is also the value returned bystr(addr) for IPv6 addresses.
The long form of the address representation, with all leading zeroes andgroups consisting entirely of zeroes included.
Refer to the corresponding attribute documentation inIPv4Address
True if the address is reserved for site-local usage. Note thatthe site-local address space has been deprecated byRFC 3879. Useis_private to test if this address is in thespace of unique local addresses as defined byRFC 4193.
For addresses that appear to be IPv4 mapped addresses (starting with::FFFF/96), this property will report the embedded IPv4 address.For any other address, this property will beNone.
To interoperate with networking interfaces such as the socket module,addresses must be converted to strings or integers. This is handled usingthestr() andint() builtin functions:
>>>str(ipaddress.IPv4Address('192.168.0.1'))'192.168.0.1'>>>int(ipaddress.IPv4Address('192.168.0.1'))3232235521>>>str(ipaddress.IPv6Address('::1'))'::1'>>>int(ipaddress.IPv6Address('::1'))1
Address objects support some operators. Unless stated otherwise, operators canonly be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 withIPv6).
Address objects can be compared with the usual set of comparison operators. Someexamples:
>>>IPv4Address('127.0.0.2')>IPv4Address('127.0.0.1')True>>>IPv4Address('127.0.0.2')==IPv4Address('127.0.0.1')False>>>IPv4Address('127.0.0.2')!=IPv4Address('127.0.0.1')True
Integers can be added to or subtracted from address objects. Some examples:
>>>IPv4Address('127.0.0.2')+3IPv4Address('127.0.0.5')>>>IPv4Address('127.0.0.2')-3IPv4Address('126.255.255.255')>>>IPv4Address('255.255.255.255')+1Traceback (most recent call last): File"<stdin>", line1, in<module>ipaddress.AddressValueError:4294967296 (>= 2**32) is not permitted as an IPv4 address
TheIPv4Network andIPv6Network objects provide a mechanismfor defining and inspecting IP network definitions. A network definitionconsists of amask and anetwork address, and as such defines a range ofIP addresses that equal the network address when masked (binary AND) with themask. For example, a network definition with the mask255.255.255.0 andthe network address192.168.1.0 consists of IP addresses in the inclusiverange192.168.1.0 to192.168.1.255.
There are several equivalent ways to specify IP network masks. Aprefix/<nbits> is a notation that denotes how many high-order bits are set inthe network mask. Anet mask is an IP address with some number ofhigh-order bits set. Thus the prefix/24 is equivalent to the net mask255.255.255.0 in IPv4, orffff:ff00:: in IPv6. In addition, ahost mask is the logical inverse of anet mask, and is sometimes used(for example in Cisco access control lists) to denote a network mask. Thehost mask equivalent to/24 in IPv4 is0.0.0.255.
All attributes implemented by address objects are implemented by networkobjects as well. In addition, network objects implement additional attributes.All of these are common betweenIPv4Network andIPv6Network,so to avoid duplication they are only documented forIPv4Network.
Construct an IPv4 network definition.address can be one of the following:
A string consisting of an IP address and an optional mask, separated bya slash (/). The IP address is the network address, and the maskcan be either a single number, which means it’s aprefix, or a stringrepresentation of an IPv4 address. If it’s the latter, the mask isinterpreted as anet mask if it starts with a non-zero field, or asahost mask if it starts with a zero field. If no mask is provided,it’s considered to be/32.
For example, the followingaddress specifications are equivalent:192.168.1.0/24,192.168.1.0/255.255.255.0 and192.168.1.0/0.0.0.255.
An integer that fits into 32 bits. This is equivalent to asingle-address network, with the network address beingaddress andthe mask being/32.
An integer packed into abytes object of length 4, big-endian.The interpretation is similar to an integeraddress.
AnAddressValueError is raised ifaddress is not a valid IPv4address. ANetmaskValueError is raised if the mask is not valid foran IPv4 address.
Ifstrict isTrue and host bits are set in the supplied address,thenValueError is raised. Otherwise, the host bits are masked outto determine the appropriate network address.
Unless stated otherwise, all network methods accepting other network/addressobjects will raiseTypeError if the argument’s IP version isincompatible toself
Refer to the corresponding attribute documentation inIPv4Address
These attributes are true for the network as a whole if they are truefor both the network address and the broadcast address
The network address for the network. The network address and theprefix length together uniquely define a network.
The broadcast address for the network. Packets sent to the broadcastaddress should be received by every host on the network.
The host mask, as a string.
A string representation of the network, with the mask in prefixnotation.
with_prefixlen andcompressed are always the same asstr(network).exploded uses the exploded form the network address.
A string representation of the network, with the mask in net masknotation.
A string representation of the network, with the mask in host masknotation.
The total number of addresses in the network.
Length of the network prefix, in bits.
Returns an iterator over the usable hosts in the network. The usablehosts are all the IP addresses that belong to the network, except thenetwork address itself and the network broadcast address.
>>>list(ip_network('192.0.2.0/29').hosts())[IPv4Address('192.0.2.1'), IPv4Address('192.0.2.2'), IPv4Address('192.0.2.3'), IPv4Address('192.0.2.4'), IPv4Address('192.0.2.5'), IPv4Address('192.0.2.6')]
True if this network is partly or wholly contained inother orother is wholly contained in this network.
Computes the network definitions resulting from removing the givennetwork from this one. Returns an iterator of network objects.RaisesValueError ifnetwork is not completely contained inthis network.
>>>n1=ip_network('192.0.2.0/28')>>>n2=ip_network('192.0.2.1/32')>>>list(n1.address_exclude(n2))[IPv4Network('192.0.2.8/29'), IPv4Network('192.0.2.4/30'), IPv4Network('192.0.2.2/31'), IPv4Network('192.0.2.0/32')]
The subnets that join to make the current network definition, dependingon the argument values.prefixlen_diff is the amount our prefixlength should be increased by.new_prefix is the desired newprefix of the subnets; it must be larger than our prefix. One andonly one ofprefixlen_diff andnew_prefix must be set. Returns aniterator of network objects.
>>>list(ip_network('192.0.2.0/24').subnets())[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]>>>list(ip_network('192.0.2.0/24').subnets(prefixlen_diff=2))[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'), IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]>>>list(ip_network('192.0.2.0/24').subnets(new_prefix=26))[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'), IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]>>>list(ip_network('192.0.2.0/24').subnets(new_prefix=23))Traceback (most recent call last): File"<stdin>", line1, in<module>raiseValueError('new prefix must be longer')ValueError:new prefix must be longer>>>list(ip_network('192.0.2.0/24').subnets(new_prefix=25))[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]
The supernet containing this network definition, depending on theargument values.prefixlen_diff is the amount our prefix lengthshould be decreased by.new_prefix is the desired new prefix ofthe supernet; it must be smaller than our prefix. One and only oneofprefixlen_diff andnew_prefix must be set. Returns a singlenetwork object.
>>>ip_network('192.0.2.0/24').supernet()IPv4Network('192.0.2.0/23')>>>ip_network('192.0.2.0/24').supernet(prefixlen_diff=2)IPv4Network('192.0.0.0/22')>>>ip_network('192.0.2.0/24').supernet(new_prefix=20)IPv4Network('192.0.0.0/20')
Compare this network toother. In this comparison only the networkaddresses are considered; host bits aren’t. Returns either-1,0 or1.
>>>ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.2/32'))-1>>>ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.0/32'))1>>>ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.1/32'))0
Construct an IPv6 network definition.address can be one of the following:
A string consisting of an IP address and an optional mask, separated bya slash (/). The IP address is the network address, and the maskcan be either a single number, which means it’s aprefix, or a stringrepresentation of an IPv6 address. If it’s the latter, the mask isinterpreted as anet mask. If no mask is provided, it’s considered tobe/128.
For example, the followingaddress specifications are equivalent:2001:db00::0/24 and2001:db00::0/ffff:ff00::.
An integer that fits into 128 bits. This is equivalent to asingle-address network, with the network address beingaddress andthe mask being/128.
An integer packed into abytes object of length 16, bit-endian.The interpretation is similar to an integeraddress.
AnAddressValueError is raised ifaddress is not a valid IPv6address. ANetmaskValueError is raised if the mask is not valid foran IPv6 address.
Ifstrict isTrue and host bits are set in the supplied address,thenValueError is raised. Otherwise, the host bits are masked outto determine the appropriate network address.
Refer to the corresponding attribute documentation inIPv4Network
These attribute is true for the network as a whole if it is truefor both the network address and the broadcast address
Network objects support some operators. Unless stated otherwise, operators canonly be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 withIPv6).
Network objects can be compared with the usual set of logical operators,similarly to address objects.
Network objects can be iterated to list all the addresses belonging to thenetwork. For iteration,all hosts are returned, including unusable hosts(for usable hosts, use thehosts() method). Anexample:
>>>foraddrinIPv4Network('192.0.2.0/28'):...addr...IPv4Address('192.0.2.0')IPv4Address('192.0.2.1')IPv4Address('192.0.2.2')IPv4Address('192.0.2.3')IPv4Address('192.0.2.4')IPv4Address('192.0.2.5')IPv4Address('192.0.2.6')IPv4Address('192.0.2.7')IPv4Address('192.0.2.8')IPv4Address('192.0.2.9')IPv4Address('192.0.2.10')IPv4Address('192.0.2.11')IPv4Address('192.0.2.12')IPv4Address('192.0.2.13')IPv4Address('192.0.2.14')IPv4Address('192.0.2.15')
Network objects can act as containers of addresses. Some examples:
>>>IPv4Network('192.0.2.0/28')[0]IPv4Address('192.0.2.0')>>>IPv4Network('192.0.2.0/28')[15]IPv4Address('192.0.2.15')>>>IPv4Address('192.0.2.6')inIPv4Network('192.0.2.0/28')True>>>IPv4Address('192.0.3.6')inIPv4Network('192.0.2.0/28')False
Construct an IPv4 interface. The meaning ofaddress is as in theconstructor ofIPv4Network, except that arbitrary host addressesare always accepted.
IPv4Interface is a subclass ofIPv4Address, so it inheritsall the attributes from that class. In addition, the following attributesare available:
The address (IPv4Address) without network information.
>>>interface=IPv4Interface('192.0.2.5/24')>>>interface.ipIPv4Address('192.0.2.5')
The network (IPv4Network) this interface belongs to.
>>>interface=IPv4Interface('192.0.2.5/24')>>>interface.networkIPv4Network('192.0.2.0/24')
A string representation of the interface with the mask in prefix notation.
>>>interface=IPv4Interface('192.0.2.5/24')>>>interface.with_prefixlen'192.0.2.5/24'
A string representation of the interface with the network as a net mask.
>>>interface=IPv4Interface('192.0.2.5/24')>>>interface.with_netmask'192.0.2.5/255.255.255.0'
A string representation of the interface with the network as a host mask.
>>>interface=IPv4Interface('192.0.2.5/24')>>>interface.with_hostmask'192.0.2.5/0.0.0.255'
Construct an IPv6 interface. The meaning ofaddress is as in theconstructor ofIPv6Network, except that arbitrary host addressesare always accepted.
IPv6Interface is a subclass ofIPv6Address, so it inheritsall the attributes from that class. In addition, the following attributesare available:
Refer to the corresponding attribute documentation inIPv4Interface.
The module also provides the following module level functions:
Represent an address as 4 packed bytes in network (big-endian) order.address is an integer representation of an IPv4 IP address. AValueError is raised if the integer is negative or too large to be anIPv4 IP address.
>>>ipaddress.ip_address(3221225985)IPv4Address('192.0.2.1')>>>ipaddress.v4_int_to_packed(3221225985)b'\xc0\x00\x02\x01'
Represent an address as 16 packed bytes in network (big-endian) order.address is an integer representation of an IPv6 IP address. AValueError is raised if the integer is negative or too large to be anIPv6 IP address.
Return an iterator of the summarized network range given the first and lastIP addresses.first is the firstIPv4Address orIPv6Address in the range andlast is the lastIPv4AddressorIPv6Address in the range. ATypeError is raised iffirst orlast are not IP addresses or are not of the same version. AValueError is raised iflast is not greater thanfirst or iffirst address version is not 4 or 6.
>>>[ipaddrforipaddrinipaddress.summarize_address_range(...ipaddress.IPv4Address('192.0.2.0'),...ipaddress.IPv4Address('192.0.2.130'))][IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'), IPv4Network('192.0.2.130/32')]
Return an iterator of the collapsedIPv4Network orIPv6Network objects.addresses is an iterator ofIPv4Network orIPv6Network objects. ATypeError israised ifaddresses contains mixed version objects.
>>>[ipaddrforipaddrin...ipaddress.collapse_addresses([ipaddress.IPv4Network('192.0.2.0/25'),...ipaddress.IPv4Network('192.0.2.128/25')])][IPv4Network('192.0.2.0/24')]
Return a key suitable for sorting between networks and addresses. Addressand Network objects are not sortable by default; they’re fundamentallydifferent, so the expression:
IPv4Address('192.0.2.0')<=IPv4Network('192.0.2.0/24')
doesn’t make sense. There are some times however, where you may wish tohaveipaddress sort these anyway. If you need to do this, you can usethis function as thekey argument tosorted().
obj is either a network or address object.
To support more specific error reporting from class constructors, themodule defines the following exceptions:
Any value error related to the address.
Any value error related to the netmask.
21.27.xmlrpc.server — Basic XML-RPC servers
Enter search terms or a module, class or function name.
