21.28. `ipaddress` — IPv4/IPv6 操纵库 ¶

ipaddress 提供创建、操纵及运转于 IPv4/IPv6 地址和网络的能力。

The functions and classes in this module make it straightforward to handle various tasks related to IP addresses, including checking whether or not two hosts are on the same subnet, iterating over all hosts in a particular subnet, checking whether or not a string represents a valid IP address or network definition, and so on.

这是完整的模块 API 参考 — 对于概述和介绍，见 ipaddress 模块介绍 .

3.3 版新增。

21.28.1. Convenience factory functions ¶

The ipaddress 模块提供工厂函数以方便创建 IP 地址、网络和接口：

ipaddress. ip_address ( address ) ¶

>>> ipaddress.ip_address('192.168.0.1')
IPv4Address('192.168.0.1')
>>> ipaddress.ip_address('2001:db8::')
IPv6Address('2001:db8::')

ipaddress. ip_network ( address , strict=True ) ¶

ipaddress. ip_interface ( address ) ¶

One downside of these convenience functions is that the need to handle both IPv4 and IPv6 formats means that error messages provide minimal information on the precise error, as the functions don’t know whether the IPv4 or IPv6 format was intended. More detailed error reporting can be obtained by calling the appropriate version specific class constructors directly.

21.28.2. IP Addresses ¶

21.28.2.1. Address objects ¶

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

class ipaddress. IPv4Address ( address ) ¶

class ipaddress. IPv6Address ( address ) ¶

exploded ¶

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

For the following attributes, see the corresponding documention of the IPv4Address 类：

packed ¶

version ¶

max_prefixlen ¶

is_multicast ¶

is_private ¶

is_global ¶

is_unspecified ¶

is_reserved ¶

is_loopback ¶

is_link_local ¶

is_site_local ¶

ipv4_mapped ¶

sixtofour ¶

teredo ¶

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

21.28.2.3. Operators ¶

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

21.28.2.3.1. Comparison operators ¶

Address objects can be compared with the usual set of comparison operators. Some examples:

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

21.28.2.3.2. Arithmetic operators ¶

Integers can be added to or subtracted from address objects. Some examples:

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

21.28.3. IP Network definitions ¶

The IPv4Network and IPv6Network objects provide a mechanism for defining and inspecting IP network definitions. A network definition consists of a mask 和 network address , and as such defines a range of IP addresses that equal the network address when masked (binary AND) with the mask. For example, a network definition with the mask 255.255.255.0 and the network address 192.168.1.0 consists of IP addresses in the inclusive range 192.168.1.0 to 192.168.1.255 .

21.28.3.1. Prefix, net mask and host mask ¶

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 .

21.28.3.2. Network objects ¶

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 .

class ipaddress. IPv4Network ( address , strict=True ) ¶

version ¶

max_prefixlen ¶

is_multicast ¶

is_private ¶

is_unspecified ¶

is_reserved ¶

is_loopback ¶

is_link_local ¶

network_address ¶

broadcast_address ¶

hostmask ¶

with_prefixlen ¶

compressed ¶

exploded ¶

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.

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

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

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

class ipaddress. IPv6Network ( address , strict=True ) ¶

21.28.3.3. Operators ¶

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

21.28.3.3.1. Logical operators ¶

Network objects can be compared with the usual set of logical operators, similarly to address objects.

21.28.3.3.2. Iteration ¶

Network objects can be iterated to list all the addresses belonging to the network. For iteration, all hosts are returned, including unusable hosts (for usable hosts, use the hosts() method). An example:

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

21.28.3.3.3. Networks as containers of addresses ¶

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

21.28.4. Interface objects ¶

class ipaddress. IPv4Interface ( address ) ¶

class ipaddress. IPv6Interface ( address ) ¶

21.28.5. Other Module Level Functions ¶

The module also provides the following module level functions:

ipaddress. v4_int_to_packed ( address ) ¶

Represent an address as 4 packed bytes in network (big-endian) order. address is an integer representation of an IPv4 IP address. A ValueError is raised if the integer is negative or too large to be an IPv4 IP address.

>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.v4_int_to_packed(3221225985)
b'\xc0\x00\x02\x01'

ipaddress. v6_int_to_packed ( address ) ¶

21.28. `ipaddress` — IPv4/IPv6 操纵库 ¶

21.28.1. Convenience factory functions ¶

21.28.2. IP Addresses ¶

21.28.2.1. Address objects ¶

21.28.2.2. Conversion to Strings and Integers ¶

21.28.2.3. Operators ¶

21.28.2.3.1. Comparison operators ¶

21.28.2.3.2. Arithmetic operators ¶

21.28.3. IP Network definitions ¶

21.28.3.1. Prefix, net mask and host mask ¶

21.28.3.2. Network objects ¶

21.28.3.3. Operators ¶

21.28.3.3.1. Logical operators ¶

21.28.3.3.2. Iteration ¶

21.28.3.3.3. Networks as containers of addresses ¶

21.28.4. Interface objects ¶

21.28.5. Other Module Level Functions ¶

21.28.6. Custom Exceptions ¶

内容表

上一话题

下一话题

本页

快速搜索

21.28. ipaddress — IPv4/IPv6 操纵库 ¶

21.28.1. Convenience factory functions ¶

21.28.2. IP Addresses ¶

21.28.2.1. Address objects ¶

21.28.2.2. Conversion to Strings and Integers ¶

21.28.2.3. Operators ¶

21.28.2.3.1. Comparison operators ¶

21.28.2.3.2. Arithmetic operators ¶

21.28.3. IP Network definitions ¶

21.28.3.1. Prefix, net mask and host mask ¶

21.28.3.2. Network objects ¶

21.28.3.3. Operators ¶

21.28.3.3.1. Logical operators ¶

21.28.3.3.2. Iteration ¶

21.28.3.3.3. Networks as containers of addresses ¶

21.28.4. Interface objects ¶

21.28.5. Other Module Level Functions ¶

21.28.6. Custom Exceptions ¶

内容表

上一话题

下一话题

本页

快速搜索

21.28. `ipaddress` — IPv4/IPv6 操纵库 ¶