Skip to content
A Python Module for CIDR Lookups
C++ C Python CMake Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmake @ 1dd6a7b Updating submodule(s). Sep 4, 2019
testing Update for a directory name change May 24, 2019
.gitignore Updated setup.py to work with setuptools (pypi). Apr 1, 2014
.gitmodules Update submodules to use github.com/zeek Dec 6, 2018
.travis.yml Drop use of Python 2.6 for Travis CI tests Aug 1, 2019
.update-changes.cfg Fixing version number in setup.cfg. Oct 14, 2013
CHANGES Updating CHANGES and VERSION. Aug 8, 2019
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 Check for twine existence in `make upload` Apr 12, 2019
README Updating CHANGES and VERSION. Aug 8, 2019
README.rst Merge branch 'docs_changes' of https://github.com/dsalisbury/pysubnet… Mar 23, 2015
SubnetTree.cc Merge branch 'seg_bad_mask' of https://github.com/sbentov/pysubnettree Mar 22, 2019
SubnetTree.h GH-14: Fix segfault in lookup operations with Python3 Apr 12, 2019
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 Updating CHANGES and VERSION. Aug 8, 2019
btest Merge remote-tracking branch 'origin/fastpath' Jul 5, 2012
configure Fix python3 compatibility of ./configure script Mar 22, 2019
patricia.c Fix some issues reported by coverity Mar 23, 2018
patricia.h Apply patch from ticket #750 Mar 29, 2012
setup.py Updating CHANGES and VERSION. Aug 8, 2019

README.rst

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.


Download

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.31. See the CHANGES file for version history.

Example

A simple example which associates CIDR prefixes with strings:

>>> import SubnetTree
>>> t = SubnetTree.SubnetTree()
>>> t["10.1.0.0/16"] = "Network 1"
>>> t["10.1.42.0/24"] = "Network 1, Subnet 42"
>>> print("10.1.42.1" in t)
True
>>> print(t["10.1.42.1"])
Network 1, Subnet 42
>>> print(t["10.1.43.1"])
Network 1
>>> print("10.20.1.1" in t)
False
>>> try:
...     print(t["10.20.1.1"])
... except KeyError as err:
...     print("Error: %s not found" % err)
Error: '10.20.1.1' 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()
False
>>> t.set_binary_lookup_mode(True)
>>> t.get_binary_lookup_mode()
True
>>> import socket
>>> print(t[socket.inet_aton("10.1.42.1")])
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.

Prerequisites

This package requires Python 2.6 or newer.

Installation

Installation is pretty simple:

> python setup.py install
You can’t perform that action at this time.