A Python Module for CIDR Lookups
Branch: master
Clone or download
Latest commit 447dc14 Jan 17, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmake @ 6135c1a Updating submodule(s). Jan 16, 2019
testing Cleanup tests for the prefixes() function Oct 4, 2016
.gitignore Updated setup.py to work with setuptools (pypi). Apr 1, 2014
.travis.yml Configure Travis CI email recipients and build branches Feb 22, 2018
.update-changes.cfg Fixing version number in setup.cfg. Oct 14, 2013
CHANGES Update github/download link Dec 7, 2018
CMakeLists.txt Fix deprecation warning for swig_add_module Aug 6, 2018
COPYING Updating copyright notice. Oct 8, 2013
MANIFEST.in Update MANIFEST.in May 30, 2014
Makefile Add dist target to Makefile. May 8, 2015
README.rst Merge branch 'docs_changes' of https://github.com/dsalisbury/pysubnet… Mar 23, 2015
SubnetTree.h Added prefixes() method to return all prefixes in the tree as a set of Jan 23, 2016
SubnetTree.i Initial import Nov 4, 2010
SubnetTree.py Merge branch 'topic/jroyalty/prefixset' of https://github.com/jroyalt… Jan 25, 2016
SubnetTree_wrap.cc Merge branch 'topic/jroyalty/prefixset' of https://github.com/jroyalt… Jan 25, 2016
VERSION Update github/download link Dec 7, 2018
btest Merge remote-tracking branch 'origin/fastpath' Jul 5, 2012
configure Fix configure script to exit with non-zero status on error Aug 1, 2012
patricia.c Fix some issues reported by coverity Mar 23, 2018
setup.py Update github/download link Dec 7, 2018


PySubnetTree - A Python Module for CIDR Lookups

.. rst-class:: opening

    The PySubnetTree package provides a Python data structure
    ``SubnetTree`` which maps subnets given in `CIDR
    <http://tools.ietf.org/html/rfc4632>`_ notation (incl.
    corresponding IPv6 versions) to Python objects. Lookups are
    performed by longest-prefix matching.


You can find the latest PySubnetTree release for download at https://www.zeek.org/download.

PySubnetTree's git repository is located at https://github.com/zeek/pysubnettree

This document describes PySubnetTree 0.28-2. See the CHANGES file for version history.


A simple example which associates CIDR prefixes with strings:

>>> import SubnetTree
>>> t = SubnetTree.SubnetTree()
>>> t[""] = "Network 1"
>>> t[""] = "Network 1, Subnet 42"
>>> print("" in t)
>>> print(t[""])
Network 1, Subnet 42
>>> print(t[""])
Network 1
>>> print("" in t)
>>> try:
...     print(t[""])
... except KeyError as err:
...     print("Error: %s not found" % err)
Error: '' not found

PySubnetTree also supports IPv6 addresses and prefixes:

>>> import SubnetTree
>>> t = SubnetTree.SubnetTree()
>>> t["2001:db8::/32"] = "Company 1"
>>> t["2001:db8:4000::/48"] = "Company 1, Site 1"
>>> t["2001:db8:4000:abcd::"]
Company 1, Site 1
>>> t["2001:db8:fe:1234::"]
Company 1

By default, CIDR prefixes and IP addresses are given as strings. Alternatively, a SubnetTree object can be switched into binary mode, in which single addresses are passed in the form of packed binary strings as, e.g., returned by socket.inet_aton:

>>> t.get_binary_lookup_mode()
>>> t.set_binary_lookup_mode(True)
>>> t.get_binary_lookup_mode()
>>> import socket
>>> print(t[socket.inet_aton("")])
Network 1, Subnet 42

A SubnetTree also provides methods insert(prefix,object=None) for insertion of prefixes (object can be skipped to use the tree like a set), and remove(prefix) for removing entries (remove performs an _exact_ match rather than longest-prefix).

Internally, the CIDR prefixes of a SubnetTree are managed by a Patricia tree data structure and lookups are therefore efficient even with a large number of prefixes.

PySubnetTree comes with a BSD license.


This package requires Python 2.6 or newer.


Installation is pretty simple:

> python setup.py install