Skip to main content

Cidrize parses IPv4/IPv6 addresses, CIDRs, ranges, and wildcard matches & attempts to return a valid list of IP addresses

Project description

Cidrize

IP address parsing for humans.

Cidrize takes IP address inputs that people tend to use in practice, validates them, and converts them to objects.

Intelligently parses IPv4/IPv6 addresses, CIDRs, ranges, and wildcard matches to attempt return a valid list of IP addresses.

The cidrize() function does all the work trying to parse IP addresses correctly.

Installation

You can install cidrize via Pip:

pip install cidrize

Dependencies

Cidrize is basically a thin veneer around netaddr to provide a human layer for parsing IP addresses.

Usage

Supported input formats

Input is very flexible and can be of any of the following formats:

192.0.2.18
192.0.20.64/26
192.0.2.80-192.0.2.85
192.0.2.170-175
192.0.2.8[0-5]
192.0.2.[5678]

Hyphenated ranges do not need to form a CIDR block but the starting number must be of lower value than the end. The netaddr module does most of the heavy lifting for us here.

Unsupported formats

Network mask (e.g. 192.0.2.0 255.255.255.0) and host mask (aka reverse mask, 192.0.2.0 0.0.0.255) notation are not accepted at this time.

The cidrize function returns a list of consolidated netaddr.IPNetwork objects. By default parsing exceptions will raise a CidrizeError (with default argument of raise_errors=True). You may pass raise_errors=False to cause exceptions to be stripped and the error text will be returned as a list. This is intended for use with scripts or APIs where receiving exceptions would not be preferred.

The module may also be run as a script for debugging purposes.

The cidrize function

Fire up your trusty old Python interpreter and follow along!

>>> from cidrize import cidrize

Old-fashioned CIDR

>>> cidrize("1.2.3.4")
[IPNetwork('1.2.3.4/32')]

Hyphenated range (default, strict=False)

>>> cidrize("2.4.6.8-2.4.6.80")
[IPNetwork('2.4.6.0/25')]

Hyphenated range strict (strict=True)

>>> cidrize("2.4.6.8-2.4.6.80", strict=True)
[IPNetwork('2.4.6.8/29'), IPNetwork('2.4.6.16/28'),
IPNetwork('2.4.6.32/27'), IPNetwork('2.4.6.64/28'),
IPNetwork('2.4.6.80/32')]

Wildcard

You may provide wildcards using asterisks. This is limited to the 4th and final octet only:

>>> cidrize("15.63.148.*")
[IPNetwork('15.63.148.0/24')]

Bracketed range

>>> cidrize("21.43.180.1[40-99]")
[IPNetwork('21.43.180.140/30'), IPNetwork('21.43.180.144/28'),
IPNetwork('21.43.180.160/27'), IPNetwork('21.43.180.192/29')]

Bad!

Bad CIDR prefixes are rejected outright:

>>> cidrize("1.2.3.38/40")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "cidrize.py", line 145, in cidrize
    raise CidrizeError(err)
cidrize.CidrizeError: CIDR prefix /40 out of range for IPv4!

Wack range?!

Ranges must always start from lower to upper bound, or this happens:

>>> cidrize("1.2.3.4-0")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "cidrize.py", line 145, in cidrize
    raise CidrizeError(err)
cidrize.CidrizeError: lower bound IP greater than upper bound!

Cidr Tool

The cidrize package also comes with the cidr command, which has two basic operations.

Simple output:

% cidr 1.2.3.4/30
1.2.3.4/30

Verbose output:

% cidr -v 1.2.3.4/30
Spanning CIDR:          1.2.3.4/30
Block Start/Network:    1.2.3.4
1st host:               1.2.3.5
Gateway:                1.2.3.6
Block End/Broadcast:    1.2.3.7
DQ Mask:                255.255.255.252
Cisco ACL Mask:         0.0.0.3
# of hosts:             2
Explicit CIDR blocks:   1.2.3.4/30

And that’s that!

License

Cidrize is licensed under the BSD 3-Clause License. Please see LICENSE.rst for the details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cidrize-2.1.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

cidrize-2.1.0-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file cidrize-2.1.0.tar.gz.

File metadata

  • Download URL: cidrize-2.1.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.3 Darwin/22.3.0

File hashes

Hashes for cidrize-2.1.0.tar.gz
Algorithm Hash digest
SHA256 37ac7940d3851a0791291591ebc8a71cfb7cc7b3980436dbf83ea76308750f9f
MD5 48e0a15b94dd3fd760d51bd8ab3c7b2b
BLAKE2b-256 02171df5ec056021dd98ddbbcf7a26f04310e332fd2a24cbed4397685bdb32c7

See more details on using hashes here.

File details

Details for the file cidrize-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: cidrize-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.3 Darwin/22.3.0

File hashes

Hashes for cidrize-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d80dee5d4344446e14408727ce4ac287fa21dfe142d4ab9eb0e76435da84a591
MD5 6c57dbbccba9d13bdda3d05105d0d9d7
BLAKE2b-256 af7f06f2a14c69b17692f852856e56b08f6fc694332bb3175cdbafcff0a7020a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page