ipaddress — Bibliothèque de manipulation IPv4/IPv6

Code source : Lib/ipaddress.py


ipaddress propose des fonctionnalités pour créer, manipuler et opérer sur des réseaux et adresses IPv4 et IPv6.

Les fonctions et les classes dans ce module facilitent la gestion de différentes tâches reliée aux adresses IP, incluant vérifier si deux hôtes sont sur le même sous-réseau, itérer sur tous les hôtes d'un sous-réseau particulier, vérifier si une chaîne représente bien une adresse IP ou une définition de réseau valide, et ainsi de suite.

Ceci est la référence complète de l'API du module, pour un aperçu et introduction, voir Introduction au module ipaddress.

Nouveau dans la version 3.3.

Fonctions fabriques pratiques

Le module ipaddress propose des fonctions fabriques pour facilement créer des adresses IP, réseaux et interfaces :

ipaddress.ip_address(address)

Return an IPv4Address or IPv6Address object depending on the IP address passed as argument. Either IPv4 or IPv6 addresses may be supplied; integers less than 2**32 will be considered to be IPv4 by default. A ValueError is raised if address does not represent a valid IPv4 or IPv6 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)

Return an IPv4Network or IPv6Network object depending on the IP address passed as argument. address is a string or integer representing the IP network. Either IPv4 or IPv6 networks may be supplied; integers less than 2**32 will be considered to be IPv4 by default. strict is passed to IPv4Network or IPv6Network constructor. A ValueError is raised if address does not represent a valid IPv4 or IPv6 address, or if the network has host bits set.

>>> ipaddress.ip_network('192.168.0.0/28')
IPv4Network('192.168.0.0/28')
ipaddress.ip_interface(address)

Return an IPv4Interface or IPv6Interface object depending on the IP address passed as argument. address is a string or integer representing the IP address. Either IPv4 or IPv6 addresses may be supplied; integers less than 2**32 will be considered to be IPv4 by default. A ValueError is raised if address does not represent a valid IPv4 or IPv6 address.

Un inconvénient de ces fonctions pratiques est que le besoin de gérer à la fois IPv4 et IPv6 signifie que les messages d'erreur contiennent peu d'information sur l'erreur précise puisqu'elles ne peuvent pas deviner quel format entre IPv4 et IPv6 est voulu. Un compte-rendu d'erreur plus détaillé peut être obtenu en appelant directement le constructeur de classe pour la version voulue.

Adresses IP

Objets adresse

Les objets IPv4Address et IPv6Address ont beaucoup d'attributs en commun. Certains attributs qui n'ont du sens que pour des adresses IPv6 sont aussi implémentés par les objets IPv4Address pour faciliter l'écriture de code qui gère les 2 versions IP correctement. Les objets d'adresse sont hachables pour qu'ils puissent être utilisés comme des clés dans des dictionnaires.

class ipaddress.IPv4Address(address)

Construit une adresse IPv4. Une exception AddressValueError est levée si address n'est pas une adresse IPv4 valide.

Une adresse IPv4 valide est composée de :

  1. Une chaîne en notation décimale par points, composée de quatre entiers décimaux dans la plage inclusive 0—255, séparés par des points (p. ex. 192.168.0.1). Chaque entier représente un octet dans l'adresse. Les zéros en tête ne sont pas tolérés pour éviter toute confusion avec la notation octale.

  2. Un entier qui tient dans 32 bits.

  3. Un entier tassé dans un objet bytes de taille 4 (gros-boutiste).

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

Modifié dans la version 3.8: Les zéros en tête sont tolérés, même dans les cas ambigus qui ont l'apparence de notation octal.

Modifié dans la version 3.10: Les zéros en tête ne sont plus tolérés et seront traités comme une erreur. Les chaînes d'adresses IPv4 sont maintenant analysées aussi strictement que dans dans la fonction glibc inet_pton().

Modifié dans la version 3.9.5: Le changement ci-dessus est aussi inclus dans Python 3.9 à partir de la version 3.9.5.

Modifié dans la version 3.8.12: The above change was also included in Python 3.8 starting with version 3.8.12.

version

Numéro de version approprié : 4 pour IPv4, 6 pour IPv6.

max_prefixlen

Nombre total de bits dans la représentation d'adresse de cette version : 32 pour IPv4, 128 pour IPv6.

Le préfixe définit le nombre de bits en tête dans une adresse qui sont comparés pour déterminer si une adresse fait partie d'un réseau.

compressed
exploded

Une chaîne en notation décimale par points. Les zéros en tête ne sont jamais inclus dans la représentation.

Comme IPv4 ne définit pas une notation abrégée pour les adresses avec des octets définis à zéro, ces deux attributs sont toujours identiques à str(addr) pour les adresses IPv4. Exposer ces attributs rend plus simple l'écriture de code d'affichage qui peut gérer à la fois les adresses IPv4 et IPv6.

packed

La représentation binaire de cette adresse — un objet bytes avec une taille appropriée (gros-boutiste). La taille est de 4 octets pour IPv4 et 16 octets pour IPv6.

reverse_pointer

Nom de l'enregistrement DNS PTR inverse pour l'adresse IP, p. ex :

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

C'est le nom utilisé pour effectuer une recherche inverse PTR et non le nom de l'hôte résolu lui-même.

Nouveau dans la version 3.5.

is_multicast

True si l'adresse est réservée pour utilisation multicast. Voir RFC 3171 (pour IPv4) or RFC 2373 (pour IPv6).

is_private

True si l'adresse est allouée à des réseaux privés. Voir iana-ipv4-special-registry (pour IPv4) ou iana-ipv6-special-registry (pour IPv6).

is_global

True si l'adresse est allouée à des réseaux publics. Voir iana-ipv4-special-registry (pour IPv4) or iana-ipv6-special-registry (pour IPv6).

Nouveau dans la version 3.4.

is_unspecified

True si l'adresse est non-spécifiée. Voir RFC 5735 (pour IPv4) or RFC 2373 (pour IPv6).

is_reserved

True si l'adresse est réservée par l'IETF.

is_loopback

True si c'est une adresse de rebouclage (loopback en anglais). Voir RFC 3330 (pour IPv4) or RFC 2373 (pour IPv6).

True si l'adresse est réservée pour les liaisons locales auto-configurées. Voir RFC 3927.

ipv6_mapped

IPv4Address object representing the IPv4-mapped IPv6 address. See RFC 4291.

Nouveau dans la version 3.13.

IPv4Address.__format__(fmt)

Renvoie l'adresse IP sous forme d'une chaîne, contrôlée par une chaîne de formatage explicite. fmt peut être : 's', l'option par défaut, équivalent à str(), 'b' pour une chaîne binaire préfixée par des zéros, 'X' ou 'x' pour une représentation hexadécimale majuscule ou minuscule, ou 'n', équivalant à 'b' pour les adresses IPv4 et 'x' pour IPv6. Pour les représentations binaires et hexadécimales, le spécificateur de forme '#' et l'option de regroupement '_' sont disponibles. __format__ est utilisé par format, str.format et les f-strings.

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

Nouveau dans la version 3.9.

class ipaddress.IPv6Address(address)

Construit une adresse IPv6. Une AddressValueError est levée si address n'est pas une adresse IPv6 valide.

Une adresse IPv6 valide est constituée de :

  1. Une chaîne constituée de huit groupes de quatre chiffres hexadécimaux, chaque groupe représentant 16 bits. Les groupes sont séparés par des deux-points. Ceci décrit une notation éclatée (longue). La chaîne peut-être aussi abrégée (notation courte) par différents moyens. Voir RFC 4291 pour plus de détails. Par exemple, "0000:0000:0000:0000:0000:0abc:0007:0def" peut s'écrire "::abc:7:def".

    Optionnellement, la chaîne peut avoir un indice de zone de portée, exprimé avec un suffixe %scope_id. Si présent, l'indice de portée ne doit pas être vide et ne doit pas contenir %. Voir RFC 4007 pour plus de détails. Par exemple, fe80::1234%1 pourrait identifier fe80::1234 sur la première interface du nœud.

  2. Un entier qui tient dans 128 bits.

  3. Un entier tassé dans un objet bytes de taille 16, gros-boutiste.

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

Version courte de la représentation d'adresse, avec les groupes de zéros en tête omis et la séquence la plus longue de groupes constitués entièrement de zéros réduit à un seul groupe vide.

C'est aussi la valeur renvoyée par str(addr) pour les adresses IPv6.

exploded

Version longue de la représentation d'adresse, avec tous les zéros en tête et groupes composés entièrement de zéros inclus.

Pour les attributs et méthodes suivants, voir la documentation de la classe IPv4Address :

packed
reverse_pointer
version
max_prefixlen
is_multicast
is_private
is_global
is_unspecified
is_reserved
is_loopback

Nouveau dans la version 3.4: is_global

is_site_local

True si l'adresse est réservée pour usage sur réseau local. Notez que l'espace d'adressage sur réseau local a été rendu obsolète par RFC 3879. Utilisez is_private pour tester si l'adresse est dans l'espace d'adresses locales et uniques défini par RFC 4193.

ipv4_mapped

Pour les adresses qui semblent être des adresses mappées IPv4 (commençant par ::FFFF/96), cette propriété rapporte l'adresse IPv4 imbriquée. Pour toute autre adresse, cette propriété sera None.

scope_id

Pour les adresses avec une portée spécifiée comme définies par RFC 4007, cette propriété identifie la zone précise de la portée d'adresse à laquelle cette adresse appartient, en tant que chaîne. Quand la zone de portée n'est pas spécifiée, cette propriété est None.

sixtofour

Pour les adresses qui semblent être des adresses 6to4 (commençant par 2002::/16) tel que défini par RFC 3056, cette propriété rapporte l'adresse IPv4 imbriquée. Pour toute autre adresse, cette propriété sera None.

teredo

Pour les adresses qui semblent être des adresses Teredo (commençant par 2001::/32) tel que défini par RFC 4380, cette propriété rapporte la paire (server, client) imbriquée. Pour toute autre adresse, cette propriété sera None.

IPv6Address.__format__(fmt)

Référez-vous à la documentation de la méthode correspondante dans IPv4Address.

Nouveau dans la version 3.9.

Conversion vers les chaînes et les entiers

Afin d'interagir avec les API de réseau tels que le module socket, les adresses doivent être converties en chaînes et en entiers. Ceci est géré en utilisant les fonctions natives str() et 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.

Opérateurs

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

Opérateurs de comparaison

Address objects can be compared with the usual set of comparison operators. Same IPv6 addresses with different scope zone IDs are not equal. 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
>>> IPv6Address('fe80::1234') == IPv6Address('fe80::1234%1')
False
>>> IPv6Address('fe80::1234%1') != IPv6Address('fe80::1234%2')
True

Opérateurs arithmétiques

Les entiers peuvent être additionnés ou soustraits des objets d'adresse. Quelques exemples :

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

Définitions de réseaux IP

The IPv4Network and IPv6Network objects provide a mechanism for defining and inspecting IP network definitions. A network definition consists of a mask and a 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.

Préfixe, masque réseau et masque de l'hôte

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.

Objets réseau

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

class ipaddress.IPv4Network(address, strict=True)

Construit une définition de réseau IPv4. address peut valoir :

  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 is raised if address is not a valid IPv4 address. A NetmaskValueError is raised if the mask is not valid for an IPv4 address.

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

Modifié dans la version 3.5: Ajout de la forme paire pour le paramètre address du constructeur.

version
max_prefixlen

Référez-vous à la documentation de l'attribut correspondant dans IPv4Address.

is_multicast
is_private
is_unspecified
is_reserved
is_loopback

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

Le masque de l'hôte, en tant qu'objet IPv4Address.

netmask

Le masque réseau, en tant qu'objet IPv4Address.

with_prefixlen
compressed
exploded

Adresse IP du réseau sous forme d'une chaîne, avec le masque en notation CIDR.

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

Le nombre total d'adresses dans le réseau.

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 si ce réseau est partiellement ou complètement contenu dans other ou other est complètement contenu dans ce réseau.

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)

Renvoie True si ce réseau est un sous-réseau de other.

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

Nouveau dans la version 3.7.

supernet_of(other)

Renvoie True si other est un sous-réseau de ce réseau.

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

Nouveau dans la version 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

Obsolète depuis la version 3.7: Utilise le même algorithme de relation d'ordre et de comparaison que <, ==, et >.

class ipaddress.IPv6Network(address, strict=True)

Construit une définition de réseau IPv6. address peut valoir :

  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:: is 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 is raised if address is not a valid IPv6 address. A NetmaskValueError is raised if the mask is not valid for an IPv6 address.

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

Modifié dans la version 3.5: Ajout de la forme paire pour le paramètre address du constructeur.

version
max_prefixlen
is_multicast
is_private
is_unspecified
is_reserved
is_loopback
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)

Référez-vous à la documentation de l'attribut correspondant dans 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.

Opérateurs

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

Opérateurs logiques

Network objects can be compared with the usual set of logical operators. Network objects are ordered first by network address, then by net mask.

Itération

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

Réseaux en tant que conteneurs d'adresses

Les objets réseau peuvent agir en tant que conteneurs d'adresses. Quelques exemples :

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

Objets interface

Les objets interface sont hachables, ce qui signifie qu'ils peuvent être utilisés comme clés de dictionnaire.

class ipaddress.IPv4Interface(address)

Construct an IPv4 interface. The meaning of address is as in the constructor of IPv4Network, except that arbitrary host addresses are always accepted.

IPv4Interface is a subclass of IPv4Address, so it inherits all the attributes from that class. In addition, the following attributes are available:

ip

L'adresse (IPv4Address) sans information de réseau.

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.ip
IPv4Address('192.0.2.5')
network

Le réseau (IPv4Network) auquel cette interface appartient.

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.network
IPv4Network('192.0.2.0/24')
with_prefixlen

A string representation of the interface with the mask in prefix notation.

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_prefixlen
'192.0.2.5/24'
with_netmask

A string representation of the interface with the network as a net mask.

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_netmask
'192.0.2.5/255.255.255.0'
with_hostmask

A string representation of the interface with the network as a host mask.

>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_hostmask
'192.0.2.5/0.0.0.255'
class ipaddress.IPv6Interface(address)

Construct an IPv6 interface. The meaning of address is as in the constructor of IPv6Network, except that arbitrary host addresses are always accepted.

IPv6Interface is a subclass of IPv6Address, so it inherits all the attributes from that class. In addition, the following attributes are available:

ip
network
with_prefixlen
with_netmask
with_hostmask

Référez-vous à la documentation de l'attribut correspondant dans IPv4Interface.

Opérateurs

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

Opérateurs logiques

Interface objects can be compared with the usual set of logical operators.

For equality comparison (== and !=), both the IP address and network must be the same for the objects to be equal. An interface will not compare equal to any address or network object.

For ordering (<, >, etc) the rules are different. Interface and address objects with the same IP version can be compared, and the address objects will always sort before the interface objects. Two interface objects are first compared by their networks and, if those are the same, then by their IP addresses.

Autres fonctions au niveau de module

Le module fournit aussi les fonctions suivantes :

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)

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

ipaddress.summarize_address_range(first, last)

Return an iterator of the summarized network range given the first and last IP addresses. first is the first IPv4Address or IPv6Address in the range and last is the last IPv4Address or IPv6Address in the range. A TypeError is raised if first or last are not IP addresses or are not of the same version. A ValueError is raised if last is not greater than first or if first address version is not 4 or 6.

>>> [ipaddr for ipaddr in ipaddress.summarize_address_range(
...    ipaddress.IPv4Address('192.0.2.0'),
...    ipaddress.IPv4Address('192.0.2.130'))]
[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'), IPv4Network('192.0.2.130/32')]
ipaddress.collapse_addresses(addresses)

Return an iterator of the collapsed IPv4Network or IPv6Network objects. addresses is an iterator of IPv4Network or IPv6Network objects. A TypeError is raised if addresses contains mixed version objects.

>>> [ipaddr for ipaddr in
... ipaddress.collapse_addresses([ipaddress.IPv4Network('192.0.2.0/25'),
... ipaddress.IPv4Network('192.0.2.128/25')])]
[IPv4Network('192.0.2.0/24')]
ipaddress.get_mixed_type_key(obj)

Return a key suitable for sorting between networks and addresses. Address and Network objects are not sortable by default; they're fundamentally different, so the expression:

IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')

doesn't make sense. There are some times however, where you may wish to have ipaddress sort these anyway. If you need to do this, you can use this function as the key argument to sorted().

obj est un objet réseau ou adresse.

Exceptions personnalisées

To support more specific error reporting from class constructors, the module defines the following exceptions:

exception ipaddress.AddressValueError(ValueError)

Toute erreur de valeur liée à l'adresse.

exception ipaddress.NetmaskValueError(ValueError)

Toute erreur de valeur liée au masque réseau.