Address objects¶

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. Address objects arehashable, so they can be used as keys in dictionaries.

classipaddress.IPv4Address(address)¶

Construct an IPv4 address. AnAddressValueError is raised ifaddress is not a valid IPv4 address.

The following constitutes a valid IPv4 address:

1. A string in decimal-dot notation, consisting of four decimal integers inthe inclusive range 0–255, separated by dots (e.g.192.168.0.1). Eachinteger represents an octet (byte) in the address. Leading zeroes arenot tolerated to prevent confusion with octal notation.

2. An integer that fits into 32 bits.

3. An integer packed into abytes object of length 4 (mostsignificant octet first).

>>>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')

Changed in version 3.8:Leading zeros are tolerated, even in ambiguous cases that look likeoctal notation.

Changed in version 3.8.12:Leading zeros are no longer tolerated and are treated as an error.IPv4 address strings are now parsed as strict as glibcinet_pton().

version¶

The appropriate version number:4 for IPv4,6 for IPv6.

max_prefixlen¶

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.

compressed¶

exploded¶

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.

packed¶

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.

reverse_pointer¶

The name of the reverse DNS PTR record 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'

This is the name that could be used for performing a PTR lookup, not theresolved hostname itself.

New in version 3.5.

is_multicast¶

True if the address is reserved for multicast use. SeeRFC 3171 (for IPv4) orRFC 2373 (for IPv6).

is_private¶

True if the address is allocated for private networks. Seeiana-ipv4-special-registry (for IPv4) oriana-ipv6-special-registry(for IPv6).

is_global¶

True if the address is allocated for public networks. Seeiana-ipv4-special-registry (for IPv4) oriana-ipv6-special-registry(for IPv6).

New in version 3.4.

is_unspecified¶

True if the address is unspecified. SeeRFC 5735 (for IPv4)orRFC 2373 (for IPv6).

is_reserved¶

True if the address is otherwise IETF reserved.

is_loopback¶

True if this is a loopback address. SeeRFC 3330 (for IPv4)orRFC 2373 (for IPv6).

is_link_local¶

True if the address is reserved for link-local usage. SeeRFC 3927.

classipaddress.IPv6Address(address)¶

Construct an IPv6 address. AnAddressValueError is raised ifaddress is not a valid IPv6 address.

The following constitutes a valid IPv6 address:

1. A string consisting of eight groups of four hexadecimal digits, eachgroup representing 16 bits. The groups are separated by colons.This describes anexploded (longhand) notation. The string canalso becompressed (shorthand notation) by various means. SeeRFC 4291 for details. For example,"0000:0000:0000:0000:0000:0abc:0007:0def" can be compressed to"::abc:7:def".

2. An integer that fits into 128 bits.

3. An integer packed into abytes object of length 16, big-endian.

>>>ipaddress.IPv6Address('2001:db8::1000')IPv6Address('2001:db8::1000')

compressed¶

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.

exploded¶

The long form of the address representation, with all leading zeroes andgroups consisting entirely of zeroes included.

For the following attributes, see the corresponding documentation of theIPv4Address class:

packed¶

reverse_pointer¶

version¶

max_prefixlen¶

is_multicast¶

is_private¶

is_global¶

is_unspecified¶

is_reserved¶

is_loopback¶

is_link_local¶

New in version 3.4:is_global

is_site_local¶

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.

ipv4_mapped¶

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.

sixtofour¶

For addresses that appear to be 6to4 addresses (starting with2002::/16) as defined byRFC 3056, this property will reportthe embedded IPv4 address. For any other address, this property willbeNone.

teredo¶

For addresses that appear to be Teredo addresses (starting with2001::/32) as defined byRFC 4380, this property will reportthe embedded(server,client) IP address pair. For any otheraddress, this property will beNone.

Conversion to Strings and Integers¶

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

Operators¶

Address objects support some operators. Unless stated otherwise, operators canonly be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 withIPv6).

>>>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

>>>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

Prefix, net mask and host mask¶

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.

Network objects¶

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.Network objects arehashable, so they can be used as keys indictionaries.

classipaddress.IPv4Network(address,strict=True)¶

Construct an IPv4 network definition.address can be one of the following:

1. 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 as ahost mask if it starts with a zero field, with the single exception ofan all-zero mask which is treated as anet mask. 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.

2. An integer that fits into 32 bits. This is equivalent to asingle-address network, with the network address beingaddress andthe mask being/32.

3. An integer packed into abytes object of length 4, big-endian.The interpretation is similar to an integeraddress.

4. A two-tuple of an address description and a netmask, where the addressdescription is either a string, a 32-bits integer, a 4-bytes packedinteger, or an existing IPv4Address object; and the netmask is eitheran integer representing the prefix length (e.g.24) or a stringrepresenting the prefix mask (e.g.255.255.255.0).

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.

Changed in version 3.5:Added the two-tuple form for theaddress constructor parameter.

version¶

max_prefixlen¶

Refer to the corresponding attribute documentation inIPv4Address.

is_multicast¶

is_private¶

is_unspecified¶

is_reserved¶

is_loopback¶

is_link_local¶

These attributes are true for the network as a whole if they are truefor both the network address and the broadcast address.

network_address¶

The network address for the network. The network address and theprefix length together uniquely define a network.

broadcast_address¶

The broadcast address for the network. Packets sent to the broadcastaddress should be received by every host on the network.

hostmask¶

The host mask, as anIPv4Address object.

netmask¶

The net mask, as anIPv4Address object.

with_prefixlen¶

compressed¶

exploded¶

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.

with_netmask¶

A string representation of the network, with the mask in net masknotation.

with_hostmask¶

A string representation of the network, with the mask in host masknotation.

num_addresses¶

The total number of addresses in the network.

prefixlen¶

Length of the network prefix, in bits.

hosts()¶

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. For networkswith a mask length of 31, the network address and network broadcastaddress are also included in the result. Networks with a mask of 32will return a list containing the single host 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')]>>>list(ip_network('192.0.2.0/31').hosts())[IPv4Address('192.0.2.0'), IPv4Address('192.0.2.1')]>>>list(ip_network('192.0.2.1/32').hosts())[IPv4Address('192.0.2.1')]

overlaps(other)¶

True if this network is partly or wholly contained inother orother is wholly contained in this network.

address_exclude(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')]

subnets(prefixlen_diff=1,new_prefix=None)¶

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')]

supernet(prefixlen_diff=1,new_prefix=None)¶

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')

subnet_of(other)¶

ReturnTrue if this network is a subnet ofother.

>>>a=ip_network('192.168.1.0/24')>>>b=ip_network('192.168.1.128/30')>>>b.subnet_of(a)True

New in version 3.7.

supernet_of(other)¶

ReturnTrue if this network is a supernet ofother.

>>>a=ip_network('192.168.1.0/24')>>>b=ip_network('192.168.1.128/30')>>>a.supernet_of(b)True

New in version 3.7.

compare_networks(other)¶

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

Deprecated since version 3.7:It uses the same ordering and comparison algorithm as “<”, “==”, and “>”

classipaddress.IPv6Network(address,strict=True)¶

Construct an IPv6 network definition.address can be one of the following:

1. A string consisting of an IP address and an optional prefix length,separated by a slash (/). The IP address is the network address,and the prefix length must be a single number, theprefix. If noprefix length is provided, it’s considered to be/128.

   Note that currently expanded netmasks are not supported. That means2001:db00::0/24 is a valid argument while2001:db00::0/ffff:ff00::not.

2. An integer that fits into 128 bits. This is equivalent to asingle-address network, with the network address beingaddress andthe mask being/128.

3. An integer packed into abytes object of length 16, big-endian.The interpretation is similar to an integeraddress.

4. A two-tuple of an address description and a netmask, where the addressdescription is either a string, a 128-bits integer, a 16-bytes packedinteger, or an existing IPv6Address object; and the netmask is aninteger representing the prefix length.

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.

Changed in version 3.5:Added the two-tuple form for theaddress constructor parameter.

version¶

max_prefixlen¶

is_multicast¶

is_private¶

is_unspecified¶

is_reserved¶

is_loopback¶

is_link_local¶

network_address¶

broadcast_address¶

hostmask¶

netmask¶

with_prefixlen¶

compressed¶

exploded¶

with_netmask¶

with_hostmask¶

num_addresses¶

prefixlen¶

hosts()¶

Returns an iterator over the usable hosts in the network. The usablehosts are all the IP addresses that belong to the network, except theSubnet-Router anycast address. For networks with a mask length of 127,the Subnet-Router anycast address is also included in the result.Networks with a mask of 128 will return a list containing thesingle host address.

overlaps(other)¶

address_exclude(network)¶

subnets(prefixlen_diff=1,new_prefix=None)¶

supernet(prefixlen_diff=1,new_prefix=None)¶

subnet_of(other)¶

supernet_of(other)¶

compare_networks(other)¶

Refer to the corresponding attribute documentation inIPv4Network.

is_site_local¶

These attribute is true for the network as a whole if it is truefor both the network address and the broadcast address.

Operators¶

Network objects support some operators. Unless stated otherwise, operators canonly be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 withIPv6).

>>>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')

>>>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

Operators¶

Interface objects support some operators. Unless stated otherwise, operatorscan only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 withIPv6).