ipaddress — IPv4/IPv6 操纵库 ¶

地址对象 ¶

IPv4Address and IPv6Address objects share a lot of common attributes. Some attributes that are only meaningful for IPv6 addresses are also implemented by IPv4Address objects, in order to make it easier to write code that handles both IP versions correctly. Address objects are hashable ，因此可以将它们用作字典键。

class ipaddress. IPv4Address ( address ) ¶

构造 IPv4 地址。 AddressValueError 被引发若 address 不是有效 IPv4 地址。

以下构成有效 IPv4 地址：

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

2. 拟合成 32 位的整数。

3. An integer packed into a bytes object of length 4 (most significant 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')
											

3.8 版改变： Leading zeros are tolerated, even in ambiguous cases that look like octal notation.

3.10 版改变： Leading zeros are no longer tolerated and are treated as an error. IPv4 address strings are now parsed as strict as glibc inet_pton() .

3.9.5 版改变： The above change was also included in Python 3.9 starting with version 3.9.5.

3.8.12 版改变： The above change was also included in Python 3.8 starting with version 3.8.12.

version ¶

合适的版本号： 4 对于 IPv4， 6 对于 IPv6。

max_prefixlen ¶

The total number of bits in the address representation for this version: 32 对于 IPv4， 128 对于 IPv6。

The prefix defines the number of leading bits in an address that are compared to determine whether or not an address is part of a network.

compressed ¶

exploded ¶

The string representation in dotted decimal notation. Leading zeroes are never included in the representation.

As IPv4 does not define a shorthand notation for addresses with octets set to zero, these two attributes are always the same as str(addr) for IPv4 addresses. Exposing these attributes makes it easier to write display code that can handle both IPv4 and IPv6 addresses.

packed ¶

此地址的二进制表示 - bytes object of the appropriate length (most significant octet first). This is 4 bytes for 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 the resolved hostname itself.

3.5 版新增。

is_multicast ¶

True if the address is reserved for multicast use. See RFC 3171 (对于 IPv4) 或 RFC 2373 (对于 IPv6)。

is_private ¶

True if the address is allocated for private networks. See iana-ipv4-special-registry (对于 IPv4) 或 iana-ipv6-special-registry (对于 IPv6)。

is_global ¶

True if the address is allocated for public networks. See iana-ipv4-special-registry (对于 IPv4) 或 iana-ipv6-special-registry (对于 IPv6)。

3.4 版新增。

is_unspecified ¶

True 若地址未指定。见 RFC 5735 (对于 IPv4) 或 RFC 2373 (对于 IPv6)。

is_reserved ¶

True if the address is otherwise IETF reserved.

is_loopback ¶

True if this is a loopback address. See RFC 3330 (对于 IPv4) 或 RFC 2373 (对于 IPv6)。

is_link_local ¶

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

IPv4Address. __format__ ( fmt ) ¶

Returns a string representation of the IP address, controlled by an explicit format string. fmt can be one of the following: 's' , the default option, equivalent to str() , 'b' for a zero-padded binary string, 'X' or 'x' for an uppercase or lowercase hexadecimal representation, or 'n' , which is equivalent to 'b' for IPv4 addresses and 'x' for IPv6. For binary and hexadecimal representations, the form specifier '#' and the grouping option '_' are available. __format__ is used by format , str.format 和 f 字符串。

>>> format(ipaddress.IPv4Address('192.168.0.1'))
'192.168.0.1'
>>> '{:#b}'.format(ipaddress.IPv4Address('192.168.0.1'))
'0b11000000101010000000000000000001'
>>> f'{ipaddress.IPv6Address("2001:db8::1000"):s}'
'2001:db8::1000'
>>> format(ipaddress.IPv6Address('2001:db8::1000'), '_X')
'2001_0DB8_0000_0000_0000_0000_0000_1000'
>>> '{:#_n}'.format(ipaddress.IPv6Address('2001:db8::1000'))
'0x2001_0db8_0000_0000_0000_0000_0000_1000'
											

3.9 版新增。

class ipaddress. IPv6Address ( address ) ¶

构造 IPv6 地址。 AddressValueError 被引发若 address 不是有效 IPv6 地址。

以下构成有效 IPv6 地址：

1. A string consisting of eight groups of four hexadecimal digits, each group representing 16 bits. The groups are separated by colons. This describes an exploded (longhand) notation. The string can also be compressed (shorthand notation) by various means. See RFC 4291 了解细节。例如， "0000:0000:0000:0000:0000:0abc:0007:0def" can be compressed to "::abc:7:def" .

   Optionally, the string may also have a scope zone ID, expressed with a suffix %scope_id . If present, the scope ID must be non-empty, and may not contain % 。见 RFC 4007 了解细节。例如， fe80::1234%1 might identify address fe80::1234 on the first link of the node.

2. 拟合成 128 位的整数。

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

>>> ipaddress.IPv6Address('2001:db8::1000')
IPv6Address('2001:db8::1000')
>>> ipaddress.IPv6Address('ff02::5678%1')
IPv6Address('ff02::5678%1')
											

compressed ¶

The short form of the address representation, with leading zeroes in groups omitted and the longest sequence of groups consisting entirely of zeroes collapsed to a single empty group.

This is also the value returned by str(addr) 对于 IPv6 地址。

exploded ¶

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

对于下列属性和方法，见相应文档编制的 IPv4Address 类：

packed ¶

reverse_pointer ¶

version ¶

max_prefixlen ¶

is_multicast ¶

is_private ¶

is_global ¶

is_unspecified ¶

is_reserved ¶

is_loopback ¶

is_link_local ¶

3.4 版新增： is_global

is_site_local ¶

True if the address is reserved for site-local usage. Note that the site-local address space has been deprecated by RFC 3879 。使用 is_private to test if this address is in the space of unique local addresses as defined by RFC 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 be None .

scope_id ¶

For scoped addresses as defined by RFC 4007 , this property identifies the particular zone of the address’s scope that the address belongs to, as a string. When no scope zone is specified, this property will be None .

sixtofour ¶

For addresses that appear to be 6to4 addresses (starting with 2002::/16 ) 作为定义通过 RFC 3056 , this property will report the embedded IPv4 address. For any other address, this property will be None .

teredo ¶

For addresses that appear to be Teredo addresses (starting with 2001::/32 ) 作为定义通过 RFC 4380 ，此特性将报告嵌入式 (server, client) IP 地址对。对于任何其它地址，此特性将为 None .

IPv6Address. __format__ ( fmt ) ¶

Refer to the corresponding method documentation in IPv4Address .

3.9 版新增。

转换成字符串和整数 ¶

To interoperate with networking interfaces such as the socket module, addresses must be converted to strings or integers. This is handled using the str() and int() 内置函数：

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

Note that IPv6 scoped addresses are converted to integers without scope zone ID.

运算符 ¶

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

>>> 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
>>> IPv6Address('fe80::1234') == IPv6Address('fe80::1234%1')
False
>>> IPv6Address('fe80::1234%1') != IPv6Address('fe80::1234%2')
True
										

>>> IPv4Address('127.0.0.2') + 3
IPv4Address('127.0.0.5')
>>> IPv4Address('127.0.0.2') - 3
IPv4Address('126.255.255.255')
>>> IPv4Address('255.255.255.255') + 1
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ipaddress.AddressValueError: 4294967296 (>= 2**32) is not permitted as an IPv4 address
										

前缀、网络掩码和主机掩码 ¶

There are several equivalent ways to specify IP network masks. A prefix /<nbits> is a notation that denotes how many high-order bits are set in the network mask. A net mask is an IP address with some number of high-order bits set. Thus the prefix /24 is equivalent to the net mask 255.255.255.0 in IPv4, or ffff:ff00:: in IPv6. In addition, a host mask is the logical inverse of a net mask , and is sometimes used (for example in Cisco access control lists) to denote a network mask. The host mask equivalent to /24 in IPv4 is 0.0.0.255 .

网络对象 ¶

All attributes implemented by address objects are implemented by network objects as well. In addition, network objects implement additional attributes. All of these are common between IPv4Network and IPv6Network , so to avoid duplication they are only documented for IPv4Network . Network objects are hashable ，因此可以将它们用作字典键。

class ipaddress. 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 by a slash ( / ). The IP address is the network address, and the mask can be either a single number, which means it’s a prefix , or a string representation of an IPv4 address. If it’s the latter, the mask is interpreted as a net mask if it starts with a non-zero field, or as a host mask if it starts with a zero field, with the single exception of an all-zero mask which is treated as a net mask . If no mask is provided, it’s considered to be /32 .

   For example, the following address specifications are equivalent: 192.168.1.0/24 , 192.168.1.0/255.255.255.0 and 192.168.1.0/0.0.0.255 .

2. An integer that fits into 32 bits. This is equivalent to a single-address network, with the network address being address and the mask being /32 .

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

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

An AddressValueError 被引发若 address is not a valid IPv4 address. A NetmaskValueError is raised if the mask is not valid for an IPv4 address.

若 strict is True and host bits are set in the supplied address, then ValueError is raised. Otherwise, the host bits are masked out to determine the appropriate network address.

Unless stated otherwise, all network methods accepting other network/address objects will raise TypeError if the argument’s IP version is incompatible to self .

3.5 版改变： Added the two-tuple form for the address constructor parameter.

version ¶

max_prefixlen ¶

Refer to the corresponding attribute documentation in IPv4Address .

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 true for both the network address and the broadcast address.

network_address ¶

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

broadcast_address ¶

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

hostmask ¶

The host mask, as an IPv4Address 对象。

netmask ¶

The net mask, as an IPv4Address 对象。

with_prefixlen ¶

compressed ¶

exploded ¶

A string representation of the network, with the mask in prefix notation.

with_prefixlen and compressed are always the same as str(network) . exploded uses the exploded form the network address.

with_netmask ¶

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

with_hostmask ¶

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

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 usable hosts are all the IP addresses that belong to the network, except the network address itself and the network broadcast address. For networks with a mask length of 31, the network address and network broadcast address are also included in the result. Networks with a mask of 32 will 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 in other or other is wholly contained in this network.

address_exclude ( network ) ¶

Computes the network definitions resulting from removing the given network from this one. Returns an iterator of network objects. Raises ValueError if network is not completely contained in this 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, depending on the argument values. prefixlen_diff is the amount our prefix length should be increased by. new_prefix is the desired new prefix of the subnets; it must be larger than our prefix. One and only one of prefixlen_diff and new_prefix must be set. Returns an iterator 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>", line 1, in <module>
    raise ValueError('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 the argument values. prefixlen_diff is the amount our prefix length should be decreased by. new_prefix is the desired new prefix of the supernet; it must be smaller than our prefix. One and only one of prefixlen_diff and new_prefix must be set. Returns a single network 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 ) ¶

返回 True if this network is a subnet of other .

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

3.7 版新增。

supernet_of ( other ) ¶

返回 True if this network is a supernet of other .

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

3.7 版新增。

compare_networks ( other ) ¶

Compare this network to other . In this comparison only the network addresses are considered; host bits aren’t. Returns either -1 , 0 or 1 .

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

class ipaddress. 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, the prefix . If no prefix length is provided, it’s considered to be /128 .

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

2. An integer that fits into 128 bits. This is equivalent to a single-address network, with the network address being address and the mask being /128 .

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

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

An AddressValueError 被引发若 address is not a valid IPv6 address. A NetmaskValueError is raised if the mask is not valid for an IPv6 address.

若 strict is True and host bits are set in the supplied address, then ValueError is raised. Otherwise, the host bits are masked out to determine the appropriate network address.

3.5 版改变： Added the two-tuple form for the address 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 usable hosts are all the IP addresses that belong to the network, except the Subnet-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 the single 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 in IPv4Network .

is_site_local ¶

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

运算符 ¶

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

>>> for addr in IPv4Network('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') in IPv4Network('192.0.2.0/28')
True
>>> IPv4Address('192.0.3.6') in IPv4Network('192.0.2.0/28')
False
										

运算符 ¶

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