Python/docs/3.9/howto/ipaddress

ipaddress 模块介绍

作者

彼得·穆迪

作者

尼克·科格兰

概述

本文档旨在简要介绍 ipaddress 模块。 它主要针对不熟悉 IP 网络术语的用户，但对于想要了解 ipaddress 如何表示 IP 网络寻址概念的网络工程师也可能有用。

创建地址/网络/接口对象

由于 ipaddress 是一个用于检查和操作 IP 地址的模块，因此您要做的第一件事就是创建一些对象。 您可以使用 ipaddress 从字符串和整数创建对象。

关于 IP 版本的说明

对于不是特别熟悉 IP 寻址的读者，重要的是要知道 Internet 协议目前正在从协议的第 4 版迁移到第 6 版。 这种转变的发生主要是因为该协议的第 4 版没有提供足够的地址来满足全世界的需求，特别是考虑到直接连接到互联网的设备数量不断增加。

详细解释两个版本的协议差异超出了本介绍的范围，但读者至少需要意识到这两个版本的存在，并且有时需要强制使用一个版本或其他。

IP 主机地址

地址，通常称为“主机地址”，是使用 IP 寻址时最基本的单位。 创建地址最简单的方法是使用 ipaddress.ip_address() 工厂函数，它会根据传入的值自动确定是创建 IPv4 还是 IPv6 地址：

>>> ipaddress.ip_address('192.0.2.1')
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address('2001:DB8::1')
IPv6Address('2001:db8::1')

Copy

地址也可以直接从整数创建。 将适合 32 位的值假定为 IPv4 地址：

>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address(42540766411282592856903984951653826561)
IPv6Address('2001:db8::1')

Copy

要强制使用 IPv4 或 IPv6 地址，可以直接调用相关类。 这对于强制为小整数创建 IPv6 地址特别有用：

>>> ipaddress.ip_address(1)
IPv4Address('0.0.0.1')
>>> ipaddress.IPv4Address(1)
IPv4Address('0.0.0.1')
>>> ipaddress.IPv6Address(1)
IPv6Address('::1')

Copy

定义网络

主机地址通常组合到 IP 网络中，因此 ipaddress 提供了一种创建、检查和操作网络定义的方法。 IP 网络对象由定义作为该网络一部分的主机地址范围的字符串构成。 该信息的最简单形式是“网络地址/网络前缀”对，其中前缀定义了前导位的数量，用于确定地址是否是网络的一部分，网络地址定义了预期值那些位。

至于地址，提供了一个工厂函数，可以自动确定正确的 IP 版本：

>>> ipaddress.ip_network('192.0.2.0/24')
IPv4Network('192.0.2.0/24')
>>> ipaddress.ip_network('2001:db8::0/96')
IPv6Network('2001:db8::/96')

Copy

网络对象不能设置任何主机位。 这样做的实际效果是 192.0.2.1/24 没有描述网络。 此类定义被称为接口对象，因为 ip-on-a-network 表示法通常用于描述给定网络上计算机的网络接口，并在下一节中进一步描述。

默认情况下，尝试创建设置了主机位的网络对象将导致引发 ValueError。 要请求将附加位强制为零，可以将标志 strict=False 传递给构造函数：

>>> ipaddress.ip_network('192.0.2.1/24')
Traceback (most recent call last):
   ...
ValueError: 192.0.2.1/24 has host bits set
>>> ipaddress.ip_network('192.0.2.1/24', strict=False)
IPv4Network('192.0.2.0/24')

Copy

虽然字符串形式提供了更大的灵活性，但网络也可以用整数定义，就像主机地址一样。 在这种情况下，网络被认为只包含由整数标识的单个地址，因此网络前缀包括整个网络地址：

>>> ipaddress.ip_network(3221225984)
IPv4Network('192.0.2.0/32')
>>> ipaddress.ip_network(42540766411282592856903984951653826560)
IPv6Network('2001:db8::/128')

Copy

与地址一样，可以通过直接调用类构造函数而不是使用工厂函数来强制创建特定类型的网络。

主机接口

如上所述，如果您需要描述特定网络上的地址，地址和网络类别都不够。 像 192.0.2.1/24 这样的符号通常被网络工程师和为防火墙和路由器编写工具的人用作“网络 192.0.2.0/24 上的主机 192.0.2.1”的简写，因此，[ X196X]ipaddress 提供了一组将地址与特定网络相关联的混合类。 用于创建的接口与用于定义网络对象的接口相同，只是地址部分不限于网络地址。

>>> ipaddress.ip_interface('192.0.2.1/24')
IPv4Interface('192.0.2.1/24')
>>> ipaddress.ip_interface('2001:db8::1/96')
IPv6Interface('2001:db8::1/96')

Copy

接受整数输入（与网络一样），并且可以通过直接调用相关构造函数来强制使用特定 IP 版本。

检查地址/网络/接口对象

您在创建 IPv(4|6)(Address|Network|Interface) 对象时遇到了麻烦，因此您可能想要获取有关它的信息。 ipaddress 试图让这件事变得简单而直观。

提取IP版本：

>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> addr6 = ipaddress.ip_address('2001:db8::1')
>>> addr6.version
6
>>> addr4.version
4

Copy

从接口获取网络：

>>> host4 = ipaddress.ip_interface('192.0.2.1/24')
>>> host4.network
IPv4Network('192.0.2.0/24')
>>> host6 = ipaddress.ip_interface('2001:db8::1/96')
>>> host6.network
IPv6Network('2001:db8::/96')

Copy

找出网络中有多少个单独的地址：

>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> net4.num_addresses
256
>>> net6 = ipaddress.ip_network('2001:db8::0/96')
>>> net6.num_addresses
4294967296

Copy

遍历网络上的“可用”地址：

>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> for x in net4.hosts():
...     print(x)  
192.0.2.1
192.0.2.2
192.0.2.3
192.0.2.4
...
192.0.2.252
192.0.2.253
192.0.2.254

Copy

获取网络掩码（即 设置对应于网络前缀的位）或主机掩码（不属于网络掩码的任何位）：

>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> net4.netmask
IPv4Address('255.255.255.0')
>>> net4.hostmask
IPv4Address('0.0.0.255')
>>> net6 = ipaddress.ip_network('2001:db8::0/96')
>>> net6.netmask
IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff::')
>>> net6.hostmask
IPv6Address('::ffff:ffff')

Copy

分解或压缩地址：

>>> addr6.exploded
'2001:0db8:0000:0000:0000:0000:0000:0001'
>>> addr6.compressed
'2001:db8::1'
>>> net6.exploded
'2001:0db8:0000:0000:0000:0000:0000:0000/96'
>>> net6.compressed
'2001:db8::/96'

Copy

虽然 IPv4 不支持扩展或压缩，但关联对象仍提供相关属性，以便版本中立代码可以轻松确保对 IPv6 地址使用最简洁或最详细的形式，同时仍能正确处理 IPv4 地址。

作为地址列表的网络

将网络视为列表有时很有用。 这意味着可以像这样对它们进行索引：

>>> net4[1]
IPv4Address('192.0.2.1')
>>> net4[-1]
IPv4Address('192.0.2.255')
>>> net6[1]
IPv6Address('2001:db8::1')
>>> net6[-1]
IPv6Address('2001:db8::ffff:ffff')

Copy

这也意味着网络对象适合使用这样的列表成员测试语法：

if address in network:
    # do something

Copy

基于网络前缀有效地完成遏制测试：

>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> addr4 in ipaddress.ip_network('192.0.2.0/24')
True
>>> addr4 in ipaddress.ip_network('192.0.3.0/24')
False

Copy

比较

ipaddress 提供了一些简单的、希望直观的方法来比较对象，在那里它是有意义的：

>>> ipaddress.ip_address('192.0.2.1') < ipaddress.ip_address('192.0.2.2')
True

Copy

如果您尝试比较不同版本或不同类型的对象，则会引发 TypeError 异常。

将 IP 地址与其他模块一起使用

其他使用 IP 地址的模块（例如 socket）通常不会直接接受来自该模块的对象。 相反，它们必须被强制转换为其他模块将接受的整数或字符串：

>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> str(addr4)
'192.0.2.1'
>>> int(addr4)
3221225985

Copy

实例创建失败时获取更多详细信息

使用与版本无关的工厂函数创建地址/网络/接口对象时，任何错误都将报告为 ValueError 并带有一般错误消息，仅说明传入的值未被识别为该类型的对象. 缺少特定错误是因为有必要知道值是 supposed 是 IPv4 还是 IPv6，以便提供有关拒绝的原因的更多详细信息。

为了支持访问此附加细节有用的用例，各个类构造函数实际上引发了 ValueError 子类 ipaddress.AddressValueError 和 ipaddress.NetmaskValueError准确指出定义的哪一部分未能正确解析。

直接使用类构造函数时，错误消息要详细得多。 例如：

>>> ipaddress.ip_address("192.168.0.256")
Traceback (most recent call last):
  ...
ValueError: '192.168.0.256' does not appear to be an IPv4 or IPv6 address
>>> ipaddress.IPv4Address("192.168.0.256")
Traceback (most recent call last):
  ...
ipaddress.AddressValueError: Octet 256 (> 255) not permitted in '192.168.0.256'

>>> ipaddress.ip_network("192.168.0.1/64")
Traceback (most recent call last):
  ...
ValueError: '192.168.0.1/64' does not appear to be an IPv4 or IPv6 network
>>> ipaddress.IPv4Network("192.168.0.1/64")
Traceback (most recent call last):
  ...
ipaddress.NetmaskValueError: '64' is not a valid netmask

Copy

但是，这两个特定于模块的异常都将 ValueError 作为它们的父类，因此如果您不关心特定类型的错误，您仍然可以编写如下代码：

try:
    network = ipaddress.IPv4Network(address)
except ValueError:
    print('address/netmask is invalid for IPv4:', address)

Copy