Документация Python неофициальный перевод

ipaddress.md

769 строк · 51.6 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.8/library/ipaddress.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`ipaddress`](https://python-all.ru/3.8/library/ipaddress.html#module-ipaddress) – библиотека для работы с IPv4/IPv689**Исходный код:** [Lib/ipaddress.py](https://python-all.ru/src/3.8/Lib/ipaddress.py)1011---1213[`ipaddress`](https://python-all.ru/3.8/library/ipaddress.html#module-ipaddress) предоставляет возможности для создания, изменения и работы с IPv4- и IPv6-адресами и сетями.1415Функции и классы этого модуля упрощают выполнение различных задач, связанных с IP-адресами: проверку, находятся ли два хоста в одной подсети; перебор всех хостов в заданной подсети; проверку, является ли строка корректным IP-адресом или определением сети, и так далее.1617Это полная справочная информация по модулю API. Обзор и введение см. в [Введение в модуль ipaddress](https://python-all.ru/3.8/howto/ipaddress.html#ipaddress-howto).1819Новое в версии 3.3.2021## Удобные фабричные функции2223Модуль [`ipaddress`](https://python-all.ru/3.8/library/ipaddress.html#module-ipaddress) предоставляет фабричные функции для удобного создания IP-адресов, сетей и интерфейсов:2425#### `ipaddress.ip_address(address)`2627Возвращает объект [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address) или [`IPv6Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Address) в зависимости от IP-адреса, переданного в качестве аргумента. Можно передавать как IPv4-, так и IPv6-адреса; целые числа меньше 2\*\*32 по умолчанию считаются IPv4. Исключение [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) возбуждается, если *address* не является корректным IPv4- или IPv6-адресом.2829```python30>>> ipaddress.ip_address('192.168.0.1')31IPv4Address('192.168.0.1')32>>> ipaddress.ip_address('2001:db8::')33IPv6Address('2001:db8::')34```3536#### `ipaddress.ip_network(address, strict=True)`3738Возвращает объект [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network) или [`IPv6Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Network) в зависимости от IP-адреса, переданного в качестве аргумента. *address* – это строка или целое число, представляющее IP-сеть. Можно передавать как IPv4-, так и IPv6-сети; целые числа меньше 2\*\*32 по умолчанию считаются IPv4. Параметр *strict* передаётся конструктору [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network) или [`IPv6Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Network). Исключение [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) возбуждается, если *address* не является корректным IPv4- или IPv6-адресом, или если в сети установлены биты узла.3940```python41>>> ipaddress.ip_network('192.168.0.0/28')42IPv4Network('192.168.0.0/28')43```4445#### `ipaddress.ip_interface(address)`4647Возвращает объект [`IPv4Interface`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Interface) или [`IPv6Interface`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Interface) в зависимости от IP-адреса, переданного в качестве аргумента. *address* – это строка или целое число, представляющее IP-адрес. Можно передавать как IPv4-, так и IPv6-адреса; целые числа меньше 2\*\*32 по умолчанию считаются IPv4. Исключение [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) возбуждается, если *address* не является корректным IPv4- или IPv6-адресом.4849Недостаток этих удобных функций в том, что необходимость поддержки обоих форматов – IPv4 и IPv6 – приводит к тому, что сообщения об ошибках содержат минимум информации о точной ошибке, поскольку функции не знают, какой формат предполагался. Более подробные сообщения об ошибках можно получить, напрямую вызывая соответствующие версии конструкторов классов.5051## IP-адреса5253### Объекты адресов5455Объекты [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address) и [`IPv6Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Address) имеют много общих атрибутов. Некоторые атрибуты, имеющие смысл только для IPv6-адресов, также реализованы в объектах [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address), чтобы упростить написание кода, корректно работающего с обеими версиями IP. Объекты адресов являются [хешируемыми](https://python-all.ru/3.8/glossary.html#term-hashable), поэтому их можно использовать в качестве ключей словаря.5657#### `class ipaddress.IPv4Address(address)`5859Создаёт IPv4-адрес. Если *address* не является корректным IPv4-адресом, возбуждается [`AddressValueError`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.AddressValueError).6061Корректным IPv4-адресом считается следующее:62631. Строка в десятично-точечной нотации, состоящая из четырёх десятичных целых чисел в диапазоне от 0 до 255 включительно, разделённых точками (например, `192.168.0.1`). Каждое целое число представляет октет (байт) адреса. Начальные нули не допускаются, чтобы избежать путаницы с восьмеричной записью.642. Целое число, помещающееся в 32 бита.653. Целое число, упакованное в объект [`bytes`](https://python-all.ru/3.8/library/stdtypes.html#bytes) длиной 4 (сначала старший октет).6667```python68>>> ipaddress.IPv4Address('192.168.0.1')69IPv4Address('192.168.0.1')70>>> ipaddress.IPv4Address(3232235521)71IPv4Address('192.168.0.1')72>>> ipaddress.IPv4Address(b'\xC0\xA8\x00\x01')73IPv4Address('192.168.0.1')74```7576Изменено в версии 3.8: Начальные нули теперь допускаются, даже в неоднозначных случаях, похожих на восьмеричную запись.7778Изменено в версии 3.8.12: Начальные нули больше не допускаются и считаются ошибкой. Строки IPv4-адресов теперь анализируются так же строго, как в glibc [`inet_pton()`](https://python-all.ru/3.8/library/socket.html#socket.inet_pton).7980#### `version`8182Соответствующий номер версии: `4` для IPv4, `6` для IPv6.8384#### `max_prefixlen`8586Общее количество бит в представлении адреса для данной версии: `32` для IPv4, `128` для IPv6.8788Префикс определяет количество старших бит в адресе, которые сравниваются, чтобы определить, принадлежит ли адрес сети.8990#### `compressed`9192#### `exploded`9394Строковое представление в десятичной записи с точками. Начальные нули никогда не включаются в представление.9596Поскольку IPv4 не определяет сокращённой записи для адресов, в которых октеты равны нулю, эти два атрибута всегда совпадают с `str(addr)` для IPv4-адресов. Наличие этих атрибутов упрощает написание кода отображения, способного работать как с IPv4-, так и с IPv6-адресами.9798#### `packed`99100Двоичное представление этого адреса – объект [`bytes`](https://python-all.ru/3.8/library/stdtypes.html#bytes) соответствующей длины (сначала старший октет). Это 4 байта для IPv4 и 16 байт для IPv6.101102#### `reverse_pointer`103104Имя обратной PTR-записи DNS для IP-адреса, например:105106```python107>>> ipaddress.ip_address("127.0.0.1").reverse_pointer108'1.0.0.127.in-addr.arpa'109>>> ipaddress.ip_address("2001:db8::1").reverse_pointer110'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'111```112113Это имя, которое можно использовать для выполнения PTR-запроса, а не разрешённое имя узла.114115Новое в версии 3.5.116117#### `is_multicast`118119`True`, если адрес зарезервирован для многоадресной рассылки. См. [**RFC 3171**](https://python-all.ru/3.8/library/ipaddress.html) (для IPv4) или [**RFC 2373**](https://python-all.ru/3.8/library/ipaddress.html) (для IPv6).120121#### `is_private`122123`True`, если адрес определён как глобально недостижимый согласно [iana-ipv4-special-registry](https://python-all.ru/3.8/library/ipaddress.html) (для IPv4) или [iana-ipv6-special-registry](https://python-all.ru/3.8/library/ipaddress.html) (для IPv6), за следующими исключениями:124125- `is_private` равно `False` для общего адресного пространства (`100.64.0.0/10`)126- Для IPv4-отображённых IPv6-адресов значение `is_private` определяется семантикой базовых IPv4-адресов, и выполняется следующее условие (см. [`IPv6Address.ipv4_mapped`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Address.ipv4_mapped)):127128  ```python129  address.is_private == address.ipv4_mapped.is_private130  ```131132`is_private` имеет значение, противоположное [`is_global`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address.is_global), за исключением общего адресного пространства (диапазон `100.64.0.0/10`), где оба равны `False`.133134Изменено в версии 3.8.20: Исправлены некоторые ложные срабатывания и пропуски.135136- `192.0.0.0/24` считается частным, за исключением `192.0.0.9/32` и `192.0.0.10/32` (ранее: только поддиапазон `192.0.0.0/29` считался частным).137- `64:ff9b:1::/48` считается частным.138- `2002::/16` считается частным.139- Внутри `2001::/23` (в остальном считающегося частным) есть исключения: `2001:1::1/128`, `2001:1::2/128`, `2001:3::/32`, `2001:4:112::/48`, `2001:20::/28`, `2001:30::/28`. Исключения не считаются частными.140141#### `is_global`142143`True`, если адрес определён как глобально достижимый согласно [iana-ipv4-special-registry](https://python-all.ru/3.8/library/ipaddress.html) (для IPv4) или [iana-ipv6-special-registry](https://python-all.ru/3.8/library/ipaddress.html) (для IPv6), за следующим исключением:144145Для IPv4-отображённых IPv6-адресов значение `is_private` определяется семантикой базовых IPv4-адресов, и выполняется следующее условие (см. [`IPv6Address.ipv4_mapped`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Address.ipv4_mapped)):146147```python148address.is_global == address.ipv4_mapped.is_global149```150151`is_global` имеет значение, противоположное [`is_private`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address.is_private), за исключением общего адресного пространства (диапазон `100.64.0.0/10`), где оба равны `False`.152153Новое в версии 3.4.154155Изменено в версии 3.8.20: Исправлены некоторые ложные срабатывания и пропуски; подробнее см. [`is_private`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address.is_private).156157#### `is_unspecified`158159`True`, если адрес не определён. См. [**RFC 5735**](https://python-all.ru/3.8/library/ipaddress.html) (для IPv4) или [**RFC 2373**](https://python-all.ru/3.8/library/ipaddress.html) (для IPv6).160161#### `is_reserved`162163`True` если адрес зарезервирован IETF.164165#### `is_loopback`166167`True`, если это адрес loopback. См. [**RFC 3330**](https://python-all.ru/3.8/library/ipaddress.html) (для IPv4) или [**RFC 2373**](https://python-all.ru/3.8/library/ipaddress.html) (для IPv6).168169#### `is_link_local`170171`True`, если адрес зарезервирован для использования в link-local. См. [**RFC 3927**](https://python-all.ru/3.8/library/ipaddress.html).172173#### `class ipaddress.IPv6Address(address)`174175Создаёт IPv6-адрес. [`AddressValueError`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.AddressValueError) возникает, если *address* не является допустимым IPv6-адресом.176177Допустимый IPv6-адрес образуется следующим образом:1781791. Строка из восьми групп по четыре шестнадцатеричных цифры, каждая группа представляет 16 бит. Группы разделяются двоеточиями. Это описывает *развёрнутую* (полную) запись. Строка также может быть *сжата* (краткая запись) различными способами. Подробнее см. [**RFC 4291**](https://python-all.ru/3.8/library/ipaddress.html). Например, `"0000:0000:0000:0000:0000:0abc:0007:0def"` можно сжать до `"::abc:7:def"`.1802. Целое число, помещающееся в 128 бит.1813. Целое число, упакованное в объект [`bytes`](https://python-all.ru/3.8/library/stdtypes.html#bytes) длиной 16, big-endian.182183```python184>>> ipaddress.IPv6Address('2001:db8::1000')185IPv6Address('2001:db8::1000')186```187188#### `compressed`189190Краткая форма представления адреса, в которой опущены ведущие нули в группах, а самая длинная последовательность групп, состоящих полностью из нулей, сжата в одну пустую группу.191192Это также значение, возвращаемое `str(addr)` для IPv6-адресов.193194#### `exploded`195196Полная форма представления адреса, включающая все ведущие нули и группы, состоящие полностью из нулей.197198Для следующих атрибутов обратитесь к соответствующей документации класса [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address):199200#### `packed`201202#### `reverse_pointer`203204#### `version`205206#### `max_prefixlen`207208#### `is_multicast`209210#### `is_private`211212#### `is_global`213214#### `is_unspecified`215216#### `is_reserved`217218#### `is_loopback`219220#### `is_link_local`221222Новое в версии 3.4: is\_global223224#### `is_site_local`225226`True` если адрес зарезервирован для использования в локальной сети (site-local). Обратите внимание, что пространство адресов site-local признано устаревшим согласно [**RFC 3879**](https://python-all.ru/3.8/library/ipaddress.html). Используйте [`is_private`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address.is_private) для проверки, принадлежит ли этот адрес пространству уникальных локальных адресов, определённому в [**RFC 4193**](https://python-all.ru/3.8/library/ipaddress.html).227228#### `ipv4_mapped`229230Для адресов, которые выглядят как IPv4-mapped адреса (начинающихся с `::FFFF/96`), это свойство возвращает встроенный IPv4-адрес. Для всех остальных адресов это свойство будет `None`.231232#### `sixtofour`233234Для адресов, которые выглядят как адреса 6to4 (начинающиеся с `2002::/16`), определённые в [**RFC 3056**](https://python-all.ru/3.8/library/ipaddress.html), это свойство возвращает встроенный IPv4-адрес. Для любого другого адреса это свойство будет `None`.235236#### `teredo`237238Для адресов, которые выглядят как адреса Teredo (начинающиеся с `2001::/32`), определённые в [**RFC 4380**](https://python-all.ru/3.8/library/ipaddress.html), это свойство возвращает встроенную пару `(server, client)` IP-адресов. Для любого другого адреса это свойство будет `None`.239240### Преобразование в строки и целые числа241242Для взаимодействия с сетевыми интерфейсами, такими как модуль socket, адреса должны быть преобразованы в строки или целые числа. Это делается с помощью встроенных функций [`str()`](https://python-all.ru/3.8/library/stdtypes.html#str) и [`int()`](https://python-all.ru/3.8/library/functions.html#int):243244```python245>>> str(ipaddress.IPv4Address('192.168.0.1'))246'192.168.0.1'247>>> int(ipaddress.IPv4Address('192.168.0.1'))2483232235521249>>> str(ipaddress.IPv6Address('::1'))250'::1'251>>> int(ipaddress.IPv6Address('::1'))2521253```254255### Операторы256257Объекты адресов поддерживают некоторые операторы. Если не указано иное, операторы могут применяться только между совместимыми объектами (т.е. IPv4 с IPv4, IPv6 с IPv6).258259#### Операторы сравнения260261Объекты адресов можно сравнивать с помощью обычных операторов сравнения. Несколько примеров:262263```python264>>> IPv4Address('127.0.0.2') > IPv4Address('127.0.0.1')265True266>>> IPv4Address('127.0.0.2') == IPv4Address('127.0.0.1')267False268>>> IPv4Address('127.0.0.2') != IPv4Address('127.0.0.1')269True270```271272#### Арифметические операторы273274Целые числа можно прибавлять к объектам адресов или вычитать из них. Несколько примеров:275276```python277>>> IPv4Address('127.0.0.2') + 3278IPv4Address('127.0.0.5')279>>> IPv4Address('127.0.0.2') - 3280IPv4Address('126.255.255.255')281>>> IPv4Address('255.255.255.255') + 1282Traceback (most recent call last):283  File "<stdin>", line 1, in <module>284ipaddress.AddressValueError: 4294967296 (>= 2**32) is not permitted as an IPv4 address285```286287## Определения IP-сетей288289Объекты [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network) и [`IPv6Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Network) предоставляют механизм для определения и изучения определений IP-сетей. Определение сети состоит из *маски* и *сетевого адреса* и, таким образом, определяет диапазон IP-адресов, которые равны сетевому адресу при наложении маски (побитовое И) с маской. Например, определение сети с маской `255.255.255.0` и сетевым адресом `192.168.1.0` включает IP-адреса в диапазоне от `192.168.1.0` до `192.168.1.255` включительно.290291### Префикс, маска сети и маска хоста292293Существует несколько эквивалентных способов указания масок IP-сетей. *Префикс* `/<nbits>` – это обозначение, показывающее, сколько старших битов установлено в маске сети. *Маска сети* – это IP-адрес, в котором установлено некоторое количество старших битов. Таким образом, префикс `/24` эквивалентен маске сети `255.255.255.0` в IPv4 или `ffff:ff00::` в IPv6. Кроме того, *маска хоста* является логическим отрицанием *маски сети* и иногда используется (например, в списках управления доступом Cisco) для обозначения маски сети. Маска хоста, эквивалентная `/24` в IPv4, – это `0.0.0.255`.294295### Объекты сетей296297Все атрибуты, реализованные объектами адресов, также реализованы объектами сетей. Кроме того, объекты сетей реализуют дополнительные атрибуты. Все они являются общими для [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network) и [`IPv6Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Network), поэтому во избежание дублирования они задокументированы только для [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network). Объекты сетей являются [хешируемыми](https://python-all.ru/3.8/glossary.html#term-hashable), поэтому их можно использовать в качестве ключей в словарях.298299#### `class ipaddress.IPv4Network(address, strict=True)`300301Создаёт определение IPv4-сети. *адрес* может быть одним из следующих:3023031. Строка, состоящая из IP-адреса и необязательной маски, разделённых косой чертой (`/`). IP-адрес является сетевым адресом, а маска может быть либо числом, что означает *префикс*, либо строковым представлением IPv4-адреса. Если маска указана в виде строки, она интерпретируется как *маска сети*, если начинается с ненулевого поля, или как *маска хоста*, если начинается с нулевого поля, за единственным исключением: все нулевая маска обрабатывается как *маска сети*. Если маска не указана, считается равной `/32`.304305   Например, следующие спецификации *адрес* эквивалентны: `192.168.1.0/24`, `192.168.1.0/255.255.255.0` и `192.168.1.0/0.0.0.255`.3062. Целое число, помещающееся в 32 бита. Оно эквивалентно сети с одним адресом, где адресом сети является *address*, а маской – `/32`.3073. Целое число, упакованное в объект [`bytes`](https://python-all.ru/3.8/library/stdtypes.html#bytes) длиной 4 байта, с порядком от старшего к младшему. Интерпретация аналогична целочисленному *адресу*.3084. Кортеж из двух элементов: описание адреса и маска сети, где описание адреса может быть строкой, 32-битным целым числом, упакованным 4-байтовым целым или существующим объектом IPv4Address; а маска сети – либо целым числом, представляющим длину префикса (например, `24`), либо строкой, представляющей маску префикса (например, `255.255.255.0`).309310Исключение [`AddressValueError`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.AddressValueError) возбуждается, если *адрес* не является допустимым IPv4-адресом. Исключение [`NetmaskValueError`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.NetmaskValueError) возбуждается, если маска недопустима для IPv4-адреса.311312Если *strict* равен `True` и в предоставленном адресе установлены биты хоста, вызывается [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError). В противном случае биты хоста маскируются для определения соответствующего сетевого адреса.313314Если не указано иное, все методы сетей, принимающие другие объекты сетей/адресов, возбуждают [`TypeError`](https://python-all.ru/3.8/library/exceptions.html#TypeError), если версия IP аргумента несовместима с `self`.315316Изменено в версии 3.5: Добавлена двухэлементная форма для параметра конструктора *address*.317318#### `version`319320#### `max_prefixlen`321322Обратитесь к соответствующей документации атрибутов в [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address).323324#### `is_multicast`325326#### `is_private`327328#### `is_unspecified`329330#### `is_reserved`331332#### `is_loopback`333334#### `is_link_local`335336Эти атрибуты истинны для всей сети, если они истинны как для сетевого адреса, так и для широковещательного адреса.337338#### `network_address`339340Сетевой адрес для этой сети. Сетевой адрес и длина префикса вместе однозначно определяют сеть.341342#### `broadcast_address`343344Широковещательный адрес для этой сети. Пакеты, отправленные на широковещательный адрес, должны быть получены каждым хостом в сети.345346#### `hostmask`347348Маска хоста в виде объекта [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address).349350#### `netmask`351352Маска сети в виде объекта [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address).353354#### `with_prefixlen`355356#### `compressed`357358#### `exploded`359360Строковое представление сети с маской в префиксной нотации.361362`with_prefixlen` и `compressed` всегда совпадают с `str(network)`. `exploded` использует развёрнутую форму сетевого адреса.363364#### `with_netmask`365366Строковое представление сети с маской в нотации маски сети.367368#### `with_hostmask`369370Строковое представление сети с маской в нотации хостовой маски.371372#### `num_addresses`373374Общее количество адресов в сети.375376#### `prefixlen`377378Длина префикса сети в битах.379380#### `hosts()`381382Возвращает итератор по доступным хостам в сети. Доступные хосты – это все IP-адреса, принадлежащие сети, кроме самого сетевого адреса и широковещательного адреса сети. Для сетей с длиной маски 31 сетевой адрес и широковещательный адрес также включаются в результат. Сети с маской 32 вернут список, содержащий единственный адрес хоста.383384```python385>>> list(ip_network('192.0.2.0/29').hosts())  386[IPv4Address('192.0.2.1'), IPv4Address('192.0.2.2'),387 IPv4Address('192.0.2.3'), IPv4Address('192.0.2.4'),388 IPv4Address('192.0.2.5'), IPv4Address('192.0.2.6')]389>>> list(ip_network('192.0.2.0/31').hosts())390[IPv4Address('192.0.2.0'), IPv4Address('192.0.2.1')]391>>> list(ip_network('192.0.2.1/32').hosts())392[IPv4Address('192.0.2.1')]393```394395#### `overlaps(other)`396397`True`, если данная сеть частично или полностью содержится в *другом* или *другой* полностью содержится в данной сети.398399#### `address_exclude(network)`400401Вычисляет определения сети, получающиеся при удалении указанной *сети* из данной. Возвращает итератор объектов сети. Вызывает [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError), если *сеть* не полностью содержится в данной сети.402403```python404>>> n1 = ip_network('192.0.2.0/28')405>>> n2 = ip_network('192.0.2.1/32')406>>> list(n1.address_exclude(n2))  407[IPv4Network('192.0.2.8/29'), IPv4Network('192.0.2.4/30'),408 IPv4Network('192.0.2.2/31'), IPv4Network('192.0.2.0/32')]409```410411#### `subnets(prefixlen_diff=1, new_prefix=None)`412413Подсети, объединение которых образует текущее определение сети, в зависимости от значений аргументов. *prefixlen\_diff* – это величина, на которую должна быть увеличена длина нашего префикса. *new\_prefix* – это желаемый новый префикс подсетей; он должен быть больше нашего префикса. Должен быть задан ровно один из *prefixlen\_diff* и *new\_prefix*. Возвращает итератор объектов сети.414415```python416>>> list(ip_network('192.0.2.0/24').subnets())417[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]418>>> list(ip_network('192.0.2.0/24').subnets(prefixlen_diff=2))  419[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),420 IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]421>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=26))  422[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),423 IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]424>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=23))425Traceback (most recent call last):426  File "<stdin>", line 1, in <module>427    raise ValueError('new prefix must be longer')428ValueError: new prefix must be longer429>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=25))430[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]431```432433#### `supernet(prefixlen_diff=1, new_prefix=None)`434435Суперсеть, содержащая данное определение сети, в зависимости от значений аргументов. *prefixlen\_diff* – это величина, на которую должна быть уменьшена длина нашего префикса. *new\_prefix* – это желаемый новый префикс суперсети; он должен быть меньше нашего префикса. Должен быть задан ровно один из *prefixlen\_diff* и *new\_prefix*. Возвращает один объект сети.436437```python438>>> ip_network('192.0.2.0/24').supernet()439IPv4Network('192.0.2.0/23')440>>> ip_network('192.0.2.0/24').supernet(prefixlen_diff=2)441IPv4Network('192.0.0.0/22')442>>> ip_network('192.0.2.0/24').supernet(new_prefix=20)443IPv4Network('192.0.0.0/20')444```445446#### `subnet_of(other)`447448Возвращает `True`, если данная сеть является подсетью *другого*.449450```python451>>> a = ip_network('192.168.1.0/24')452>>> b = ip_network('192.168.1.128/30')453>>> b.subnet_of(a)454True455```456457Добавлено в версии 3.7.458459#### `supernet_of(other)`460461Возвращает `True`, если данная сеть является суперсетью *другого*.462463```python464>>> a = ip_network('192.168.1.0/24')465>>> b = ip_network('192.168.1.128/30')466>>> a.supernet_of(b)467True468```469470Добавлено в версии 3.7.471472#### `compare_networks(other)`473474Сравнивает данную сеть с *другим*. При таком сравнении учитываются только сетевые адреса; биты хоста не учитываются. Возвращает `-1`, `0` или `1`.475476```python477>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.2/32'))478-1479>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.0/32'))4801481>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.1/32'))4820483```484485Устарело с версии 3.7: Использует тот же алгоритм упорядочивания и сравнения, что и “\<”, “==”, и “\>”486487#### `class ipaddress.IPv6Network(address, strict=True)`488489Создаёт определение IPv6-сети. *адрес* может быть одним из следующих:4904911. Строка, состоящая из IP-адреса и необязательной длины префикса, разделённых косой чертой (`/`). IP-адрес является сетевым адресом, а длина префикса должна быть одним числом – *префикс*. Если длина префикса не указана, считается равной `/128`.492493   Обратите внимание, что развёрнутые маски сети в настоящее время не поддерживаются. Это означает, что `2001:db00::0/24` является допустимым аргументом, а `2001:db00::0/ffff:ff00::` – нет.4942. Целое число, помещающееся в 128 бит. Это эквивалентно сети с одним адресом, где сетевым адресом является *адрес*, а маской – `/128`.4953. Целое число, упакованное в объект [`bytes`](https://python-all.ru/3.8/library/stdtypes.html#bytes) длиной 16 байт, порядок байтов от старшего к младшему. Интерпретация аналогична целому числу *адрес*.4964. Двухэлементный кортеж из описания адреса и маски подсети, где описание адреса может быть строкой, 128-битным целым числом, 16-байтовым упакованным целым числом или существующим объектом IPv6Address; а маска подсети – это целое число, представляющее длину префикса.497498[`AddressValueError`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.AddressValueError) вызывается, если *адрес* не является допустимым IPv6-адресом. [`NetmaskValueError`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.NetmaskValueError) вызывается, если маска недопустима для IPv6-адреса.499500Если *strict* равен `True` и в предоставленном адресе установлены биты хоста, вызывается [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError). В противном случае биты хоста маскируются для определения соответствующего сетевого адреса.501502Изменено в версии 3.5: Добавлена двухэлементная форма для параметра конструктора *address*.503504#### `version`505506#### `max_prefixlen`507508#### `is_multicast`509510#### `is_private`511512#### `is_unspecified`513514#### `is_reserved`515516#### `is_loopback`517518#### `is_link_local`519520#### `network_address`521522#### `broadcast_address`523524#### `hostmask`525526#### `netmask`527528#### `with_prefixlen`529530#### `compressed`531532#### `exploded`533534#### `with_netmask`535536#### `with_hostmask`537538#### `num_addresses`539540#### `prefixlen`541542#### `hosts()`543544Возвращает итератор по используемым хостам в сети. Используемые хосты – это все IP-адреса, принадлежащие сети, за исключением anycast-адреса подсети-маршрутизатора. Для сетей с длиной маски 127 anycast-адрес подсети-маршрутизатора также включается в результат. Сети с маской 128 вернут список, содержащий единственный адрес хоста.545546#### `overlaps(other)`547548#### `address_exclude(network)`549550#### `subnets(prefixlen_diff=1, new_prefix=None)`551552#### `supernet(prefixlen_diff=1, new_prefix=None)`553554#### `subnet_of(other)`555556#### `supernet_of(other)`557558#### `compare_networks(other)`559560Обратитесь к соответствующей документации атрибутов в [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network).561562#### `is_site_local`563564Этот атрибут истинен для сети в целом, если он истинен как для адреса сети, так и для широковещательного адреса.565566### Операторы567568Сетевые объекты поддерживают некоторые операторы. Если не указано иное, операторы можно применять только между совместимыми объектами (например, IPv4 с IPv4, IPv6 с IPv6).569570#### Логические операторы571572Сетевые объекты можно сравнивать с помощью обычного набора логических операторов. Сетевые объекты упорядочиваются сначала по сетевому адресу, затем по маске сети.573574#### Перебор575576Сетевые объекты можно перебирать для получения списка всех адресов, принадлежащих сети. При переборе возвращаются *все* хосты, включая непригодные для использования (для пригодных хостов используйте метод [`hosts()`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network.hosts)). Пример:577578```python579>>> for addr in IPv4Network('192.0.2.0/28'):580...     addr581...582IPv4Address('192.0.2.0')583IPv4Address('192.0.2.1')584IPv4Address('192.0.2.2')585IPv4Address('192.0.2.3')586IPv4Address('192.0.2.4')587IPv4Address('192.0.2.5')588IPv4Address('192.0.2.6')589IPv4Address('192.0.2.7')590IPv4Address('192.0.2.8')591IPv4Address('192.0.2.9')592IPv4Address('192.0.2.10')593IPv4Address('192.0.2.11')594IPv4Address('192.0.2.12')595IPv4Address('192.0.2.13')596IPv4Address('192.0.2.14')597IPv4Address('192.0.2.15')598```599600#### Сети как контейнеры адресов601602Сетевые объекты могут выступать в качестве контейнеров адресов. Несколько примеров:603604```python605>>> IPv4Network('192.0.2.0/28')[0]606IPv4Address('192.0.2.0')607>>> IPv4Network('192.0.2.0/28')[15]608IPv4Address('192.0.2.15')609>>> IPv4Address('192.0.2.6') in IPv4Network('192.0.2.0/28')610True611>>> IPv4Address('192.0.3.6') in IPv4Network('192.0.2.0/28')612False613```614615## Объекты интерфейсов616617Объекты интерфейсов [хешируемы](https://python-all.ru/3.8/glossary.html#term-hashable), поэтому их можно использовать в качестве ключей в словарях.618619#### `class ipaddress.IPv4Interface(address)`620621Создаёт интерфейс IPv4. Значение *address* такое же, как в конструкторе [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network), за исключением того, что произвольные адреса хостов всегда принимаются.622623[`IPv4Interface`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Interface) является подклассом [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address), поэтому наследует все атрибуты этого класса. Кроме того, доступны следующие атрибуты:624625#### `ip`626627Адрес ([`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address)) без информации о сети.628629```python630>>> interface = IPv4Interface('192.0.2.5/24')631>>> interface.ip632IPv4Address('192.0.2.5')633```634635#### `network`636637Сеть ([`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network)), к которой принадлежит данный интерфейс.638639```python640>>> interface = IPv4Interface('192.0.2.5/24')641>>> interface.network642IPv4Network('192.0.2.0/24')643```644645#### `with_prefixlen`646647Строковое представление интерфейса с маской в префиксной нотации.648649```python650>>> interface = IPv4Interface('192.0.2.5/24')651>>> interface.with_prefixlen652'192.0.2.5/24'653```654655#### `with_netmask`656657Строковое представление интерфейса, где сеть указана в виде маски сети.658659```python660>>> interface = IPv4Interface('192.0.2.5/24')661>>> interface.with_netmask662'192.0.2.5/255.255.255.0'663```664665#### `with_hostmask`666667Строковое представление интерфейса, где сеть указана в виде маски хоста.668669```python670>>> interface = IPv4Interface('192.0.2.5/24')671>>> interface.with_hostmask672'192.0.2.5/0.0.0.255'673```674675#### `class ipaddress.IPv6Interface(address)`676677Создаёт интерфейс IPv6. Значение *address* такое же, как в конструкторе [`IPv6Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Network), за исключением того, что произвольные адреса хостов всегда принимаются.678679[`IPv6Interface`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Interface) является подклассом [`IPv6Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Address), поэтому наследует все атрибуты этого класса. Кроме того, доступны следующие атрибуты:680681#### `ip`682683#### `network`684685#### `with_prefixlen`686687#### `with_netmask`688689#### `with_hostmask`690691Обратитесь к соответствующей документации атрибутов в [`IPv4Interface`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Interface).692693### Операторы694695Объекты интерфейса поддерживают некоторые операторы. Если не указано иное, операторы можно применять только между совместимыми объектами (т.е. IPv4 с IPv4, IPv6 с IPv6).696697#### Логические операторы698699Объекты интерфейса можно сравнивать с помощью обычного набора логических операторов.700701Для сравнения на равенство (`==` и `!=`) и IP-адрес, и сеть должны совпадать, чтобы объекты были равны. Интерфейс не будет равен ни одному адресу или сетевому объекту.702703Для упорядочивания (`<`, `>` и т.д.) действуют другие правила. Интерфейсные объекты и объекты адресов одной версии IP можно сравнивать, при этом объекты адресов всегда будут сортироваться перед интерфейсными объектами. Два интерфейсных объекта сначала сравниваются по своим сетям, а если они одинаковы, то по своим IP-адресам.704705## Другие функции уровня модуля706707Модуль также предоставляет следующие функции уровня модуля:708709#### `ipaddress.v4_int_to_packed(address)`710711Представляет адрес в виде 4 упакованных байт в сетевом порядке (big-endian). *address* – это целочисленное представление IPv4-адреса. Исключение [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) возбуждается, если целое отрицательно или слишком велико для IPv4-адреса.712713```python714>>> ipaddress.ip_address(3221225985)715IPv4Address('192.0.2.1')716>>> ipaddress.v4_int_to_packed(3221225985)717b'\xc0\x00\x02\x01'718```719720#### `ipaddress.v6_int_to_packed(address)`721722Представляет адрес в виде 16 упакованных байт в сетевом порядке (big-endian). *address* – это целочисленное представление IPv6-адреса. Исключение [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) возбуждается, если целое отрицательно или слишком велико для IPv6-адреса.723724#### `ipaddress.summarize_address_range(first, last)`725726Возвращает итератор суммарного диапазона сети, заданного первым и последним IP-адресами. *first* – это первый [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address) или [`IPv6Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Address) в диапазоне, а *last* – это последний [`IPv4Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Address) или [`IPv6Address`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Address) в диапазоне. Исключение [`TypeError`](https://python-all.ru/3.8/library/exceptions.html#TypeError) возбуждается, если *first* или *last* не являются IP-адресами или имеют разные версии. Исключение [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) возбуждается, если *last* не больше *first*, или если версия адреса *first* не равна 4 или 6.727728```python729>>> [ipaddr for ipaddr in ipaddress.summarize_address_range(730...    ipaddress.IPv4Address('192.0.2.0'),731...    ipaddress.IPv4Address('192.0.2.130'))]732[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'), IPv4Network('192.0.2.130/32')]733```734735#### `ipaddress.collapse_addresses(addresses)`736737Возвращает итератор по свернутым [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network) или [`IPv6Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Network) объектам. *addresses* – это итератор из [`IPv4Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv4Network) или [`IPv6Network`](https://python-all.ru/3.8/library/ipaddress.html#ipaddress.IPv6Network) объектов. Исключение [`TypeError`](https://python-all.ru/3.8/library/exceptions.html#TypeError) возбуждается, если *addresses* содержит объекты разных версий.738739```python740>>> [ipaddr for ipaddr in741... ipaddress.collapse_addresses([ipaddress.IPv4Network('192.0.2.0/25'),742... ipaddress.IPv4Network('192.0.2.128/25')])]743[IPv4Network('192.0.2.0/24')]744```745746#### `ipaddress.get_mixed_type_key(obj)`747748Возвращает ключ, подходящий для сортировки сетей и адресов. Объекты Address и Network по умолчанию не сортируются; они принципиально разные, поэтому выражение:749750```python751IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')752```753754не имеет смысла. Однако иногда может потребоваться, чтобы [`ipaddress`](https://python-all.ru/3.8/library/ipaddress.html#module-ipaddress) всё же сортировал их. Если это необходимо, можно использовать эту функцию в качестве аргумента *key* для [`sorted()`](https://python-all.ru/3.8/library/functions.html#sorted).755756*obj* – это объект сети или адреса.757758## Пользовательские исключения759760Для поддержки более конкретных сообщений об ошибках от конструкторов классов модуль определяет следующие исключения:761762#### `exception ipaddress.AddressValueError(ValueError)`763764Любая ошибка значения, связанная с адресом.765766#### `exception ipaddress.NetmaskValueError(ValueError)`767768Любая ошибка значения, связанная с маской сети.769