Google's IP Address Manipulation Library

Warnings

• breaking The `ipaddr` library has been officially superseded by the `ipaddress` module, which is included in the Python 3 standard library. The PyPI package for `ipaddr` is primarily a backport for Python 2. Users on Python 3 should migrate to `ipaddress` for future compatibility and maintenance.
  Fix: Migrate your codebase from `ipaddr` to the built-in `ipaddress` module. The API is largely similar but has some differences (e.g., stricter network object creation, renamed factory functions). Refer to PEP 3144 for a detailed comparison of API changes: https://peps.python.org/pep-3144/
• gotcha When creating `IPNetwork` objects with `ipaddr`, the library is more lenient about host bits being set compared to the `ipaddress` module. In `ipaddress`, creating a network object like `ipaddress.ip_network('192.168.1.5/24')` would raise a `ValueError` because the host bits are set. `ipaddr` might implicitly correct this or allow it depending on the version and specific method.
  Fix: Always ensure the host portion of a network address is zero when defining a network, e.g., '192.168.1.0/24'. If migrating to `ipaddress`, be aware that `ipaddress`'s `*Network` classes default to `strict=True`, requiring canonical network addresses. For interface objects (address on a network), use `ipaddr.IPNetwork('192.168.1.5/24', strict=False)` or `ipaddress.ip_interface('192.168.1.5/24')` in `ipaddress`.
• deprecated The `ipaddr.IPAddress()` and `ipaddr.IPNetwork()` factory functions had equivalent, but slightly different, behavior and naming conventions compared to the `ipaddress.ip_address()` and `ipaddress.ip_network()` factory functions in the standard library.
  Fix: When migrating to the `ipaddress` module, use `ipaddress.ip_address()` for addresses and `ipaddress.ip_network()` for networks. These factory functions automatically determine the IP version (IPv4 or IPv6) and return the appropriate object.

Install

• pip install ipaddr Install latest version

Imports

• IPAddress

  from ipaddr import IPAddress

  IPAddress is a class, import directly or use ipaddr.IPAddress() after importing the module.
• IPNetwork

  from ipaddr import IPNetwork

  IPNetwork is a class, import directly or use ipaddr.IPNetwork() after importing the module.

Quickstart

This quickstart demonstrates how to create IP address and network objects using the `ipaddr` library, check their properties, and perform basic network membership tests.

import ipaddr

# Create an IPv4 address object
ip_v4 = ipaddr.IPAddress('192.168.1.1')
print(f"IPv4 Address: {ip_v4}")
print(f"Is private: {ip_v4.is_private}")

# Create an IPv6 address object
ip_v6 = ipaddr.IPAddress('2001:db8::1')
print(f"IPv6 Address: {ip_v6}")

# Create a network object
network = ipaddr.IPNetwork('192.168.1.0/24')
print(f"Network: {network}")
print(f"Network address: {network.network}")
print(f"Broadcast address: {network.broadcast}")
print(f"Number of hosts: {network.numhosts}")

# Check if an address is in a network
print(f"192.168.1.5 in network: {ipaddr.IPAddress('192.168.1.5') in network}")