From 4cccfcdc49b1ea6b1693a49926464f25103b3844 Mon Sep 17 00:00:00 2001 From: "David P. D. Moss" Date: Wed, 21 Jan 2009 01:11:51 +0000 Subject: This checkin makes up release 0.6. See CHANGELOG for details. --- docs/api/api-objects.txt | 451 +- docs/api/class-tree.html | 124 +- docs/api/help.html | 2 +- docs/api/identifier-index.html | 785 ++- docs/api/module-tree.html | 15 +- docs/api/netaddr-module.html | 160 +- docs/api/netaddr-pysrc.html | 77 +- docs/api/netaddr.AddrConversionError-class.html | 5 +- docs/api/netaddr.AddrFormatError-class.html | 5 +- docs/api/netaddr.address-module.html | 105 +- docs/api/netaddr.address-pysrc.html | 6058 +++++++++++--------- docs/api/netaddr.address.Addr-class.html | 600 +- docs/api/netaddr.address.AddrRange-class.html | 1111 ---- .../netaddr.address.AddrTypeDescriptor-class.html | 2 +- .../netaddr.address.AddrValueDescriptor-class.html | 2 +- docs/api/netaddr.address.CIDR-class.html | 485 +- docs/api/netaddr.address.EUI-class.html | 197 +- .../netaddr.address.FormatDescriptor-class.html | 237 + docs/api/netaddr.address.IP-class.html | 559 +- docs/api/netaddr.address.IPRange-class.html | 1415 +++++ docs/api/netaddr.address.IPRangeSet-class.html | 500 ++ .../api/netaddr.address.KlassDescriptor-class.html | 237 - .../netaddr.address.PrefixLenDescriptor-class.html | 6 +- .../netaddr.address.StrategyDescriptor-class.html | 2 +- docs/api/netaddr.address.Wildcard-class.html | 134 +- docs/api/netaddr.core-module.html | 152 + docs/api/netaddr.core-pysrc.html | 203 + docs/api/netaddr.core.PrettyPrinter-class.html | 264 + docs/api/netaddr.core.Publisher-class.html | 274 + docs/api/netaddr.core.Subscriber-class.html | 189 + docs/api/netaddr.eui-module.html | 437 ++ docs/api/netaddr.eui-pysrc.html | 690 +++ docs/api/netaddr.eui.FileIndexer-class.html | 262 + docs/api/netaddr.eui.IAB-class.html | 599 ++ docs/api/netaddr.eui.IABIndexParser-class.html | 253 + docs/api/netaddr.eui.NotRegisteredError-class.html | 179 + docs/api/netaddr.eui.OUI-class.html | 600 ++ docs/api/netaddr.eui.OUIIndexParser-class.html | 253 + docs/api/netaddr.ip-module.html | 284 + docs/api/netaddr.ip-pysrc.html | 637 ++ docs/api/netaddr.ip.DictUpdater-class.html | 268 + docs/api/netaddr.ip.IPv4Parser-class.html | 277 + docs/api/netaddr.ip.IPv6Parser-class.html | 277 + docs/api/netaddr.ip.LineRecordParser-class.html | 292 + docs/api/netaddr.ip.MulticastParser-class.html | 296 + docs/api/netaddr.misc-module.html | 196 + docs/api/netaddr.misc-pysrc.html | 194 + docs/api/netaddr.strategy-module.html | 46 +- docs/api/netaddr.strategy-pysrc.html | 2052 +++---- docs/api/netaddr.strategy.AddrStrategy-class.html | 465 +- docs/api/netaddr.strategy.EUI48Strategy-class.html | 173 +- .../netaddr.strategy.IPv4StrategyOpt-class.html | 103 +- .../netaddr.strategy.IPv4StrategyStd-class.html | 42 +- docs/api/netaddr.strategy.IPv6Strategy-class.html | 42 +- docs/api/redirect.html | 2 +- docs/api/toc-everything.html | 18 +- docs/api/toc-netaddr-module.html | 15 +- docs/api/toc-netaddr.core-module.html | 28 + docs/api/toc-netaddr.eui-module.html | 30 + docs/api/toc-netaddr.ip-module.html | 38 + docs/api/toc-netaddr.misc-module.html | 32 + docs/api/toc.html | 4 +- 62 files changed, 17116 insertions(+), 6324 deletions(-) delete mode 100755 docs/api/netaddr.address.AddrRange-class.html create mode 100644 docs/api/netaddr.address.FormatDescriptor-class.html create mode 100644 docs/api/netaddr.address.IPRange-class.html create mode 100644 docs/api/netaddr.address.IPRangeSet-class.html delete mode 100644 docs/api/netaddr.address.KlassDescriptor-class.html create mode 100644 docs/api/netaddr.core-module.html create mode 100644 docs/api/netaddr.core-pysrc.html create mode 100644 docs/api/netaddr.core.PrettyPrinter-class.html create mode 100644 docs/api/netaddr.core.Publisher-class.html create mode 100644 docs/api/netaddr.core.Subscriber-class.html create mode 100644 docs/api/netaddr.eui-module.html create mode 100644 docs/api/netaddr.eui-pysrc.html create mode 100644 docs/api/netaddr.eui.FileIndexer-class.html create mode 100644 docs/api/netaddr.eui.IAB-class.html create mode 100644 docs/api/netaddr.eui.IABIndexParser-class.html create mode 100644 docs/api/netaddr.eui.NotRegisteredError-class.html create mode 100644 docs/api/netaddr.eui.OUI-class.html create mode 100644 docs/api/netaddr.eui.OUIIndexParser-class.html create mode 100644 docs/api/netaddr.ip-module.html create mode 100644 docs/api/netaddr.ip-pysrc.html create mode 100644 docs/api/netaddr.ip.DictUpdater-class.html create mode 100644 docs/api/netaddr.ip.IPv4Parser-class.html create mode 100644 docs/api/netaddr.ip.IPv6Parser-class.html create mode 100644 docs/api/netaddr.ip.LineRecordParser-class.html create mode 100644 docs/api/netaddr.ip.MulticastParser-class.html create mode 100644 docs/api/netaddr.misc-module.html create mode 100644 docs/api/netaddr.misc-pysrc.html create mode 100644 docs/api/toc-netaddr.core-module.html create mode 100644 docs/api/toc-netaddr.eui-module.html create mode 100644 docs/api/toc-netaddr.ip-module.html create mode 100644 docs/api/toc-netaddr.misc-module.html (limited to 'docs') diff --git a/docs/api/api-objects.txt b/docs/api/api-objects.txt index 86db877..010b040 100755 --- a/docs/api/api-objects.txt +++ b/docs/api/api-objects.txt @@ -14,67 +14,70 @@ netaddr.ST_EUI64 netaddr-module.html#ST_EUI64 netaddr.address netaddr.address-module.html netaddr.address.AT_STRATEGIES netaddr.address-module.html#AT_STRATEGIES netaddr.address.nrange netaddr.address-module.html#nrange +netaddr.core netaddr.core-module.html +netaddr.eui netaddr.eui-module.html +netaddr.eui.create_ieee_indices netaddr.eui-module.html#create_ieee_indices +netaddr.eui.IEEE_OUI_METADATA netaddr.eui-module.html#IEEE_OUI_METADATA +netaddr.eui.IEEE_IAB_REGISTRY netaddr.eui-module.html#IEEE_IAB_REGISTRY +netaddr.eui.IEEE_OUI_INDEX netaddr.eui-module.html#IEEE_OUI_INDEX +netaddr.eui.IEEE_OUI_REGISTRY netaddr.eui-module.html#IEEE_OUI_REGISTRY +netaddr.eui.IEEE_IAB_METADATA netaddr.eui-module.html#IEEE_IAB_METADATA +netaddr.eui.IEEE_IAB_INDEX netaddr.eui-module.html#IEEE_IAB_INDEX +netaddr.eui.load_ieee_indices netaddr.eui-module.html#load_ieee_indices +netaddr.ip netaddr.ip-module.html +netaddr.ip.IANA_INFO netaddr.ip-module.html#IANA_INFO +netaddr.ip.query netaddr.ip-module.html#query +netaddr.ip.load_iana_info netaddr.ip-module.html#load_iana_info +netaddr.misc netaddr.misc-module.html +netaddr.misc.ipv6_cidr_prefixes netaddr.misc-module.html#ipv6_cidr_prefixes +netaddr.misc.print_ipv6_cidr_prefixes netaddr.misc-module.html#print_ipv6_cidr_prefixes +netaddr.misc.ipv4_cidr_prefixes netaddr.misc-module.html#ipv4_cidr_prefixes +netaddr.misc.print_ipv4_cidr_prefixes netaddr.misc-module.html#print_ipv4_cidr_prefixes netaddr.strategy netaddr.strategy-module.html -netaddr.strategy.ST_EUI48 netaddr.strategy-module.html#ST_EUI48 netaddr.strategy.USE_IPV4_OPT netaddr.strategy-module.html#USE_IPV4_OPT -netaddr.strategy.ST_IPV4 netaddr.strategy-module.html#ST_IPV4 +netaddr.strategy.ST_EUI48 netaddr.strategy-module.html#ST_EUI48 netaddr.strategy._BYTES_TO_BITS netaddr.strategy-module.html#_BYTES_TO_BITS netaddr.strategy.ST_IPV6 netaddr.strategy-module.html#ST_IPV6 +netaddr.strategy.ST_IPV4 netaddr.strategy-module.html#ST_IPV4 netaddr.strategy.ST_EUI64 netaddr.strategy-module.html#ST_EUI64 netaddr.AddrConversionError netaddr.AddrConversionError-class.html netaddr.AddrFormatError netaddr.AddrFormatError-class.html netaddr.address.Addr netaddr.address.Addr-class.html netaddr.address.Addr.__int__ netaddr.address.Addr-class.html#__int__ netaddr.address.Addr.ADDR_TYPES netaddr.address.Addr-class.html#ADDR_TYPES -netaddr.address.Addr.__isub__ netaddr.address.Addr-class.html#__isub__ +netaddr.address.Addr.__ne__ netaddr.address.Addr-class.html#__ne__ netaddr.address.Addr.__str__ netaddr.address.Addr-class.html#__str__ netaddr.address.Addr.value netaddr.address.Addr-class.html#value +netaddr.address.Addr.__and__ netaddr.address.Addr-class.html#__and__ netaddr.address.Addr.__lt__ netaddr.address.Addr-class.html#__lt__ netaddr.address.Addr.__init__ netaddr.address.Addr-class.html#__init__ +netaddr.address.Addr.__sub__ netaddr.address.Addr-class.html#__sub__ +netaddr.address.Addr.__rshift__ netaddr.address.Addr-class.html#__rshift__ +netaddr.address.Addr.__invert__ netaddr.address.Addr-class.html#__invert__ netaddr.address.Addr.strategy netaddr.address.Addr-class.html#strategy +netaddr.address.Addr.packed netaddr.address.Addr-class.html#packed netaddr.address.Addr.bits netaddr.address.Addr-class.html#bits netaddr.address.Addr.addr_type netaddr.address.Addr-class.html#addr_type netaddr.address.Addr.__len__ netaddr.address.Addr-class.html#__len__ -netaddr.address.Addr.__ne__ netaddr.address.Addr-class.html#__ne__ +netaddr.address.Addr.bin netaddr.address.Addr-class.html#bin +netaddr.address.Addr.__isub__ netaddr.address.Addr-class.html#__isub__ +netaddr.address.Addr.__lshift__ netaddr.address.Addr-class.html#__lshift__ netaddr.address.Addr.__getitem__ netaddr.address.Addr-class.html#__getitem__ -netaddr.address.Addr.__iter__ netaddr.address.Addr-class.html#__iter__ +netaddr.address.Addr.__setitem__ netaddr.address.Addr-class.html#__setitem__ +netaddr.address.Addr.__or__ netaddr.address.Addr-class.html#__or__ +netaddr.address.Addr.__add__ netaddr.address.Addr-class.html#__add__ netaddr.address.Addr.__gt__ netaddr.address.Addr-class.html#__gt__ netaddr.address.Addr.__hex__ netaddr.address.Addr-class.html#__hex__ netaddr.address.Addr.__eq__ netaddr.address.Addr-class.html#__eq__ -netaddr.address.Addr.__setitem__ netaddr.address.Addr-class.html#__setitem__ +netaddr.address.Addr.__iter__ netaddr.address.Addr-class.html#__iter__ netaddr.address.Addr.__iadd__ netaddr.address.Addr-class.html#__iadd__ +netaddr.address.Addr.__xor__ netaddr.address.Addr-class.html#__xor__ netaddr.address.Addr.__le__ netaddr.address.Addr-class.html#__le__ netaddr.address.Addr.__repr__ netaddr.address.Addr-class.html#__repr__ netaddr.address.Addr.__hash__ netaddr.address.Addr-class.html#__hash__ netaddr.address.Addr.STRATEGIES netaddr.address.Addr-class.html#STRATEGIES netaddr.address.Addr.__long__ netaddr.address.Addr-class.html#__long__ netaddr.address.Addr.__ge__ netaddr.address.Addr-class.html#__ge__ -netaddr.address.AddrRange netaddr.address.AddrRange-class.html -netaddr.address.AddrRange.ADDR_TYPES netaddr.address.AddrRange-class.html#ADDR_TYPES -netaddr.address.AddrRange.__ne__ netaddr.address.AddrRange-class.html#__ne__ -netaddr.address.AddrRange.__str__ netaddr.address.AddrRange-class.html#__str__ -netaddr.address.AddrRange.data_flavour netaddr.address.AddrRange-class.html#data_flavour -netaddr.address.AddrRange.__lt__ netaddr.address.AddrRange-class.html#__lt__ -netaddr.address.AddrRange.__init__ netaddr.address.AddrRange-class.html#__init__ -netaddr.address.AddrRange.size netaddr.address.AddrRange-class.html#size -netaddr.address.AddrRange.__contains__ netaddr.address.AddrRange-class.html#__contains__ -netaddr.address.AddrRange.strategy netaddr.address.AddrRange-class.html#strategy -netaddr.address.AddrRange.addr_type netaddr.address.AddrRange-class.html#addr_type -netaddr.address.AddrRange.__len__ netaddr.address.AddrRange-class.html#__len__ -netaddr.address.AddrRange.klass netaddr.address.AddrRange-class.html#klass -netaddr.address.AddrRange.__isub__ netaddr.address.AddrRange-class.html#__isub__ -netaddr.address.AddrRange.__getitem__ netaddr.address.AddrRange-class.html#__getitem__ -netaddr.address.AddrRange.__iter__ netaddr.address.AddrRange-class.html#__iter__ -netaddr.address.AddrRange.__gt__ netaddr.address.AddrRange-class.html#__gt__ -netaddr.address.AddrRange.__eq__ netaddr.address.AddrRange-class.html#__eq__ -netaddr.address.AddrRange.last netaddr.address.AddrRange-class.html#last -netaddr.address.AddrRange.__iadd__ netaddr.address.AddrRange-class.html#__iadd__ -netaddr.address.AddrRange.__le__ netaddr.address.AddrRange-class.html#__le__ -netaddr.address.AddrRange.__repr__ netaddr.address.AddrRange-class.html#__repr__ -netaddr.address.AddrRange.__hash__ netaddr.address.AddrRange-class.html#__hash__ -netaddr.address.AddrRange.STRATEGIES netaddr.address.AddrRange-class.html#STRATEGIES -netaddr.address.AddrRange.__ge__ netaddr.address.AddrRange-class.html#__ge__ -netaddr.address.AddrRange.first netaddr.address.AddrRange-class.html#first netaddr.address.AddrTypeDescriptor netaddr.address.AddrTypeDescriptor-class.html netaddr.address.AddrTypeDescriptor.__set__ netaddr.address.AddrTypeDescriptor-class.html#__set__ netaddr.address.AddrTypeDescriptor.__init__ netaddr.address.AddrTypeDescriptor-class.html#__init__ @@ -84,106 +87,190 @@ netaddr.address.AddrValueDescriptor.__init__ netaddr.address.AddrValueDescriptor netaddr.address.CIDR netaddr.address.CIDR-class.html netaddr.address.CIDR.ADDR_TYPES netaddr.address.CIDR-class.html#ADDR_TYPES netaddr.address.CIDR.hostmask netaddr.address.CIDR-class.html#hostmask -netaddr.address.AddrRange.__isub__ netaddr.address.AddrRange-class.html#__isub__ +netaddr.address.IPRange.__ne__ netaddr.address.IPRange-class.html#__ne__ netaddr.address.CIDR.__str__ netaddr.address.CIDR-class.html#__str__ -netaddr.address.AddrRange.__gt__ netaddr.address.AddrRange-class.html#__gt__ -netaddr.address.AddrRange.data_flavour netaddr.address.AddrRange-class.html#data_flavour +netaddr.address.IPRange.__gt__ netaddr.address.IPRange-class.html#__gt__ netaddr.address.CIDR.prefixlen netaddr.address.CIDR-class.html#prefixlen -netaddr.address.AddrRange.__lt__ netaddr.address.AddrRange-class.html#__lt__ +netaddr.address.IPRange.__lt__ netaddr.address.IPRange-class.html#__lt__ +netaddr.address.IPRange.iprange netaddr.address.IPRange-class.html#iprange netaddr.address.CIDR.__init__ netaddr.address.CIDR-class.html#__init__ -netaddr.address.AddrRange.size netaddr.address.AddrRange-class.html#size -netaddr.address.AddrRange.__contains__ netaddr.address.AddrRange-class.html#__contains__ +netaddr.address.IPRange.size netaddr.address.IPRange-class.html#size +netaddr.address.CIDR.subnet netaddr.address.CIDR-class.html#subnet +netaddr.address.CIDR.span netaddr.address.CIDR-class.html#span +netaddr.address.CIDR.network netaddr.address.CIDR-class.html#network +netaddr.address.IPRange.__contains__ netaddr.address.IPRange-class.html#__contains__ +netaddr.address.IPRange.issupernet netaddr.address.IPRange-class.html#issupernet +netaddr.address.CIDR.fmt netaddr.address.CIDR-class.html#fmt netaddr.address.CIDR.strategy netaddr.address.CIDR-class.html#strategy +netaddr.address.IPRange.adjacent netaddr.address.IPRange-class.html#adjacent netaddr.address.CIDR.addr_type netaddr.address.CIDR-class.html#addr_type -netaddr.address.AddrRange.__len__ netaddr.address.AddrRange-class.html#__len__ -netaddr.address.CIDR.__repr__ netaddr.address.CIDR-class.html#__repr__ -netaddr.address.AddrRange.__ne__ netaddr.address.AddrRange-class.html#__ne__ -netaddr.address.AddrRange.__getitem__ netaddr.address.AddrRange-class.html#__getitem__ +netaddr.address.IPRange.__len__ netaddr.address.IPRange-class.html#__len__ +netaddr.address.IPRange.overlaps netaddr.address.IPRange-class.html#overlaps +netaddr.address.IPRange.__isub__ netaddr.address.IPRange-class.html#__isub__ +netaddr.address.IPRange.__getitem__ netaddr.address.IPRange-class.html#__getitem__ +netaddr.address.IPRange.format netaddr.address.IPRange-class.html#format +netaddr.address.CIDR.broadcast netaddr.address.CIDR-class.html#broadcast netaddr.address.CIDR.netmask netaddr.address.CIDR-class.html#netmask -netaddr.address.CIDR.STRATEGIES netaddr.address.CIDR-class.html#STRATEGIES -netaddr.address.AddrRange.__eq__ netaddr.address.AddrRange-class.html#__eq__ -netaddr.address.CIDR.abbrev_to_verbose netaddr.address.CIDR-class.html#abbrev_to_verbose -netaddr.address.AddrRange.last netaddr.address.AddrRange-class.html#last -netaddr.address.AddrRange.__iter__ netaddr.address.AddrRange-class.html#__iter__ -netaddr.address.AddrRange.__iadd__ netaddr.address.AddrRange-class.html#__iadd__ -netaddr.address.AddrRange.__le__ netaddr.address.AddrRange-class.html#__le__ -netaddr.address.CIDR.klass netaddr.address.CIDR-class.html#klass -netaddr.address.CIDR.wildcard netaddr.address.CIDR-class.html#wildcard -netaddr.address.AddrRange.__hash__ netaddr.address.AddrRange-class.html#__hash__ +netaddr.address.CIDR.__add__ netaddr.address.CIDR-class.html#__add__ netaddr.address.CIDR.__sub__ netaddr.address.CIDR-class.html#__sub__ -netaddr.address.AddrRange.__ge__ netaddr.address.AddrRange-class.html#__ge__ -netaddr.address.AddrRange.first netaddr.address.AddrRange-class.html#first +netaddr.address.IPRange.__eq__ netaddr.address.IPRange-class.html#__eq__ +netaddr.address.CIDR.abbrev_to_verbose netaddr.address.CIDR-class.html#abbrev_to_verbose +netaddr.address.IPRange.last netaddr.address.IPRange-class.html#last +netaddr.address.CIDR.cidrs netaddr.address.CIDR-class.html#cidrs +netaddr.address.IPRange.__iter__ netaddr.address.IPRange-class.html#__iter__ +netaddr.address.IPRange.__iadd__ netaddr.address.IPRange-class.html#__iadd__ +netaddr.address.IPRange.__le__ netaddr.address.IPRange-class.html#__le__ +netaddr.address.CIDR.__repr__ netaddr.address.CIDR-class.html#__repr__ +netaddr.address.IPRange.wildcard netaddr.address.IPRange-class.html#wildcard +netaddr.address.IPRange.issubnet netaddr.address.IPRange-class.html#issubnet +netaddr.address.IPRange.__hash__ netaddr.address.IPRange-class.html#__hash__ +netaddr.address.CIDR.STRATEGIES netaddr.address.CIDR-class.html#STRATEGIES +netaddr.address.IPRange.__ge__ netaddr.address.IPRange-class.html#__ge__ +netaddr.address.IPRange.first netaddr.address.IPRange-class.html#first netaddr.address.EUI netaddr.address.EUI-class.html netaddr.address.Addr.__int__ netaddr.address.Addr-class.html#__int__ netaddr.address.EUI.oui netaddr.address.EUI-class.html#oui netaddr.address.EUI.ei netaddr.address.EUI-class.html#ei netaddr.address.EUI.ADDR_TYPES netaddr.address.EUI-class.html#ADDR_TYPES -netaddr.address.Addr.__ne__ netaddr.address.Addr-class.html#__ne__ +netaddr.address.Addr.__isub__ netaddr.address.Addr-class.html#__isub__ netaddr.address.Addr.__str__ netaddr.address.Addr-class.html#__str__ +netaddr.address.Addr.__gt__ netaddr.address.Addr-class.html#__gt__ +netaddr.address.Addr.__getitem__ netaddr.address.Addr-class.html#__getitem__ netaddr.address.Addr.__iadd__ netaddr.address.Addr-class.html#__iadd__ +netaddr.address.Addr.__and__ netaddr.address.Addr-class.html#__and__ netaddr.address.Addr.__lt__ netaddr.address.Addr-class.html#__lt__ -netaddr.address.EUI.__init__ netaddr.address.EUI-class.html#__init__ +netaddr.address.EUI.iab netaddr.address.EUI-class.html#iab +netaddr.address.Addr.packed netaddr.address.Addr-class.html#packed +netaddr.address.Addr.__rshift__ netaddr.address.Addr-class.html#__rshift__ netaddr.address.EUI.ipv6_link_local netaddr.address.EUI-class.html#ipv6_link_local netaddr.address.EUI.strategy netaddr.address.EUI-class.html#strategy +netaddr.address.EUI.isiab netaddr.address.EUI-class.html#isiab +netaddr.address.EUI.__init__ netaddr.address.EUI-class.html#__init__ netaddr.address.Addr.bits netaddr.address.Addr-class.html#bits netaddr.address.EUI.addr_type netaddr.address.EUI-class.html#addr_type netaddr.address.Addr.__len__ netaddr.address.Addr-class.html#__len__ -netaddr.address.Addr.__isub__ netaddr.address.Addr-class.html#__isub__ -netaddr.address.Addr.__getitem__ netaddr.address.Addr-class.html#__getitem__ +netaddr.address.Addr.bin netaddr.address.Addr-class.html#bin +netaddr.address.Addr.__ne__ netaddr.address.Addr-class.html#__ne__ +netaddr.address.Addr.__invert__ netaddr.address.Addr-class.html#__invert__ +netaddr.address.Addr.__add__ netaddr.address.Addr-class.html#__add__ netaddr.address.Addr.__hash__ netaddr.address.Addr-class.html#__hash__ -netaddr.address.Addr.__iter__ netaddr.address.Addr-class.html#__iter__ -netaddr.address.Addr.__gt__ netaddr.address.Addr-class.html#__gt__ +netaddr.address.Addr.__setitem__ netaddr.address.Addr-class.html#__setitem__ +netaddr.address.Addr.__or__ netaddr.address.Addr-class.html#__or__ +netaddr.address.Addr.__lshift__ netaddr.address.Addr-class.html#__lshift__ +netaddr.address.EUI.STRATEGIES netaddr.address.EUI-class.html#STRATEGIES netaddr.address.Addr.__hex__ netaddr.address.Addr-class.html#__hex__ netaddr.address.Addr.__eq__ netaddr.address.Addr-class.html#__eq__ -netaddr.address.Addr.__setitem__ netaddr.address.Addr-class.html#__setitem__ +netaddr.address.EUI.info netaddr.address.EUI-class.html#info +netaddr.address.Addr.__iter__ netaddr.address.Addr-class.html#__iter__ netaddr.address.Addr.value netaddr.address.Addr-class.html#value +netaddr.address.Addr.__xor__ netaddr.address.Addr-class.html#__xor__ netaddr.address.Addr.__le__ netaddr.address.Addr-class.html#__le__ netaddr.address.Addr.__repr__ netaddr.address.Addr-class.html#__repr__ netaddr.address.EUI.eui64 netaddr.address.EUI-class.html#eui64 -netaddr.address.EUI.STRATEGIES netaddr.address.EUI-class.html#STRATEGIES +netaddr.address.Addr.__sub__ netaddr.address.Addr-class.html#__sub__ netaddr.address.Addr.__long__ netaddr.address.Addr-class.html#__long__ netaddr.address.Addr.__ge__ netaddr.address.Addr-class.html#__ge__ +netaddr.address.FormatDescriptor netaddr.address.FormatDescriptor-class.html +netaddr.address.FormatDescriptor.__set__ netaddr.address.FormatDescriptor-class.html#__set__ +netaddr.address.FormatDescriptor.__init__ netaddr.address.FormatDescriptor-class.html#__init__ netaddr.address.IP netaddr.address.IP-class.html netaddr.address.Addr.__int__ netaddr.address.Addr-class.html#__int__ +netaddr.address.Addr.packed netaddr.address.Addr-class.html#packed netaddr.address.IP.ADDR_TYPES netaddr.address.IP-class.html#ADDR_TYPES -netaddr.address.Addr.__ne__ netaddr.address.Addr-class.html#__ne__ +netaddr.address.Addr.__isub__ netaddr.address.Addr-class.html#__isub__ netaddr.address.IP.__str__ netaddr.address.IP-class.html#__str__ +netaddr.address.Addr.__gt__ netaddr.address.Addr-class.html#__gt__ +netaddr.address.Addr.__and__ netaddr.address.Addr-class.html#__and__ netaddr.address.IP.netmask_bits netaddr.address.IP-class.html#netmask_bits netaddr.address.Addr.__iadd__ netaddr.address.Addr-class.html#__iadd__ netaddr.address.IP.prefixlen netaddr.address.IP-class.html#prefixlen netaddr.address.Addr.__lt__ netaddr.address.Addr-class.html#__lt__ -netaddr.address.IP.__init__ netaddr.address.IP-class.html#__init__ +netaddr.address.IP.iprange netaddr.address.IP-class.html#iprange +netaddr.address.IP.is_ipv4_mapped netaddr.address.IP-class.html#is_ipv4_mapped +netaddr.address.Addr.__rshift__ netaddr.address.Addr-class.html#__rshift__ +netaddr.address.Addr.__getitem__ netaddr.address.Addr-class.html#__getitem__ netaddr.address.IP.hostname netaddr.address.IP-class.html#hostname +netaddr.address.Addr.__iter__ netaddr.address.Addr-class.html#__iter__ netaddr.address.IP.strategy netaddr.address.IP-class.html#strategy netaddr.address.IP.is_unicast netaddr.address.IP-class.html#is_unicast -netaddr.address.IP.ipv4 netaddr.address.IP-class.html#ipv4 +netaddr.address.IP.is_private netaddr.address.IP-class.html#is_private netaddr.address.IP.is_multicast netaddr.address.IP-class.html#is_multicast -netaddr.address.Addr.__setitem__ netaddr.address.Addr-class.html#__setitem__ +netaddr.address.IP.is_ipv4_compat netaddr.address.IP-class.html#is_ipv4_compat netaddr.address.IP.is_netmask netaddr.address.IP-class.html#is_netmask netaddr.address.Addr.bits netaddr.address.Addr-class.html#bits netaddr.address.IP.addr_type netaddr.address.IP-class.html#addr_type netaddr.address.Addr.__len__ netaddr.address.Addr-class.html#__len__ -netaddr.address.Addr.__isub__ netaddr.address.Addr-class.html#__isub__ -netaddr.address.Addr.__getitem__ netaddr.address.Addr-class.html#__getitem__ +netaddr.address.IP.ipv4 netaddr.address.IP-class.html#ipv4 +netaddr.address.Addr.bin netaddr.address.Addr-class.html#bin +netaddr.address.Addr.__ne__ netaddr.address.Addr-class.html#__ne__ +netaddr.address.IP.wildcard netaddr.address.IP-class.html#wildcard +netaddr.address.Addr.__invert__ netaddr.address.Addr-class.html#__invert__ +netaddr.address.Addr.__add__ netaddr.address.Addr-class.html#__add__ netaddr.address.IP.ipv6 netaddr.address.IP-class.html#ipv6 +netaddr.address.IP.is_link_local netaddr.address.IP-class.html#is_link_local netaddr.address.IP.is_hostmask netaddr.address.IP-class.html#is_hostmask -netaddr.address.Addr.__gt__ netaddr.address.Addr-class.html#__gt__ +netaddr.address.Addr.__or__ netaddr.address.Addr-class.html#__or__ +netaddr.address.Addr.__lshift__ netaddr.address.Addr-class.html#__lshift__ +netaddr.address.Addr.__sub__ netaddr.address.Addr-class.html#__sub__ netaddr.address.Addr.__hex__ netaddr.address.Addr-class.html#__hex__ netaddr.address.IP.cidr netaddr.address.IP-class.html#cidr netaddr.address.IP.TRANSLATE_STR netaddr.address.IP-class.html#TRANSLATE_STR netaddr.address.Addr.__eq__ netaddr.address.Addr-class.html#__eq__ -netaddr.address.Addr.__iter__ netaddr.address.Addr-class.html#__iter__ +netaddr.address.IP._ netaddr.address.IP-class.html#_ +netaddr.address.IP.info netaddr.address.IP-class.html#info +netaddr.address.IP.is_reserved netaddr.address.IP-class.html#is_reserved +netaddr.address.IP.is_loopback netaddr.address.IP-class.html#is_loopback +netaddr.address.Addr.__setitem__ netaddr.address.Addr-class.html#__setitem__ netaddr.address.Addr.value netaddr.address.Addr-class.html#value +netaddr.address.Addr.__xor__ netaddr.address.Addr-class.html#__xor__ netaddr.address.IP.reverse_dns netaddr.address.IP-class.html#reverse_dns netaddr.address.Addr.__le__ netaddr.address.Addr-class.html#__le__ netaddr.address.IP.__repr__ netaddr.address.IP-class.html#__repr__ +netaddr.address.IP.__init__ netaddr.address.IP-class.html#__init__ netaddr.address.Addr.__hash__ netaddr.address.Addr-class.html#__hash__ netaddr.address.IP.STRATEGIES netaddr.address.IP-class.html#STRATEGIES netaddr.address.Addr.__long__ netaddr.address.Addr-class.html#__long__ netaddr.address.Addr.__ge__ netaddr.address.Addr-class.html#__ge__ -netaddr.address.KlassDescriptor netaddr.address.KlassDescriptor-class.html -netaddr.address.KlassDescriptor.__set__ netaddr.address.KlassDescriptor-class.html#__set__ -netaddr.address.KlassDescriptor.__init__ netaddr.address.KlassDescriptor-class.html#__init__ +netaddr.address.IPRange netaddr.address.IPRange-class.html +netaddr.address.IPRange.ADDR_TYPES netaddr.address.IPRange-class.html#ADDR_TYPES +netaddr.address.IPRange.__isub__ netaddr.address.IPRange-class.html#__isub__ +netaddr.address.IPRange.__str__ netaddr.address.IPRange-class.html#__str__ +netaddr.address.IPRange.__lt__ netaddr.address.IPRange-class.html#__lt__ +netaddr.address.IPRange.iprange netaddr.address.IPRange-class.html#iprange +netaddr.address.IPRange.__init__ netaddr.address.IPRange-class.html#__init__ +netaddr.address.IPRange.size netaddr.address.IPRange-class.html#size +netaddr.address.IPRange.__contains__ netaddr.address.IPRange-class.html#__contains__ +netaddr.address.IPRange.issupernet netaddr.address.IPRange-class.html#issupernet +netaddr.address.IPRange.fmt netaddr.address.IPRange-class.html#fmt +netaddr.address.IPRange.strategy netaddr.address.IPRange-class.html#strategy +netaddr.address.IPRange.adjacent netaddr.address.IPRange-class.html#adjacent +netaddr.address.IPRange.addr_type netaddr.address.IPRange-class.html#addr_type +netaddr.address.IPRange.__len__ netaddr.address.IPRange-class.html#__len__ +netaddr.address.IPRange.overlaps netaddr.address.IPRange-class.html#overlaps +netaddr.address.IPRange.__ne__ netaddr.address.IPRange-class.html#__ne__ +netaddr.address.IPRange.__getitem__ netaddr.address.IPRange-class.html#__getitem__ +netaddr.address.IPRange.format netaddr.address.IPRange-class.html#format +netaddr.address.IPRange.__iter__ netaddr.address.IPRange-class.html#__iter__ +netaddr.address.IPRange.__gt__ netaddr.address.IPRange-class.html#__gt__ +netaddr.address.IPRange.__eq__ netaddr.address.IPRange-class.html#__eq__ +netaddr.address.IPRange.last netaddr.address.IPRange-class.html#last +netaddr.address.IPRange.cidrs netaddr.address.IPRange-class.html#cidrs +netaddr.address.IPRange.__iadd__ netaddr.address.IPRange-class.html#__iadd__ +netaddr.address.IPRange.__le__ netaddr.address.IPRange-class.html#__le__ +netaddr.address.IPRange.__repr__ netaddr.address.IPRange-class.html#__repr__ +netaddr.address.IPRange.wildcard netaddr.address.IPRange-class.html#wildcard +netaddr.address.IPRange.issubnet netaddr.address.IPRange-class.html#issubnet +netaddr.address.IPRange.__hash__ netaddr.address.IPRange-class.html#__hash__ +netaddr.address.IPRange.STRATEGIES netaddr.address.IPRange-class.html#STRATEGIES +netaddr.address.IPRange.__ge__ netaddr.address.IPRange-class.html#__ge__ +netaddr.address.IPRange.first netaddr.address.IPRange-class.html#first +netaddr.address.IPRangeSet netaddr.address.IPRangeSet-class.html +netaddr.address.IPRangeSet.max_match netaddr.address.IPRangeSet-class.html#max_match +netaddr.address.IPRangeSet.__init__ netaddr.address.IPRangeSet-class.html#__init__ +netaddr.address.IPRangeSet.any_match netaddr.address.IPRangeSet-class.html#any_match +netaddr.address.IPRangeSet.__contains__ netaddr.address.IPRangeSet-class.html#__contains__ +netaddr.address.IPRangeSet.all_matches netaddr.address.IPRangeSet-class.html#all_matches +netaddr.address.IPRangeSet.min_match netaddr.address.IPRangeSet-class.html#min_match netaddr.address.PrefixLenDescriptor netaddr.address.PrefixLenDescriptor-class.html netaddr.address.PrefixLenDescriptor.__set__ netaddr.address.PrefixLenDescriptor-class.html#__set__ netaddr.address.PrefixLenDescriptor.__init__ netaddr.address.PrefixLenDescriptor-class.html#__init__ @@ -192,137 +279,207 @@ netaddr.address.StrategyDescriptor.__set__ netaddr.address.StrategyDescriptor-cl netaddr.address.StrategyDescriptor.__init__ netaddr.address.StrategyDescriptor-class.html#__init__ netaddr.address.Wildcard netaddr.address.Wildcard-class.html netaddr.address.Wildcard.ADDR_TYPES netaddr.address.Wildcard-class.html#ADDR_TYPES -netaddr.address.AddrRange.__isub__ netaddr.address.AddrRange-class.html#__isub__ +netaddr.address.IPRange.__ne__ netaddr.address.IPRange-class.html#__ne__ netaddr.address.Wildcard.__str__ netaddr.address.Wildcard-class.html#__str__ -netaddr.address.AddrRange.data_flavour netaddr.address.AddrRange-class.html#data_flavour -netaddr.address.AddrRange.__lt__ netaddr.address.AddrRange-class.html#__lt__ +netaddr.address.IPRange.__lt__ netaddr.address.IPRange-class.html#__lt__ +netaddr.address.IPRange.iprange netaddr.address.IPRange-class.html#iprange netaddr.address.Wildcard.__init__ netaddr.address.Wildcard-class.html#__init__ -netaddr.address.AddrRange.size netaddr.address.AddrRange-class.html#size -netaddr.address.AddrRange.__contains__ netaddr.address.AddrRange-class.html#__contains__ +netaddr.address.IPRange.size netaddr.address.IPRange-class.html#size +netaddr.address.IPRange.__contains__ netaddr.address.IPRange-class.html#__contains__ +netaddr.address.IPRange.issupernet netaddr.address.IPRange-class.html#issupernet +netaddr.address.Wildcard.fmt netaddr.address.Wildcard-class.html#fmt netaddr.address.Wildcard.strategy netaddr.address.Wildcard-class.html#strategy netaddr.address.Wildcard.is_valid netaddr.address.Wildcard-class.html#is_valid +netaddr.address.IPRange.adjacent netaddr.address.IPRange-class.html#adjacent netaddr.address.Wildcard.addr_type netaddr.address.Wildcard-class.html#addr_type -netaddr.address.AddrRange.__len__ netaddr.address.AddrRange-class.html#__len__ -netaddr.address.Wildcard.klass netaddr.address.Wildcard-class.html#klass -netaddr.address.AddrRange.__ne__ netaddr.address.AddrRange-class.html#__ne__ -netaddr.address.AddrRange.__getitem__ netaddr.address.AddrRange-class.html#__getitem__ -netaddr.address.AddrRange.__iter__ netaddr.address.AddrRange-class.html#__iter__ -netaddr.address.AddrRange.__gt__ netaddr.address.AddrRange-class.html#__gt__ -netaddr.address.Wildcard.cidr netaddr.address.Wildcard-class.html#cidr -netaddr.address.AddrRange.__eq__ netaddr.address.AddrRange-class.html#__eq__ -netaddr.address.AddrRange.last netaddr.address.AddrRange-class.html#last -netaddr.address.AddrRange.__iadd__ netaddr.address.AddrRange-class.html#__iadd__ -netaddr.address.AddrRange.__le__ netaddr.address.AddrRange-class.html#__le__ +netaddr.address.IPRange.__len__ netaddr.address.IPRange-class.html#__len__ +netaddr.address.IPRange.overlaps netaddr.address.IPRange-class.html#overlaps +netaddr.address.IPRange.__isub__ netaddr.address.IPRange-class.html#__isub__ +netaddr.address.IPRange.__getitem__ netaddr.address.IPRange-class.html#__getitem__ +netaddr.address.IPRange.format netaddr.address.IPRange-class.html#format +netaddr.address.IPRange.__iter__ netaddr.address.IPRange-class.html#__iter__ +netaddr.address.IPRange.__gt__ netaddr.address.IPRange-class.html#__gt__ +netaddr.address.IPRange.__eq__ netaddr.address.IPRange-class.html#__eq__ +netaddr.address.IPRange.last netaddr.address.IPRange-class.html#last +netaddr.address.IPRange.cidrs netaddr.address.IPRange-class.html#cidrs +netaddr.address.IPRange.__iadd__ netaddr.address.IPRange-class.html#__iadd__ +netaddr.address.IPRange.__le__ netaddr.address.IPRange-class.html#__le__ netaddr.address.Wildcard.__repr__ netaddr.address.Wildcard-class.html#__repr__ -netaddr.address.AddrRange.__hash__ netaddr.address.AddrRange-class.html#__hash__ +netaddr.address.IPRange.wildcard netaddr.address.IPRange-class.html#wildcard +netaddr.address.IPRange.issubnet netaddr.address.IPRange-class.html#issubnet +netaddr.address.IPRange.__hash__ netaddr.address.IPRange-class.html#__hash__ netaddr.address.Wildcard.STRATEGIES netaddr.address.Wildcard-class.html#STRATEGIES -netaddr.address.AddrRange.__ge__ netaddr.address.AddrRange-class.html#__ge__ -netaddr.address.AddrRange.first netaddr.address.AddrRange-class.html#first +netaddr.address.IPRange.__ge__ netaddr.address.IPRange-class.html#__ge__ +netaddr.address.IPRange.first netaddr.address.IPRange-class.html#first +netaddr.core.PrettyPrinter netaddr.core.PrettyPrinter-class.html +netaddr.core.PrettyPrinter.update netaddr.core.PrettyPrinter-class.html#update +netaddr.core.PrettyPrinter.__init__ netaddr.core.PrettyPrinter-class.html#__init__ +netaddr.core.Publisher netaddr.core.Publisher-class.html +netaddr.core.Publisher.attach netaddr.core.Publisher-class.html#attach +netaddr.core.Publisher.notify netaddr.core.Publisher-class.html#notify +netaddr.core.Publisher.detach netaddr.core.Publisher-class.html#detach +netaddr.core.Publisher.__init__ netaddr.core.Publisher-class.html#__init__ +netaddr.core.Subscriber netaddr.core.Subscriber-class.html +netaddr.core.Subscriber.update netaddr.core.Subscriber-class.html#update +netaddr.eui.FileIndexer netaddr.eui.FileIndexer-class.html +netaddr.eui.FileIndexer.update netaddr.eui.FileIndexer-class.html#update +netaddr.eui.FileIndexer.__init__ netaddr.eui.FileIndexer-class.html#__init__ +netaddr.eui.IAB netaddr.eui.IAB-class.html +netaddr.eui.IAB.__int__ netaddr.eui.IAB-class.html#__int__ +netaddr.eui.IAB.organisation netaddr.eui.IAB-class.html#organisation +netaddr.eui.IAB.registration netaddr.eui.IAB-class.html#registration +netaddr.eui.IAB.split_iab_mac netaddr.eui.IAB-class.html#split_iab_mac +netaddr.eui.IAB._parse_data netaddr.eui.IAB-class.html#_parse_data +netaddr.eui.IAB.__repr__ netaddr.eui.IAB-class.html#__repr__ +netaddr.eui.IAB.address netaddr.eui.IAB-class.html#address +netaddr.eui.IAB.__hex__ netaddr.eui.IAB-class.html#__hex__ +netaddr.eui.IAB.org netaddr.eui.IAB-class.html#org +netaddr.eui.IAB.__str__ netaddr.eui.IAB-class.html#__str__ +netaddr.eui.IAB.__init__ netaddr.eui.IAB-class.html#__init__ +netaddr.eui.IABIndexParser netaddr.eui.IABIndexParser-class.html +netaddr.eui.IABIndexParser.parse netaddr.eui.IABIndexParser-class.html#parse +netaddr.core.Publisher.attach netaddr.core.Publisher-class.html#attach +netaddr.core.Publisher.notify netaddr.core.Publisher-class.html#notify +netaddr.core.Publisher.detach netaddr.core.Publisher-class.html#detach +netaddr.eui.IABIndexParser.__init__ netaddr.eui.IABIndexParser-class.html#__init__ +netaddr.eui.NotRegisteredError netaddr.eui.NotRegisteredError-class.html +netaddr.eui.OUI netaddr.eui.OUI-class.html +netaddr.eui.OUI.__int__ netaddr.eui.OUI-class.html#__int__ +netaddr.eui.OUI.organisation netaddr.eui.OUI-class.html#organisation +netaddr.eui.OUI.address netaddr.eui.OUI-class.html#address +netaddr.eui.OUI._parse_data netaddr.eui.OUI-class.html#_parse_data +netaddr.eui.OUI.__repr__ netaddr.eui.OUI-class.html#__repr__ +netaddr.eui.OUI.registration netaddr.eui.OUI-class.html#registration +netaddr.eui.OUI.__hex__ netaddr.eui.OUI-class.html#__hex__ +netaddr.eui.OUI.org netaddr.eui.OUI-class.html#org +netaddr.eui.OUI.__str__ netaddr.eui.OUI-class.html#__str__ +netaddr.eui.OUI.__init__ netaddr.eui.OUI-class.html#__init__ +netaddr.eui.OUI.org_count netaddr.eui.OUI-class.html#org_count +netaddr.eui.OUIIndexParser netaddr.eui.OUIIndexParser-class.html +netaddr.eui.OUIIndexParser.parse netaddr.eui.OUIIndexParser-class.html#parse +netaddr.core.Publisher.attach netaddr.core.Publisher-class.html#attach +netaddr.core.Publisher.notify netaddr.core.Publisher-class.html#notify +netaddr.core.Publisher.detach netaddr.core.Publisher-class.html#detach +netaddr.eui.OUIIndexParser.__init__ netaddr.eui.OUIIndexParser-class.html#__init__ +netaddr.ip.DictUpdater netaddr.ip.DictUpdater-class.html +netaddr.ip.DictUpdater.update netaddr.ip.DictUpdater-class.html#update +netaddr.ip.DictUpdater.__init__ netaddr.ip.DictUpdater-class.html#__init__ +netaddr.ip.IPv4Parser netaddr.ip.IPv4Parser-class.html +netaddr.ip.LineRecordParser.parse netaddr.ip.LineRecordParser-class.html#parse +netaddr.core.Publisher.attach netaddr.core.Publisher-class.html#attach +netaddr.ip.IPv4Parser.parse_line netaddr.ip.IPv4Parser-class.html#parse_line +netaddr.core.Publisher.notify netaddr.core.Publisher-class.html#notify +netaddr.core.Publisher.detach netaddr.core.Publisher-class.html#detach +netaddr.ip.IPv4Parser.__init__ netaddr.ip.IPv4Parser-class.html#__init__ +netaddr.ip.IPv6Parser netaddr.ip.IPv6Parser-class.html +netaddr.ip.LineRecordParser.parse netaddr.ip.LineRecordParser-class.html#parse +netaddr.core.Publisher.attach netaddr.core.Publisher-class.html#attach +netaddr.ip.IPv6Parser.parse_line netaddr.ip.IPv6Parser-class.html#parse_line +netaddr.core.Publisher.notify netaddr.core.Publisher-class.html#notify +netaddr.core.Publisher.detach netaddr.core.Publisher-class.html#detach +netaddr.ip.IPv6Parser.__init__ netaddr.ip.IPv6Parser-class.html#__init__ +netaddr.ip.LineRecordParser netaddr.ip.LineRecordParser-class.html +netaddr.ip.LineRecordParser.parse netaddr.ip.LineRecordParser-class.html#parse +netaddr.core.Publisher.attach netaddr.core.Publisher-class.html#attach +netaddr.ip.LineRecordParser.parse_line netaddr.ip.LineRecordParser-class.html#parse_line +netaddr.core.Publisher.notify netaddr.core.Publisher-class.html#notify +netaddr.core.Publisher.detach netaddr.core.Publisher-class.html#detach +netaddr.ip.LineRecordParser.__init__ netaddr.ip.LineRecordParser-class.html#__init__ +netaddr.ip.MulticastParser netaddr.ip.MulticastParser-class.html +netaddr.ip.MulticastParser.normalise_addr netaddr.ip.MulticastParser-class.html#normalise_addr +netaddr.ip.LineRecordParser.parse netaddr.ip.LineRecordParser-class.html#parse +netaddr.core.Publisher.attach netaddr.core.Publisher-class.html#attach +netaddr.ip.MulticastParser.parse_line netaddr.ip.MulticastParser-class.html#parse_line +netaddr.core.Publisher.notify netaddr.core.Publisher-class.html#notify +netaddr.core.Publisher.detach netaddr.core.Publisher-class.html#detach +netaddr.ip.MulticastParser.__init__ netaddr.ip.MulticastParser-class.html#__init__ netaddr.strategy.AddrStrategy netaddr.strategy.AddrStrategy-class.html -netaddr.strategy.AddrStrategy.words_to_str netaddr.strategy.AddrStrategy-class.html#words_to_str netaddr.strategy.AddrStrategy.int_to_bits netaddr.strategy.AddrStrategy-class.html#int_to_bits -netaddr.strategy.AddrStrategy.valid_bits netaddr.strategy.AddrStrategy-class.html#valid_bits +netaddr.strategy.AddrStrategy.int_to_packed netaddr.strategy.AddrStrategy-class.html#int_to_packed +netaddr.strategy.AddrStrategy.int_to_words netaddr.strategy.AddrStrategy-class.html#int_to_words netaddr.strategy.AddrStrategy.__init__ netaddr.strategy.AddrStrategy-class.html#__init__ +netaddr.strategy.AddrStrategy.valid_bits netaddr.strategy.AddrStrategy-class.html#valid_bits netaddr.strategy.AddrStrategy.valid_int netaddr.strategy.AddrStrategy-class.html#valid_int -netaddr.strategy.AddrStrategy.str_to_bits netaddr.strategy.AddrStrategy-class.html#str_to_bits -netaddr.strategy.AddrStrategy.str_to_words netaddr.strategy.AddrStrategy-class.html#str_to_words -netaddr.strategy.AddrStrategy.bits_to_words netaddr.strategy.AddrStrategy-class.html#bits_to_words -netaddr.strategy.AddrStrategy.int_to_words netaddr.strategy.AddrStrategy-class.html#int_to_words -netaddr.strategy.AddrStrategy.description netaddr.strategy.AddrStrategy-class.html#description +netaddr.strategy.AddrStrategy.packed_to_int netaddr.strategy.AddrStrategy-class.html#packed_to_int netaddr.strategy.AddrStrategy.int_to_str netaddr.strategy.AddrStrategy-class.html#int_to_str netaddr.strategy.AddrStrategy.valid_str netaddr.strategy.AddrStrategy-class.html#valid_str -netaddr.strategy.AddrStrategy.word_to_bits netaddr.strategy.AddrStrategy-class.html#word_to_bits netaddr.strategy.AddrStrategy.bits_to_int netaddr.strategy.AddrStrategy-class.html#bits_to_int netaddr.strategy.AddrStrategy.str_to_int netaddr.strategy.AddrStrategy-class.html#str_to_int netaddr.strategy.AddrStrategy.words_to_int netaddr.strategy.AddrStrategy-class.html#words_to_int netaddr.strategy.AddrStrategy.valid_words netaddr.strategy.AddrStrategy-class.html#valid_words netaddr.strategy.AddrStrategy.__repr__ netaddr.strategy.AddrStrategy-class.html#__repr__ -netaddr.strategy.AddrStrategy.words_to_bits netaddr.strategy.AddrStrategy-class.html#words_to_bits -netaddr.strategy.AddrStrategy.bits_to_str netaddr.strategy.AddrStrategy-class.html#bits_to_str +netaddr.strategy.AddrStrategy.int_to_bin netaddr.strategy.AddrStrategy-class.html#int_to_bin +netaddr.strategy.AddrStrategy.STRUCT_FORMATS netaddr.strategy.AddrStrategy-class.html#STRUCT_FORMATS netaddr.strategy.EUI48Strategy netaddr.strategy.EUI48Strategy-class.html -netaddr.strategy.AddrStrategy.words_to_str netaddr.strategy.AddrStrategy-class.html#words_to_str netaddr.strategy.AddrStrategy.int_to_bits netaddr.strategy.AddrStrategy-class.html#int_to_bits -netaddr.strategy.AddrStrategy.valid_bits netaddr.strategy.AddrStrategy-class.html#valid_bits +netaddr.strategy.AddrStrategy.int_to_packed netaddr.strategy.AddrStrategy-class.html#int_to_packed +netaddr.strategy.AddrStrategy.int_to_words netaddr.strategy.AddrStrategy-class.html#int_to_words netaddr.strategy.EUI48Strategy.__init__ netaddr.strategy.EUI48Strategy-class.html#__init__ +netaddr.strategy.AddrStrategy.valid_bits netaddr.strategy.AddrStrategy-class.html#valid_bits netaddr.strategy.AddrStrategy.valid_int netaddr.strategy.AddrStrategy-class.html#valid_int -netaddr.strategy.AddrStrategy.str_to_bits netaddr.strategy.AddrStrategy-class.html#str_to_bits -netaddr.strategy.EUI48Strategy.str_to_words netaddr.strategy.EUI48Strategy-class.html#str_to_words -netaddr.strategy.AddrStrategy.word_to_bits netaddr.strategy.AddrStrategy-class.html#word_to_bits -netaddr.strategy.AddrStrategy.int_to_words netaddr.strategy.AddrStrategy-class.html#int_to_words -netaddr.strategy.AddrStrategy.description netaddr.strategy.AddrStrategy-class.html#description -netaddr.strategy.AddrStrategy.bits_to_words netaddr.strategy.AddrStrategy-class.html#bits_to_words -netaddr.strategy.EUI48Strategy.valid_str netaddr.strategy.EUI48Strategy-class.html#valid_str +netaddr.strategy.AddrStrategy.packed_to_int netaddr.strategy.AddrStrategy-class.html#packed_to_int +netaddr.strategy.EUI48Strategy.RE_MAC_FORMATS netaddr.strategy.EUI48Strategy-class.html#RE_MAC_FORMATS netaddr.strategy.EUI48Strategy.int_to_str netaddr.strategy.EUI48Strategy-class.html#int_to_str +netaddr.strategy.EUI48Strategy.valid_str netaddr.strategy.EUI48Strategy-class.html#valid_str netaddr.strategy.AddrStrategy.bits_to_int netaddr.strategy.AddrStrategy-class.html#bits_to_int -netaddr.strategy.AddrStrategy.str_to_int netaddr.strategy.AddrStrategy-class.html#str_to_int +netaddr.strategy.EUI48Strategy._ netaddr.strategy.EUI48Strategy-class.html#_ +netaddr.strategy.EUI48Strategy.str_to_int netaddr.strategy.EUI48Strategy-class.html#str_to_int netaddr.strategy.AddrStrategy.words_to_int netaddr.strategy.AddrStrategy-class.html#words_to_int netaddr.strategy.AddrStrategy.valid_words netaddr.strategy.AddrStrategy-class.html#valid_words netaddr.strategy.AddrStrategy.__repr__ netaddr.strategy.AddrStrategy-class.html#__repr__ -netaddr.strategy.AddrStrategy.words_to_bits netaddr.strategy.AddrStrategy-class.html#words_to_bits -netaddr.strategy.AddrStrategy.bits_to_str netaddr.strategy.AddrStrategy-class.html#bits_to_str +netaddr.strategy.AddrStrategy.int_to_bin netaddr.strategy.AddrStrategy-class.html#int_to_bin +netaddr.strategy.AddrStrategy.STRUCT_FORMATS netaddr.strategy.AddrStrategy-class.html#STRUCT_FORMATS netaddr.strategy.IPv4StrategyOpt netaddr.strategy.IPv4StrategyOpt-class.html -netaddr.strategy.AddrStrategy.words_to_str netaddr.strategy.AddrStrategy-class.html#words_to_str netaddr.strategy.AddrStrategy.int_to_bits netaddr.strategy.AddrStrategy-class.html#int_to_bits +netaddr.strategy.AddrStrategy.int_to_packed netaddr.strategy.AddrStrategy-class.html#int_to_packed netaddr.strategy.IPv4StrategyOpt.int_to_words netaddr.strategy.IPv4StrategyOpt-class.html#int_to_words netaddr.strategy.IPv4StrategyOpt.__init__ netaddr.strategy.IPv4StrategyOpt-class.html#__init__ netaddr.strategy.AddrStrategy.valid_bits netaddr.strategy.AddrStrategy-class.html#valid_bits netaddr.strategy.AddrStrategy.valid_int netaddr.strategy.AddrStrategy-class.html#valid_int -netaddr.strategy.AddrStrategy.word_to_bits netaddr.strategy.AddrStrategy-class.html#word_to_bits -netaddr.strategy.AddrStrategy.str_to_bits netaddr.strategy.AddrStrategy-class.html#str_to_bits -netaddr.strategy.AddrStrategy.str_to_words netaddr.strategy.AddrStrategy-class.html#str_to_words -netaddr.strategy.IPv4StrategyStd.int_to_arpa netaddr.strategy.IPv4StrategyStd-class.html#int_to_arpa -netaddr.strategy.AddrStrategy.description netaddr.strategy.AddrStrategy-class.html#description -netaddr.strategy.AddrStrategy.bits_to_words netaddr.strategy.AddrStrategy-class.html#bits_to_words -netaddr.strategy.AddrStrategy.valid_str netaddr.strategy.AddrStrategy-class.html#valid_str +netaddr.strategy.AddrStrategy.valid_words netaddr.strategy.AddrStrategy-class.html#valid_words +netaddr.strategy.AddrStrategy.packed_to_int netaddr.strategy.AddrStrategy-class.html#packed_to_int netaddr.strategy.IPv4StrategyOpt.int_to_str netaddr.strategy.IPv4StrategyOpt-class.html#int_to_str +netaddr.strategy.IPv4StrategyOpt.valid_str netaddr.strategy.IPv4StrategyOpt-class.html#valid_str netaddr.strategy.AddrStrategy.bits_to_int netaddr.strategy.AddrStrategy-class.html#bits_to_int netaddr.strategy.IPv4StrategyOpt.str_to_int netaddr.strategy.IPv4StrategyOpt-class.html#str_to_int netaddr.strategy.IPv4StrategyOpt.words_to_int netaddr.strategy.IPv4StrategyOpt-class.html#words_to_int -netaddr.strategy.AddrStrategy.valid_words netaddr.strategy.AddrStrategy-class.html#valid_words +netaddr.strategy.IPv4StrategyStd.int_to_arpa netaddr.strategy.IPv4StrategyStd-class.html#int_to_arpa netaddr.strategy.AddrStrategy.__repr__ netaddr.strategy.AddrStrategy-class.html#__repr__ -netaddr.strategy.AddrStrategy.words_to_bits netaddr.strategy.AddrStrategy-class.html#words_to_bits -netaddr.strategy.AddrStrategy.bits_to_str netaddr.strategy.AddrStrategy-class.html#bits_to_str +netaddr.strategy.AddrStrategy.int_to_bin netaddr.strategy.AddrStrategy-class.html#int_to_bin +netaddr.strategy.AddrStrategy.STRUCT_FORMATS netaddr.strategy.AddrStrategy-class.html#STRUCT_FORMATS netaddr.strategy.IPv4StrategyStd netaddr.strategy.IPv4StrategyStd-class.html -netaddr.strategy.AddrStrategy.words_to_str netaddr.strategy.AddrStrategy-class.html#words_to_str netaddr.strategy.AddrStrategy.int_to_bits netaddr.strategy.AddrStrategy-class.html#int_to_bits -netaddr.strategy.AddrStrategy.valid_bits netaddr.strategy.AddrStrategy-class.html#valid_bits +netaddr.strategy.AddrStrategy.int_to_packed netaddr.strategy.AddrStrategy-class.html#int_to_packed +netaddr.strategy.AddrStrategy.int_to_words netaddr.strategy.AddrStrategy-class.html#int_to_words netaddr.strategy.IPv4StrategyStd.__init__ netaddr.strategy.IPv4StrategyStd-class.html#__init__ +netaddr.strategy.AddrStrategy.valid_bits netaddr.strategy.AddrStrategy-class.html#valid_bits netaddr.strategy.AddrStrategy.valid_int netaddr.strategy.AddrStrategy-class.html#valid_int -netaddr.strategy.AddrStrategy.word_to_bits netaddr.strategy.AddrStrategy-class.html#word_to_bits -netaddr.strategy.AddrStrategy.str_to_bits netaddr.strategy.AddrStrategy-class.html#str_to_bits -netaddr.strategy.AddrStrategy.str_to_words netaddr.strategy.AddrStrategy-class.html#str_to_words netaddr.strategy.AddrStrategy.valid_words netaddr.strategy.AddrStrategy-class.html#valid_words -netaddr.strategy.AddrStrategy.int_to_words netaddr.strategy.AddrStrategy-class.html#int_to_words -netaddr.strategy.AddrStrategy.description netaddr.strategy.AddrStrategy-class.html#description -netaddr.strategy.AddrStrategy.bits_to_words netaddr.strategy.AddrStrategy-class.html#bits_to_words -netaddr.strategy.AddrStrategy.valid_str netaddr.strategy.AddrStrategy-class.html#valid_str +netaddr.strategy.AddrStrategy.packed_to_int netaddr.strategy.AddrStrategy-class.html#packed_to_int netaddr.strategy.AddrStrategy.int_to_str netaddr.strategy.AddrStrategy-class.html#int_to_str +netaddr.strategy.AddrStrategy.valid_str netaddr.strategy.AddrStrategy-class.html#valid_str netaddr.strategy.AddrStrategy.bits_to_int netaddr.strategy.AddrStrategy-class.html#bits_to_int netaddr.strategy.AddrStrategy.str_to_int netaddr.strategy.AddrStrategy-class.html#str_to_int netaddr.strategy.AddrStrategy.words_to_int netaddr.strategy.AddrStrategy-class.html#words_to_int netaddr.strategy.IPv4StrategyStd.int_to_arpa netaddr.strategy.IPv4StrategyStd-class.html#int_to_arpa netaddr.strategy.AddrStrategy.__repr__ netaddr.strategy.AddrStrategy-class.html#__repr__ -netaddr.strategy.AddrStrategy.words_to_bits netaddr.strategy.AddrStrategy-class.html#words_to_bits -netaddr.strategy.AddrStrategy.bits_to_str netaddr.strategy.AddrStrategy-class.html#bits_to_str +netaddr.strategy.AddrStrategy.int_to_bin netaddr.strategy.AddrStrategy-class.html#int_to_bin +netaddr.strategy.AddrStrategy.STRUCT_FORMATS netaddr.strategy.AddrStrategy-class.html#STRUCT_FORMATS netaddr.strategy.IPv6Strategy netaddr.strategy.IPv6Strategy-class.html -netaddr.strategy.AddrStrategy.words_to_str netaddr.strategy.AddrStrategy-class.html#words_to_str netaddr.strategy.AddrStrategy.int_to_bits netaddr.strategy.AddrStrategy-class.html#int_to_bits +netaddr.strategy.AddrStrategy.int_to_packed netaddr.strategy.AddrStrategy-class.html#int_to_packed netaddr.strategy.AddrStrategy.valid_bits netaddr.strategy.AddrStrategy-class.html#valid_bits netaddr.strategy.IPv6Strategy.__init__ netaddr.strategy.IPv6Strategy-class.html#__init__ netaddr.strategy.AddrStrategy.valid_int netaddr.strategy.AddrStrategy-class.html#valid_int -netaddr.strategy.AddrStrategy.word_to_bits netaddr.strategy.AddrStrategy-class.html#word_to_bits -netaddr.strategy.AddrStrategy.str_to_bits netaddr.strategy.AddrStrategy-class.html#str_to_bits -netaddr.strategy.AddrStrategy.str_to_words netaddr.strategy.AddrStrategy-class.html#str_to_words -netaddr.strategy.IPv6Strategy.int_to_arpa netaddr.strategy.IPv6Strategy-class.html#int_to_arpa +netaddr.strategy.AddrStrategy.valid_words netaddr.strategy.AddrStrategy-class.html#valid_words +netaddr.strategy.AddrStrategy.packed_to_int netaddr.strategy.AddrStrategy-class.html#packed_to_int netaddr.strategy.AddrStrategy.int_to_words netaddr.strategy.AddrStrategy-class.html#int_to_words -netaddr.strategy.AddrStrategy.description netaddr.strategy.AddrStrategy-class.html#description -netaddr.strategy.AddrStrategy.bits_to_words netaddr.strategy.AddrStrategy-class.html#bits_to_words -netaddr.strategy.IPv6Strategy.valid_str netaddr.strategy.IPv6Strategy-class.html#valid_str netaddr.strategy.IPv6Strategy.int_to_str netaddr.strategy.IPv6Strategy-class.html#int_to_str +netaddr.strategy.IPv6Strategy.valid_str netaddr.strategy.IPv6Strategy-class.html#valid_str netaddr.strategy.AddrStrategy.bits_to_int netaddr.strategy.AddrStrategy-class.html#bits_to_int netaddr.strategy.IPv6Strategy.str_to_int netaddr.strategy.IPv6Strategy-class.html#str_to_int netaddr.strategy.AddrStrategy.words_to_int netaddr.strategy.AddrStrategy-class.html#words_to_int -netaddr.strategy.AddrStrategy.valid_words netaddr.strategy.AddrStrategy-class.html#valid_words +netaddr.strategy.IPv6Strategy.int_to_arpa netaddr.strategy.IPv6Strategy-class.html#int_to_arpa netaddr.strategy.AddrStrategy.__repr__ netaddr.strategy.AddrStrategy-class.html#__repr__ -netaddr.strategy.AddrStrategy.words_to_bits netaddr.strategy.AddrStrategy-class.html#words_to_bits -netaddr.strategy.AddrStrategy.bits_to_str netaddr.strategy.AddrStrategy-class.html#bits_to_str +netaddr.strategy.AddrStrategy.int_to_bin netaddr.strategy.AddrStrategy-class.html#int_to_bin +netaddr.strategy.AddrStrategy.STRUCT_FORMATS netaddr.strategy.AddrStrategy-class.html#STRUCT_FORMATS diff --git a/docs/api/class-tree.html b/docs/api/class-tree.html index a2a4bf7..29b9c0c 100755 --- a/docs/api/class-tree.html +++ b/docs/api/class-tree.html @@ -66,36 +66,19 @@ representing various network address types. - -
  • netaddr.address.AddrRange: - A block of contiguous network addresses bounded by an arbitrary - start and stop address. -
  • netaddr.strategy.AddrStrategy: - Very basic support for all common operations performed on each - network type. + Basic support for common operations performed on each address type
    • -
  • netaddr.address.KlassDescriptor: - A descriptor that checks klass (data flavour) property assignments - for validity. +
  • netaddr.address.FormatDescriptor: + A descriptor that checks formatter property assignments for + validity. +
    • +
  • netaddr.eui.IAB: + Represents an individual IEEE IAB (Individual Address Block) + identifier. +
    • +
  • netaddr.address.IPRange: + Represents arbitrary contiguous blocks of IPv4 and IPv6 addresses + using only a lower and upper bound IP address. + +
    • +
  • netaddr.eui.OUI: + Represents an individual IEEE OUI (Organisationally Unique + Identifier) identifier.
  • netaddr.address.PrefixLenDescriptor: A descriptor that checks prefixlen property assignments for validity based on address type.
    • +
  • netaddr.core.Publisher: + A 'push' publisher that maintains a list of Subscriber objects + notifying them of state changes when its subclasses encounter + events of interest. + +
  • netaddr.address.StrategyDescriptor: A descriptor that checks strategy property assignments for validity and also keeps the addr_type property in sync with any changes made.
    • +
  • netaddr.core.Subscriber: + Abstract class defining interface expected by a Publisher that + concrete subclass instances register with to receive updates from. + +
    • +
  • set: + set(iterable) --> set object + +
    • @@ -185,7 +255,7 @@ @@ -176,15 +186,15 @@ - - + + - - @@ -196,22 +206,29 @@ + + + + - + + -
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:23 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 - - + + - - + + - - - - - - + - @@ -135,23 +127,31 @@ (in EUI) - - + + + + + + - - - + @@ -159,14 +159,24 @@ (in Addr) - + - + - + + + + + +
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:23 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 H I J - K + K L - M + M N O P - Q + Q R S T @@ -93,41 +93,33 @@
    abbrev_to_verbose()
    (in CIDR)    		ADDR_TYPES
    -(in CIDR)    		AddrValueDescriptor
    -(in netaddr.address)    		ADDR_TYPES
    +(in IP)    		adjacent()
    +(in IPRange)
    Addr
    (in netaddr.address)    		ADDR_TYPES
    -(in EUI)    		AT_EUI64
    -(in netaddr)    		ADDR_TYPES
    +(in IPRange)    		all_matches()
    +(in IPRangeSet)
    addr_type
    (in Addr)    		ADDR_TYPES
    -(in IP)    		AT_INET
    -(in netaddr)
    addr_type
    -(in AddrRange)    		 ADDR_TYPES
    (in Wildcard)    		AT_INET6
    -(in netaddr)    		any_match()
    +(in IPRangeSet)
    addr_type
    (in CIDR)    		 AddrConversionError
    (in netaddr)    		AT_LINK
    +    		AT_EUI64
    (in netaddr)
    address
    (in netaddr)    		AT_NAMES
    +    		AT_INET
    (in netaddr)
    addr_type
    (in IP)    		AddrFormatError
    +    		address()
    +(in IAB)    		AT_INET6
    +(in netaddr)
    addr_type
    +(in IPRange)    		address()
    +(in OUI)    		AT_LINK
    (in netaddr)    		AT_STRATEGIES
    -(in netaddr.address)
    addr_type
    (in Wildcard)    		AddrRange
    -(in netaddr.address)    		AT_UNSPEC
    +    		AddrFormatError
    +(in netaddr)    		AT_NAMES
    (in netaddr)
    AddrStrategy
    (in netaddr.strategy)    		 AT_STRATEGIES
    +(in netaddr.address)
    ADDR_TYPES
    -(in AddrRange)    		ADDR_TYPES
    +(in CIDR)    		 AddrTypeDescriptor
    (in netaddr.address)    		 AT_UNSPEC
    +(in netaddr)
    ADDR_TYPES
    +(in EUI)    		AddrValueDescriptor
    +(in netaddr.address)    		attach()
    +(in Publisher)
    BIG_ENDIAN_PLATFORM
    (in netaddr)    		bits_to_int()
    -(in AddrStrategy)    		bits_to_words()
    -(in AddrStrategy)    		bits()
    +(in Addr)    		broadcast
    +(in CIDR)
    bits()
    +    		bin()
    (in Addr)    		bits_to_str()
    +    		bits_to_int()
    (in AddrStrategy)    		  
    CIDR
    (in netaddr.address)    		cidrs()
    +(in CIDR)    		core
    +(in netaddr)
    cidr()
    (in IP)    		cidr()
    -(in Wildcard)    		cidrs()
    +(in IPRange)    		create_ieee_indices()
    +(in netaddr.eui)
       

    D

    - - + + @@ -223,15 +240,16 @@ - - + + - +
    data_flavour()
    -(in AddrRange)    		description()
    -(in AddrStrategy)    		detach()
    +(in Publisher)    		DictUpdater
    +(in netaddr.ip)    		  
       
    ei()
    (in EUI)    		EUI48Strategy
    -(in netaddr.strategy)    		 eui
    +(in netaddr)    		eui64()
    +(in EUI)
    EUI
    (in netaddr.address)    		eui64()
    -(in EUI)    		EUI48Strategy
    +(in netaddr.strategy)    		  
    @@ -240,19 +258,34 @@ - + + + + + + + + + + + -
    first
    -(in AddrRange)    		FileIndexer
    +(in netaddr.eui)    		fmt
    +(in IPRange)    		FormatDescriptor
    +(in netaddr.address)
    first
    +(in IPRange)    		fmt
    +(in Wildcard)    		  
    fmt
    +(in CIDR)    		format()
    +(in IPRange)    		  
       

    H

    - @@ -265,92 +298,186 @@ - + - + @@ -358,15 +485,24 @@
    hostmask()
    +    		hostmask
    (in CIDR)    		 hostname()
    (in IP)    		 - - + + - - + + + + + + - + + + + + + + + + + - - - + + + + + + + + + + + - - + + - - + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + +
    int_to_arpa()
    -(in IPv4StrategyStd)    		int_to_words()
    -(in AddrStrategy)    		IAB
    +(in netaddr.eui)    		int_to_str()
    +(in EUI48Strategy)    		 ipv6_link_local()
    (in EUI)
    int_to_arpa()
    -(in IPv6Strategy)    		int_to_words()
    +    		iab()
    +(in EUI)    		int_to_str()
    (in IPv4StrategyOpt)    		IPv6Parser
    +(in netaddr.ip)
    IABIndexParser
    +(in netaddr.eui)    		int_to_str()
    +(in IPv6Strategy)    		 IPv6Strategy
    (in netaddr.strategy)
    int_to_bits()
    +    		IANA_INFO
    +(in netaddr.ip)    		int_to_words()
    (in AddrStrategy)    		is_hostmask()
    +(in IP)
    IEEE_IAB_INDEX
    +(in netaddr.eui)    		int_to_words()
    +(in IPv4StrategyOpt)    		is_ipv4_compat()
    +(in IP)
    IEEE_IAB_METADATA
    +(in netaddr.eui)    		 IP
    (in netaddr.address)    		is_hostmask()
    +    		is_ipv4_mapped()
    (in IP)
    int_to_str()
    -(in AddrStrategy)    		ipv4()
    +    		IEEE_IAB_REGISTRY
    +(in netaddr.eui)    		ip
    +(in netaddr)    		is_link_local()
    +(in IP)
    IEEE_OUI_INDEX
    +(in netaddr.eui)    		IPRange
    +(in netaddr.address)    		is_loopback()
    +(in IP)
    IEEE_OUI_METADATA
    +(in netaddr.eui)    		iprange()
    (in IP)    		 is_multicast()
    (in IP)
    int_to_str()
    -(in EUI48Strategy)    		IPv4StrategyOpt
    -(in netaddr.strategy)    		IEEE_OUI_REGISTRY
    +(in netaddr.eui)    		iprange()
    +(in IPRange)    		 is_netmask()
    (in IP)
    int_to_str()
    -(in IPv4StrategyOpt)    		IPv4StrategyStd
    -(in netaddr.strategy)    		info()
    +(in EUI)    		IPRangeSet
    +(in netaddr.address)    		is_private()
    +(in IP)
    info()
    +(in IP)    		ipv4()
    +(in IP)    		is_reserved()
    +(in IP)
    int_to_arpa()
    +(in IPv4StrategyStd)    		ipv4_cidr_prefixes()
    +(in netaddr.misc)    		 is_unicast()
    (in IP)
    int_to_str()
    +    		int_to_arpa()
    (in IPv6Strategy)    		ipv6()
    -(in IP)    		IPv4Parser
    +(in netaddr.ip)    		 is_valid()
    (in Wildcard)
    int_to_bin()
    +(in AddrStrategy)    		IPv4StrategyOpt
    +(in netaddr.strategy)    		isiab()
    +(in EUI)
    int_to_bits()
    +(in AddrStrategy)    		IPv4StrategyStd
    +(in netaddr.strategy)    		issubnet()
    +(in IPRange)
    int_to_packed()
    +(in AddrStrategy)    		ipv6()
    +(in IP)    		issupernet()
    +(in IPRange)
    int_to_str()
    +(in AddrStrategy)    		ipv6_cidr_prefixes()
    +(in netaddr.misc)    		 

    K

    L

    		 - - + + - - + +
    klass
    -(in AddrRange)    		klass
    -(in Wildcard)    		last
    +(in IPRange)    		load_iana_info()
    +(in netaddr.ip)    		  
    klass
    -(in CIDR)    		KlassDescriptor
    -(in netaddr.address)    		LineRecordParser
    +(in netaddr.ip)    		load_ieee_indices()
    +(in netaddr.eui)    		  

    L

    M

    		 - + + + + + + -
    last
    -(in AddrRange)    		max_match()
    +(in IPRangeSet)    		misc
    +(in netaddr)    		  
    min_match()
    +(in IPRangeSet)    		MulticastParser
    +(in netaddr.ip)    		  
       

    N

    - - + + - + + + + +
    netaddrnetmask_bits()
    -(in IP)    		 network
    +(in CIDR)    		NotRegisteredError
    +(in netaddr.eui)
    netmask()
    +    		netmask
    (in CIDR)    		normalise_addr()
    +(in MulticastParser)    		 nrange()
    (in netaddr.address)
    netmask_bits()
    +(in IP)    		notify()
    +(in Publisher)    		  
    @@ -375,24 +511,88 @@ + + + + + + + + + + -
    org()
    +(in IAB)    		OUI
    +(in netaddr.eui)    		overlaps()
    +(in IPRange)
    org()
    +(in OUI)    		 oui()
    (in EUI)    		  
    org_count()
    +(in OUI)    		OUIIndexParser
    +(in netaddr.eui)    		  
       

    P

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    packed()
    +(in Addr)    		parse_line()
    +(in IPv6Parser)    		PrettyPrinter
    +(in netaddr.core)
    packed_to_int()
    +(in AddrStrategy)    		parse_line()
    +(in LineRecordParser)    		print_ipv4_cidr_prefixes()
    +(in netaddr.misc)
    parse()
    +(in IABIndexParser)    		parse_line()
    +(in MulticastParser)    		print_ipv6_cidr_prefixes()
    +(in netaddr.misc)
    parse()
    +(in OUIIndexParser)    		 prefixlen
    (in CIDR)    		Publisher
    +(in netaddr.core)
    parse()
    +(in LineRecordParser)    		 prefixlen
    (in IP)    		 
    parse_line()
    +(in IPv4Parser)    		 PrefixLenDescriptor
    (in netaddr.address)    		 
    + +

    Q

    + + + + + +
    query()
    +(in netaddr.ip)    		  
       
    @@ -401,94 +601,109 @@ + + + + + + - -
    RE_MAC_FORMATS
    +(in EUI48Strategy)    		registration()
    +(in OUI)    		 
    registration()
    +(in IAB)    		 reverse_dns()
    (in IP)    		   
       

    S

    - + - + - + + + + + + - + - + - + + + + + + - - + - - + - - + - - + + - - + + - - - - - - +
    size()
    -(in AddrRange)    		size()
    +(in IPRange)    		 str_to_int()
    (in AddrStrategy)    		STRATEGIES
    -(in Wildcard)    		strategy
    +(in CIDR)
    ST_EUI48
    -(in netaddr)    		span()
    +(in CIDR)    		str_to_int()
    +(in EUI48Strategy)    		strategy
    +(in EUI)
    split_iab_mac()
    +(in IAB)    		 str_to_int()
    (in IPv4StrategyOpt)    		strategy
    -(in Addr)    		strategy
    +(in IP)
    ST_EUI48
    -(in netaddr.strategy)    		ST_EUI48
    +(in netaddr)    		 str_to_int()
    (in IPv6Strategy)    		strategy
    -(in AddrRange)    		strategy
    +(in IPRange)
    ST_EUI48
    +(in netaddr.strategy)    		STRATEGIES
    +(in Addr)    		strategy
    +(in Wildcard)
    ST_EUI64
    (in netaddr)    		str_to_words()
    -(in AddrStrategy)    		strategy
    +    		STRATEGIES
    (in CIDR)    		strategy
    +(in netaddr)
    ST_EUI64
    (in netaddr.strategy)    		str_to_words()
    -(in EUI48Strategy)    		strategy
    +    		STRATEGIES
    (in EUI)    		StrategyDescriptor
    +(in netaddr.address)
    ST_IPV4
    (in netaddr)    		STRATEGIES
    -(in Addr)    		strategy
    +    		STRATEGIES
    (in IP)    		STRUCT_FORMATS
    +(in AddrStrategy)
    ST_IPV4
    (in netaddr.strategy)    		STRATEGIES
    -(in AddrRange)    		strategy
    -(in Wildcard)    		STRATEGIES
    +(in IPRange)    		subnet()
    +(in CIDR)
    ST_IPV6
    (in netaddr)    		STRATEGIES
    -(in CIDR)    		strategy
    -(in netaddr)    		STRATEGIES
    +(in Wildcard)    		Subscriber
    +(in netaddr.core)
    ST_IPV6
    (in netaddr.strategy)    		STRATEGIES
    -(in EUI)    		StrategyDescriptor
    -(in netaddr.address)
    str_to_bits()
    -(in AddrStrategy)    		STRATEGIES
    -(in IP)    		strategy
    +(in Addr)    		  
    @@ -509,12 +724,20 @@ + + - + + + + -
    update()
    +(in PrettyPrinter)    		update()
    +(in FileIndexer)    		 USE_IPV4_OPT
    (in netaddr.strategy)    		 
    update()
    +(in Subscriber)    		update()
    +(in DictUpdater)    		  
       

    V

    @@ -525,21 +748,22 @@ (in AddrStrategy) valid_str()
    (in EUI48Strategy) -value
    -(in Addr) +valid_words()
    +(in AddrStrategy) valid_int()
    (in AddrStrategy) -valid_str()
    -(in IPv6Strategy) -  +valid_str()
    +(in IPv4StrategyOpt) +value
    +(in Addr) valid_str()
    (in AddrStrategy) -valid_words()
    -(in AddrStrategy) +valid_str()
    +(in IPv6Strategy)   @@ -550,178 +774,227 @@ Wildcard
    (in netaddr.address) -words_to_bits()
    -(in AddrStrategy) -words_to_str()
    -(in AddrStrategy) +wildcard()
    +(in IPRange) +words_to_int()
    +(in IPv4StrategyOpt) -wildcard()
    -(in CIDR) +wildcard()
    +(in IP) words_to_int()
    (in AddrStrategy)   - -word_to_bits()
    -(in AddrStrategy) -words_to_int()
    -(in IPv4StrategyOpt) -  -

    _

    - - + + + + + + + + + + + + + + + + + - - - + + - - - + + - + + - - - - + + - - + + - - + + + + + + + + + + + + + + + + + - + - - - + + + - + + + + + + - - - + + - - + + - - + - - + + - - + + - - - + + + - - + - - + + - @@ -729,16 +1002,48 @@ - + + + + + - + - + + + + + + + + + + + + + + + + @@ -776,7 +1081,7 @@
    __contains__()
    -(in AddrRange)    		__init__()
    -(in KlassDescriptor)    		_
    +(in IP)    		__init__()
    +(in StrategyDescriptor)    		__lshift__()
    +(in Addr)
    _
    +(in EUI48Strategy)    		__init__()
    +(in Wildcard)    		__lt__()
    +(in Addr)
    __add__()
    +(in Addr)    		__init__()
    +(in PrettyPrinter)    		__lt__()
    +(in IPRange)
    __add__()
    +(in CIDR)    		__init__()
    +(in Publisher)    		 __ne__()
    (in Addr)
    __eq__()
    +    		__and__()
    (in Addr)    		__init__()
    -(in PrefixLenDescriptor)    		__ne__()
    -(in AddrRange)    		__init__()
    +(in FileIndexer)    		__ne__()
    +(in IPRange)
    __eq__()
    -(in AddrRange)    		__init__()
    -(in StrategyDescriptor)    		__repr__()
    +    		__contains__()
    +(in IPRange)    		__init__()
    +(in IAB)    		__or__()
    (in Addr)
    __ge__()
    +    		__contains__()
    +(in IPRangeSet)    		__init__()
    +(in IABIndexParser)    		__repr__()
    (in Addr)    		__init__()
    -(in Wildcard)    		__repr__()
    -(in AddrRange)
    __ge__()
    -(in AddrRange)    		__init__()
    -(in AddrStrategy)    		__eq__()
    +(in Addr)    		__init__()
    +(in OUI)    		 __repr__()
    (in CIDR)
    __getitem__()
    -(in Addr)    		__init__()
    -(in EUI48Strategy)    		__eq__()
    +(in IPRange)    		__init__()
    +(in OUIIndexParser)    		 __repr__()
    (in IP)
    __getitem__()
    -(in AddrRange)    		__init__()
    -(in IPv4StrategyOpt)    		__ge__()
    +(in Addr)    		__init__()
    +(in DictUpdater)    		__repr__()
    +(in IPRange)
    __ge__()
    +(in IPRange)    		__init__()
    +(in IPv4Parser)    		 __repr__()
    (in Wildcard)
    __getitem__()
    +(in Addr)    		__init__()
    +(in IPv6Parser)    		__repr__()
    +(in IAB)
    __getitem__()
    +(in IPRange)    		__init__()
    +(in LineRecordParser)    		__repr__()
    +(in OUI)
    __gt__()
    (in Addr)    		__init__()
    -(in IPv4StrategyStd)    		__init__()
    +(in MulticastParser)    		 __repr__()
    (in AddrStrategy)
    __gt__()
    -(in AddrRange)    		__init__()
    -(in IPv6Strategy)    		__set__()
    -(in AddrTypeDescriptor)    		__gt__()
    +(in IPRange)    		__init__()
    +(in AddrStrategy)    		__rshift__()
    +(in Addr)
    __hash__()
    (in Addr)    		__int__()
    -(in Addr)    		__init__()
    +(in EUI48Strategy)    		__set__()
    +(in AddrTypeDescriptor)
    __hash__()
    +(in IPRange)    		__init__()
    +(in IPv4StrategyOpt)    		 __set__()
    (in AddrValueDescriptor)
    __hash__()
    -(in AddrRange)    		__isub__()
    +    		__hex__()
    (in Addr)    		__set__()
    -(in KlassDescriptor)    		__init__()
    +(in IPv4StrategyStd)    		__set__()
    +(in FormatDescriptor)
    __hex__()
    -(in Addr)    		__isub__()
    -(in AddrRange)    		__hex__()
    +(in IAB)    		__init__()
    +(in IPv6Strategy)    		 __set__()
    (in PrefixLenDescriptor)
    __iadd__()
    -(in Addr)    		__iter__()
    +    		__hex__()
    +(in OUI)    		__int__()
    (in Addr)    		 __set__()
    (in StrategyDescriptor)
    __iadd__()
    -(in AddrRange)    		__iter__()
    -(in AddrRange)    		__iadd__()
    +(in Addr)    		__int__()
    +(in IAB)    		 __setitem__()
    (in Addr)
    __init__()
    -(in Addr)    		__le__()
    -(in Addr)    		__iadd__()
    +(in IPRange)    		__int__()
    +(in OUI)    		 __str__()
    (in Addr)
    __init__()
    -(in AddrRange)    		__le__()
    -(in AddrRange)    		__str__()
    -(in AddrRange)    		__init__()
    +(in Addr)    		__invert__()
    +(in Addr)    		__str__()
    +(in CIDR)
    __init__()
    (in AddrTypeDescriptor)    		__len__()
    +    		__isub__()
    (in Addr)    		__str__()
    -(in CIDR)    		__str__()
    +(in IP)
    __init__()
    (in AddrValueDescriptor)    		__len__()
    -(in AddrRange)    		__str__()
    -(in IP)    		__isub__()
    +(in IPRange)    		__str__()
    +(in IPRange)
    __init__()
    (in CIDR)    		__long__()
    +    		__iter__()
    (in Addr)    		 __str__()
    (in Wildcard)
    __init__()
    (in EUI)    		__lt__()
    +    		__iter__()
    +(in IPRange)    		__str__()
    +(in IAB)
    __init__()
    +(in FormatDescriptor)    		__le__()
    (in Addr)    		__sub__()
    -(in CIDR)    		__str__()
    +(in OUI)
    __init__()
    (in IP)    		__lt__()
    -(in AddrRange)    		__le__()
    +(in IPRange)    		__sub__()
    +(in Addr)
    __init__()
    +(in IPRange)    		__len__()
    +(in Addr)    		__sub__()
    +(in CIDR)
    __init__()
    +(in IPRangeSet)    		__len__()
    +(in IPRange)    		__xor__()
    +(in Addr)
    __init__()
    +(in PrefixLenDescriptor)    		__long__()
    +(in Addr)    		 _BYTES_TO_BITS
    (in netaddr.strategy)
    @@ -103,34 +111,34 @@   @@ -138,9 +146,8 @@   @@ -148,8 +155,8 @@   @@ -157,7 +164,34 @@   + + + + + + + + +
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:23 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 netaddr: network address manipulation, done Pythonically
    • netaddr.address: network address classes (IP, EUI) and associated aggregate classes - (CIDR, Wilcard, etc).
      • -
    • netaddr.strategy: network address type logic, constants used to identify them and - shared strategy objects.
      • + (CIDR, Wildcard and IPRange). +
    • netaddr.core: Classes and routines that are common to various netaddr sub + modules.
      • +
    • netaddr.eui: Provides access to public network address information published by + the IEEE.
      • +
    • netaddr.ip: Provides access to public network address information published by + IANA.
      • +
    • netaddr.misc: Miscellanous functions and classes.
      • +
    • netaddr.strategy: network address conversion logic, constants and shared strategy + objects.
    @@ -98,7 +105,7 @@
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:23 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009

    Version: - 0.5.2 + 0.6

    @@ -75,9 +75,16 @@
    • netaddr.address: network address classes (IP, EUI) and associated aggregate classes - (CIDR, Wilcard, etc).
      • -
    • netaddr.strategy: network address type logic, constants used to identify them and - shared strategy objects.
      • + (CIDR, Wildcard and IPRange). +
    • netaddr.core: Classes and routines that are common to various netaddr sub + modules.
      • +
    • netaddr.eui: Provides access to public network address information published by + the IEEE.
      • +
    • netaddr.ip: Provides access to public network address information published by + IANA.
      • +
    • netaddr.misc: Miscellanous functions and classes.
      • +
    • netaddr.strategy: network address conversion logic, constants and shared strategy + objects.
    @@ -95,7 +102,8 @@       		AddrFormatError
    - Network address format not recognised. + An Exception indicating that a network address format is not + recognised.
    AddrConversionError
    - Conversion between address types or notations failed. + An Exception indicating a failure to convert between address types + or notations.
      - Addr
    - The base class containing common functionality for all subclasses - representing various network address types. + IP
    + Represents individual IPv4 and IPv6 addresses.
      - AddrRange
    - A block of contiguous network addresses bounded by an arbitrary - start and stop address. + IPRange
    + Represents arbitrary contiguous blocks of IPv4 and IPv6 addresses + using only a lower and upper bound IP address.
      - IP
    - A class whose objects represent Internet Protocol network - addresses. + IPRangeSet
    + *EXPERIMENTAL* A customised Python set class that deals with + collections of IPRange class and subclass instances.
    CIDR
    - A block of contiguous IPv4 or IPv6 network addresses defined by a - base network address and a bitmask prefix or subnet mask address - indicating the size/extent of the subnet. + Represents blocks of IPv4 and IPv6 addresses using CIDR (Classless + Inter-Domain Routing) notation.
    Wildcard
    - A block of contiguous IPv4 network addresses defined using a - wildcard style syntax. + Represents blocks of IPv4 addresses using a wildcard or glob style + syntax.
    EUI
    - EUI objects represent IEEE Extended Unique Identifiers. + Represents an IEEE EUI (Extended Unique Identifier) indentifier. +
    +   + + OUI
    + Represents an individual IEEE OUI (Organisationally Unique + Identifier) identifier. +
    +   + + IAB
    + Represents an individual IEEE IAB (Individual Address Block) + identifier. +
    +   + + NotRegisteredError
    + An Exception indicating that an OUI or IAB was not found in the + IEEE Registry.
    @@ -178,9 +212,10 @@ nrange(start, stop, step=1, - klass=None)
    - A generator producing sequences of network addresses based on start - and stop values, in intervals of step. + fmt=None)
    + An xrange work alike generator that produces sequences of IP + addresses based on start and stop addresses, in intervals of step + size. source code @@ -235,28 +270,28 @@   - ST_IPV4 = netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False... + ST_IPV4 = netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 10, F...   - ST_IPV6 = netaddr.address.IPv6Strategy(128, 16, ':', 6, True, ... + ST_IPV6 = netaddr.address.IPv6Strategy(128, 16, ':', 6, 16, Fa...   - ST_EUI48 = netaddr.address.EUI48Strategy(48, 8, '-', 48, True,... + ST_EUI48 = netaddr.address.EUI48Strategy(48, 8, '-', 48, 16, T...   - ST_EUI64 = netaddr.address.AddrStrategy(64, 8, '-', 64, True, ... + ST_EUI64 = netaddr.address.AddrStrategy(64, 8, '-', 64, 16, True) @@ -279,43 +314,42 @@

    nrange(start, stop, step=1, - klass=None) + fmt=None)

    source code  -

    A generator producing sequences of network addresses based on start - and stop values, in intervals of step.

    +

    An xrange work alike generator that produces sequences of IP addresses + based on start and stop addresses, in intervals of step size.

    Parameters:
      -
    • start - first network address as string or instance of Addr - (sub)class.
      • -
    • stop - last network address as string or instance of Addr - (sub)class.
      • -
    • step - (optional) size of step between addresses in range. Default is 1.
      • -
    • klass - (optional) the class used to create objects returned. Default: Addr - class. +
    • start - first IP address string or IP object + in range.
      • +
    • stop - last IP address string or IP object in range
      • +
    • step - (optional) size of step between address in range. (Default: 1)
      • +
    • fmt - (optional) callable used on addresses returned. (Default: None - + IP + objects). Supported options :-
      • - str returns string representation of network - address + str - IP address strings +
        • +
      • + int, long - IP address integer + (network byte order)
      • - int, long and hex - return expected values + hex - IP address as a hexadecimal number
      • - Addr (sub)class or duck type* return objects - of that class. If you use your own duck class, make sure you - handle both arguments (addr_value, addr_type) - passed to the constructor. + IP + class/subclass or callable that accepts + addr_value and addr_type arguments.
    @@ -344,7 +378,7 @@
    Value:
    -netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False, False)
+netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 10, False)
    @@ -362,7 +396,7 @@ netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False, False)
    Value:
    -netaddr.address.IPv6Strategy(128, 16, ':', 6, True, False)
+netaddr.address.IPv6Strategy(128, 16, ':', 6, 16, False)
    @@ -380,25 +414,7 @@ netaddr.address.IPv6Strategy(128, 16, ':', 6, True, False)
    Value:
    -netaddr.address.EUI48Strategy(48, 8, '-', 48, True, True)
-
    -
    -
    - - - -
    - -
    -

    ST_EUI64

    - -
    -
    -
    -
    Value:
    - 
    -netaddr.address.AddrStrategy(64, 8, '-', 64, True, True)
+netaddr.address.EUI48Strategy(48, 8, '-', 48, 16, True)
    @@ -436,7 +452,7 @@ netaddr.address.AddrStrategy(64, 8, '-', 64, True, True) + + + + + + + + + + + + + + + + + + @@ -309,7 +507,7 @@ object --+ + common string representation for this IP address + executable Python string to recreate equivalent object. @@ -429,6 +636,13 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\ prefixlen = PrefixLenDescriptor() + + +
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:23 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 7 """ 8 network address manipulation, done Pythonically 9 """ -10 __version__ = '0.5.2' +10 __version__ = '0.6' 11 12 import struct as _struct 13 @@ -100,42 +100,61 @@ 40
    41 -class AddrFormatError(Exception):
    42 """ -43 Network address format not recognised. +43 An Exception indicating that a network address format is not recognised. 44 """ 45 pass
    46
    47 -class AddrConversionError(Exception):
    48 """ -49 Conversion between address types or notations failed. -50 """ -51 pass -
    52 -53 #----------------------------------------------------------------------------- -54 # Public interface and exports. -55 #----------------------------------------------------------------------------- -56 -57 from netaddr.address import Addr, AddrRange, nrange, IP, CIDR, Wildcard, EUI -58 -59 from netaddr.49 An Exception indicating a failure to convert between address types or +50 notations. +51 """ +52 pass +53 +54 #----------------------------------------------------------------------------- +55 # Submodule imports. +56 #----------------------------------------------------------------------------- +57 +58 from netaddr.address import nrange, IP, IPRange, IPRangeSet, CIDR, \ +59 Wildcard, EUI +60 +61 from netaddr.eui import OUI, IAB, NotRegisteredError +62 +63 from netaddr.strategy import ST_IPV4, ST_IPV6, ST_EUI48, ST_EUI64 -60 -61 __all__ = [ -62 'Addr', 'AddrRange', 'nrange', # generic functionality -63 'AddrFormatError', 'AddrConversionError', # custom exceptions -64 'IP', 'CIDR', 'Wildcard', 'EUI', # general purpose classes -65 'ST_IPV4', 'ST_IPV6', 'ST_EUI48', 'ST_EUI64', # shared strategy objects -66 'AT_INET', 'AT_INET6', 'AT_LINK', 'AT_EUI64', # type constants -67 ] -68 - - - - - - - - - - - - - - - - - - - - - -
       Home      Trees      Indices      Help    - - -
    netaddr
    - - - - - -
    - - Package netaddr :: - Module address :: - Class AddrRange - - - - - -
    [frames] | no frames]
    -
    - -

    Class AddrRange

    source code

    -
    -object --+
-         |
-        AddrRange
-
    - -
    Known Subclasses:
    -
    - -
    - -
    -

    A block of contiguous network addresses bounded by an arbitrary start - and stop address. There is no requirement that they fall on strict bit - mask boundaries, unlike CIDR addresses.

    -

    This is the only network address aggregate supporting all network - address types. Most AddrRange subclasses usually only support a subset of - address types.

    -

    A sequence of address ranges sort first by address type then by - magnitude. So for a list containing ranges of all currently supported - address types, IPv4 ranges come first, then IPv6, EUI-48 and lastly - EUI-64.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - Instance Methods
    -   - - - - - - -
    __init__(self, - first, - last, - klass=<class 'netaddr.address.Addr'>)
    - Constructor.    		 - source code - -
    - -
    -   - - - - - - -
    __hash__(self)
    - Returns: - The hash of this address range.    		 - source code - -
    - -
    -   - - - - - - -
    __len__(self)
    - Returns: - The total number of network addresses in this range.    		 - source code - -
    - -
    -   - - - - - - -
    size(self)
    - Returns: - The total number of network addresses in this range.    		 - source code - -
    - -
    -   - - - - - - -
    data_flavour(self, - int_addr)
    - Returns: - a network address in whatever 'flavour' is required based on the - value of the klass property.    		 - source code - -
    - -
    -   - - - - - - -
    __getitem__(self, - index)
    - Returns: - The network address(es) in this address range indicated by - index/slice.    		 - source code - -
    - -
    -   - - - - - - -
    __iter__(self)
    - Returns: - An iterator object providing access to all network addresses within - this range.    		 - source code - -
    - -
    -   - - - - - - -
    __contains__(self, - addr)
    - Returns: - True if given address or range falls within this range, - False otherwise.    		 - source code - -
    - -
    -   - - - - - - -
    __eq__(self, - other)
    - Returns: - True if the boundaries of this range are the same as - other, False otherwise.    		 - source code - -
    - -
    -   - - - - - - -
    __ne__(self, - other)
    - Returns: - True if the boundaries of this range are not the same as - other, False otherwise.    		 - source code - -
    - -
    -   - - - - - - -
    __lt__(self, - other)
    - Returns: - True if the boundaries of this range are less than - other, False otherwise.    		 - source code - -
    - -
    -   - - - - - - -
    __le__(self, - other)
    - Returns: - True if the boundaries of this range are less or equal - to other, False otherwise.    		 - source code - -
    - -
    -   - - - - - - -
    __gt__(self, - other)
    - Returns: - True if the boundaries of this range are greater than - other, False otherwise.    		 - source code - -
    - -
    -   - - - - - - -
    __ge__(self, - other)
    - Returns: - True if the boundaries of this range are greater or - equal to other, False otherwise.    		 - source code - -
    - -
    -   - - - - - - -
    __iadd__(self, - i)
    - Increments start and end addresses of this range by the current size.    		 - source code - -
    - -
    -   - - - - - - -
    __isub__(self, - i)
    - Decrements start and end addresses of this range by the current size.    		 - source code - -
    - -
    -   - - - - - - -
    __str__(self)
    - str(x)    		 - source code - -
    - -
    -   - - - - - - -
    __repr__(self)
    - Returns: - An executable Python statement that can recreate an object with an - equivalent state.    		 - source code - -
    - -
    -

    Inherited from object: - __delattr__, - __getattribute__, - __new__, - __reduce__, - __reduce_ex__, - __setattr__ -

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - Class Variables
    -   - - STRATEGIES = (netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, F... -
    -   - - ADDR_TYPES = (0, 4, 6, 48, 64) -
    -   - - strategy = StrategyDescriptor(STRATEGIES) -
    -   - - addr_type = AddrTypeDescriptor(ADDR_TYPES) -
    -   - - first = AddrValueDescriptor('first') -
    -   - - last = AddrValueDescriptor('last') -
    -   - - klass = KlassDescriptor(Addr) -
    - - - - - - - - - -
    - Properties
    -

    Inherited from object: - __class__ -

    -
    - - - - - - -
    - Method Details
    - -
    - -
    - - -
    -

    __init__(self, - first, - last, - klass=<class 'netaddr.address.Addr'>) -
    (Constructor) -

    -     		source code  -
    - -

    Constructor.

    -
    -
    Parameters:
    -
      -
    • first - start address for this network address range.
      • -
    • last - stop address for this network address range.
      • -
    • klass - (optional) class used to create each object returned. Default: Addr() - objects. See nrange() documentations for additional details - on options.
      • -
    -
    Overrides: - object.__init__ -
    -
    -
    -
    - -
    - -
    - - -
    -

    __hash__(self) -
    (Hashing function) -

    -     		source code  -
    - -

    hash(x)

    -
    -
    Returns:
    -
    The hash of this address range. Allow them to be used in sets and - as keys in dictionaries.
    -
    Overrides: - object.__hash__ -
    -
    -
    -
    - -
    - -
    - - -
    -

    __len__(self) -
    (Length operator) -

    -     		source code  -
    - - -
    -
    Returns:
    -
    The total number of network addresses in this range. -
      -
    • - Use this method only for ranges that contain less than - 2^31 addresses or try the size() method. Raises an - IndexError if size is exceeded. -
      • -
    -
    -
    -
    - -
    - -
    - - -
    -

    size(self) -

    -     		source code  -
    - - -
    -
    Returns:
    -
    The total number of network addresses in this range. -
      -
    • - Use this method in preference to __len__() when size of ranges exceeds - 2^31 addresses. -
      • -
    -
    -
    -
    - -
    - -
    - - -
    -

    data_flavour(self, - int_addr) -

    -     		source code  -
    - - -
    -
    Parameters:
    -
      -
    • int_addr - an network address as a network byte order integer.
      • -
    -
    Returns:
    -
    a network address in whatever 'flavour' is required based on the - value of the klass property.
    -
    -
    -
    - -
    - -
    - - -
    -

    __getitem__(self, - index) -
    (Indexing operator) -

    -     		source code  -
    - - -
    -
    Returns:
    -
    The network address(es) in this address range indicated by - index/slice. Slicing objects can produce large sequences so - generator objects are returned instead to the usual sequences. - Wrapping a raw slice with list() or - tuple() may be required dependent on context.
    -
    -
    -
    - -
    - -
    - - -
    -

    __iter__(self) -

    -     		source code  -
    - - -
    -
    Returns:
    -
    An iterator object providing access to all network addresses - within this range.
    -
    -
    -
    - -
    - -
    - - -
    -

    __contains__(self, - addr) -
    (In operator) -

    -     		source code  -
    - - -
    -
    Parameters:
    -
      -
    • addr - object of Addr/AddrRange (sub)class or a network address string - to be compared.
      • -
    -
    Returns:
    -
    True if given address or range falls within this - range, False otherwise.
    -
    -
    -
    - -
    - -
    - - -
    -

    __eq__(self, - other) -
    (Equality operator) -

    -     		source code  -
    - - -
    -
    Parameters:
    -
      -
    • other - an address object of the same address type as self.
      • -
    -
    Returns:
    -
    True if the boundaries of this range are the same as - other, False otherwise.
    -
    -
    -
    - -
    - -
    - - -
    -

    __ne__(self, - other) -

    -     		source code  -
    - - -
    -
    Parameters:
    -
      -
    • other - an address object of the same address type as self.
      • -
    -
    Returns:
    -
    True if the boundaries of this range are not the - same as other, False otherwise.
    -
    -
    -
    - -
    - -
    - - -
    -

    __lt__(self, - other) -
    (Less-than operator) -

    -     		source code  -
    - - -
    -
    Parameters:
    -
      -
    • other - an address object of the same address type as self.
      • -
    -
    Returns:
    -
    True if the boundaries of this range are less than - other, False otherwise.
    -
    -
    -
    - -
    - -
    - - -
    -

    __le__(self, - other) -
    (Less-than-or-equals operator) -

    -     		source code  -
    - - -
    -
    Parameters:
    -
      -
    • other - an address object of the same address type as self.
      • -
    -
    Returns:
    -
    True if the boundaries of this range are less or - equal to other, False otherwise.
    -
    -
    -
    - -
    - -
    - - -
    -

    __gt__(self, - other) -
    (Greater-than operator) -

    -     		source code  -
    - - -
    -
    Parameters:
    -
      -
    • other - an address object of the same address type as self.
      • -
    -
    Returns:
    -
    True if the boundaries of this range are greater - than other, False otherwise.
    -
    -
    -
    - -
    - -
    - - -
    -

    __ge__(self, - other) -
    (Greater-than-or-equals operator) -

    -     		source code  -
    - - -
    -
    Parameters:
    -
      -
    • other - an address object of the same address type as self.
      • -
    -
    Returns:
    -
    True if the boundaries of this range are greater or - equal to other, False otherwise.
    -
    -
    -
    - -
    - -
    - - -
    -

    __iadd__(self, - i) -

    -     		source code  -
    - -

    Increments start and end addresses of this range by the current - size.

    -

    If the result exceeds address type range for the address type an - IndexError is raised.

    -
    -
    -
    -
    - -
    - -
    - - -
    -

    __isub__(self, - i) -

    -     		source code  -
    - -

    Decrements start and end addresses of this range by the current - size.

    -

    If the result less than zero an IndexError is raised.

    -
    -
    -
    -
    - -
    - -
    - - -
    -

    __str__(self) -
    (Informal representation operator) -

    -     		source code  -
    - -

    str(x)

    -
    -
    Overrides: - object.__str__ -
    (inherited documentation)
    - -
    -
    -
    - -
    - -
    - - -
    -

    __repr__(self) -
    (Representation operator) -

    -     		source code  -
    - -

    repr(x)

    -
    -
    Returns:
    -
    An executable Python statement that can recreate an object with - an equivalent state.
    -
    Overrides: - object.__repr__ -
    -
    -
    -
    -
    - - - - - - -
    - Class Variable Details
    - -
    - -
    -

    STRATEGIES

    - -
    -
    -
    -
    Value:
    - 
    -(netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False, False),
- netaddr.address.IPv6Strategy(128, 16, ':', 6, True, False),
- netaddr.address.EUI48Strategy(48, 8, '-', 48, True, True),
- netaddr.address.AddrStrategy(64, 8, '-', 64, True, True))
-
    -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - - - - -
       Home      Trees      Indices      Help    - - -
    netaddr
    - - - - - -
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 - - http://epydoc.sourceforge.net -
    - - - - diff --git a/docs/api/netaddr.address.AddrTypeDescriptor-class.html b/docs/api/netaddr.address.AddrTypeDescriptor-class.html index 11e1eb3..d7bb8e8 100644 --- a/docs/api/netaddr.address.AddrTypeDescriptor-class.html +++ b/docs/api/netaddr.address.AddrTypeDescriptor-class.html @@ -216,7 +216,7 @@ object --+ + + + + + + @@ -233,8 +300,8 @@ object --+ + A new version 4 IP object numerically equivalent this address. + + + @@ -290,8 +375,8 @@ object --+ + True if this IP is multicast, False + otherwise
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 object --+ | - AddrRange --+ + IPRange --+ | CIDR
    -

    A block of contiguous IPv4 or IPv6 network addresses defined by a base - network address and a bitmask prefix or subnet mask address indicating - the size/extent of the subnet.

    -

    By default, this class does not allow any non-zero bits to be set - right of the bitmask when it is applied to the supplied base address. - Doing so raises an AddrFormatError exception. However, it is now - configurable and will allow a less strict base address if you ask for - one. Be aware though that the bitmask will be applied to the base address - and and trailing non-zero bits removed losing the original address. It - will *not* be preserved!

    -

    Contrast this behaviour with the IP class which is - less strict and has a cidr() method for returning CIDR objects without - any loss of information.

    -

    Examples of supported formats :-

    -
      -
    1. - CIDR address format - - <address>/<mask_length>: +

      Represents blocks of IPv4 and IPv6 addresses using CIDR (Classless + Inter-Domain Routing) notation.

      +

      CIDR is a method of categorising contiguous blocks of both IPv4 and + IPv6 addresses. It is very scalable allowing for the optimal usage of the + IP address space. It permits the aggregation of networks via route + summarisation (supernetting) where adjacent routes can be combined into a + single route easily. This greatly assists in the reduction of routing + table sizes and improves network router efficiency.

      +

      CIDR blocks are represented by a base network address and a prefix + indicating the size of the (variable length) subnet mask. These are + separated by a single '/' character. Subnet sizes increase in powers of + base 2 aligning to bit boundaries.

      +

      It is technically invalid to have non-zero bits in a CIDR address to + the right of the implied netmask. For user convenience this is however + configurable and can be disabled using a constructor argument.

      +

      The constructor accepts CIDRs expressed in one of 4 different ways + :-

      +

      A) Standard CIDR format :-

      +

      IPv4:

      -   192.168.0.0/16
-   fe80::/64
+   x.x.x.x/y -> 192.0.2.0/24
      -
      2. -
    2. - Address and subnet mask combo : +

      where the x's represent the network address and y is the netmask + prefix between 0 and 32.

      +

      IPv6:

      -   192.168.0.0/255.255.0.0 == 192.168.0.0/16
-   fe80::/ffff:ffff:ffff:ffff::  == fe80::/64
+   x::/y -> fe80::/10
      -
      3. -
    3. - Partial or abbreviated formats (IPv4 only). Prefixes may be omitted - and in this case older class-based default prefixes apply : +

      where the x's represent the network address and y is the netmask + prefix between 0 and 128.

      +

      B) Abbreviated CIDR format (IPv4 only):

      -10          ==  10.0.0.0/8
-10.0        ==  10.0.0.0/8
-10/8        ==  10.0.0.0/8
-
-128         ==  128.0.0.0/16
-128.0       ==  128.0.0.0/16
-128/16      ==  128.0.0.0/16
+   x       -> 192
+   x/y     -> 10/8
+   x.x/y   -> 192.168/16
+   x.x.x/y -> 192.168.0/24
+
      +

      which are equivalent to:

      +
      +   x.0.0.0/y   -> 192.0.0.0/24
+   x.0.0.0/y   -> 10.0.0.0/8
+   x.x.0.0/y   -> 192.168.0.0/16
+   x.x.x.0/y   -> 192.168.0.0/24
 
-192         ==  10.0.0.0/24
-192.168.0   ==  192.168.0.0/24
-192.168/16  ==  192.168.0.0/16
+   - The trailing zeros are implicit.
+   - Old classful IP address rules apply if y is omitted.
+
      +

      C) Hybrid CIDR format (prefix replaced by netmask) :-

      +

      IPv4:

      +
      +   x.x.x.x/y.y.y.y -> 192.0.2.0/255.255.255.0
      -
      4. -
    +

    IPv6:

    +
    +   x::/y:: -> fe80::/ffc0::
+
    +

    where the y's represent a valid netmask.

    +

    D) ACL-style CIDR format (prefix is replaced by a hostmask) :-

    +

    Akin to Cisco's ACL (Access Control List) bitmasking (reverse + netmasks).

    +

    IPv4:

    +
    +   x.x.x.x/y.y.y.y -> 192.0.2.0/0.0.0.255
+
    +

    IPv6:

    +
    +   x::/y:: -> fe80::/3f:ffff:ffff:ffff:ffff:ffff:ffff:ffff
+
    +

    where the y's represent a valid hostmask.

    +

    Reference: RFCs 1338 and 4632.

    @@ -136,8 +156,8 @@ object --+
    __init__(self, cidr, - klass=<class 'netaddr.address.IP'>, - strict_bitmask=True)
    + fmt=<class 'netaddr.address.IP'>, + strict=True)
    Constructor.    		 source code @@ -172,11 +192,12 @@ object --+ - + @@ -190,11 +211,14 @@ object --+
    netmask(self)
    - Returns: - The subnet mask address of this CIDR range.    		__add__(self, + other)
    + Add another CIDR to this one returning a CIDR supernet that will + contain both in the smallest possible sized range.    		 - source code + source code
    - + @@ -208,10 +232,12 @@ object --+
    hostmask(self)
    - Returns: - The host mask address of this CIDR range.    		subnet(self, + prefixlen, + count=None, + fmt=None)
    + A generator that returns CIDR subnets based on the current network + base address and provided CIDR prefix and count.    		 - source code + source code
    - + @@ -225,12 +251,10 @@ object --+
    __str__(self)
    - str(x)    		cidrs(self)
    + Returns: + A list of a copy of this CIDR object.    		 - source code + source code
    - + @@ -244,12 +268,11 @@ object --+ @@ -362,14 +411,14 @@ object --+ @@ -382,6 +431,38 @@ object --+ + + + + + + + + + + + +
    __repr__(self)
    - Returns: - An executable Python statement that can recreate an object with an - equivalent state.    		__str__(self)
    + str(x)    		 - source code + source code
    - + executable Python string to recreate equivalent object. @@ -259,22 +282,28 @@ object --+ + + +
    wildcard(self)
    +     		__repr__(self)
    Returns: - A Wildcard object equivalent to this CIDR.    		 - source code + source code
    -

    Inherited from AddrRange: - __contains__, - __eq__, - __ge__, - __getitem__, - __gt__, - __hash__, - __iadd__, - __isub__, - __iter__, - __le__, - __len__, - __lt__, - __ne__, - data_flavour, - size +

    Inherited from IPRange: + __contains__, + __eq__, + __ge__, + __getitem__, + __gt__, + __hash__, + __iadd__, + __isub__, + __iter__, + __le__, + __len__, + __lt__, + __ne__, + adjacent, + format, + iprange, + issubnet, + issupernet, + overlaps, + size, + wildcard

    Inherited from object: __delattr__, @@ -302,8 +331,8 @@ object --+ + A static method that converts abbreviated IPv4 CIDRs to their more + verbose equivalent.
    abbrev_to_verbose(abbrev_cidr)
    - A statis method that converts abbreviated CIDR addresses into their - verbose form.    		 source code @@ -311,6 +340,27 @@ object --+
    +

    +   + + + + + + +
    span(addrs, + fmt=None)
    + Static method that accepts a sequence of IP addresses and/or CIDRs, + Wildcards and IPRanges returning a single CIDR that is large enough + to span the lowest and highest IP addresses in the sequence (with a + possible overlap on either end).    		 + source code + +
    +
    @@ -326,15 +376,14 @@ object --+     		  - STRATEGIES = (netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, F... + STRATEGIES = ST_IPV4, ST_IPV6
      - ADDR_TYPES = (0, 4, 6) + ADDR_TYPES = AT_UNSPEC, AT_INET, AT_INET6
      - klass = KlassDescriptor(IP) + fmt = FormatDescriptor(IP)
    -

    Inherited from AddrRange: - first, - last +

    Inherited from IPRange: + first, + last

    Properties
    +   + + network +
    +   + + broadcast
    + Please Note: although IPv6 doesn't actually recognise the + concept of a 'broadcast' address as the last address in a subnet (as + in IPv4) so many other libraries do this that it isn't worth trying + to resist. +
    +   + + netmask +
    +   + + hostmask +

    Inherited from object: @@ -414,12 +495,12 @@ object --+

    -

    A statis method that converts abbreviated CIDR addresses into their - verbose form.

    +

    A static method that converts abbreviated IPv4 CIDRs to their more + verbose equivalent.

    Parameters:
      -
    • abbrev_cidr - an abbreviated CIDR network address. +
    • abbrev_cidr - an abbreviated CIDR.

      Uses the old-style classful IP address rules to decide on a default subnet prefix if one is not explicitly provided.

      Only supports IPv4 addresses.

      @@ -439,6 +520,40 @@ object --+
    + +
    + +
    + + +
    +

    span(addrs, + fmt=None) +
    Static Method +

    +     		source code  +
    + +

    Static method that accepts a sequence of IP addresses and/or CIDRs, + Wildcards and IPRanges returning a single CIDR that is large enough to + span the lowest and highest IP addresses in the sequence (with a possible + overlap on either end).

    +
    +
    Parameters:
    +
      +
    • addrs - a sequence of IP, CIDR, Wildcard or IPRange objects and/or their + string representations.
      • +
    • fmt - (optional) callable used on return values. (Default: None - CIDR + object) Also accepts str() and unicode().
      • +
    +
    Returns:
    +
    a single CIDR object spanning all addresses.
    +
    +
    +

    __init__(self, cidr, - klass=<class 'netaddr.address.IP'>, - strict_bitmask=True) + fmt=<class 'netaddr.address.IP'>, + strict=True)
    (Constructor)

    • cidr - a valid IPv4/IPv6 CIDR address or abbreviated IPv4 network address.
      • -
    • klass - (optional) type, BIF or class used to create each object - returned. Default: IP class. See nrange() documentations for additional details - on options.
      • -
    • strict_bitmask - (optional) performs a test to ensure there are no non-zero bits +
    • fmt - (optional) callable used on return values. Default: IP class. + See nrange() documentations for more details on the + various options.
      • +
    • strict - (optional) performs a test to ensure there are no non-zero bits to the right of the subnet mask or prefix when it is applied to the base address. (default: True)
    @@ -507,45 +621,92 @@ object --+
    - +
    -

    netmask(self) +

    __add__(self, + other) +
    (Addition operator)

    		source code  + >source code 
    +

    Add another CIDR to this one returning a CIDR supernet that will + contain both in the smallest possible sized range.

    +
    +
    Parameters:
    +
      +
    • other - a CIDR object.
      • +
    +
    Returns:
    +
    A new (potentially larger) CIDR object.
    +
    +
    +
    + +
    + +
    + + +
    +

    subnet(self, + prefixlen, + count=None, + fmt=None) +

    +     		source code  +
    +

    A generator that returns CIDR subnets based on the current network + base address and provided CIDR prefix and count.

    +
    Parameters:
    +
      +
    • prefixlen - a CIDR prefix.
      • +
    • count - number of consecutive CIDRs to be returned.
      • +
    • fmt - callable used on return values. Default: None - CIDR + objects. str() and unicode() supported.
      • +
    Returns:
    -
    The subnet mask address of this CIDR range.
    +
    an iterator (as lists could potentially be very large) containing + CIDR subnets below this CIDR's base address.
    - +
    -

    hostmask(self) +

    cidrs(self)

    		source code  + >source code 
    Returns:
    -
    The host mask address of this CIDR range.
    +
    A list of a copy of this CIDR + object. This method is here mainly for compatibility with IPRange + interface.
    +
    Overrides: + IPRange.cidrs +
    @@ -591,73 +752,89 @@ object --+

    repr(x)

    Returns:
    -
    An executable Python statement that can recreate an object with - an equivalent state.
    +
    executable Python string to recreate equivalent object.
    Overrides: object.__repr__
    - +
    + + + + + + +
    + Property Details
    +
    - - -
    -

    wildcard(self) -

    -     		source code  -
    - +

    network

    -
    Returns:
    -
    A Wildcard object equivalent to this CIDR. -
      -
    • - If CIDR was initialised with klass=str a - wildcard string is returned, in all other cases a Wildcard object is returned. -
      • -
    • - Only supports IPv4 CIDR addresses. -
      • -
    +
    Get Method:
    +
    unreachable.network(self) + - Returns: +The network (first) address in this CIDR block. +
    -
    - - + +
    - - - -
    - Class Variable Details
    - +
    +

    broadcast

    +

    Please Note: although IPv6 doesn't actually recognise the + concept of a 'broadcast' address as the last address in a subnet (as in + IPv4) so many other libraries do this that it isn't worth trying to + resist. This issue raises so many user queries that it is easier to + dispense with the theory and be pragmatic instead.

    +
    +
    Get Method:
    +
    unreachable.broadcast(self) + - Please Note: although IPv6 doesn't actually recognise the concept of +a 'broadcast' address as the last address in a subnet (as in IPv4) so many +other libraries do this that it isn't worth trying to resist. +
    +
    +
    + +
    -

    STRATEGIES

    +

    netmask

    +
    Get Method:
    +
    unreachable.netmask(self) + - Returns: +The subnet mask address of this CIDR block. +
    +
    +
    + +
    + +
    +

    hostmask

    +
    -
    Value:
    - 
    -(netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False, False),
- netaddr.address.IPv6Strategy(128, 16, ':', 6, True, False))
-
    -
    +
    Get Method:
    +
    unreachable.hostmask(self) + - Returns: +The host mask address of this CIDR block. +
    @@ -693,7 +870,7 @@ object --+ + + + + + + @@ -162,9 +201,10 @@ object --+ + new link local IPv6 IP object based on this EUI using + technique described in RFC 4291. + + + @@ -299,7 +368,8 @@ object --+
    Parameters:
      -
    • addr - an EUI/MAC address string or a network byte order integer.
      • +
    • addr - an EUI-48 (MAC) or EUI-64 address string or a network byte order + integer.
    • addr_type - (optional) the specific EUI address type (AT_LINK or AT_EUI64). If addr is an integer, this argument is mandatory.
      • @@ -317,7 +387,8 @@ object --+
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009
    -

    EUI objects represent IEEE Extended Unique Identifiers. Input parsing - is flexible, supporting EUI-48, EUI-64 and all MAC (Media Access Control) - address flavours.

    +

    Represents an IEEE EUI (Extended Unique Identifier) indentifier.

    +

    Input parser is flexible, supporting EUI-48 (including the many Media + Access Control variants) and EUI-64.

     @@ -106,7 +106,8 @@ object --+     		- + The EI (Extension Identifier) for this EUI
    oui(self)
    +     		oui(self, + fmt=<class 'netaddr.eui.OUI'>)
    Returns: The OUI (Organisationally Unique Identifier) for this EUI.    		 @@ -126,7 +127,7 @@ object --+
    ei(self)
    Returns: - The EI (Extension Identifier) for this EUI.    		 source code @@ -134,6 +135,44 @@ object --+
    +
    +   + + + + + + +
    isiab(self)
    + Returns: + True if this EUI is an IAB address, False otherwise    		 + source code + +
    + +
    +   + + + + + + +
    iab(self, + fmt=<class 'netaddr.eui.IAB'>)
    + Returns: + If isiab() is True, the IAB (Individual Address Block) is returned, + None otherwise.    		 + source code + +
    +
    ipv6_link_local(self)
    Returns: - An IPv6 IP - object initialised using the value of this EUI.    		 source code @@ -174,9 +214,30 @@ object --+
    +   + + + + + + +
    info(self)
    + Returns: + A record dict containing IEEE registration details for this EUI + (MAC-48) if available, None otherwise.    		 + source code + +
    + +

    Inherited from Addr: + __add__, + __and__, __eq__, __ge__, __getitem__, @@ -185,17 +246,25 @@ object --+ __hex__, __iadd__, __int__, + __invert__, __isub__, __iter__, __le__, __len__, __long__, + __lshift__, __lt__, __ne__, + __or__, __repr__, + __rshift__, __setitem__, __str__, - bits + __sub__, + __xor__, + bin, + bits, + packed

    Inherited from object: __delattr__, @@ -220,8 +289,8 @@ object --+

    		  - STRATEGIES = (netaddr.address.EUI48Strategy(48, 8, '-', 48, Tr... + STRATEGIES = (netaddr.address.EUI48Strategy(48, 8, '-', 48, 16...
    -

    oui(self) +

    oui(self, + fmt=<class 'netaddr.eui.OUI'>)

    		source code  @@ -326,6 +397,12 @@ object --+
    +
    Parameters:
    +
      +
    • fmt - callable used on return values. Default: OUI object. + Also Supports str(), unicode(), int() and long().
      • +
    Returns:
    The OUI (Organisationally Unique Identifier) for this EUI.
    @@ -348,7 +425,57 @@ object --+
    Returns:
    -
    The EI (Extension Identifier) for this EUI.
    +
    The EI (Extension Identifier) for this EUI
    +
    +
    + + +
    + +
    + + +
    +

    isiab(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if this EUI is an IAB address, False otherwise
    +
    +
    +
    + +
    + +
    + + +
    +

    iab(self, + fmt=<class 'netaddr.eui.IAB'>) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • fmt - callable used on return values. Default: IAB object. + Also Supports str(), unicode(), int() and long().
      • +
    +
    Returns:
    +
    If isiab() is True, the IAB (Individual Address Block) is + returned, None otherwise.
    @@ -400,14 +527,34 @@ object --+
    Returns:
    -
    An IPv6 IP object initialised using the value of this EUI. -
      -
    • - See RFC 4921 for details. -
      • -
    +
    new link local IPv6 IP object based on this EUI using + technique described in RFC 4291. Please Note: this + technique poses security risks in certain scenarios. Please read + RFC 4941 for details. Reference: RFCs 4291 and 4941.
    +
    +
    + + +
    + +
    + + +
    +

    info(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    A record dict containing IEEE registration details for this EUI + (MAC-48) if available, None otherwise.
    @@ -433,8 +580,8 @@ object --+
    Value:
    -(netaddr.address.EUI48Strategy(48, 8, '-', 48, True, True),
- netaddr.address.AddrStrategy(64, 8, '-', 64, True, True))
+(netaddr.address.EUI48Strategy(48, 8, '-', 48, 16, True),
+ netaddr.address.AddrStrategy(64, 8, '-', 64, 16, True))
    @@ -472,7 +619,7 @@ object --+ + returned, otherwise it returns the width in bits for based on the + version, 32 for IPv4 and 128 for IPv6. + The reverse DNS lookup string for this IP address + A CIDR + object based on this IP address
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + + + netaddr.address.FormatDescriptor + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module address :: + Class FormatDescriptor + + + + + +
    [frames] | no frames]
    +
    + +

    Class FormatDescriptor

    source code

    +
    +object --+
+         |
+        FormatDescriptor
+
    + +
    +

    A descriptor that checks formatter property assignments for + validity.

    + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + default)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    __set__(self, + instance, + value) + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + default) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +
    +
    Parameters:
    +
      +
    • default - the default callable to use if the formatter property is None.
      • +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.address.IP-class.html b/docs/api/netaddr.address.IP-class.html index 01052d5..11989f7 100755 --- a/docs/api/netaddr.address.IP-class.html +++ b/docs/api/netaddr.address.IP-class.html @@ -69,20 +69,49 @@ object --+
    -

    A class whose objects represent Internet Protocol network addresses. - Both IPv4 and IPv6 are fully supported and also permit the inclusion of - bitmask prefix or subnet mask address indicating the size/extent of the - subnet, for example :

    +

    Represents individual IPv4 and IPv6 addresses.

    +

    Please Note: this class is intended to provide low-level + functionality to individual IP addresses such as octet/hextet access, + integer/hex/binary conversions, etc. If you are coming from other + libraries you may expect to find much higher level networking operations + here. While the inclusion of a bitmask prefix or netmask to indicate + subnet membership is permitted by the class constructor they are provided + only as a convenience to the user.

    +

    All higher level subnet and network operations can be found in objects + of classes CIDR, IPRange and Wildcard. + There are handy helper methods here, (.cidr(), + .iprange() and .wildcard()) that return + pre-initialised objects of those classes without you having to call them + explicitly.

    +

    Example usage :

    -   IPv4
+   >>> ip = IP('10.0.0.1')
+   >>> list(ip) == [10, 0, 0, 1]
+   True
+   >>> ip += 1
+   >>> str(ip) == '10.0.0.2'
+   True
 
-   192.168.0.1/24
-   192.168.0.1/255.255.255.0
+   >>> IP('10.0.0.0/28').iprange()
+   IPRange('10.0.0.0', '10.0.0.15')
 
-   IPv6
+   >>> IP('10.0.0.64/24').cidr()
+   CIDR('10.0.0.0/24')
 
-   fe80::20f:1fff:fe12:e733/64
+   >>> IP('192.168.0.1/255.255.253.0').wildcard()
+   Wildcard('192.168.0-1.*')
+
+   >>> ipv6 = IP('fe80::20f:1fff:fe12:e733')
+   >>> ipv6[0:4]
+   [65152, 0, 0, 0]
+
+   >>> IP('fe80::20f:1fff:fe12:e733/64').cidr()
+   CIDR('fe80::/64')
    +

    See those classes for details on the functionality they provide.

    @@ -139,8 +168,8 @@ object --+     		netmask_bits(self)
    Returns: If this address is a valid netmask, the number of non-zero bits are - returned, otherwise it returns the width (in bits) for the given - address type (IPv4: 32, IPv6: 128).    		 source code @@ -158,7 +187,7 @@ object --+
    reverse_dns(self)
    Returns: - The reverse DNS lookup string for this IP address.    		 source code @@ -214,8 +243,8 @@ object --+
    cidr(self)
    Returns: - A valid CIDR object for this IP address.    		 source code @@ -223,6 +252,44 @@ object --+
    +
    +   + + + + + + +
    wildcard(self)
    + Returns: + A Wildcard object based on this IP address    		 + source code + +
    + +
    +   + + + + + + +
    iprange(self)
    + Returns: + A CIDR + object based on this IP address    		 + source code + +
    +
    ipv4(self)
    Returns: - A new IP - object numerically equivalent this address.    		 source code @@ -250,10 +317,10 @@ object --+ - + + True if this IP is unicast, False otherwise
    ipv6(self)
    - Returns: - A new IP - object numerically equivalent this address.    		ipv6(self, + ipv4_compatible=False)
    + Please Note: the IPv4-Mapped IPv6 address format is now + considered deprecated.    		 source code @@ -271,8 +338,7 @@ object --+
    is_unicast(self)
    Returns: - True if this address is unicast, False - otherwise.    		 source code @@ -280,6 +346,25 @@ object --+
    +
    +   + + + + + + +
    is_loopback(self)
    + Returns: + True if this IP is loopback address (not for network + transmission), False otherwise.    		 + source code + +
    +
    is_multicast(self)
    Returns: - True if this address is multicast, False - otherwise.    		 source code @@ -299,6 +384,119 @@ object --+
    +
    +   + + + + + + +
    is_private(self)
    + Returns: + True if this IP is for internal/private use only (i.e.    		 + source code + +
    + +
    +   + + + + + + +
    is_link_local(self)
    + Returns: + True if this IP is link-local address False + otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    is_reserved(self)
    + Returns: + True if this IP is in IANA reserved range, + False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    is_ipv4_mapped(self)
    + Returns: + True if this IP is IPv4-compatible IPv6 address, + False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    is_ipv4_compat(self)
    + Returns: + True if this IP is IPv4-mapped IPv6 address, + False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    info(self)
    + Returns: + A record dict containing IANA registration details for this IP + address if available, None otherwise.    		 + source code + +
    +
    __str__(self)
    Returns: - The common string representation for this IP address.    		 source code @@ -327,8 +525,7 @@ object --+
    __repr__(self)
    Returns: - An executable Python statement that can recreate an object with an - equivalent state.    		 source code @@ -341,6 +538,8 @@ object --+

    Inherited from Addr: + __add__, + __and__, __eq__, __ge__, __getitem__, @@ -349,15 +548,23 @@ object --+ __hex__, __iadd__, __int__, + __invert__, __isub__, __iter__, __le__, __len__, __long__, + __lshift__, __lt__, __ne__, + __or__, + __rshift__, __setitem__, - bits + __sub__, + __xor__, + bin, + bits, + packed

    Inherited from object: __delattr__, @@ -382,8 +589,8 @@ object --+

    		  - STRATEGIES = (netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, F... + STRATEGIES = (netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 1...
    +   + + _ = 255 +

    Inherited from Addr: @@ -535,8 +749,8 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\

    Returns:
    If this address is a valid netmask, the number of non-zero bits - are returned, otherwise it returns the width (in bits) for the - given address type (IPv4: 32, IPv6: 128).
    + are returned, otherwise it returns the width in bits for based on + the version, 32 for IPv4 and 128 for IPv6.
    @@ -557,7 +771,7 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\
    Returns:
    -
    The reverse DNS lookup string for this IP address.
    +
    The reverse DNS lookup string for this IP address
    @@ -622,8 +836,52 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\
    Returns:
    -
    A valid CIDR object for this IP address.
    +
    A CIDR + object based on this IP address
    +
    + + + +
    + +
    + + +
    +

    wildcard(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    A Wildcard object based on this IP address
    +
    +
    +
    + +
    + +
    + + +
    +

    iprange(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    A CIDR + object based on this IP address
    @@ -644,23 +902,15 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\
    Returns:
    -
    A new IP - object numerically equivalent this address. -
      -
    • - If its address type is IPv4. -
      • -
    • - If object's address type is IPv6 and its value is mappable to - IPv4, a new IPv4 IP object is returned instead. -
      • -
    • - Raises an AddrConversionError if IPv6 address is not - mappable to IPv4. -
      • -
    +
    A new version 4 IP object numerically equivalent this address. + If this object is already IPv4 then a copy is returned. If this + object is IPv6 and its value is compatible with IPv4, a new IPv4 + IP + object is returned. +

    Raises an AddrConversionError is IPv6 address cannot be + converted.

    @@ -671,32 +921,30 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\
    -

    ipv6(self) +

    ipv6(self, + ipv4_compatible=False)

    		source code 
    - +

    Please Note: the IPv4-Mapped IPv6 address format is now + considered deprecated. Reference: RFC 4291

    +
    Parameters:
    +
      +
    • ipv4_compatible - If True returns an IPv4-Mapped address + (::ffff:x.x.x.x), an IPv4-Compatible (::x.x.x.x) address + otherwise. Default: False (IPv4-Mapped).
      • +
    Returns:
    A new IP - object numerically equivalent this address. -
      -
    • - If object's address type is IPv6. -
      • -
    • - If object's address type is IPv4 a new IPv6 IP - object, as a IPv4 mapped address is returned instead. Uses - the preferred IPv4 embedded in IPv6 form - - ::ffff:x.x.x.x ('mapped' address) over the (now - deprecated) form - ::x.x.x.x ('compatible' - address). See RFC 4921 for details. -
      • -
    + version 6 object that is numerically equivalent this address. If + this object is already IPv6 then a copy of this object is + returned. If this object is IPv4, a new version 6 IP object + is returned.
    @@ -717,8 +965,31 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\
    Returns:
    -
    True if this address is unicast, False - otherwise.
    +
    True if this IP is unicast, False + otherwise
    +
    + + + +
    + +
    + + +
    +

    is_loopback(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if this IP is loopback address (not for network + transmission), False otherwise. References: RFC 3330 + and 4291.
    @@ -739,11 +1010,144 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\
    Returns:
    -
    True if this address is multicast, +
    True if this IP is multicast, False + otherwise
    +
    + + + +
    + +
    + + +
    +

    is_private(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if this IP is for internal/private use only + (i.e. non-public), False otherwise. Reference: RFCs + 1918, 3330, 4193, 3879 and 2365.
    +
    +
    +
    + +
    + +
    + + +
    +

    is_link_local(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if this IP is link-local address + False otherwise. Reference: RFCs 3927 and 4291.
    +
    +
    +
    + +
    + +
    + + +
    +

    is_reserved(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if this IP is in IANA reserved range, + False otherwise. Reference: RFCs 3330 and 3171.
    +
    +
    +
    + +
    + +
    + + +
    +

    is_ipv4_mapped(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if this IP is IPv4-compatible IPv6 address, + False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    is_ipv4_compat(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if this IP is IPv4-mapped IPv6 address, False otherwise.
    + +
    + +
    + + +
    +

    info(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    A record dict containing IANA registration details for this IP + address if available, None otherwise.
    +
    +
    +
    str(x)

    Returns:
    -
    The common string representation for this IP address.
    +
    common string representation for this IP address
    Overrides: object.__str__
    @@ -787,8 +1191,7 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\

    repr(x)

    Returns:
    -
    An executable Python statement that can recreate an object with - an equivalent state.
    +
    executable Python string to recreate equivalent object.
    Overrides: object.__repr__
    @@ -817,8 +1220,8 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\
    Value:
    -(netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False, False),
- netaddr.address.IPv6Strategy(128, 16, ':', 6, True, False))
+(netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 10, False),
+ netaddr.address.IPv6Strategy(128, 16, ':', 6, 16, False))
    @@ -882,7 +1285,7 @@ xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xc\ - - - @@ -189,8 +173,7 @@ object --+ + executable Python string to recreate equivalent object. @@ -297,14 +286,14 @@ object --+ @@ -369,7 +358,7 @@ object --+
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + + + netaddr.address.IPRange + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module address :: + Class IPRange + + + + + +
    [frames] | no frames]
    +
    + +

    Class IPRange

    source code

    +
    +object --+
+         |
+        IPRange
+
    + +
    Known Subclasses:
    +
    + +
    + +
    +

    Represents arbitrary contiguous blocks of IPv4 and IPv6 addresses + using only a lower and upper bound IP address.

    +

    It is the base class for more specialised block types such as CIDR() and Wildcard(). + There is no requirement that the boundary IP addresses fall on strict + bitmask boundaries.

    +

    The sort order for sequence of mixed version IPRange + objects is IPv4 followed by IPv6, based on the range's magnitude + (size).

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + first, + last, + fmt=<class 'netaddr.address.IP'>)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    __hash__(self)
    + Returns: + The hash of this address range.    		 + source code + +
    + +
    +   + + + + + + +
    __len__(self)
    + Returns: + The total number of network addresses in this range.    		 + source code + +
    + +
    +   + + + + + + +
    size(self)
    + Returns: + The total number of network addresses in this range.    		 + source code + +
    + +
    +   + + + + + + +
    format(self, + int_addr, + fmt=None)
    + Returns: + a network address in the format returned after passing it through + this object's fmt property callable.    		 + source code + +
    + +
    +   + + + + + + +
    __getitem__(self, + index)
    + Returns: + The IP address(es) in this address range referenced by index/slice.    		 + source code + +
    + +
    +   + + + + + + +
    __iter__(self)
    + Returns: + An iterator object providing access to all network addresses within + this range.    		 + source code + +
    + +
    +   + + + + + + +
    __contains__(self, + addr)
    + Returns: + True if given address or range falls within this range, + False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    __eq__(self, + other)
    + Returns: + True if the boundaries of this range are the same as + other, False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    __ne__(self, + other)
    + Returns: + True if the boundaries of this range are not the same as + other, False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    __lt__(self, + other)
    + Returns: + True if the boundaries of this range are less than + other, False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    __le__(self, + other)
    + Returns: + True if the boundaries of this range are less or equal + to other, False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    __gt__(self, + other)
    + Returns: + True if the boundaries of this range are greater than + other, False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    __ge__(self, + other)
    + Returns: + True if the boundaries of this range are greater or + equal to other, False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    __iadd__(self, + i)
    + Increments start and end addresses of this range by the current size.    		 + source code + +
    + +
    +   + + + + + + +
    __isub__(self, + i)
    + Decrements start and end addresses of this range by the current size.    		 + source code + +
    + +
    +   + + + + + + +
    iprange(self)
    + Returns: + A valid IPRange object for this address range.    		 + source code + +
    + +
    +   + + + + + + +
    cidrs(self)
    + Returns: + A list of one or more CIDR objects covering this address range.    		 + source code + +
    + +
    +   + + + + + + +
    wildcard(self)
    + Returns: + A Wildcard object equivalent to this CIDR.    		 + source code + +
    + +
    +   + + + + + + +
    issubnet(self, + other)
    + Returns: + True if other's boundary is equal to or within this range.    		 + source code + +
    + +
    +   + + + + + + +
    issupernet(self, + other)
    + Returns: + True if other's boundary is equal to or contains this range.    		 + source code + +
    + +
    +   + + + + + + +
    adjacent(self, + other)
    + Returns: + True if other's boundary touches the boundary of this address range, + False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    overlaps(self, + other)
    + Returns: + True if other's boundary crosses the boundary of this address range, + False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    __str__(self)
    + str(x)    		 + source code + +
    + +
    +   + + + + + + +
    __repr__(self)
    + Returns: + executable Python string to recreate equivalent object.    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __new__, + __reduce__, + __reduce_ex__, + __setattr__ +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Class Variables
    +   + + STRATEGIES = (netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 1... +
    +   + + ADDR_TYPES = (0, 4, 6) +
    +   + + strategy = StrategyDescriptor(STRATEGIES) +
    +   + + addr_type = AddrTypeDescriptor(ADDR_TYPES) +
    +   + + first = AddrValueDescriptor('first') +
    +   + + last = AddrValueDescriptor('last') +
    +   + + fmt = FormatDescriptor(IP) +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + first, + last, + fmt=<class 'netaddr.address.IP'>) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +
    +
    Parameters:
    +
      +
    • first - start address for this IP address range.
      • +
    • last - stop address for this IP address range.
      • +
    • fmt - (optional) callable used to create return values. Default: IP() + objects. See nrange() documentations for more details on the + various options.
      • +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    __hash__(self) +
    (Hashing function) +

    +     		source code  +
    + +

    hash(x)

    +
    +
    Returns:
    +
    The hash of this address range. Allow them to be used in sets and + as keys in dictionaries.
    +
    Overrides: + object.__hash__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    __len__(self) +
    (Length operator) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    The total number of network addresses in this range. +
      +
    • + Use this method only for ranges that contain less than + 2^31 addresses or try the size() method. Raises an + IndexError if size is exceeded. +
      • +
    +
    +
    +
    + +
    + +
    + + +
    +

    size(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    The total number of network addresses in this range. +
      +
    • + Use this method in preference to __len__() when size of ranges potentially + exceeds 2^31 addresses. +
      • +
    +
    +
    +
    + +
    + +
    + + +
    +

    format(self, + int_addr, + fmt=None) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • int_addr - a network address integer (network byte order).
      • +
    • fmt - (optional) a callable used on return values. Default: None. If + set to None, this method uses the self.fmt setting instead. The + argument is provided as an override option.
      • +
    +
    Returns:
    +
    a network address in the format returned after passing it through + this object's fmt property callable.
    +
    +
    +
    + +
    + +
    + + +
    +

    __getitem__(self, + index) +
    (Indexing operator) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    The IP address(es) in this address range referenced by + index/slice. Slicing objects can produce large sequences so + generator objects are returned instead of a list. Wrapping a + slice with list() or tuple() may be + required dependent on context in which it is called.
    +
    +
    +
    + +
    + +
    + + +
    +

    __iter__(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    An iterator object providing access to all network addresses + within this range.
    +
    +
    +
    + +
    + +
    + + +
    +

    __contains__(self, + addr) +
    (In operator) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • addr - and IP/IPRange class/subclass instance or IP string value to be + compared.
      • +
    +
    Returns:
    +
    True if given address or range falls within this + range, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    __eq__(self, + other) +
    (Equality operator) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - an address object of the same address type as self.
      • +
    +
    Returns:
    +
    True if the boundaries of this range are the same as + other, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    __ne__(self, + other) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - an address object of the same address type as self.
      • +
    +
    Returns:
    +
    True if the boundaries of this range are not the + same as other, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    __lt__(self, + other) +
    (Less-than operator) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - an address object of the same address type as self.
      • +
    +
    Returns:
    +
    True if the boundaries of this range are less than + other, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    __le__(self, + other) +
    (Less-than-or-equals operator) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - an address object of the same address type as self.
      • +
    +
    Returns:
    +
    True if the boundaries of this range are less or + equal to other, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    __gt__(self, + other) +
    (Greater-than operator) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - an address object of the same address type as self.
      • +
    +
    Returns:
    +
    True if the boundaries of this range are greater + than other, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    __ge__(self, + other) +
    (Greater-than-or-equals operator) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - an address object of the same address type as self.
      • +
    +
    Returns:
    +
    True if the boundaries of this range are greater or + equal to other, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    __iadd__(self, + i) +

    +     		source code  +
    + +

    Increments start and end addresses of this range by the current + size.

    +

    Raises IndexError if the result exceeds address range maximum.

    +
    +
    +
    +
    + +
    + +
    + + +
    +

    __isub__(self, + i) +

    +     		source code  +
    + +

    Decrements start and end addresses of this range by the current + size.

    +

    Raises IndexError if the result is less than zero.

    +
    +
    +
    +
    + +
    + +
    + + +
    +

    iprange(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    A valid IPRange object for this address range.
    +
    +
    +
    + +
    + +
    + + +
    +

    cidrs(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    A list of one or more CIDR objects covering this address range. + Please Note: a list is returned even if this range maps to + a single CIDR because arbitrary ranges may not be aligned with + base 2 subnet sizes and will therefore return multiple CIDRs.
    +
    +
    +
    + +
    + +
    + + +
    +

    wildcard(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    A Wildcard object equivalent to this CIDR. +
      +
    • + If CIDR was initialised with fmt=str, a wildcard + string is returned, in all other cases a Wildcard object is returned. +
      • +
    • + Only supports IPv4 CIDR addresses. +
      • +
    +
    +
    +
    + +
    + +
    + + +
    +

    issubnet(self, + other) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if other's boundary is equal to or within this range. False + otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    issupernet(self, + other) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if other's boundary is equal to or contains this range. + False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    adjacent(self, + other) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if other's boundary touches the boundary of this address + range, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    overlaps(self, + other) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    True if other's boundary crosses the boundary of this address + range, False otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    __str__(self) +
    (Informal representation operator) +

    +     		source code  +
    + +

    str(x)

    +
    +
    Overrides: + object.__str__ +
    (inherited documentation)
    + +
    +
    +
    + +
    + +
    + + +
    +

    __repr__(self) +
    (Representation operator) +

    +     		source code  +
    + +

    repr(x)

    +
    +
    Returns:
    +
    executable Python string to recreate equivalent object.
    +
    Overrides: + object.__repr__ +
    +
    +
    +
    +
    + + + + + + +
    + Class Variable Details
    + +
    + +
    +

    STRATEGIES

    + +
    +
    +
    +
    Value:
    + 
    +(netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 10, False),
+ netaddr.address.IPv6Strategy(128, 16, ':', 6, 16, False))
+
    +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.address.IPRangeSet-class.html b/docs/api/netaddr.address.IPRangeSet-class.html new file mode 100644 index 0000000..eea6811 --- /dev/null +++ b/docs/api/netaddr.address.IPRangeSet-class.html @@ -0,0 +1,500 @@ + + + + + netaddr.address.IPRangeSet + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module address :: + Class IPRangeSet + + + + + +
    [frames] | no frames]
    +
    + +

    Class IPRangeSet

    source code

    +
    +object --+    
+         |    
+       set --+
+             |
+            IPRangeSet
+
    + +
    +

    *EXPERIMENTAL* A customised Python set class that deals with + collections of IPRange class and subclass instances.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + addrs)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    __contains__(self, + other)
    + Returns: + True if other IP or IPRange class/subclass instance + matches any of the members in this IPRangeSet, False otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    any_match(self, + other)
    + Returns: + The first IP or IPRange class/subclass instance object that matches + other from any of the members in this IPRangeSet, None + otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    all_matches(self, + other)
    + Returns: + All IP or IPRange class/subclass instances matching + other from this IPRangeSet, an empty list otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    min_match(self, + other)
    + Returns: + The smallest IP or IPRange class/subclass instance matching + other from this IPRangeSet, None otherwise.    		 + source code + +
    + +
    +   + + + + + + +
    max_match(self, + other)
    + Returns: + The largest IP or IPRange class/subclass instance matching + other from this IPRangeSet, None otherwise.    		 + source code + +
    + +
    +

    Inherited from set: + __and__, + __cmp__, + __eq__, + __ge__, + __getattribute__, + __gt__, + __hash__, + __iand__, + __ior__, + __isub__, + __iter__, + __ixor__, + __le__, + __len__, + __lt__, + __ne__, + __new__, + __or__, + __rand__, + __reduce__, + __repr__, + __ror__, + __rsub__, + __rxor__, + __sub__, + __xor__, + add, + clear, + copy, + difference, + difference_update, + discard, + intersection, + intersection_update, + issubset, + issuperset, + pop, + remove, + symmetric_difference, + symmetric_difference_update, + union, + update +

    +

    Inherited from object: + __delattr__, + __reduce_ex__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + addrs) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +
    +
    Parameters:
    +
      +
    • addrs - A sequence of IPRange class/subclass instances used to + pre-populate the set. Individual CIDR objects can be added and + removed after instantiation with the usual set methods, add() and + remove().
      • +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    __contains__(self, + other) +
    (In operator) +

    +     		source code  +
    + +

    y in x.

    +
    +
    Returns:
    +
    True if other IP or IPRange class/subclass instance + matches any of the members in this IPRangeSet, False otherwise.
    +
    Overrides: + set.__contains__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    any_match(self, + other) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - An IP or IPRange class/subclass instance.
      • +
    +
    Returns:
    +
    The first IP or IPRange class/subclass instance object that + matches other from any of the members in this + IPRangeSet, None otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    all_matches(self, + other) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - An IP or IPRange class/subclass instance.
      • +
    +
    Returns:
    +
    All IP or IPRange class/subclass instances matching + other from this IPRangeSet, an empty list otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    min_match(self, + other) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - An IP or IPRange class/subclass instance.
      • +
    +
    Returns:
    +
    The smallest IP or IPRange class/subclass instance matching + other from this IPRangeSet, None otherwise.
    +
    +
    +
    + +
    + +
    + + +
    +

    max_match(self, + other) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • other - An IP or IPRange class/subclass instance.
      • +
    +
    Returns:
    +
    The largest IP or IPRange class/subclass instance matching + other from this IPRangeSet, None otherwise.
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.address.KlassDescriptor-class.html b/docs/api/netaddr.address.KlassDescriptor-class.html deleted file mode 100644 index c1066de..0000000 --- a/docs/api/netaddr.address.KlassDescriptor-class.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - netaddr.address.KlassDescriptor - - - - - - - - - - - - - - - - - - - - - - - -
       Home      Trees      Indices      Help    - - -
    netaddr
    - - - - - -
    - - Package netaddr :: - Module address :: - Class KlassDescriptor - - - - - -
    [frames] | no frames]
    -
    - -

    Class KlassDescriptor

    source code

    -
    -object --+
-         |
-        KlassDescriptor
-
    - -
    -

    A descriptor that checks klass (data flavour) property assignments for - validity.

    - - - - - - - - - - - - - - - - -
    - Instance Methods
    -   - - - - - - -
    __init__(self, - default_klass)
    - Constructor.    		 - source code - -
    - -
    -   - - - - - - -
    __set__(self, - instance, - value) - source code - -
    - -
    -

    Inherited from object: - __delattr__, - __getattribute__, - __hash__, - __new__, - __reduce__, - __reduce_ex__, - __repr__, - __setattr__, - __str__ -

    -
    - - - - - - - - - -
    - Properties
    -

    Inherited from object: - __class__ -

    -
    - - - - - - -
    - Method Details
    - -
    - -
    - - -
    -

    __init__(self, - default_klass) -
    (Constructor) -

    -     		source code  -
    - -

    Constructor.

    -
    -
    Parameters:
    -
      -
    • default_klass - the default class to use if klass property is set to None.
      • -
    -
    Overrides: - object.__init__ -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - - - - -
       Home      Trees      Indices      Help    - - -
    netaddr
    - - - - - -
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 - - http://epydoc.sourceforge.net -
    - - - - diff --git a/docs/api/netaddr.address.PrefixLenDescriptor-class.html b/docs/api/netaddr.address.PrefixLenDescriptor-class.html index ced1fde..467f67b 100644 --- a/docs/api/netaddr.address.PrefixLenDescriptor-class.html +++ b/docs/api/netaddr.address.PrefixLenDescriptor-class.html @@ -68,8 +68,8 @@ object --+

    A descriptor that checks prefixlen property assignments for validity - based on address type. Also accepts subnet masks which can easily be - converted to the equivalent prefixlen integer.

    + based on address type. Also accepts netmasks and hostmasks which can + easily be converted to the equivalent prefixlen integer.

    @@ -216,7 +216,7 @@ object --+
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 object --+ | - AddrRange --+ + IPRange --+ | Wildcard
    -

    A block of contiguous IPv4 network addresses defined using a wildcard - style syntax.

    +

    Represents blocks of IPv4 addresses using a wildcard or glob style + syntax.

    Individual octets can be represented using the following shortcuts :

      @@ -112,11 +112,14 @@ object --+ '*.*.*.*' # the whole IPv4 address space

      Aside

      -

      Wildcard ranges are not directly equivalent to CIDR ranges as +

      Wildcard ranges are not directly equivalent to CIDR blocks as they can represent address ranges that do not fall on strict bit mask - boundaries.

      -

      All CIDR ranges can always be represented as wildcard ranges but - the reverse isn't true in every case.

      + boundaries. They are very suitable in configuration files being more + obvious and readable than their CIDR equivalents, especially for admins + and users without much networking knowledge or experience.

      +

      All CIDR blocks can always be represented as wildcard ranges but + the reverse is not true. Wildcards are almost but not quite as flexible + as IPRange objects.

      @@ -134,7 +137,7 @@ object --+
    __init__(self, wildcard, - klass=<class 'netaddr.address.IP'>)
    + fmt=<class 'netaddr.address.IP'>)
    Constructor.    		 source code @@ -143,25 +146,6 @@ object --+
    -
    -   - - - - - - -
    cidr(self)
    - Returns: - A valid CIDR object for this wildcard.    		 - source code - -
    -
    __repr__(self)
    Returns: - An executable Python statement that can recreate an object with an - equivalent state.    		 source code @@ -202,22 +185,29 @@ object --+
    -

    Inherited from AddrRange: - __contains__, - __eq__, - __ge__, - __getitem__, - __gt__, - __hash__, - __iadd__, - __isub__, - __iter__, - __le__, - __len__, - __lt__, - __ne__, - data_flavour, - size +

    Inherited from IPRange: + __contains__, + __eq__, + __ge__, + __getitem__, + __gt__, + __hash__, + __iadd__, + __isub__, + __iter__, + __le__, + __len__, + __lt__, + __ne__, + adjacent, + cidrs, + format, + iprange, + issubnet, + issupernet, + overlaps, + size, + wildcard

    Inherited from object: __delattr__, @@ -268,15 +258,14 @@ object --+

    		  - STRATEGIES = (netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, F... + STRATEGIES = (netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 1...
      - ADDR_TYPES = (0, 4, 6) + ADDR_TYPES = (0, 4)
      - klass = KlassDescriptor(IP) + fmt = FormatDescriptor(IP)
    -

    Inherited from AddrRange: - first, - last +

    Inherited from IPRange: + first, + last

    __init__(self, wildcard, - klass=<class 'netaddr.address.IP'>) + fmt=<class 'netaddr.address.IP'>)
    (Constructor)

    		Parameters:
    Overrides: object.__init__ @@ -394,31 +383,6 @@ object --+
    - -
    - -
    - - -
    -

    cidr(self) -

    -     		source code  -
    - - -
    -
    Returns:
    -
    A valid CIDR object for this wildcard. If conversion - fails an AddrConversionError is raised as not all - wildcards ranges are valid CIDR ranges.
    -
    -
    -
    repr(x)

    Returns:
    -
    An executable Python statement that can recreate an object with - an equivalent state.
    +
    executable Python string to recreate equivalent object.
    Overrides: object.__repr__
    @@ -491,8 +454,7 @@ object --+
    Value:
    -(netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False, False),
- netaddr.address.IPv6Strategy(128, 16, ':', 6, True, False))
+(netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 10, False))
    @@ -530,7 +492,7 @@ object --+
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:24 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + + + netaddr.core + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module core + + + + + +
    [frames] | no frames]
    +
    + +

    Module core

    source code

    +

    Classes and routines that are common to various netaddr sub + modules.

    + + + + + + + + + + + + + + + + +
    + Classes
    +   + + Subscriber
    + Abstract class defining interface expected by a Publisher that + concrete subclass instances register with to receive updates from. +
    +   + + PrettyPrinter
    + Concrete Subscriber that uses the pprint module to format all data + from updates received writing them to any file-like object. +
    +   + + Publisher
    + A 'push' publisher that maintains a list of Subscriber objects + notifying them of state changes when its subclasses encounter + events of interest. +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.core-pysrc.html b/docs/api/netaddr.core-pysrc.html new file mode 100644 index 0000000..1428624 --- /dev/null +++ b/docs/api/netaddr.core-pysrc.html @@ -0,0 +1,203 @@ + + + + + netaddr.core + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module core + + + + + +
    [frames] | no frames]
    +
    +

    Source Code for Module netaddr.core

    +
    + 1  #!/usr/bin/env python
 
+ 2  #-----------------------------------------------------------------------------
 
+ 3  #   Copyright (c) 2008, David P. D. Moss. All rights reserved.
 
+ 4  #
 
+ 5  #   Released under the BSD license. See the LICENSE file for details.
 
+ 6  #-----------------------------------------------------------------------------
 
+ 7  """
 
+ 8  Classes and routines that are common to various netaddr sub modules.
 
+ 9  """ 
+10  import sys as _sys 
+11  import pprint as _pprint 
+12  
 
+13  #-----------------------------------------------------------------------------
 
+
    14 -class Subscriber(object): 
+
    15      """
 
+16      Abstract class defining interface expected by a Publisher that concrete
 
+17      subclass instances register with to receive updates from.
 
+18      """ 
+
    19 -    def update(self, data): 
+
    20          """
 
+21          Callback function used by Publisher to notify this Subscriber about
 
+22          an update.
 
+23          """ 
+24          raise NotImplementedError('cannot invoke virtual method!') 
+
    25  
 
+26  #-----------------------------------------------------------------------------
 
+
    27 -class PrettyPrinter(Subscriber): 
+
    28      """
 
+29      Concrete Subscriber that uses the pprint module to format all data from
 
+30      updates received writing them to any file-like object. Useful for
 
+31      debugging.
 
+32      """ 
+
    33 -    def __init__(self, fh=_sys.stdout, write_eol=True): 
+
    34          """
 
+35          Constructor.
 
+36  
 
+37          fh - file or file like object to write to. Default: sys.stdout.
 
+38          """ 
+39          self.fh = fh 
+40          self.write_eol = write_eol 
+
    41  
 
+
    42 -    def update(self, data): 
+
    43          """
 
+44          Callback function used by Publisher to notify this Subscriber about
 
+45          an update.
 
+46          """ 
+47          self.fh.write(_pprint.pformat(data)) 
+48          if self.write_eol: 
+49              self.fh.write("\n") 
+
    50  
 
+51  #-----------------------------------------------------------------------------
 
+
    52 -class Publisher(object): 
+
    53      """
 
+54      A 'push' publisher that maintains a list of Subscriber objects notifying
 
+55      them of state changes when its subclasses encounter events of interest.
 
+56      """ 
+
    57 -    def __init__(self): 
+
    58          """Constructor""" 
+59          self.subscribers = [] 
+
    60  
 
+
    61 -    def attach(self, subscriber): 
+
    62          """Add a new subscriber""" 
+63          if hasattr(subscriber, 'update') and \
 
+64             callable(eval('subscriber.update')): 
+65              if subscriber not in self.subscribers: 
+66                  self.subscribers.append(subscriber) 
+67          else: 
+68              raise TypeError('%r does not support required interface!' \
 
+69                  % subscriber) 
+
    70  
 
+
    71 -    def detach(self, subscriber): 
+
    72          """Remove an existing subscriber""" 
+73          try: 
+74              self.subscribers.remove(subscriber) 
+75          except ValueError: 
+76              pass 
+
    77  
 
+
    78 -    def notify(self, data): 
+
    79          """Send notification message to all registered subscribers""" 
+80          for subscriber in self.subscribers: 
+81              subscriber.update(data) 
+
    82   
+
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:24 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.core.PrettyPrinter-class.html b/docs/api/netaddr.core.PrettyPrinter-class.html new file mode 100644 index 0000000..ad2b0d3 --- /dev/null +++ b/docs/api/netaddr.core.PrettyPrinter-class.html @@ -0,0 +1,264 @@ + + + + + netaddr.core.PrettyPrinter + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module core :: + Class PrettyPrinter + + + + + +
    [frames] | no frames]
    +
    + +

    Class PrettyPrinter

    source code

    +
    +object --+    
+         |    
+Subscriber --+
+             |
+            PrettyPrinter
+
    + +
    +

    Concrete Subscriber that uses the pprint module to format all data + from updates received writing them to any file-like object. Useful for + debugging.

    + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + fh=_sys.stdout, + write_eol=True)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    update(self, + data)
    + Callback function used by Publisher to notify this Subscriber about + an update.    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + fh=_sys.stdout, + write_eol=True) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    fh - file or file like object to write to. Default: sys.stdout.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    update(self, + data) +

    +     		source code  +
    + +

    Callback function used by Publisher to notify this Subscriber about an + update.

    +
    +
    Overrides: + Subscriber.update +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.core.Publisher-class.html b/docs/api/netaddr.core.Publisher-class.html new file mode 100644 index 0000000..f9bf04b --- /dev/null +++ b/docs/api/netaddr.core.Publisher-class.html @@ -0,0 +1,274 @@ + + + + + netaddr.core.Publisher + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module core :: + Class Publisher + + + + + +
    [frames] | no frames]
    +
    + +

    Class Publisher

    source code

    +
    +object --+
+         |
+        Publisher
+
    + +
    Known Subclasses:
    +
    + +
    + +
    +

    A 'push' publisher that maintains a list of Subscriber objects + notifying them of state changes when its subclasses encounter events of + interest.

    + + + + + + + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self)
    + Constructor    		 + source code + +
    + +
    +   + + + + + + +
    attach(self, + subscriber)
    + Add a new subscriber    		 + source code + +
    + +
    +   + + + + + + +
    detach(self, + subscriber)
    + Remove an existing subscriber    		 + source code + +
    + +
    +   + + + + + + +
    notify(self, + data)
    + Send notification message to all registered subscribers    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.core.Subscriber-class.html b/docs/api/netaddr.core.Subscriber-class.html new file mode 100644 index 0000000..f0a389d --- /dev/null +++ b/docs/api/netaddr.core.Subscriber-class.html @@ -0,0 +1,189 @@ + + + + + netaddr.core.Subscriber + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module core :: + Class Subscriber + + + + + +
    [frames] | no frames]
    +
    + +

    Class Subscriber

    source code

    +
    +object --+
+         |
+        Subscriber
+
    + +
    Known Subclasses:
    +
    + +
    + +
    +

    Abstract class defining interface expected by a Publisher that + concrete subclass instances register with to receive updates from.

    + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    update(self, + data)
    + Callback function used by Publisher to notify this Subscriber about + an update.    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __init__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.eui-module.html b/docs/api/netaddr.eui-module.html new file mode 100644 index 0000000..176954c --- /dev/null +++ b/docs/api/netaddr.eui-module.html @@ -0,0 +1,437 @@ + + + + + netaddr.eui + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package eui + + + + + +
    [frames] | no frames]
    +
    + +

    Package eui

    source code

    +

    Provides access to public network address information published by the + IEEE.

    +

    More details can be found at the following URLs :-

    +

    Institute of Electrical and Electronics Engineers (IEEE)

    +
      +
    • + http://www.ieee.org/ +
      • +
    • + http://standards.ieee.org/regauth/oui/ +
      • +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Classes
    +   + + NotRegisteredError
    + An Exception indicating that an OUI or IAB was not found in the + IEEE Registry. +
    +   + + FileIndexer
    + Stores index data found by a parser in a CSV file +
    +   + + OUIIndexParser
    + A parser that processes OUI (Organisationally Unique Identifier) + registration file data published by the IEEE. +
    +   + + IABIndexParser
    + A parser that processes IAB (Individual Address Block) registration + file data published by the IEEE. +
    +   + + OUI
    + Represents an individual IEEE OUI (Organisationally Unique + Identifier) identifier. +
    +   + + IAB
    + Represents an individual IEEE IAB (Individual Address Block) + identifier. +
    + + + + + + + + + + + + +
    + Functions
    +   + + + + + + +
    create_ieee_indices()
    + Create indices for OUI and IAB file based lookups    		 + source code + +
    + +
    +   + + + + + + +
    load_ieee_indices()
    + Load OUI and IAB indices into memory    		 + source code + +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    + Variables
    +   + + IEEE_OUI_REGISTRY = '/cygdrive/z/netaddr/trunk/netaddr/eui/oui...
    + Path to local copy of IEEE OUI Registry data file. +
    +   + + IEEE_OUI_METADATA = '/cygdrive/z/netaddr/trunk/netaddr/eui/oui...
    + Path to netaddr OUI index file. +
    +   + + IEEE_OUI_INDEX = {0: [(61, 154)], 1: [(215, 178)], 2: [(393, 1...
    + OUI index lookup dictionary. +
    +   + + IEEE_IAB_REGISTRY = '/cygdrive/z/netaddr/trunk/netaddr/eui/iab...
    + Path to local copy of IEEE IAB Registry data file. +
    +   + + IEEE_IAB_METADATA = '/cygdrive/z/netaddr/trunk/netaddr/eui/iab...
    + Path to netaddr IAB index file. +
    +   + + IEEE_IAB_INDEX = {84680704: [(68, 133)], 84680705: [(201, 140)...
    + IAB index lookup dictionary. +
    + + + + + + +
    + Variables Details
    + +
    + +
    +

    IEEE_OUI_REGISTRY

    +

    Path to local copy of IEEE OUI Registry data file.

    +
    +
    +
    +
    Value:
    + 
    +'/cygdrive/z/netaddr/trunk/netaddr/eui/oui.txt'
+
    +
    +
    +
    +
    + +
    + +
    +

    IEEE_OUI_METADATA

    +

    Path to netaddr OUI index file.

    +
    +
    +
    +
    Value:
    + 
    +'/cygdrive/z/netaddr/trunk/netaddr/eui/oui.idx'
+
    +
    +
    +
    +
    + +
    + +
    +

    IEEE_OUI_INDEX

    +

    OUI index lookup dictionary.

    +
    +
    +
    +
    Value:
    + 
    +{0: [(61, 154)],
+ 1: [(215, 178)],
+ 2: [(393, 178)],
+ 3: [(571, 187)],
+ 4: [(758, 179)],
+ 5: [(937, 178)],
+ 6: [(1115, 179)],
+ 7: [(1294, 178)],
+...
+
    +
    +
    +
    +
    + +
    + +
    +

    IEEE_IAB_REGISTRY

    +

    Path to local copy of IEEE IAB Registry data file.

    +
    +
    +
    +
    Value:
    + 
    +'/cygdrive/z/netaddr/trunk/netaddr/eui/iab.txt'
+
    +
    +
    +
    +
    + +
    + +
    +

    IEEE_IAB_METADATA

    +

    Path to netaddr IAB index file.

    +
    +
    +
    +
    Value:
    + 
    +'/cygdrive/z/netaddr/trunk/netaddr/eui/iab.idx'
+
    +
    +
    +
    +
    + +
    + +
    +

    IEEE_IAB_INDEX

    +

    IAB index lookup dictionary.

    +
    +
    +
    +
    Value:
    + 
    +{84680704: [(68, 133)],
+ 84680705: [(201, 140)],
+ 84680706: [(341, 172)],
+ 84680707: [(513, 139)],
+ 84680708: [(652, 141)],
+ 84680709: [(793, 144)],
+ 84680710: [(937, 195)],
+ 84680711: [(1132, 166)],
+...
+
    +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.eui-pysrc.html b/docs/api/netaddr.eui-pysrc.html new file mode 100644 index 0000000..6c6948e --- /dev/null +++ b/docs/api/netaddr.eui-pysrc.html @@ -0,0 +1,690 @@ + + + + + netaddr.eui + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package eui + + + + + +
    [frames] | no frames]
    +
    +

    Source Code for Package netaddr.eui

    +
    +  1  #!/usr/bin/env python 
+  2  #----------------------------------------------------------------------------- 
+  3  #   Copyright (c) 2008, David P. D. Moss. All rights reserved. 
+  4  # 
+  5  #   Released under the BSD license. See the LICENSE file for details. 
+  6  #----------------------------------------------------------------------------- 
+  7  """ 
+  8  Provides access to public network address information published by the IEEE. 
+  9   
+ 10  More details can be found at the following URLs :- 
+ 11   
+ 12  Institute of Electrical and Electronics Engineers (IEEE) 
+ 13   
+ 14      - http://www.ieee.org/ 
+ 15      - http://standards.ieee.org/regauth/oui/ 
+ 16  """ 
+ 17   
+ 18  import sys as _sys 
+ 19  import os as _os 
+ 20  import os.path as _path 
+ 21  import csv as _csv 
+ 22   
+ 23  import pprint as _pprint 
+ 24   
+ 25  from netaddr.core import Subscriber, Publisher 
+ 26   
+ 27  #----------------------------------------------------------------------------- 
+ 28  #   Constants. 
+ 29  #----------------------------------------------------------------------------- 
+ 30   
+ 31  #: Path to local copy of IEEE OUI Registry data file. 
+ 32  IEEE_OUI_REGISTRY = _path.join(_path.dirname(__file__), 'oui.txt') 
+ 33  #: Path to netaddr OUI index file. 
+ 34  IEEE_OUI_METADATA = _path.join(_path.dirname(__file__), 'oui.idx') 
+ 35   
+ 36  #: OUI index lookup dictionary. 
+ 37  IEEE_OUI_INDEX = {} 
+ 38   
+ 39  #: Path to local copy of IEEE IAB Registry data file. 
+ 40  IEEE_IAB_REGISTRY = _path.join(_path.dirname(__file__), 'iab.txt') 
+ 41   
+ 42  #: Path to netaddr IAB index file. 
+ 43  IEEE_IAB_METADATA = _path.join(_path.dirname(__file__), 'iab.idx') 
+ 44   
+ 45  #: IAB index lookup dictionary. 
+ 46  IEEE_IAB_INDEX = {} 
+ 47   
+
     48 -class NotRegisteredError(Exception): 
+
     49      """ 
+ 50      An Exception indicating that an OUI or IAB was not found in the IEEE 
+ 51      Registry. 
+ 52      """ 
+ 53      pass 
+
     54   
+ 55  #----------------------------------------------------------------------------- 
+
     56 -class FileIndexer(Subscriber): 
+
     57      """Stores index data found by a parser in a CSV file""" 
+
     58 -    def __init__(self, filename): 
+
     59          """ 
+ 60          Constructor. 
+ 61   
+ 62          filename - location of CSV index file. 
+ 63          """ 
+ 64          self.fh = open(filename, 'w') 
+ 65          self.writer = _csv.writer(self.fh, lineterminator="\n") 
+
     66   
+
     67 -    def update(self, data): 
+
     68          """ 
+ 69          Write received record to a CSV file 
+ 70   
+ 71          @param data: record containing offset record information. 
+ 72          """ 
+ 73          self.writer.writerow(data) 
+
     74   
+ 75  #----------------------------------------------------------------------------- 
+
     76 -class OUIIndexParser(Publisher): 
+
     77      """ 
+ 78      A parser that processes OUI (Organisationally Unique Identifier) 
+ 79      registration file data published by the IEEE. 
+ 80   
+ 81      It sends out notifications to registered subscribers for each record it 
+ 82      encounters, passing on the record's position relative to file start 
+ 83      (offset) and the size of the record (in bytes). 
+ 84   
+ 85      The file is available online here :- 
+ 86   
+ 87      http://standards.ieee.org/regauth/oui/oui.txt 
+ 88   
+ 89      Sample record:: 
+ 90   
+ 91          00-CA-FE   (hex)        ACME CORPORATION 
+ 92          00CAFE     (base 16)        ACME CORPORATION 
+ 93                          1 MAIN STREET 
+ 94                          SPRINGFIELD 
+ 95                          UNITED STATES 
+ 96      """ 
+
     97 -    def __init__(self, filename): 
+
     98          """ 
+ 99          Constructor. 
+100   
+101          filename - location of file containing OUI records. 
+102          """ 
+103          super(OUIIndexParser, self).__init__() 
+104          self.fh = open(filename, 'rb') 
+
    105   
+
    106 -    def parse(self): 
+
    107          """Parse an OUI registration file for records notifying subscribers""" 
+108          skip_header = True 
+109          record = None 
+110          size = 0 
+111   
+112          while True: 
+113              line = self.fh.readline() # unbuffered to obtain correct offsets 
+114   
+115              if not line: 
+116                  break   # EOF, we're done 
+117   
+118              if skip_header and '(hex)' in line: 
+119                  skip_header = False 
+120   
+121              if skip_header: 
+122                  #   ignoring header section 
+123                  continue 
+124   
+125              if '(hex)' in line: 
+126                  #   record start 
+127                  if record is not None: 
+128                      #   a complete record. 
+129                      record.append(size) 
+130                      self.notify(record) 
+131   
+132                  size = len(line) 
+133                  offset = (self.fh.tell() - len(line)) 
+134                  oui = line.split()[0] 
+135                  index = int(oui.replace('-', ''), 16) 
+136                  record = [index, offset] 
+137              else: 
+138                  #   within record 
+139                  size += len(line) 
+140   
+141          #   process final record on loop exit 
+142          record.append(size) 
+143          self.notify(record) 
+
    144   
+145  #----------------------------------------------------------------------------- 
+
    146 -class IABIndexParser(Publisher): 
+
    147      """ 
+148      A parser that processes IAB (Individual Address Block) registration file 
+149      data published by the IEEE. 
+150   
+151      It sends out notifications to registered Subscriber objects for each 
+152      record it encounters, passing on the record's position relative to file 
+153      start (offset) and the size of the record (in bytes). 
+154   
+155      The file is available online here :- 
+156   
+157      http://standards.ieee.org/regauth/iab/iab.txt 
+158   
+159      Sample record:: 
+160   
+161          00-50-C2   (hex)        ACME CORPORATION 
+162          ABC000-ABCFFF     (base 16)        ACME CORPORATION 
+163                          1 MAIN STREET 
+164                          SPRINGFIELD 
+165                          UNITED STATES 
+166      """ 
+
    167 -    def __init__(self, filename): 
+
    168          """ 
+169          Constructor. 
+170   
+171          filename - location of file containing IAB records. 
+172          """ 
+173          super(IABIndexParser, self).__init__() 
+174          self.fh = open(filename, 'rb') 
+
    175   
+
    176 -    def parse(self): 
+
    177          """Parse an IAB registration file for records notifying subscribers""" 
+178          skip_header = True 
+179          record = None 
+180          size = 0 
+181          while True: 
+182              line = self.fh.readline()   # unbuffered 
+183   
+184              if not line: 
+185                  break   # EOF, we're done 
+186   
+187              if skip_header and '(hex)' in line: 
+188                  skip_header = False 
+189   
+190              if skip_header: 
+191                  #   ignoring header section 
+192                  continue 
+193   
+194              if '(hex)' in line: 
+195                  #   record start 
+196                  if record is not None: 
+197                      record.append(size) 
+198                      self.notify(record) 
+199   
+200                  offset = (self.fh.tell() - len(line)) 
+201                  iab_prefix = line.split()[0] 
+202                  index = iab_prefix 
+203                  record = [index, offset] 
+204                  size = len(line) 
+205              elif '(base 16)' in line: 
+206                  #   within record 
+207                  size += len(line) 
+208                  prefix = record[0].replace('-', '') 
+209                  suffix = line.split()[0] 
+210                  suffix = suffix.split('-')[0] 
+211                  record[0] = (int(prefix + suffix, 16)) >> 12 
+212              else: 
+213                  #   within record 
+214                  size += len(line) 
+215   
+216          #   process final record on loop exit 
+217          record.append(size) 
+218          self.notify(record) 
+
    219   
+220  #----------------------------------------------------------------------------- 
+
    221 -class OUI(object): 
+
    222      """ 
+223      Represents an individual IEEE OUI (Organisationally Unique Identifier) 
+224      identifier. 
+225   
+226      For online details see - http://standards.ieee.org/regauth/oui/ 
+227      """ 
+
    228 -    def __init__(self, oui): 
+
    229          """ 
+230          Constructor 
+231   
+232          @param oui: an OUI string C{XX-XX-XX} or a network byte order integer. 
+233              Also accepts and parses full MAC/EUI-48 address strings (but not 
+234              MAC/EUI-48 integers)! 
+235          """ 
+236          self.value = None 
+237          self.records = [] 
+238   
+239          if isinstance(oui, str): 
+240  #FIXME: Improve string parsing here. Accept full MAC/EUI-48 addressse as 
+241  #FIXME: well as XX-XX-XX and just take /16 (see IAB for details)! 
+242              self.value = int(oui.replace('-', ''), 16) 
+243          elif isinstance(oui, (int, long)): 
+244              if 0 <= oui <= 0xffffff: 
+245                  self.value = oui 
+246              else: 
+247                  raise ValueError('OUI int outside expected range: %r' % oui) 
+248          else: 
+249              raise TypeError('unexpected OUI format: %r' % oui) 
+250   
+251          #   Discover offsets. 
+252          if self.value in IEEE_OUI_INDEX: 
+253              fh = open(IEEE_OUI_REGISTRY, 'rb') 
+254              for (offset, size) in IEEE_OUI_INDEX[self.value]: 
+255                  fh.seek(offset) 
+256                  data = fh.read(size) 
+257                  self._parse_data(data, offset, size) 
+258              fh.close() 
+259          else: 
+260              raise NotRegisteredError('OUI %r not registered!' % oui) 
+
    261   
+
    262 -    def _parse_data(self, data, offset, size): 
+
    263          """Returns a dict record from raw OUI record data""" 
+264          record = { 
+265              'idx': 0, 
+266              'oui': '', 
+267              'org': '', 
+268              'address' : [], 
+269              'offset': offset, 
+270              'size': size, 
+271          } 
+272   
+273          for line in data.split("\n"): 
+274              line = line.strip() 
+275              if line == '': 
+276                  continue 
+277   
+278              if '(hex)' in line: 
+279                  record['idx'] = self.value 
+280                  record['org'] = ' '.join(line.split()[2:]) 
+281                  record['oui'] = str(self) 
+282              elif '(base 16)' in line: 
+283                  continue 
+284              else: 
+285                  record['address'].append(line) 
+286   
+287          self.records.append(record) 
+
    288   
+
    289 -    def org_count(self): 
+
    290          """@return: number of organisations with this OUI""" 
+291          return len(self.records) 
+
    292   
+
    293 -    def address(self, index=0): 
+
    294          """ 
+295          @param index: the index of record (multiple registrations) 
+296              (Default: 0 - first registration) 
+297   
+298          @return: registered address of organisation linked to OUI 
+299          """ 
+300          return self.records[index]['address'] 
+
    301   
+
    302 -    def org(self, index=0): 
+
    303          """ 
+304          @param index: the index of record (multiple registrations) 
+305              (Default: 0 - first registration) 
+306   
+307          @return: the name of organisation linked to OUI 
+308          """ 
+309          return self.records[index]['org'] 
+
    310   
+311      organisation = org 
+312   
+
    313 -    def __int__(self): 
+
    314          """@return: integer representation of this OUI""" 
+315          return self.value 
+
    316   
+
    317 -    def __hex__(self): 
+
    318          """@return: network byte order hexadecimal string of this OUI""" 
+319          return hex(self.value).rstrip('L').lower() 
+
    320   
+
    321 -    def __str__(self): 
+
    322          """@return: string representation of this OUI""" 
+323          int_val = self.value 
+324          words = [] 
+325          for _ in range(3): 
+326              word = int_val & 0xff 
+327              words.append('%02x' % word) 
+328              int_val >>= 8 
+329          words.reverse() 
+330          return '-'.join(words).upper() 
+
    331   
+
    332 -    def registration(self): 
+
    333          """@return: registration details for this IAB""" 
+334          return self.records 
+
    335   
+
    336 -    def __repr__(self): 
+
    337          """@return: executable Python string to recreate equivalent object.""" 
+338          return '%s(%r)' % (self.__class__.__name__, str(self)) 
+
    339   
+340  #----------------------------------------------------------------------------- 
+
    341 -class IAB(object): 
+
    342      """ 
+343      Represents an individual IEEE IAB (Individual Address Block) identifier. 
+344   
+345      For online details see - http://standards.ieee.org/regauth/oui/ 
+346      """ 
+
    347 -    def split_iab_mac(eui_int, strict=False): 
+
    348          """ 
+349          @param eui_int: a MAC IAB integer value in network byte order. 
+350   
+351          @param strict: If True, raises a ValueError if the last 12 bits of 
+352              IAB MAC/EUI-48 address are non-zero, ignores them otherwise. 
+353              (Default: False) 
+354          """ 
+355          if 0x50c2000 <= eui_int <= 0x50c2fff: 
+356              return eui_int, 0 
+357   
+358          user_mask = 2 ** 12 - 1 
+359          iab_mask = (2 ** 48 - 1) ^ user_mask 
+360          iab_bits = eui_int >> 12 
+361          user_bits = (eui_int | iab_mask) - iab_mask 
+362   
+363          if 0x50c2000 <= iab_bits <= 0x50c2fff: 
+364              if strict and user_bits != 0: 
+365                  raise ValueError('%r is not a strict IAB!' % hex(user_bits)) 
+366          else: 
+367              raise ValueError('%r is not an IAB address!' % hex(eui_int)) 
+368   
+369          return iab_bits, user_bits 
+
    370   
+371      split_iab_mac = staticmethod(split_iab_mac) 
+372   
+
    373 -    def __init__(self, iab, strict=False): 
+
    374          """ 
+375          Constructor 
+376   
+377          @param iab: an IAB string C{00-50-C2-XX-X0-00} or a network byte order 
+378              integer. This address looks like an EUI-48 but it should not have 
+379              any non-zero bits in the last 3 bytes. 
+380   
+381          @param strict: If True, raises a ValueError if the last 12 bits of 
+382              IAB MAC/EUI-48 address are non-zero, ignores them otherwise. 
+383              (Default: False) 
+384          """ 
+385          self.value = None 
+386          self.record = { 
+387              'idx': 0, 
+388              'iab': '', 
+389              'org': '', 
+390              'address' : [], 
+391              'offset': 0, 
+392              'size': 0, 
+393          } 
+394   
+395          if isinstance(iab, str): 
+396  #FIXME: Improve string parsing here !!! '00-50-C2' is actually invalid. 
+397  #FIXME: Should be '00-50-C2-00-00-00' (i.e. a full MAC/EUI-48) 
+398              int_val = int(iab.replace('-', ''), 16) 
+399              (iab_int, user_int) = IAB.split_iab_mac(int_val, strict) 
+400              self.value = iab_int 
+401          elif isinstance(iab, (int, long)): 
+402              (iab_int, user_int) = IAB.split_iab_mac(iab, strict) 
+403              self.value = iab_int 
+404          else: 
+405              raise TypeError('unexpected IAB format: %r!' % iab) 
+406   
+407          #   Discover offsets. 
+408          if self.value in IEEE_IAB_INDEX: 
+409              fh = open(IEEE_IAB_REGISTRY, 'rb') 
+410              (offset, size) = IEEE_IAB_INDEX[self.value][0] 
+411              self.record['offset'] = offset 
+412              self.record['size'] = size 
+413              fh.seek(offset) 
+414              data = fh.read(size) 
+415              self._parse_data(data, offset, size) 
+416              fh.close() 
+417          else: 
+418              raise NotRegisteredError('IAB %r not unregistered!' % iab) 
+
    419   
+
    420 -    def _parse_data(self, data, offset, size): 
+
    421          """Returns a dict record from raw IAB record data""" 
+422          for line in data.split("\n"): 
+423              line = line.strip() 
+424              if line == '': 
+425                  continue 
+426   
+427              if '(hex)' in line: 
+428                  self.record['idx'] = self.value 
+429                  self.record['org'] = ' '.join(line.split()[2:]) 
+430                  self.record['iab'] = str(self) 
+431              elif '(base 16)' in line: 
+432                  continue 
+433              else: 
+434                  self.record['address'].append(line) 
+
    435   
+
    436 -    def address(self): 
+
    437          """@return: registered address of organisation""" 
+438          return self.record['address'] 
+
    439   
+
    440 -    def org(self): 
+
    441          """@return: the name of organisation""" 
+442          return self.record['org'] 
+
    443   
+444      organisation = org 
+445   
+
    446 -    def __int__(self): 
+
    447          """@return: integer representation of this IAB""" 
+448          return self.value 
+
    449   
+
    450 -    def __hex__(self): 
+
    451          """@return: network byte order hexadecimal string of this IAB""" 
+452          return hex(self.value).rstrip('L').lower() 
+
    453   
+
    454 -    def __str__(self): 
+
    455          """@return: string representation of this IAB""" 
+456          int_val = self.value << 12 
+457          words = [] 
+458          for _ in range(6): 
+459              word = int_val & 0xff 
+460              words.append('%02x' % word) 
+461              int_val >>= 8 
+462          words.reverse() 
+463          return '-'.join(words).upper() 
+
    464   
+
    465 -    def registration(self): 
+
    466          """@return: registration details for this IAB""" 
+467          return self.record 
+
    468   
+
    469 -    def __repr__(self): 
+
    470          """@return: executable Python string to recreate equivalent object.""" 
+471          return '%s(%r)' % (self.__class__.__name__, str(self)) 
+
    472   
+473  #----------------------------------------------------------------------------- 
+
    475      """Create indices for OUI and IAB file based lookups""" 
+476      oui_parser = OUIIndexParser(IEEE_OUI_REGISTRY) 
+477      oui_parser.attach(FileIndexer(IEEE_OUI_METADATA)) 
+478      oui_parser.parse() 
+479   
+480      iab_parser = IABIndexParser(IEEE_IAB_REGISTRY) 
+481      iab_parser.attach(FileIndexer(IEEE_IAB_METADATA)) 
+482      iab_parser.parse() 
+
    483   
+484  #----------------------------------------------------------------------------- 
+
    485 -def load_ieee_indices(): 
+
    486      """Load OUI and IAB indices into memory""" 
+487      for row in _csv.reader(open(IEEE_OUI_METADATA)): 
+488          (key, offset, size) = [int(_) for _ in row] 
+489          IEEE_OUI_INDEX.setdefault(key, []) 
+490          IEEE_OUI_INDEX[key].append((offset, size)) 
+491   
+492      for row in _csv.reader(open(IEEE_IAB_METADATA)): 
+493          (key, offset, size) = [int(_) for _ in row] 
+494          IEEE_IAB_INDEX.setdefault(key, []) 
+495          IEEE_IAB_INDEX[key].append((offset, size)) 
+
    496   
+497  #----------------------------------------------------------------------------- 
+498  if __name__ == '__main__': 
+499      #   Generate indices when module is executed as a script. 
+500      create_ieee_indices() 
+501   
+502  #   On module load read indices in memory to enable lookups. 
+503  load_ieee_indices() 
+504   
+
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:24 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.eui.FileIndexer-class.html b/docs/api/netaddr.eui.FileIndexer-class.html new file mode 100644 index 0000000..706ed2a --- /dev/null +++ b/docs/api/netaddr.eui.FileIndexer-class.html @@ -0,0 +1,262 @@ + + + + + netaddr.eui.FileIndexer + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package eui :: + Class FileIndexer + + + + + +
    [frames] | no frames]
    +
    + +

    Class FileIndexer

    source code

    +
    +     object --+    
+              |    
+core.Subscriber --+
+                  |
+                 FileIndexer
+
    + +
    +

    Stores index data found by a parser in a CSV file

    + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + filename)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    update(self, + data)
    + Write received record to a CSV file    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + filename) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    filename - location of CSV index file.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    update(self, + data) +

    +     		source code  +
    + +

    Write received record to a CSV file

    +
    +
    Parameters:
    +
      +
    • data - record containing offset record information.
      • +
    +
    Overrides: + core.Subscriber.update +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.eui.IAB-class.html b/docs/api/netaddr.eui.IAB-class.html new file mode 100644 index 0000000..ff00ea8 --- /dev/null +++ b/docs/api/netaddr.eui.IAB-class.html @@ -0,0 +1,599 @@ + + + + + netaddr.eui.IAB + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package eui :: + Class IAB + + + + + +
    [frames] | no frames]
    +
    + +

    Class IAB

    source code

    +
    +object --+
+         |
+        IAB
+
    + +
    +

    Represents an individual IEEE IAB (Individual Address Block) + identifier.

    +

    For online details see - http://standards.ieee.org/regauth/oui/

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + iab, + strict=False)
    + Constructor    		 + source code + +
    + +
    +   + + + + + + +
    address(self)
    + Returns: + registered address of organisation    		 + source code + +
    + +
    +   + + + + + + +
    org(self)
    + Returns: + the name of organisation    		 + source code + +
    + +
    +   + + + + + + +
    organisation(self)
    + Returns: + the name of organisation    		 + source code + +
    + +
    +   + + + + + + +
    __int__(self)
    + Returns: + integer representation of this IAB    		 + source code + +
    + +
    +   + + + + + + +
    __hex__(self)
    + Returns: + network byte order hexadecimal string of this IAB    		 + source code + +
    + +
    +   + + + + + + +
    __str__(self)
    + Returns: + string representation of this IAB    		 + source code + +
    + +
    +   + + + + + + +
    registration(self)
    + Returns: + registration details for this IAB    		 + source code + +
    + +
    +   + + + + + + +
    __repr__(self)
    + Returns: + executable Python string to recreate equivalent object.    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __setattr__ +

    +
    + + + + + + + + + +
    + Static Methods
    +   + + + + + + +
    split_iab_mac(eui_int, + strict=False) + source code + +
    + +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    split_iab_mac(eui_int, + strict=False) +
    Static Method +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • eui_int - a MAC IAB integer value in network byte order.
      • +
    • strict - If True, raises a ValueError if the last 12 bits of IAB + MAC/EUI-48 address are non-zero, ignores them otherwise. + (Default: False)
      • +
    +
    +
    +
    + +
    + +
    + + +
    +

    __init__(self, + iab, + strict=False) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor

    +
    +
    Parameters:
    +
      +
    • iab - an IAB string 00-50-C2-XX-X0-00 or a network byte + order integer. This address looks like an EUI-48 but it should + not have any non-zero bits in the last 3 bytes.
      • +
    • strict - If True, raises a ValueError if the last 12 bits of IAB + MAC/EUI-48 address are non-zero, ignores them otherwise. + (Default: False)
      • +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    address(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    registered address of organisation
    +
    +
    +
    + +
    + +
    + + +
    +

    org(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    the name of organisation
    +
    +
    +
    + +
    + +
    + + +
    +

    organisation(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    the name of organisation
    +
    +
    +
    + +
    + +
    + + +
    +

    __int__(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    integer representation of this IAB
    +
    +
    +
    + +
    + +
    + + +
    +

    __hex__(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    network byte order hexadecimal string of this IAB
    +
    +
    +
    + +
    + +
    + + +
    +

    __str__(self) +
    (Informal representation operator) +

    +     		source code  +
    + +

    str(x)

    +
    +
    Returns:
    +
    string representation of this IAB
    +
    Overrides: + object.__str__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    registration(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    registration details for this IAB
    +
    +
    +
    + +
    + +
    + + +
    +

    __repr__(self) +
    (Representation operator) +

    +     		source code  +
    + +

    repr(x)

    +
    +
    Returns:
    +
    executable Python string to recreate equivalent object.
    +
    Overrides: + object.__repr__ +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.eui.IABIndexParser-class.html b/docs/api/netaddr.eui.IABIndexParser-class.html new file mode 100644 index 0000000..0fb8662 --- /dev/null +++ b/docs/api/netaddr.eui.IABIndexParser-class.html @@ -0,0 +1,253 @@ + + + + + netaddr.eui.IABIndexParser + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package eui :: + Class IABIndexParser + + + + + +
    [frames] | no frames]
    +
    + +

    Class IABIndexParser

    source code

    +
    +    object --+    
+             |    
+core.Publisher --+
+                 |
+                IABIndexParser
+
    + +
    +

    A parser that processes IAB (Individual Address Block) registration + file data published by the IEEE.

    +

    It sends out notifications to registered Subscriber objects for each + record it encounters, passing on the record's position relative to file + start (offset) and the size of the record (in bytes).

    +

    The file is available online here :-

    +

    http://standards.ieee.org/regauth/iab/iab.txt

    +

    Sample record:

    +
    +   00-50-C2   (hex)        ACME CORPORATION
+   ABC000-ABCFFF     (base 16)        ACME CORPORATION
+                   1 MAIN STREET
+                   SPRINGFIELD
+                   UNITED STATES
+
    + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + filename)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    parse(self)
    + Parse an IAB registration file for records notifying subscribers    		 + source code + +
    + +
    +

    Inherited from core.Publisher: + attach, + detach, + notify +

    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + filename) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    filename - location of file containing IAB records.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.eui.NotRegisteredError-class.html b/docs/api/netaddr.eui.NotRegisteredError-class.html new file mode 100644 index 0000000..389bd7b --- /dev/null +++ b/docs/api/netaddr.eui.NotRegisteredError-class.html @@ -0,0 +1,179 @@ + + + + + netaddr.eui.NotRegisteredError + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package eui :: + Class NotRegisteredError + + + + + +
    [frames] | no frames]
    +
    + +

    Class NotRegisteredError

    source code

    +
    +              object --+        
+                       |        
+exceptions.BaseException --+    
+                           |    
+        exceptions.Exception --+
+                               |
+                              NotRegisteredError
+
    + +
    +

    An Exception indicating that an OUI or IAB was not found in the IEEE + Registry.

    + + + + + + + + + + +
    + Instance Methods
    +

    Inherited from exceptions.Exception: + __init__, + __new__ +

    +

    Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__, + __str__ +

    +

    Inherited from object: + __hash__, + __reduce_ex__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from exceptions.BaseException: + args, + message +

    +

    Inherited from object: + __class__ +

    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.eui.OUI-class.html b/docs/api/netaddr.eui.OUI-class.html new file mode 100644 index 0000000..6bb1cd7 --- /dev/null +++ b/docs/api/netaddr.eui.OUI-class.html @@ -0,0 +1,600 @@ + + + + + netaddr.eui.OUI + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package eui :: + Class OUI + + + + + +
    [frames] | no frames]
    +
    + +

    Class OUI

    source code

    +
    +object --+
+         |
+        OUI
+
    + +
    +

    Represents an individual IEEE OUI (Organisationally Unique Identifier) + identifier.

    +

    For online details see - http://standards.ieee.org/regauth/oui/

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + oui)
    + Constructor    		 + source code + +
    + +
    +   + + + + + + +
    org_count(self)
    + Returns: + number of organisations with this OUI    		 + source code + +
    + +
    +   + + + + + + +
    address(self, + index=0)
    + Returns: + registered address of organisation linked to OUI    		 + source code + +
    + +
    +   + + + + + + +
    org(self, + index=0)
    + Returns: + the name of organisation linked to OUI    		 + source code + +
    + +
    +   + + + + + + +
    organisation(self, + index=0)
    + Returns: + the name of organisation linked to OUI    		 + source code + +
    + +
    +   + + + + + + +
    __int__(self)
    + Returns: + integer representation of this OUI    		 + source code + +
    + +
    +   + + + + + + +
    __hex__(self)
    + Returns: + network byte order hexadecimal string of this OUI    		 + source code + +
    + +
    +   + + + + + + +
    __str__(self)
    + Returns: + string representation of this OUI    		 + source code + +
    + +
    +   + + + + + + +
    registration(self)
    + Returns: + registration details for this IAB    		 + source code + +
    + +
    +   + + + + + + +
    __repr__(self)
    + Returns: + executable Python string to recreate equivalent object.    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __setattr__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + oui) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor

    +
    +
    Parameters:
    +
      +
    • oui - an OUI string XX-XX-XX or a network byte order + integer. Also accepts and parses full MAC/EUI-48 address strings + (but not MAC/EUI-48 integers)!
      • +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    org_count(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    number of organisations with this OUI
    +
    +
    +
    + +
    + +
    + + +
    +

    address(self, + index=0) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • index - the index of record (multiple registrations) (Default: 0 - first + registration)
      • +
    +
    Returns:
    +
    registered address of organisation linked to OUI
    +
    +
    +
    + +
    + +
    + + +
    +

    org(self, + index=0) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • index - the index of record (multiple registrations) (Default: 0 - first + registration)
      • +
    +
    Returns:
    +
    the name of organisation linked to OUI
    +
    +
    +
    + +
    + +
    + + +
    +

    organisation(self, + index=0) +

    +     		source code  +
    + + +
    +
    Parameters:
    +
      +
    • index - the index of record (multiple registrations) (Default: 0 - first + registration)
      • +
    +
    Returns:
    +
    the name of organisation linked to OUI
    +
    +
    +
    + +
    + +
    + + +
    +

    __int__(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    integer representation of this OUI
    +
    +
    +
    + +
    + +
    + + +
    +

    __hex__(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    network byte order hexadecimal string of this OUI
    +
    +
    +
    + +
    + +
    + + +
    +

    __str__(self) +
    (Informal representation operator) +

    +     		source code  +
    + +

    str(x)

    +
    +
    Returns:
    +
    string representation of this OUI
    +
    Overrides: + object.__str__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    registration(self) +

    +     		source code  +
    + + +
    +
    Returns:
    +
    registration details for this IAB
    +
    +
    +
    + +
    + +
    + + +
    +

    __repr__(self) +
    (Representation operator) +

    +     		source code  +
    + +

    repr(x)

    +
    +
    Returns:
    +
    executable Python string to recreate equivalent object.
    +
    Overrides: + object.__repr__ +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.eui.OUIIndexParser-class.html b/docs/api/netaddr.eui.OUIIndexParser-class.html new file mode 100644 index 0000000..58f10fe --- /dev/null +++ b/docs/api/netaddr.eui.OUIIndexParser-class.html @@ -0,0 +1,253 @@ + + + + + netaddr.eui.OUIIndexParser + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package eui :: + Class OUIIndexParser + + + + + +
    [frames] | no frames]
    +
    + +

    Class OUIIndexParser

    source code

    +
    +    object --+    
+             |    
+core.Publisher --+
+                 |
+                OUIIndexParser
+
    + +
    +

    A parser that processes OUI (Organisationally Unique Identifier) + registration file data published by the IEEE.

    +

    It sends out notifications to registered subscribers for each record + it encounters, passing on the record's position relative to file start + (offset) and the size of the record (in bytes).

    +

    The file is available online here :-

    +

    http://standards.ieee.org/regauth/oui/oui.txt

    +

    Sample record:

    +
    +   00-CA-FE   (hex)        ACME CORPORATION
+   00CAFE     (base 16)        ACME CORPORATION
+                   1 MAIN STREET
+                   SPRINGFIELD
+                   UNITED STATES
+
    + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + filename)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    parse(self)
    + Parse an OUI registration file for records notifying subscribers    		 + source code + +
    + +
    +

    Inherited from core.Publisher: + attach, + detach, + notify +

    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + filename) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    filename - location of file containing OUI records.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.ip-module.html b/docs/api/netaddr.ip-module.html new file mode 100644 index 0000000..078ceb6 --- /dev/null +++ b/docs/api/netaddr.ip-module.html @@ -0,0 +1,284 @@ + + + + + netaddr.ip + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package ip + + + + + +
    [frames] | no frames]
    +
    + +

    Package ip

    source code

    +

    Provides access to public network address information published by + IANA.

    +

    More details can be found at the following URLs :-

    +

    Internet Assigned Numbers Authority (IANA)

    +
      +
    • + http://www.iana.org/ +
      • +
    • + http://www.iana.org/protocols/ +
      • +
    + + + + + + + + + + + + + + + + + + + + + + +
    + Classes
    +   + + LineRecordParser
    + A configurable Parser that understands how to parse line based + records. +
    +   + + IPv4Parser
    + A LineRecordParser that understands how to parse and retrieve data + records from the IANA IPv4 address space file. +
    +   + + IPv6Parser
    + A LineRecordParser that understands how to parse and retrieve data + records from the IANA IPv6 address space file. +
    +   + + MulticastParser
    + A LineParser that knows how to process the IANA IPv4 multicast + address allocation file. +
    +   + + DictUpdater
    + Concrete Subscriber that inserts records received from a Publisher + into a dictionary. +
    + + + + + + + + + + + + +
    + Functions
    +   + + + + + + +
    load_iana_info()
    + Parse and load internal IANA data lookups with the latest information + from data files.    		 + source code + +
    + +
    +   + + + + + + +
    query(ip_addr)
    + Returns informational data specific to this IP address.    		 + source code + +
    + +
    + + + + + + + + + +
    + Variables
    +   + + IANA_INFO = {'IPv4': {CIDR('0.0.0.0/8'): {'date': '1981-09', '...
    + Topic based lookup dictionary for IANA information. +
    + + + + + + +
    + Variables Details
    + +
    + +
    +

    IANA_INFO

    +

    Topic based lookup dictionary for IANA information.

    +
    +
    +
    +
    Value:
    + 
    +{'IPv4': {CIDR('0.0.0.0/8'): {'date': '1981-09',
+                              'designation': 'IANA - Local Identificat\
+ion',
+                              'prefix': '0/8',
+                              'status': 'Reserved',
+                              'whois': ''},
+          CIDR('1.0.0.0/8'): {'date': '',
+                              'designation': 'IANA',
+...
+
    +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.ip-pysrc.html b/docs/api/netaddr.ip-pysrc.html new file mode 100644 index 0000000..be1c419 --- /dev/null +++ b/docs/api/netaddr.ip-pysrc.html @@ -0,0 +1,637 @@ + + + + + netaddr.ip + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package ip + + + + + +
    [frames] | no frames]
    +
    +

    Source Code for Package netaddr.ip

    +
    +  1  #!/usr/bin/env python
 
+  2  #-----------------------------------------------------------------------------
 
+  3  #   Copyright (c) 2008, David P. D. Moss. All rights reserved.
 
+  4  #
 
+  5  #   Released under the BSD license. See the LICENSE file for details.
 
+  6  #-----------------------------------------------------------------------------
 
+  7  """
 
+  8  Provides access to public network address information published by IANA.
 
+  9  
 
+ 10  More details can be found at the following URLs :-
 
+ 11  
 
+ 12  Internet Assigned Numbers Authority (IANA)
 
+ 13   
+ 14      - http://www.iana.org/
 
+ 15      - http://www.iana.org/protocols/ 
+ 16  """ 
+ 17   
+ 18  import os as _os 
+ 19  import os.path as _path 
+ 20  import re as _re 
+ 21  
 
+ 22  from netaddr.core import Publisher, Subscriber, PrettyPrinter 
+ 23  from netaddr import AT_INET, AT_INET6 
+ 24  from netaddr.address import CIDR, IPRange 
+ 25   
+ 26  #----------------------------------------------------------------------------- 
+ 27   
+ 28  #: Topic based lookup dictionary for IANA information. 
+ 29  IANA_INFO = { 
+ 30      'IPv4'      : {}, 
+ 31      'IPv6'      : {}, 
+ 32      'multicast' : {}, 
+ 33  } 
+ 34  
 
+ 35  #-----------------------------------------------------------------------------
 
+
     36 -class LineRecordParser(Publisher): 
+
     37      """
 
+ 38      A configurable Parser that understands how to parse line based records.
 
+ 39      """ 
+
     40 -    def __init__(self, fh, **kwargs): 
+
     41          """
 
+ 42          Constructor.
 
+ 43  
 
+ 44          fh - a valid, open file handle to line based record data.
 
+ 45          """ 
+ 46          super(LineRecordParser, self).__init__() 
+ 47          self.fh = fh 
+ 48  
 
+ 49          self.__dict__.update(kwargs) 
+ 50  
 
+ 51          #   Regex used to identify start of lines of interest.
 
+ 52          if 're_start' not in self.__dict__: 
+ 53              self.re_start = r'^.*$' 
+ 54  
 
+ 55          #   Regex used to identify line to be parsed within block of interest.
 
+ 56          if 're_parse_line' not in self.__dict__: 
+ 57              self.re_parse_line = r'^.*$' 
+ 58  
 
+ 59          #   Regex used to identify end of lines of interest.
 
+ 60          if 're_stop' not in self.__dict__: 
+ 61              self.re_stop = r'^.*$' 
+ 62  
 
+ 63          #   If enabled, skips blank lines after being stripped.
 
+ 64          if 'skip_blank_lines' not in self.__dict__: 
+ 65              self.skip_blank_lines = False 
+
     66  
 
+
     67 -    def parse_line(self, line): 
+
     68          """
 
+ 69          This is the callback method invoked for every line considered valid by
 
+ 70          the line parser's settings. It is usually over-ridden by base classes
 
+ 71          to provide specific line parsing and line skipping logic.
 
+ 72  
 
+ 73          Any line can be vetoed (not passed to registered Subscriber objects)
 
+ 74          by simply returning None.
 
+ 75          """ 
+ 76          return line 
+
     77  
 
+
     78 -    def parse(self): 
+
     79          """
 
+ 80          Parse and normalises records, notifying registered subscribers with
 
+ 81          record data as it is encountered.
 
+ 82          """ 
+ 83          record = None 
+ 84          section_start = False 
+ 85          section_end = False 
+ 86  
 
+ 87          for line in self.fh: 
+ 88              line = line.strip() 
+ 89  
 
+ 90              #   Skip blank lines if required.
 
+ 91              if self.skip_blank_lines and line == '': 
+ 92                  continue 
+ 93  
 
+ 94              #   Entered record section.
 
+ 95              if not section_start and len(_re.findall(self.re_start, line)) > 0: 
+ 96                  section_start = True 
+ 97  
 
+ 98              #   Exited record section.
 
+ 99              if section_start and len(_re.findall(self.re_stop, line)) > 0: 
+100                  section_end = True 
+101  
 
+102              #   Stop parsing.
 
+103              if section_end: 
+104                  break 
+105  
 
+106              #   Is this a line of interest?
 
+107              if section_start and len(_re.findall(self.re_parse_line, line)) == 0: 
+108                  continue 
+109  
 
+110              if section_start: 
+111                  record = self.parse_line(line) 
+112  
 
+113                  #   notify subscribers of final record details.
 
+114                  self.notify(record) 
+
    115  
 
+116  #-----------------------------------------------------------------------------
 
+
    117 -class IPv4Parser(LineRecordParser): 
+
    118      """
 
+119      A LineRecordParser that understands how to parse and retrieve data records
 
+120      from the IANA IPv4 address space file.
 
+121  
 
+122      It can be found online here :-
 
+123  
 
+124      http://www.iana.org/assignments/ipv4-address-space
 
+125      """ 
+
    126 -    def __init__(self, fh, **kwargs): 
+
    127          """
 
+128          Constructor.
 
+129  
 
+130          fh - a valid, open file handle to an OUI Registry data file.
 
+131  
 
+132          kwargs - additional parser options.
 
+133  
 
+134          """ 
+135          super(IPv4Parser, self).__init__(fh,
 
+136              re_start=r'^Prefix',
 
+137              re_parse_line=r'^\d{3}\/\d',
 
+138              re_stop=r'^Notes\s*$',
 
+139              skip_blank_lines=True,
 
+140          ) 
+141  
 
+142          self.record_widths = (
 
+143              ('prefix', 0, 8),
 
+144              ('designation', 8, 37),
 
+145              ('date', 45, 10),
 
+146              ('whois', 55, 20),
 
+147              ('status', 75, 19),
 
+148          ) 
+
    149  
 
+
    150 -    def parse_line(self, line): 
+
    151          """
 
+152          Callback method invoked for every line considered valid by the line
 
+153          parser's settings.
 
+154  
 
+155          See base class method for more details.
 
+156          """ 
+157          record = {} 
+158          for (key, start, width) in self.record_widths: 
+159              value = line[start:start+width] 
+160              record[key] = value.strip() 
+161  
 
+162          #   Strip leading zeros from octet.
 
+163          if '/' in record['prefix']: 
+164              (octet, prefix) = record['prefix'].split('/') 
+165              record['prefix'] = "%d/%d" % (int(octet), int(prefix)) 
+166  
 
+167          record['status'] = record['status'].capitalize() 
+168  
 
+169          return record 
+
    170  
 
+171  #-----------------------------------------------------------------------------
 
+
    172 -class IPv6Parser(LineRecordParser): 
+
    173      """
 
+174      A LineRecordParser that understands how to parse and retrieve data records
 
+175      from the IANA IPv6 address space file.
 
+176  
 
+177      It can be found online here :-
 
+178  
 
+179      http://www.iana.org/assignments/ipv6-address-space
 
+180      """ 
+
    181 -    def __init__(self, fh, **kwargs): 
+
    182          """
 
+183          Constructor.
 
+184  
 
+185          fh - a valid, open file handle to an OUI Registry data file.
 
+186  
 
+187          kwargs - additional parser options.
 
+188  
 
+189          """ 
+190          super(IPv6Parser, self).__init__(fh,
 
+191          re_start=r'^IPv6 Prefix',
 
+192          re_parse_line=r'^[A-F0-9]+::\/\d+',
 
+193          re_stop=r'^Notes:\s*$',
 
+194              skip_blank_lines=True) 
+195  
 
+196          self.record_widths = (
 
+197              ('prefix', 0, 22),
 
+198              ('allocation', 22, 24),
 
+199              ('reference', 46, 15)) 
+
    200  
 
+
    201 -    def parse_line(self, line): 
+
    202          """
 
+203          Callback method invoked for every line considered valid by the line
 
+204          parser's settings.
 
+205  
 
+206          See base class method for more details.
 
+207          """ 
+208          record = {} 
+209          for (key, start, width) in self.record_widths: 
+210              value = line[start:start+width] 
+211              record[key] = value.strip() 
+212  
 
+213              #   Remove square brackets from reference field.
 
+214              record[key] = record[key].lstrip('[') 
+215              record[key] = record[key].rstrip(']') 
+216          return record 
+
    217  
 
+218  #-----------------------------------------------------------------------------
 
+
    219 -class MulticastParser(LineRecordParser): 
+
    220      """
 
+221      A LineParser that knows how to process the IANA IPv4 multicast address
 
+222      allocation file.
 
+223  
 
+224      It can be found online here :-
 
+225  
 
+226      http://www.iana.org/assignments/multicast-addresses
 
+227      """ 
+
    228 -    def __init__(self, fh, **kwargs): 
+
    229          """
 
+230          Constructor.
 
+231  
 
+232          fh - a valid, open file handle to an OUI Registry data file.
 
+233  
 
+234          kwargs - additional parser options.
 
+235  
 
+236          """ 
+237          super(MulticastParser, self).__init__(fh,
 
+238          re_start=r'^Registry:',
 
+239          re_parse_line=r'^\d+\.\d+\.\d+\.\d+',
 
+240          re_stop=r'^Relative',
 
+241              skip_blank_lines=True) 
+
    242  
 
+
    243 -    def normalise_addr(self, addr): 
+
    244          """
 
+245          Removes variations from address entries found in this particular file.
 
+246          """ 
+247          if '-' in addr: 
+248              (a1, a2) = addr.split('-') 
+249              o1 = a1.strip().split('.') 
+250              o2 = a2.strip().split('.') 
+251              return "%s-%s" % ('.'.join([str(int(i)) for i in o1]),
 
+252                                '.'.join([str(int(i)) for i in o2])) 
+253          else: 
+254              o1 = addr.strip().split('.') 
+255              return '.'.join([str(int(i)) for i in o1]) 
+
    256  
 
+
    257 -    def parse_line(self, line): 
+
    258          """
 
+259          Callback method invoked for every line considered valid by the line
 
+260          parser's settings.
 
+261  
 
+262          See base class method for more details.
 
+263          """ 
+264          index = line.find('[') 
+265          if index != -1: 
+266              line = line[0:index].strip() 
+267          (addr, descr) = [i.strip() for i in _re.findall(
 
+268              r'^([\d.]+(?:\s*-\s*[\d.]+)?)\s+(.+)$', line)[0]] 
+269          addr = self.normalise_addr(addr) 
+270          descr = ' '.join(descr.split()) 
+271          descr = descr.replace('Date registered' , '').rstrip() 
+272   
+273          return dict(address=addr, descr=descr) 
+
    274  
 
+275  #----------------------------------------------------------------------------- 
+
    276 -class DictUpdater(Subscriber): 
+
    277      """ 
+278      Concrete Subscriber that inserts records received from a Publisher into a 
+279      dictionary. 
+280      """ 
+
    281 -    def __init__(self, dct, topic, unique_key): 
+
    282          """ 
+283          Constructor. 
+284   
+285          dct - lookup dict or dict like object to insert records into. 
+286   
+287          topic - high-level category name of data to be processed. 
+288   
+289          unique_key - key name in data dict that uniquely identifies it. 
+290          """ 
+291          self.dct = dct 
+292          self.topic = topic 
+293          self.unique_key = unique_key 
+
    294   
+
    295 -    def update(self, data): 
+
    296          """ 
+297          Callback function used by Publisher to notify this Subscriber about 
+298          an update. Stores topic based information into dictionary passed to 
+299          constructor. 
+300          """ 
+301          data_id = data[self.unique_key] 
+302   
+303          if self.topic == 'IPv4': 
+304              cidr = CIDR(data_id) 
+305              self.dct[cidr] = data 
+306          elif self.topic == 'IPv6': 
+307              cidr = CIDR(data_id) 
+308              self.dct[cidr] = data 
+309          elif self.topic == 'multicast': 
+310              iprange = None 
+311              if '-' in data_id: 
+312                  (first, last) = data_id.split('-') 
+313                  iprange = IPRange(first, last) 
+314              else: 
+315                  iprange = IPRange(data_id, data_id) 
+316              self.dct[iprange] = data 
+
    317   
+318  #----------------------------------------------------------------------------- 
+
    319 -def load_iana_info(): 
+
    320      """ 
+321      Parse and load internal IANA data lookups with the latest information from 
+322      data files. 
+323      """ 
+324      PATH = _path.dirname(__file__) 
+325   
+326      ipv4 = IPv4Parser(open(_path.join(PATH, 'ipv4-address-space'))) 
+327      ipv4.attach(DictUpdater(IANA_INFO['IPv4'], 'IPv4', 'prefix')) 
+328      ipv4.parse() 
+329   
+330      ipv6 = IPv6Parser(open(_path.join(PATH, 'ipv6-address-space'))) 
+331      ipv6.attach(DictUpdater(IANA_INFO['IPv6'], 'IPv6', 'prefix')) 
+332      ipv6.parse() 
+333   
+334      mcast = MulticastParser(open(_path.join(PATH, 'multicast-addresses'))) 
+335      mcast.attach(DictUpdater(IANA_INFO['multicast'], 'multicast', 'address')) 
+336      mcast.parse() 
+
    337   
+338  #----------------------------------------------------------------------------- 
+
    339 -def query(ip_addr): 
+
    340      """ 
+341      Returns informational data specific to this IP address. 
+342      """ 
+343      info = {} 
+344   
+345      if ip_addr.addr_type == AT_INET: 
+346          for cidr, record in IANA_INFO['IPv4'].items(): 
+347              if ip_addr in cidr: 
+348                  info.setdefault('IPv4', []) 
+349                  info['IPv4'].append(record) 
+350   
+351          if ip_addr.is_multicast(): 
+352              for iprange, record in IANA_INFO['multicast'].items(): 
+353                  if ip_addr in iprange: 
+354                      info.setdefault('Multicast', []) 
+355                      info['Multicast'].append(record) 
+356   
+357      elif ip_addr.addr_type == AT_INET6: 
+358          for cidr, record in IANA_INFO['IPv6'].items(): 
+359              if ip_addr in cidr: 
+360                  info.setdefault('IPv6', []) 
+361                  info['IPv6'].append(record) 
+362   
+363      return info 
+
    364   
+365  #   On module import, read IANA data files and populate lookups dict. 
+366  load_iana_info() 
+367   
+
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:24 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.ip.DictUpdater-class.html b/docs/api/netaddr.ip.DictUpdater-class.html new file mode 100644 index 0000000..040f809 --- /dev/null +++ b/docs/api/netaddr.ip.DictUpdater-class.html @@ -0,0 +1,268 @@ + + + + + netaddr.ip.DictUpdater + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package ip :: + Class DictUpdater + + + + + +
    [frames] | no frames]
    +
    + +

    Class DictUpdater

    source code

    +
    +     object --+    
+              |    
+core.Subscriber --+
+                  |
+                 DictUpdater
+
    + +
    +

    Concrete Subscriber that inserts records received from a Publisher + into a dictionary.

    + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + dct, + topic, + unique_key)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    update(self, + data)
    + Callback function used by Publisher to notify this Subscriber about + an update.    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + dct, + topic, + unique_key) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    dct - lookup dict or dict like object to insert records into.

    +

    topic - high-level category name of data to be processed.

    +

    unique_key - key name in data dict that uniquely identifies it.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    update(self, + data) +

    +     		source code  +
    + +

    Callback function used by Publisher to notify this Subscriber about an + update. Stores topic based information into dictionary passed to + constructor.

    +
    +
    Overrides: + core.Subscriber.update +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.ip.IPv4Parser-class.html b/docs/api/netaddr.ip.IPv4Parser-class.html new file mode 100644 index 0000000..f573127 --- /dev/null +++ b/docs/api/netaddr.ip.IPv4Parser-class.html @@ -0,0 +1,277 @@ + + + + + netaddr.ip.IPv4Parser + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package ip :: + Class IPv4Parser + + + + + +
    [frames] | no frames]
    +
    + +

    Class IPv4Parser

    source code

    +
    +    object --+        
+             |        
+core.Publisher --+    
+                 |    
+  LineRecordParser --+
+                     |
+                    IPv4Parser
+
    + +
    +

    A LineRecordParser that understands how to parse and retrieve data + records from the IANA IPv4 address space file.

    +

    It can be found online here :-

    +

    http://www.iana.org/assignments/ipv4-address-space

    + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + fh, + **kwargs)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    parse_line(self, + line)
    + Callback method invoked for every line considered valid by the line + parser's settings.    		 + source code + +
    + +
    +

    Inherited from LineRecordParser: + parse +

    +

    Inherited from core.Publisher: + attach, + detach, + notify +

    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + fh, + **kwargs) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    fh - a valid, open file handle to an OUI Registry data file.

    +

    kwargs - additional parser options.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    parse_line(self, + line) +

    +     		source code  +
    + +

    Callback method invoked for every line considered valid by the line + parser's settings.

    +

    See base class method for more details.

    +
    +
    Overrides: + LineRecordParser.parse_line +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.ip.IPv6Parser-class.html b/docs/api/netaddr.ip.IPv6Parser-class.html new file mode 100644 index 0000000..85e1e6e --- /dev/null +++ b/docs/api/netaddr.ip.IPv6Parser-class.html @@ -0,0 +1,277 @@ + + + + + netaddr.ip.IPv6Parser + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package ip :: + Class IPv6Parser + + + + + +
    [frames] | no frames]
    +
    + +

    Class IPv6Parser

    source code

    +
    +    object --+        
+             |        
+core.Publisher --+    
+                 |    
+  LineRecordParser --+
+                     |
+                    IPv6Parser
+
    + +
    +

    A LineRecordParser that understands how to parse and retrieve data + records from the IANA IPv6 address space file.

    +

    It can be found online here :-

    +

    http://www.iana.org/assignments/ipv6-address-space

    + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + fh, + **kwargs)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    parse_line(self, + line)
    + Callback method invoked for every line considered valid by the line + parser's settings.    		 + source code + +
    + +
    +

    Inherited from LineRecordParser: + parse +

    +

    Inherited from core.Publisher: + attach, + detach, + notify +

    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + fh, + **kwargs) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    fh - a valid, open file handle to an OUI Registry data file.

    +

    kwargs - additional parser options.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    parse_line(self, + line) +

    +     		source code  +
    + +

    Callback method invoked for every line considered valid by the line + parser's settings.

    +

    See base class method for more details.

    +
    +
    Overrides: + LineRecordParser.parse_line +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.ip.LineRecordParser-class.html b/docs/api/netaddr.ip.LineRecordParser-class.html new file mode 100644 index 0000000..5128f2c --- /dev/null +++ b/docs/api/netaddr.ip.LineRecordParser-class.html @@ -0,0 +1,292 @@ + + + + + netaddr.ip.LineRecordParser + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package ip :: + Class LineRecordParser + + + + + +
    [frames] | no frames]
    +
    + +

    Class LineRecordParser

    source code

    +
    +    object --+    
+             |    
+core.Publisher --+
+                 |
+                LineRecordParser
+
    + +
    Known Subclasses:
    +
    + +
    + +
    +

    A configurable Parser that understands how to parse line based + records.

    + + + + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + fh, + **kwargs)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    parse_line(self, + line)
    + This is the callback method invoked for every line considered valid + by the line parser's settings.    		 + source code + +
    + +
    +   + + + + + + +
    parse(self)
    + Parse and normalises records, notifying registered subscribers with + record data as it is encountered.    		 + source code + +
    + +
    +

    Inherited from core.Publisher: + attach, + detach, + notify +

    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + fh, + **kwargs) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    fh - a valid, open file handle to line based record data.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    parse_line(self, + line) +

    +     		source code  +
    + +

    This is the callback method invoked for every line considered valid by + the line parser's settings. It is usually over-ridden by base classes to + provide specific line parsing and line skipping logic.

    +

    Any line can be vetoed (not passed to registered Subscriber objects) + by simply returning None.

    +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.ip.MulticastParser-class.html b/docs/api/netaddr.ip.MulticastParser-class.html new file mode 100644 index 0000000..b9bc6cf --- /dev/null +++ b/docs/api/netaddr.ip.MulticastParser-class.html @@ -0,0 +1,296 @@ + + + + + netaddr.ip.MulticastParser + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Package ip :: + Class MulticastParser + + + + + +
    [frames] | no frames]
    +
    + +

    Class MulticastParser

    source code

    +
    +    object --+        
+             |        
+core.Publisher --+    
+                 |    
+  LineRecordParser --+
+                     |
+                    MulticastParser
+
    + +
    +

    A LineParser that knows how to process the IANA IPv4 multicast address + allocation file.

    +

    It can be found online here :-

    +

    http://www.iana.org/assignments/multicast-addresses

    + + + + + + + + + + + + + + + + + + + +
    + Instance Methods
    +   + + + + + + +
    __init__(self, + fh, + **kwargs)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    normalise_addr(self, + addr)
    + Removes variations from address entries found in this particular + file.    		 + source code + +
    + +
    +   + + + + + + +
    parse_line(self, + line)
    + Callback method invoked for every line considered valid by the line + parser's settings.    		 + source code + +
    + +
    +

    Inherited from LineRecordParser: + parse +

    +

    Inherited from core.Publisher: + attach, + detach, + notify +

    +

    Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

    +
    + + + + + + + + + +
    + Properties
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + Method Details
    + +
    + +
    + + +
    +

    __init__(self, + fh, + **kwargs) +
    (Constructor) +

    +     		source code  +
    + +

    Constructor.

    +

    fh - a valid, open file handle to an OUI Registry data file.

    +

    kwargs - additional parser options.

    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    parse_line(self, + line) +

    +     		source code  +
    + +

    Callback method invoked for every line considered valid by the line + parser's settings.

    +

    See base class method for more details.

    +
    +
    Overrides: + LineRecordParser.parse_line +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.misc-module.html b/docs/api/netaddr.misc-module.html new file mode 100644 index 0000000..8073db4 --- /dev/null +++ b/docs/api/netaddr.misc-module.html @@ -0,0 +1,196 @@ + + + + + netaddr.misc + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module misc + + + + + +
    [frames] | no frames]
    +
    + +

    Module misc

    source code

    +

    Miscellanous functions and classes. Do not rely on anything in here as + it is liable to change, move or be deleted with each release.

    + + + + + + + + + + + + + + + + + + + +
    + Functions
    +   + + + + + + +
    ipv4_cidr_prefixes()
    + Returns a recordset (list of dicts) of host/network breakdown for + IPv4 using all of the various CIDR prefixes.    		 + source code + +
    + +
    +   + + + + + + +
    ipv6_cidr_prefixes()
    + Returns a recordset (list of dicts) of host/network breakdown for + IPv6 using all of the various CIDR prefixes.    		 + source code + +
    + +
    +   + + + + + + +
    print_ipv4_cidr_prefixes()
    + Prints a table to stdout of host/network breakdown for IPv4 using + CIDR notation.    		 + source code + +
    + +
    +   + + + + + + +
    print_ipv6_cidr_prefixes()
    + Prints a table to stdout of host/network breakdown for IPv6 using + CIDR notation.    		 + source code + +
    + +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.misc-pysrc.html b/docs/api/netaddr.misc-pysrc.html new file mode 100644 index 0000000..38526f7 --- /dev/null +++ b/docs/api/netaddr.misc-pysrc.html @@ -0,0 +1,194 @@ + + + + + netaddr.misc + + + + + + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + + Package netaddr :: + Module misc + + + + + +
    [frames] | no frames]
    +
    +

    Source Code for Module netaddr.misc

    +
    + 1  #!/usr/bin/env python 
+ 2  #----------------------------------------------------------------------------- 
+ 3  #   Copyright (c) 2008, David P. D. Moss. All rights reserved. 
+ 4  # 
+ 5  #   Released under the BSD license. See the LICENSE file for details. 
+ 6  #----------------------------------------------------------------------------- 
+ 7  """ 
+ 8  Miscellanous functions and classes. Do not rely on anything in here as it is 
+ 9  liable to change, move or be deleted with each release. 
+10  """ 
+11  import pprint 
+12   
+13  from netaddr import CIDR, Wildcard 
+14   
+15  #----------------------------------------------------------------------------- 
+
    17      """ 
+18      Returns a recordset (list of dicts) of host/network breakdown for IPv4 
+19      using all of the various CIDR prefixes. 
+20      """ 
+21      table = [] 
+22      prefix = 32 
+23      while prefix >= 0: 
+24          cidr = CIDR('0.0.0.0/%d' % prefix) 
+25          table.append(dict(prefix=str(cidr), hosts=cidr.size(), 
+26              networks=2 ** cidr.prefixlen)) 
+27          prefix -= 1 
+28      return table 
+
    29   
+30  #----------------------------------------------------------------------------- 
+
    32      """ 
+33      Returns a recordset (list of dicts) of host/network breakdown for IPv6 
+34      using all of the various CIDR prefixes. 
+35      """ 
+36      table = [] 
+37      prefix = 128 
+38      while prefix >= 0: 
+39          cidr = CIDR('::/%d' % prefix) 
+40          table.append(dict(prefix=str(cidr), hosts=cidr.size(), 
+41              networks=2 ** cidr.prefixlen)) 
+42          prefix -= 1 
+43      return table 
+
    44   
+45  #----------------------------------------------------------------------------- 
+55   
+56  #----------------------------------------------------------------------------- 
+66   
+67  #----------------------------------------------------------------------------- 
+68  if __name__ == '__main__': 
+69      import pprint 
+70      #pprint.pprint(ipv4_cidr_prefixes()) 
+71      print_ipv4_cidr_prefixes() 
+72      #pprint.pprint(ipv6_cidr_prefixes()) 
+73      print_ipv6_cidr_prefixes() 
+74   
+
    +
    + + + + + + + + + + + + + + + + + + +
       Home      Trees      Indices      Help    + + +
    netaddr
    + + + + + +
    + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:24 2009 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/api/netaddr.strategy-module.html b/docs/api/netaddr.strategy-module.html index 9761e86..fcdc382 100755 --- a/docs/api/netaddr.strategy-module.html +++ b/docs/api/netaddr.strategy-module.html @@ -59,8 +59,8 @@

    Module strategy

    source code

    -

    network address type logic, constants used to identify them and shared - strategy objects.

    +

    network address conversion logic, constants and shared strategy + objects.

    @@ -75,8 +75,7 @@   AddrStrategy
    - Very basic support for all common operations performed on each - network type. + Basic support for common operations performed on each address type @@ -112,7 +111,7 @@ EUI48Strategy
    Implements the operations that can be performed on an IEEE 48-bit - EUI (Extended Unique Identifer). + EUI (Extended Unique Identifer) a.k.a. @@ -129,14 +128,14 @@   USE_IPV4_OPT = True
    - Use IPv4 optimised strategy class? Default: True + Use optimised IPv4 strategy? Default: True   - ST_IPV4 = netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False...
    + ST_IPV4 = netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 10, F...
    A shared strategy object supporting all operations on IPv4 addresses. @@ -144,7 +143,7 @@   - ST_IPV6 = netaddr.address.IPv6Strategy(128, 16, ':', 6, True, ...
    + ST_IPV6 = netaddr.address.IPv6Strategy(128, 16, ':', 6, 16, Fa...
    A shared strategy object supporting all operations on IPv6 addresses. @@ -152,7 +151,7 @@   - ST_EUI48 = netaddr.address.EUI48Strategy(48, 8, '-', 48, True,...
    + ST_EUI48 = netaddr.address.EUI48Strategy(48, 8, '-', 48, 16, T...
    A shared strategy object supporting all operations on EUI-48/MAC addresses. @@ -161,7 +160,7 @@   - ST_EUI64 = netaddr.address.AddrStrategy(64, 8, '-', 64, True, ...
    + ST_EUI64 = netaddr.address.AddrStrategy(64, 8, '-', 64, 16, True)
    A shared strategy object supporting all operations on EUI-64 addresses. @@ -189,7 +188,7 @@
    Value:
    -netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False, False)
+netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, 10, False)
    @@ -208,7 +207,7 @@ netaddr.address.IPv4StrategyOpt(32, 8, '.', 4, False, False)
    Value:
    -netaddr.address.IPv6Strategy(128, 16, ':', 6, True, False)
+netaddr.address.IPv6Strategy(128, 16, ':', 6, 16, False)
    @@ -227,26 +226,7 @@ netaddr.address.IPv6Strategy(128, 16, ':', 6, True, False)
    Value:
    -netaddr.address.EUI48Strategy(48, 8, '-', 48, True, True)
-
    -
    -
    - -
    - -
    - -
    -

    ST_EUI64

    -

    A shared strategy object supporting all operations on EUI-64 - addresses.

    -
    -
    -
    -
    Value:
    - 
    -netaddr.address.AddrStrategy(64, 8, '-', 64, True, True)
+netaddr.address.EUI48Strategy(48, 8, '-', 48, 16, True)
    @@ -284,7 +264,7 @@ netaddr.address.AddrStrategy(64, 8, '-', 64, True, True)
    - Generated by Epydoc 3.0.1 on Mon Sep 29 23:23:23 2008 + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 5 # Released under the BSD license. See the LICENSE file for details. 6 #----------------------------------------------------------------------------- 7 """ - 8 network address type logic, constants used to identify them and shared - 9 strategy objects. - 10 """ - 11 import socket as _socket - 12 import struct as _struct + 8 network address conversion logic, constants and shared strategy objects. + 9 """ + 10 import socket as _socket + 11 import struct as _struct + 12 import re as _re 13 - 14 USE_IPV4_OPT=True #: Use IPv4 optimised strategy class? Default: True + 14 USE_IPV4_OPT=True #: Use optimised IPv4 strategy? Default: True 15 16 try: - 17 # The following call erroneous raises errors on various Python - 18 # implementations. - 19 _socket.inet_aton('255.255.255.255') - 20 except: - 21 USE_IPV4_OPT=False - 22 - 23 from netaddr import BIG_ENDIAN_PLATFORM, AT_UNSPEC, AT_INET, AT_INET6, \ - 24 AT_LINK, AT_EUI64, AT_NAMES - 25 - 26 #----------------------------------------------------------------------------- -
    27 -def _BYTES_TO_BITS(): -
    28 """ - 29 Generates a 256 element list of 8-bit binary digit strings. List index is - 30 equivalent to the bit string value. - 31 """ - 32 lookup = [] - 33 bits_per_byte = range(7, -1, -1) - 34 for num in range(256): - 35 bits = 8*[None] - 36 for i in bits_per_byte: - 37 bits[i] = '01'[num&1] - 38 num >>= 1 - 39 lookup.append(''.join(bits)) - 40 return lookup -
    41 - 42 _BYTES_TO_BITS = _BYTES_TO_BITS() - 43 - 44 #----------------------------------------------------------------------------- -
    45 -class AddrStrategy(object): -
    46 """ - 47 Very basic support for all common operations performed on each network - 48 type. - 49 - 50 There are usually subclasses for each address type that over-ride methods - 51 implemented here to optimise their performance and add additional - 52 features. - 53 """ -
    54 - def __init__(self, width, word_size, delimiter, word_fmt='%x', - 55 addr_type=AT_UNSPEC, hex_words=True, to_upper=False): -
    56 - 57 self.width = width - 58 self.min_int = 0 - 59 self.max_int = 2 ** width - 1 - 60 self.word_size = word_size - 61 self.word_count = width / word_size - 62 self.min_word = 0 - 63 self.max_word = 2 ** word_size - 1 - 64 self.delimiter = delimiter - 65 self.word_fmt = word_fmt - 66 self.hex_words = hex_words - 67 self.word_base = 16 - 68 self. 17 # Detects a common bug in various Python implementations. + 18 _socket.inet_aton('255.255.255.255') + 19 except: + 20 USE_IPV4_OPT=False + 21 + 22 from netaddr import BIG_ENDIAN_PLATFORM, AT_UNSPEC, AT_INET, AT_INET6, \ + 23 AT_LINK, AT_EUI64, AT_NAMES, AddrFormatError + 24 + 25 #----------------------------------------------------------------------------- +
    26 -def _BYTES_TO_BITS(): +
    27 """ + 28 Generates a 256 element list of 8-bit binary digit strings. List index is + 29 equivalent to the bit string value. + 30 """ + 31 lookup = [] + 32 bits_per_byte = range(7, -1, -1) + 33 for num in range(256): + 34 bits = 8*[None] + 35 for i in bits_per_byte: + 36 bits[i] = '01'[num&1] + 37 num >>= 1 + 38 lookup.append(''.join(bits)) + 39 return lookup +
    40 + 41 _BYTES_TO_BITS = _BYTES_TO_BITS() + 42 + 43 #----------------------------------------------------------------------------- +
    44 -class AddrStrategy(object): +
    45 """Basic support for common operations performed on each address type""" + 46 + 47 #: Lookup table for struct module format strings. + 48 STRUCT_FORMATS = { + 49 8 : 'B', # unsigned char + 50 16 : 'H', # unsigned short + 51 32 : 'I', # unsigned int + 52 } + 53 +
    54 - def __init__(self, width, word_size, word_sep, word_fmt='%x', + 55 addr_type=AT_UNSPEC, word_base=16, uppercase=False): +
    56 """ + 57 Constructor. + 58 + 59 @param width: size of address in bits. + 60 (e.g. 32 - IPv4, 48 - MAC, 128 - IPv6) + 61 + 62 @param word_size: size of each word. + 63 (e.g. 8 - octets, 16 - hextets) + 64 + 65 @param word_sep: separator between each word. + 66 (e.g. '.' - IPv4, ':' - IPv6, '-' - EUI-48) + 67 + 68 @param word_fmt: format string for each word. + 69 (Default: '%x') + 70 + 71 @param addr_type: address type. + 72 (Default: AT_UNSPEC) + 73 + 74 @param word_base: number base used to convert each word using int(). + 75 (Default: 16) + 76 + 77 @param uppercase: uppercase address. + 78 (Default: False) + 79 """ + 80 + 81 self.width = width + 82 self.max_int = 2 ** width - 1 + 83 self.word_size = word_size + 84 self.num_words = width / word_size + 85 self.max_word = 2 ** word_size - 1 + 86 self.word_sep = word_sep + 87 self.word_fmt = word_fmt + 88 self.word_base = word_base + 89 self.addr_type = addr_type = addr_type - 69 self.to_upper = to_upper - 70 - 71 if self.hex_words is False: - 72 self.word_base = 10 - 73 - 74 try: - 75 self.name = AT_NAMES[addr_type + 90 self.uppercase = uppercase + 91 + 92 try: + 93 self.name = AT_NAMES[addr_type] - 76 except KeyError: - 77 self.name = AT_NAMES[AT_UNSPEC] -
    78 -
    79 - def __repr__(self): -
    80 """ - 81 @return: An executable Python statement that can recreate an object - 82 with an equivalent state. - 83 """ - 84 return "netaddr.address.%s(%r, %r, %r, %r, %r, %r)" % \ - 85 (self.__class__.__name__, self.width, self.word_size, - 86 self.delimiter, self.addr_type] + 94 except KeyError: + 95 self.name = AT_NAMES[AT_UNSPEC] +
    96 +
    97 - def __repr__(self): +
    98 """@return: executable Python string to recreate equivalent object""" + 99 return "netaddr.address.%s(%r, %r, %r, %r, %r, %r)" % \ +100 (self.__class__.__name__, self.width, self.word_size, +101 self.word_sep, self.addr_type, self.hex_words, self.to_upper) -
    87 - 88 #------------------------------------------------------------------------- - 89 # Binary methods. - 90 #------------------------------------------------------------------------- - 91 -
    92 - def valid_bits(self, bits): -
    93 """ - 94 @param bits: A network address in readable binary form. - 95 - 96 @return: C{True} if network address is valid for this address type, - 97 C{False} otherwise. - 98 """ - 99 if not isinstance(bits, (str, unicode)): -100 return False -101 -102 bits = bits.replace(self.delimiter, '') -103 -104 if len(bits) != self.width: -105 return False -106 -107 try: -108 if self.min_int <= int(bits, 2) <= self.max_int: -109 return True -110 except ValueError: -111 return False -112 return False -
    113 -
    114 - def bits_to_int(self, bits): -
    115 """ -116 @param bits: A network address in readable binary form. -117 -118 @return: A network byte order integer that is equivalent to value -119 represented by network address in readable binary form. -120 """ -121 words = self.bits_to_words(bits) -122 return self.words_to_int(words) -
    123 -
    124 - def bits_to_str(self, bits): -
    125 """ -126 @param bits: A network address in readable binary form. -127 -128 @return: A network address in string form that is equivalent to value -129 represented by network address in readable binary form. -130 """ -131 words = self.bits_to_words(bits) -132 return self.words_to_str(words) -
    133 -
    134 - def bits_to_words(self, bits): -
    135 """ -136 @param bits: A network address in readable binary form. -137 -138 @return: An integer word sequence that is equivalent to value -139 represented by network address in readable binary form. -140 """ -141 if not self.valid_bits(bits): -142 raise ValueError('%r is not a valid binary form string for ' \ -143 'address type!' % bits) +netaddr.address.IPRange.addr_type +netaddr.address.Wildcard.addr_type" class="py-name" href="#" onclick="return doclink('link-24', 'addr_type', 'link-18');">addr_type, self.word_base, self.uppercase) +
    102 +103 #------------------------------------------------------------------------- +104 # Binary methods. +105 #------------------------------------------------------------------------- +106 +
    107 - def valid_bits(self, bits): +
    108 """ +109 @param bits: A network address in readable binary form. +110 +111 @return: C{True} if network address is valid for this address type, +112 C{False} otherwise. +113 """ +114 if not isinstance(bits, (str, unicode)): +115 return False +116 +117 bits = bits.replace(self.word_sep, '') +118 +119 if len(bits) != self.width: +120 return False +121 +122 try: +123 if 0 <= int(bits, 2) <= self.max_int: +124 return True +125 except ValueError: +126 return False +127 return False +
    128 +
    129 - def bits_to_int(self, bits): +
    130 """ +131 @param bits: A network address in readable binary form. +132 +133 @return: A network byte order integer that is equivalent to value +134 represented by network address in readable binary form. +135 """ +136 if not self.valid_bits(bits): +137 raise ValueError('%r is not a valid binary form string for ' \ +138 'address type!' % bits) +139 +140 word_bits = bits.split(self.word_sep) +141 if len(word_bits) != self.num_words: +142 raise ValueError('invalid number of words within binary form ' \ +143 'string for address type!' % bits) 144 -145 word_bits = bits.split(self.delimiter) -146 if len(word_bits) != self.word_count: -147 raise ValueError('invalid number of words within binary form ' \ -148 'string for address type!' % bits) -149 -150 return tuple([int(i, 2) for i in word_bits]) -
    151 -152 #------------------------------------------------------------------------- -153 # Integer methods. -154 #------------------------------------------------------------------------- -155 -
    156 - def valid_int(self, int_val): -
    157 """ -158 @param int_val: A network byte order integer. -159 -160 @return: C{True} if network byte order integer falls within the -161 boundaries of this address type, C{False} otherwise. -162 """ -163 if not isinstance(int_val, (int, long)): -164 return False -165 -166 if self.min_int <= int_val <= self.max_int: -167 return True -168 -169 return False -
    170 -
    171 - def int_to_str(self, int_val): -
    172 """ -173 @param int_val: A network byte order integer. -174 -175 @return: A network address in string form that is equivalent to value -176 represented by a network byte order integer. -177 """ -178 words = self.int_to_words(int_val) -179 tokens = [self.word_fmt % i for i in words] -180 addr = self.delimiter.join(tokens) -181 -182 if self.to_upper is True: -183 return addr.upper() -184 -185 return addr -
    186 -
    187 - def int_to_bits(self, int_val): -
    188 """ -189 @param int_val: A network byte order integer. -190 -191 @return: A network address in readable binary form that is equivalent -192 to value represented by a network byte order integer. -193 """ -194 bit_words = [] -195 for word in self.int_to_words(int_val): -196 bits = self.word_to_bits(word) -197 bit_words.append(bits) -198 -199 return self.delimiter.join(bit_words) -
    200 -
    201 - def int_to_words(self, int_val): -
    202 """ -203 @param int_val: A network byte order integer. -204 -205 @return: An integer word sequence that is equivalent to value -206 represented by a network byte order integer. -207 """ -208 if not self.valid_int(int_val): -209 raise ValueError('%r is not a valid integer value for this ' \ -210 'address type!' % int_val) +145 words = tuple([int(i, 2) for i in word_bits]) +146 +147 return self.words_to_int(words) +
    148 +149 #------------------------------------------------------------------------- +150 # Integer methods. +151 #------------------------------------------------------------------------- +152 +
    153 - def valid_int(self, int_val): +
    154 """ +155 @param int_val: A network byte order integer. +156 +157 @return: C{True} if network byte order integer falls within the +158 boundaries of this address type, C{False} otherwise. +159 """ +160 if not isinstance(int_val, (int, long)): +161 return False +162 +163 return 0 <= int_val <= self.max_int +
    164 +
    165 - def int_to_str(self, int_val): +
    166 """ +167 @param int_val: A network byte order integer. +168 +169 @return: A network address in string form that is equivalent to value +170 represented by a network byte order integer. +171 """ +172 words = self.int_to_words(int_val) +173 tokens = [self.word_fmt % i for i in words] +174 addr = self.word_sep.join(tokens) +175 +176 if self.uppercase is True: +177 return addr.upper() +178 +179 return addr +
    180 +
    181 - def int_to_bits(self, int_val): +
    182 """ +183 @param int_val: A network byte order integer. +184 +185 @return: A network address in readable binary form that is equivalent +186 to value represented by a network byte order integer. +187 """ +188 bit_words = [] +189 +190 for word in self.int_to_words(int_val): +191 bits = [] +192 while word: +193 bits.append(_BYTES_TO_BITS[word&255]) +194 word >>= 8 +195 bits.reverse() +196 bit_str = ''.join(bits) or '0'*self.word_size +197 bits = ('0'*self.word_size+bit_str)[-self.word_size:] +198 bit_words.append(bits) +199 +200 return self.word_sep.join(bit_words) +
    201 +
    202 - def int_to_bin(self, int_val): +
    203 """ +204 @param int_val: A network byte order integer. +205 +206 @return: A network address in standard binary representation format +207 that is equivalent to integer address value. Essentially a back +208 port of the bin() builtin in Python 2.6.x and higher. +209 """ +210 bit_words = [] 211 -212 words = [] -213 for i in range(self.word_count): -214 word = int_val & (2 ** self.word_size - 1) -215 words.append(int(word)) -216 int_val >>= self.word_size -217 -218 words.reverse() -219 return tuple(words) -
    220 -221 #------------------------------------------------------------------------- -222 # String methods. -223 #------------------------------------------------------------------------- -224 -
    225 - def valid_str(self, addr): -
    226 """ -227 @param addr: A network address in string form. -228 -229 @return: C{True} if network address in string form is valid for this -230 address type, C{False} otherwise. -231 """ -232 if not isinstance(addr, (str, unicode)): -233 return False -234 -235 tokens = addr.split(self.delimiter) -236 if len(tokens) != self.word_count: -237 return False -238 -239 try: -240 for token in tokens: -241 if not self.min_word <= int(token, self.word_base) <= \ -242 self.max_word: -243 return False -244 except TypeError: -245 return False -246 except ValueError: -247 return False -248 return True -
    249 -
    250 - def str_to_int(self, addr): -
    251 """ -252 @param addr: A network address in string form. -253 -254 @return: A network byte order integer that is equivalent to value -255 represented by network address in string form. -256 """ -257 words = self.str_to_words(addr) -258 return self.words_to_int(words) -
    259 -
    260 - def str_to_bits(self, addr): -
    261 """ -262 @param addr: A network address in string form. -263 -264 @return: A network address in readable binary form that is equivalent -265 to value represented by network address in string form. -266 """ -267 words = self.str_to_words(addr) -268 return self.words_to_bits(words) -
    269 -
    270 - def str_to_words(self, addr): -
    271 """ -272 @param addr: A network address in string form. -273 -274 @return: An integer word sequence that is equivalent in value to the -275 network address in string form. -276 """ -277 if not self.212 for word in self.int_to_words(int_val): +213 bits = [] +214 while word: +215 bits.append(_BYTES_TO_BITS[word&255]) +216 word >>= 8 +217 bits.reverse() +218 bit_str = ''.join(bits) or '0'*self.word_size +219 bits = ('0'*self.word_size+bit_str)[-self.word_size:] +220 bit_words.append(bits) +221 +222 return '0b' + ''.join(bit_words) +
    223 +
    224 - def int_to_words(self, int_val, num_words=None, word_size=None): +
    225 """ +226 @param int_val: A network byte order integer to be split. +227 +228 @param num_words: (optional) number of words expected in return value +229 tuple. Uses address type default if not specified. +230 +231 @param word_size: (optional) size/width of individual words (in bits). +232 Uses address type default if not specified. +233 """ +234 if not self.valid_int(int_val): +235 raise IndexError('integer %r is out of bounds!' % hex(int_val)) +236 +237 # Set defaults for optional args. +238 if num_words is None: +239 num_words = self.num_words +240 if word_size is None: +241 word_size = self.word_size +242 +243 max_word_size = 2 ** word_size - 1 +244 +245 words = [] +246 for _ in range(num_words): +247 word = int_val & max_word_size +248 words.append(int(word)) +249 int_val >>= word_size +250 words.reverse() +251 +252 return tuple(words) +
    253 +
    254 - def int_to_packed(self, int_val): +
    255 """ +256 @param int_val: the integer to be packed. +257 +258 @return: a packed string that is equivalent to value represented by a +259 network byte order integer. +260 """ +261 +262 words = self.int_to_words(int_val, self.num_words, self.word_size) +263 +264 try: +265 fmt = '>%d%s' % (self.num_words, AddrStrategy.STRUCT_FORMATS[ +266 self.word_size]) +267 except KeyError: +268 raise ValueError('unsupported word size: %d!' % self.word_size) +269 +270 return _struct.pack(fmt, *words) +
    271 +272 +273 #------------------------------------------------------------------------- +274 # Packed string methods. +275 #------------------------------------------------------------------------- +276 +
    277 - def packed_to_int(self, packed_int): +
    278 """ +279 @param packed_int: a packed string containing an unsigned integer. +280 Network byte order is assumed. +281 +282 @return: A network byte order integer that is equivalent to value +283 of network address represented by packed binary string. +284 """ +285 try: +286 fmt = '>%d%s' % (self.num_words, AddrStrategy.STRUCT_FORMATS[ +287 self.word_size]) +288 except KeyError: +289 raise ValueError('unsupported word size: %d!' % self.word_size) +290 +291 words = list(_struct.unpack(fmt, packed_int)) +292 words.reverse() +293 +294 int_val = 0 +295 for i, num in enumerate(words): +296 word = num +297 word = word << self.word_size * i +298 int_val = int_val | word +299 +300 return int_val +
    301 +302 #------------------------------------------------------------------------- +303 # String methods. +304 #------------------------------------------------------------------------- +305 +
    306 - def valid_str(self, addr): +
    307 """ +308 @param addr: A network address in string form. +309 +310 @return: C{True} if network address in string form is valid for this +311 address type, C{False} otherwise. +312 """ +313 if not isinstance(addr, (str, unicode)): +314 return False +315 +316 tokens = addr.split(self.word_sep) +317 if len(tokens) != self.num_words: +318 return False +319 +320 try: +321 for token in tokens: +322 if not 0 <= int(token, self.word_base) <= \ +323 self.max_word: +324 return False +325 except TypeError: +326 return False +327 except ValueError: +328 return False +329 return True +
    330 +
    331 - def str_to_int(self, addr): +
    332 """ +333 @param addr: A network address in string form. +334 +335 @return: A network byte order integer that is equivalent to value +336 represented by network address in string form. +337 """ +338 if not self.valid_str(addr): -278 raise ValueError('%r is not a recognised string representation' \ -279 ' of this address type!' % addr) -280 -281 words = addr.split(self.delimiter) -282 return tuple([ int(word, self.word_base) for word in words ]) -
    283 -284 #------------------------------------------------------------------------- -285 # Word list methods. -286 #------------------------------------------------------------------------- -287 -
    288 - def valid_words(self, words): -
    289 """ -290 @param words: A list or tuple containing integer word values. -291 -292 @return: C{True} if word sequence is valid for this address type, -293 C{False} otherwise. -294 """ -295 if not isinstance(words, (list, tuple)): -296 return False -297 -298 if len(words) != self.word_count: -299 return False -300 -301 for i in words: -302 if not isinstance(i, (int, long)): -303 return False -304 -305 if not self.min_word <= i <= self.max_word: -306 return False -307 return True -
    308 -
    309 - def words_to_int(self, words): -
    310 """ -311 @param words: A list or tuple containing integer word values. -312 -313 @return: A network byte order integer that is equivalent to value -314 represented by word sequence. -315 """ -316 if not self.valid_words(words): -317 raise ValueError('%r is not a valid word list!' % words) -318 -319 # tuples have no reverse() method and reversed() is only available -320 # in Python 2.4. Ugly but necessary. -321 if isinstance(words, tuple): -322 words = list(words) -323 words.reverse() -324 -325 int_val = 0 -326 for i, num in enumerate(words): -327 word = num -328 word = word << self.word_size * i -329 int_val = int_val | word -330 -331 return int_val -
    332 -
    333 - def words_to_str(self, words): -
    334 """ -335 @param words: A list or tuple containing integer word values. -336 -337 @return: A network address in string form that is equivalent to value -338 represented by word sequence. -339 """ -340 if not self.valid_words(words): -341 raise ValueError('%r is not a valid word list!' % words) -342 -343 tokens = [self.word_fmt % i for i in words] -344 addr = self.delimiter.join(tokens) -345 return addr +netaddr.strategy.IPv4StrategyOpt.valid_str +netaddr.strategy.IPv6Strategy.valid_str" class="py-name" href="#" onclick="return doclink('link-64', 'valid_str', 'link-64');">valid_str(addr): +339 raise ValueError('%r is not a recognised string representation' \ +340 ' of this address type!' % addr) +341 +342 tokens = addr.split(self.word_sep) +343 words = [ int(token, self.word_base) for token in tokens ] +344 +345 return self.words_to_int(words)
    346 -
    347 - def words_to_bits(self, words): -
    348 """ -349 @param words: A list or tuple containing integer word values. -350 -351 @return: A network address in readable binary form that is equivalent -352 to value represented by word sequence. -353 """ -354 if not self.valid_words(words): -355 raise ValueError('%r is not a valid word list!' % words) -356 -357 bit_words = [] -358 for word in words: -359 bits = self.word_to_bits(word) -360 bit_words.append(bits) -361 -362 return self.delimiter.join(bit_words) -
    363 -364 #------------------------------------------------------------------------- -365 # Other methods. -366 #------------------------------------------------------------------------- -367 -
    368 - def word_to_bits(self, int_val): -
    369 """ -370 @param int_val: An individual integer word value. -371 -372 @return: An integer word value for this address type in a fixed width -373 readable binary form. -374 """ -375 bits = [] -376 -377 while int_val: -378 bits.append(_BYTES_TO_BITS[int_val&255]) -379 int_val >>= 8 -380 -381 bits.reverse() -382 bit_str = ''.join(bits) or '0'*self.word_size -383 return ('0'*self.word_size+bit_str)[-self.word_size:] -
    384 -
    385 - def description(self): -
    386 """ -387 @return: String detailing setup of this L{AddrStrategy} instance. -388 Useful for debugging. -389 """ -390 tokens = [] -391 for k in sorted(self.__dict__): -392 v = self.__dict__[k] -393 if isinstance(v, bool): -394 tokens.append("%s: %r" % (k, v)) -395 elif isinstance(v, (int, long)): -396 tokens.append( -397 "%s: %r (%s)" % (k, v, hex(v).rstrip('L').lower())) -398 else: -399 tokens.append("%s: %r" % (k, v)) -400 return "\n".join(tokens) -
    401 -402 #----------------------------------------------------------------------------- -
    403 -class IPv4StrategyStd(AddrStrategy): -
    404 """ -405 A 'safe' L{AddrStrategy} for IPv4 addresses. Unlike L{IPv4StrategyOpt}. +347 #------------------------------------------------------------------------- +348 # Word list methods. +349 #------------------------------------------------------------------------- +350 +
    351 - def valid_words(self, words): +
    352 """ +353 @param words: A sequence containing integer word values. +354 +355 @return: C{True} if word sequence is valid for this address type, +356 C{False} otherwise. +357 """ +358 if not hasattr(words, '__iter__'): +359 return False +360 +361 if len(words) != self.num_words: +362 return False +363 +364 for i in words: +365 if not isinstance(i, (int, long)): +366 return False +367 +368 if not 0 <= i <= self.max_word: +369 return False +370 return True +
    371 +
    372 - def words_to_int(self, words): +
    373 """ +374 @param words: A list or tuple containing integer word values. +375 +376 @return: A network byte order integer that is equivalent to value +377 represented by word sequence. +378 """ +379 if not self.valid_words(words): +380 raise ValueError('%r is not a valid word list!' % words) +381 +382 # tuples have no reverse() method and reversed() is only available +383 # in Python 2.4. Ugly but necessary. +384 if isinstance(words, tuple): +385 words = list(words) +386 words.reverse() +387 +388 int_val = 0 +389 for i, num in enumerate(words): +390 word = num +391 word = word << self.word_size * i +392 int_val = int_val | word +393 +394 return int_val +
    395 +396 #----------------------------------------------------------------------------- +
    397 -class IPv4StrategyStd(AddrStrategy): +
    398 """ +399 A 'safe' L{AddrStrategy} for IPv4 addresses. Unlike L{IPv4StrategyOpt}. +400 +401 It contains all methods related to IPv4 addresses that the optimised +402 version has, without the reliance on the socket or struct modules. There +403 are several cases where the use of this class are preferable when either +404 the modules mentioned do not exist on certain Python implementations or +405 contain bugs like the infamous inet_aton('255.255.255.254') bug. 406 -407 It contains all methods related to IPv4 addresses that the optimised -408 version has, without the reliance on the socket or struct modules. There -409 are several cases where the use of this class are preferable when either -410 the modules mentioned do not exist on certain Python implementations or -411 contain bugs like the infamous inet_aton('255.255.255.254') bug. -412 -413 All methods shared between the optimised class and this one should be -414 defined here. -415 """ -
    416 - def __init__(self): -
    417 """Constructor.""" -418 super(IPv4StrategyStd, self).407 All methods shared between the optimised class and this one should be +408 defined here. +409 """ +
    410 - def __init__(self): +
    411 """Constructor.""" +412 super(IPv4StrategyStd, self).__init__(width=32, word_size=8, -419 word_fmt='%d', delimiter='.', __init__(width=32, word_size=8, +413 word_fmt='%d', word_sep='.', addr_type=AT_INET, -420 hex_words=False) -
    421 -
    422 - def int_to_arpa(self, int_val): -
    423 """ -424 @param int_val: A network byte order integer. -425 -426 @return: The reverse DNS lookup for an IPv4 address in network byte -427 order integer form. -428 """ -429 words = ["%d" % i for i in self.int_to_words(int_val)] -430 words.reverse() -431 words.extend(['in-addr', 'arpa', '']) -432 return '.'.join(words) -
    433 -434 #----------------------------------------------------------------------------- -
    435 -class IPv4StrategyOpt(IPv4StrategyStd): -
    436 """ -437 An optimised L{AddrStrategy} for IPv4 addresses. -438 -439 It uses C{pack()} and C{unpack()} from the C{struct} module along with the -440 C{inet_ntoa()} and C{inet_aton()} from the C{socket} module great improve -441 the speed of certain operations (approx. 2.5 times faster than a standard -442 L{AddrStrategy} configured for IPv4). -443 -444 However, keep in mind that these modules might not be available everywhere -445 that Python itself is. Runtimes such as Google App Engine gut the -446 C{socket} module. C{struct} is also limited to processing 32-bit integers -447 which is fine for IPv4 but isn't suitable for IPv6. -448 """ -
    449 - def __init__(self): -
    450 """Constructor.""" -451 super(IPv4StrategyOpt, self).addr_type=AT_INET, word_base=10) +
    414 +
    415 - def int_to_arpa(self, int_val): +
    416 """ +417 @param int_val: A network byte order integer. +418 +419 @return: The reverse DNS lookup for an IPv4 address in network byte +420 order integer form. +421 """ +422 words = ["%d" % i for i in self.int_to_words(int_val)] +423 words.reverse() +424 words.extend(['in-addr', 'arpa', '']) +425 return '.'.join(words) +
    426 +427 #----------------------------------------------------------------------------- +
    428 -class IPv4StrategyOpt(IPv4StrategyStd): +
    429 """ +430 An optimised L{AddrStrategy} for IPv4 addresses. +431 +432 It uses C{pack()} and C{unpack()} from the C{struct} module along with the +433 C{inet_ntoa()} and C{inet_aton()} from the C{socket} module great improve +434 the speed of certain operations (approx. 2.5 times faster than a standard +435 L{AddrStrategy} configured for IPv4). +436 +437 However, keep in mind that these modules might not be available everywhere +438 that Python itself is. Runtimes such as Google App Engine gut the +439 C{socket} module. C{struct} is also limited to processing 32-bit integers +440 which is fine for IPv4 but isn't suitable for IPv6. +441 """ +
    442 - def __init__(self): +
    443 """Constructor.""" +444 super(IPv4StrategyOpt, self).__init__() -
    452 -
    453 - def str_to_int(self, addr): -
    454 """ -455 @param addr: An IPv4 dotted decimal address in string form. -456 -457 @return: A network byte order integer that is equivalent to value -458 represented by the IPv4 dotted decimal address string. -459 """ -460 if not self.__init__() +
    445 +
    446 - def valid_str(self, addr): +
    447 """ +448 @param addr: An IP address in presentation (string) format. +449 +450 @return: C{True} if network address in string form is valid for this +451 address type, C{False} otherwise. +452 """ +453 try: +454 # This call handles a lot of older IPv4 address formats that +455 # it would be a lot of work to implement (many edge cases). +456 # Please Note: only this optimised strategy class will have +457 # the ability to parse these less common formats for the +458 # moment. +459 _socket.inet_aton(addr) +460 except _socket.error: +461 return False +462 except TypeError: +463 return False +464 return True +
    465 +
    466 - def str_to_int(self, addr): +
    467 """ +468 @param addr: An IPv4 dotted decimal address in string form. +469 +470 @return: A network byte order integer that is equivalent to value +471 represented by the IPv4 dotted decimal address string. +472 """ +473 if not self.valid_str(addr): -461 raise ValueError('%r is not a valid IPv4 dotted decimal' \ -462 ' address string!' % addr) -463 return _struct.unpack('>I', _socket.inet_aton(addr))[0] -
    464 -
    465 - def int_to_str(self, int_val): -
    466 """ -467 @param int_val: A network byte order integer. -468 -469 @return: An IPv4 dotted decimal address string that is equivalent to -470 value represented by a 32 bit integer in network byte order. -471 """ -472 if not self.valid_int(int_val): -473 raise ValueError('%r is not a valid 32-bit integer!' % int_val) -474 return _socket.inet_ntoa(_struct.pack('>I', int_val)) -
    475 -
    476 - def int_to_words(self, int_val): -
    477 """ -478 @param int_val: A network byte order integer. -479 -480 @return: An integer word (octet) sequence that is equivalent to value -481 represented by network byte order integer. -482 """ -483 if not self.valid_int(int_val): -484 raise ValueError('%r is not a valid integer value supported ' \ -485 'by this address type!' % int_val) -486 return _struct.unpack('4B', _struct.pack('>I', int_val)) -
    487 -
    488 - def words_to_int(self, octets): -
    489 """ -490 @param octets: A list or tuple containing integer octets. -491 -492 @return: A network byte order integer that is equivalent to value -493 represented by word (octet) sequence. -494 """ -495 if not self.valid_words(octets): -496 raise ValueError('%r is not a valid octet list for an IPv4 ' \ -497 'address!' % octets) -498 return _struct.unpack('>I', _struct.pack('4B', *octets))[0] -
    499 -500 #----------------------------------------------------------------------------- -
    501 -class IPv6Strategy(AddrStrategy): -
    502 """ -503 Implements the operations that can be performed on an Internet Protocol -504 version 6 network address in accordance with RFC 4291. -505 -506 NB - This class would benefit greatly from access to inet_pton/inet_ntop() -507 function calls in Python's socket module. Sadly, they aren't available so -508 we'll have to put up with the pure-Python implementation here (for now at -509 least). -510 """ -
    511 - def __init__(self): -
    512 """Constructor.""" -513 super(self.__class__, self).valid_str(addr): +474 raise ValueError('%r is not a valid IPv4 address string!' \ +475 % addr) +476 return _struct.unpack('>I', _socket.inet_aton(addr))[0] +
    477 +
    478 - def int_to_str(self, int_val): +
    479 """ +480 @param int_val: A network byte order integer. +481 +482 @return: An IPv4 dotted decimal address string that is equivalent to +483 value represented by a 32 bit integer in network byte order. +484 """ +485 if not self.valid_int(int_val): +486 raise ValueError('%r is not a valid 32-bit integer!' % int_val) +487 return _socket.inet_ntoa(_struct.pack('>I', int_val)) +
    488 +
    489 - def int_to_words(self, int_val, num_words=None, word_size=None): +
    490 """ +491 @param int_val: A network byte order integer. +492 +493 @param num_words: (unused) *** interface compatibility only *** +494 +495 @param word_size: (unused) *** interface compatibility only *** +496 +497 @return: An integer word (octet) sequence that is equivalent to value +498 represented by network byte order integer. +499 """ +500 if not self.valid_int(int_val): +501 raise ValueError('%r is not a valid integer value supported ' \ +502 'by this address type!' % int_val) +503 return _struct.unpack('4B', _struct.pack('>I', int_val)) +
    504 +
    505 - def words_to_int(self, octets): +
    506 """ +507 @param octets: A list or tuple containing integer octets. +508 +509 @return: A network byte order integer that is equivalent to value +510 represented by word (octet) sequence. +511 """ +512 if not self.valid_words(octets): +513 raise ValueError('%r is not a valid octet list for an IPv4 ' \ +514 'address!' % octets) +515 return _struct.unpack('>I', _struct.pack('4B', *octets))[0] +
    516 +517 #----------------------------------------------------------------------------- +
    518 -class IPv6Strategy(AddrStrategy): +
    519 """ +520 Implements the operations that can be performed on an Internet Protocol +521 version 6 network address in accordance with RFC 4291. +522 +523 NB - This class would benefit greatly from access to inet_pton/inet_ntop() +524 function calls in Python's socket module. Sadly, they aren't available so +525 we'll have to put up with the pure-Python implementation here (for now at +526 least). +527 """ +
    528 - def __init__(self): +
    529 """Constructor.""" +530 super(self.__class__, self).__init__(__init__(addr_type=AT_INET6, -514 width=128, word_size=16, word_fmt='%x', delimiter=':') -
    515 -
    516 - def valid_str(self, addr): -
    517 """ -518 @param addr: An IPv6 address in string form. -519 -520 @return: C{True} if IPv6 network address string is valid, C{False} -521 otherwise. -522 """ -523 #TODO: Reduce the length of this method ... -524 if not isinstance(addr, (str, unicode)): -525 return False -526 -527 if '::' in addr: -528 # IPv6 compact mode. -529 try: -530 prefix, suffix = addr.split('::') -531 except ValueError: -532 return False -533 -534 l_prefix = [] -535 l_suffix = [] -536 -537 if prefix != '': -538 l_prefix = prefix.split(':') -539 -540 if suffix != '': -541 l_suffix = suffix.split(':') -542 -543 # IPv6 compact IPv4 compatibility mode. -544 if len(l_suffix) and '.' in l_suffix[-1]: -545 ipv4_str = l_suffix[-1] -546 if ST_IPV4.valid_str(ipv4_str): -547 ipv4_int = ST_IPV4.str_to_int(ipv4_str) -548 ipv4_words = ST_IPV4.int_to_words(ipv4_int) -549 l_suffix.pop() -550 l_suffix.append( -551 ''.join(["%.2x" % i for i in ipv4_words[0:2]])) -552 l_suffix.append( -553 ''.join(["%.2x" % i for i in ipv4_words[2:4]])) -554 -555 token_count = len(l_prefix) + len(l_suffix) +netaddr.address.IPRange.addr_type +netaddr.address.Wildcard.addr_type" class="py-name" href="#" onclick="return doclink('link-79', 'addr_type', 'link-18');">addr_type=AT_INET6, +531 width=128, word_size=16, word_fmt='%x', word_sep=':') +
    532 +
    533 - def valid_str(self, addr): +
    534 """ +535 @param addr: An IPv6 address in string form. +536 +537 @return: C{True} if IPv6 network address string is valid, C{False} +538 otherwise. +539 """ +540 #TODO: Reduce the length of this method ... +541 if not isinstance(addr, (str, unicode)): +542 return False +543 +544 if '::' in addr: +545 # IPv6 compact mode. +546 try: +547 prefix, suffix = addr.split('::') +548 except ValueError: +549 return False +550 +551 l_prefix = [] +552 l_suffix = [] +553 +554 if prefix != '': +555 l_prefix = prefix.split(':') 556 -557 if not 0 <= token_count <= self.word_count - 1: -558 return False +557 if suffix != '': +558 l_suffix = suffix.split(':') 559 -560 try: -561 for token in l_prefix + l_suffix: -562 word = int(token, 16) -563 if not self.min_word <= word <= self.max_word: -564 return False -565 except ValueError: -566 return False -567 else: -568 # IPv6 verbose mode. -569 if ':' in addr: -570 tokens = addr.split(':') +560 # IPv6 compact IPv4 compatibility mode. +561 if len(l_suffix) and '.' in l_suffix[-1]: +562 ipv4_str = l_suffix[-1] +563 if ST_IPV4.valid_str(ipv4_str): +564 ipv4_int = ST_IPV4.str_to_int(ipv4_str) +565 ipv4_words = ST_IPV4.int_to_words(ipv4_int) +566 l_suffix.pop() +567 l_suffix.append( +568 ''.join(["%.2x" % i for i in ipv4_words[0:2]])) +569 l_suffix.append( +570 ''.join(["%.2x" % i for i in ipv4_words[2:4]])) 571 -572 if '.' in addr: -573 ipv6_prefix = tokens[:-1] -574 if ipv6_prefix[:-1] != ['0', '0', '0', '0', '0']: -575 return False -576 if ipv6_prefix[-1].lower() not in ('0', 'ffff'): -577 return False -578 # IPv6 verbose IPv4 compatibility mode. -579 if len(tokens) != (self.word_count - 1): -580 return False -581 ipv4_str = tokens[-1] -582 if ST_IPV4.572 token_count = len(l_prefix) + len(l_suffix) +573 +574 if not 0 <= token_count <= self.num_words - 1: +575 return False +576 +577 try: +578 for token in l_prefix + l_suffix: +579 word = int(token, 16) +580 if not 0 <= word <= self.max_word: +581 return False +582 except ValueError: +583 return False +584 else: +585 # IPv6 verbose mode. +586 if ':' in addr: +587 tokens = addr.split(':') +588 +589 if '.' in addr: +590 ipv6_prefix = tokens[:-1] +591 if ipv6_prefix[:-1] != ['0', '0', '0', '0', '0']: +592 return False +593 if ipv6_prefix[-1].lower() not in ('0', 'ffff'): +594 return False +595 # IPv6 verbose IPv4 compatibility mode. +596 if len(tokens) != (self.num_words - 1): +597 return False +598 ipv4_str = tokens[-1] +599 if ST_IPV4.valid_str(ipv4_str): -583 ipv4_int = ST_IPV4.valid_str(ipv4_str): +600 ipv4_int = ST_IPV4.str_to_int(ipv4_str) -584 ipv4_words = ST_IPV4.int_to_words(ipv4_int) -585 tokens.pop() -586 tokens.append( -587 ''.join(["%.2x" % i for i in ipv4_words[0:2]])) -588 tokens.append( -589 ''.join(["%.2x" % i for i in ipv4_words[2:4]])) -590 else: -591 # IPv6 verbose mode. -592 if len(tokens) != self.word_count: -593 return False -594 try: -595 for token in tokens: -596 word = int(token, 16) -597 if not self.min_word <= word <= self.max_word: -598 return False -599 except ValueError: -600 return False -601 else: -602 return False -603 -604 return True -
    605 -
    606 - def str_to_int(self, addr): -
    607 """ -608 @param addr: An IPv6 address in string form. -609 -610 @return: The equivalent network byte order integer for a given IPv6 -611 address. -612 """ -613 if not self.str_to_int(ipv4_str) +601 ipv4_words = ST_IPV4.int_to_words(ipv4_int) +602 tokens.pop() +603 tokens.append( +604 ''.join(["%.2x" % i for i in ipv4_words[0:2]])) +605 tokens.append( +606 ''.join(["%.2x" % i for i in ipv4_words[2:4]])) +607 else: +608 # IPv6 verbose mode. +609 if len(tokens) != self.num_words: +610 return False +611 try: +612 for token in tokens: +613 word = int(token, 16) +614 if not 0 <= word <= self.max_word: +615 return False +616 except ValueError: +617 return False +618 else: +619 return False +620 +621 return True +
    622 +
    623 - def str_to_int(self, addr): +
    624 """ +625 @param addr: An IPv6 address in string form. +626 +627 @return: The equivalent network byte order integer for a given IPv6 +628 address. +629 """ +630 if not self.valid_str(addr): -614 raise ValueError("'%s' is an invalid IPv6 address!" % addr) -615 -616 values = [] -617 -618 if addr == '::': -619 # Unspecified address. -620 return 0 -621 elif '::' in addr: -622 # Abbreviated form IPv6 address. -623 prefix, suffix = addr.split('::') -624 -625 if prefix == '': -626 l_prefix = ['0'] -627 else: -628 l_prefix = prefix.split(':') -629 -630 if suffix == '': -631 l_suffix = ['0'] -632 else: -633 l_suffix = suffix.split(':') +netaddr.strategy.IPv4StrategyOpt.valid_str +netaddr.strategy.IPv6Strategy.valid_str" class="py-name" href="#" onclick="return doclink('link-93', 'valid_str', 'link-64');">valid_str(addr): +631 raise ValueError("'%s' is an invalid IPv6 address!" % addr) +632 +633 values = [] 634 -635 # Check for IPv4 compatibility address form. -636 if len(l_suffix) and '.' in l_suffix[-1]: -637 if len(l_suffix) > 2: -638 return False -639 if len(l_suffix) == 2 and l_suffix[0].lower() != 'ffff': -640 return False +635 if addr == '::': +636 # Unspecified address. +637 return 0 +638 elif '::' in addr: +639 # Abbreviated form IPv6 address. +640 prefix, suffix = addr.split('::') 641 -642 ipv4_str = l_suffix[-1] -643 if ST_IPV4.642 if prefix == '': +643 l_prefix = ['0'] +644 else: +645 l_prefix = prefix.split(':') +646 +647 if suffix == '': +648 l_suffix = ['0'] +649 else: +650 l_suffix = suffix.split(':') +651 +652 # Check for IPv4 compatibility address form. +653 if len(l_suffix) and '.' in l_suffix[-1]: +654 if len(l_suffix) > 2: +655 return False +656 if len(l_suffix) == 2 and l_suffix[0].lower() != 'ffff': +657 return False +658 +659 ipv4_str = l_suffix[-1] +660 if ST_IPV4.valid_str(ipv4_str): -644 ipv4_int = ST_IPV4.valid_str(ipv4_str): +661 ipv4_int = ST_IPV4.str_to_int(ipv4_str) -645 ipv4_words = ST_IPV4.int_to_words(ipv4_int) -646 l_suffix.pop() -647 l_suffix.append( -648 ''.join(["%.2x" % i for i in ipv4_words[0:2]])) -649 l_suffix.append( -650 ''.join(["%.2x" % i for i in ipv4_words[2:4]])) -651 -652 gap_size = 8 - ( len(l_prefix) + len(l_suffix) ) -653 -654 values = ["%04x" % int(i, 16) for i in l_prefix] \ -655 + ['0000' for i in range(gap_size)] \ -656 + ["%04x" % int(i, 16) for i in l_suffix] -657 else: -658 # Verbose form IPv6 address. -659 if '.' in addr: -660 # IPv4 compatiblility mode. -661 tokens = addr.split(':') -662 ipv4_str = tokens[-1] -663 if ST_IPV4.str_to_int(ipv4_str) +662 ipv4_words = ST_IPV4.int_to_words(ipv4_int) +663 l_suffix.pop() +664 l_suffix.append( +665 ''.join(["%.2x" % i for i in ipv4_words[0:2]])) +666 l_suffix.append( +667 ''.join(["%.2x" % i for i in ipv4_words[2:4]])) +668 +669 gap_size = 8 - ( len(l_prefix) + len(l_suffix) ) +670 +671 values = ["%04x" % int(i, 16) for i in l_prefix] \ +672 + ['0000' for i in range(gap_size)] \ +673 + ["%04x" % int(i, 16) for i in l_suffix] +674 else: +675 # Verbose form IPv6 address. +676 if '.' in addr: +677 # IPv4 compatiblility mode. +678 tokens = addr.split(':') +679 ipv4_str = tokens[-1] +680 if ST_IPV4.valid_str(ipv4_str): -664 ipv4_int = ST_IPV4.valid_str(ipv4_str): +681 ipv4_int = ST_IPV4.str_to_int(ipv4_str) -665 ipv4_words = ST_IPV4.int_to_words(ipv4_int) -666 tokens.pop() -667 tokens.append(''.join(["%.2x" % i for i in ipv4_words[0:2]])) -668 tokens.append(''.join(["%.2x" % i for i in ipv4_words[2:4]])) -669 -670 values = ["%04x" % int(i, 16) for i in tokens] -671 else: -672 # non IPv4 compatiblility mode. -673 values = ["%04x" % int(i, 16) for i in addr.split(':')] -674 -675 value = int(''.join(values), 16) -676 -677 return value -
    678 -
    679 - def int_to_str(self, int_val, compact=True, word_fmt=None): -
    680 """ -681 @param int_val: A network byte order integer. -682 -683 @param compact: (optional) A boolean flag indicating if compact -684 formatting should be used. If True, this method uses the '::' -685 string to represent the first adjacent group of words with a value -686 of zero. Default: True -687 -688 @param word_fmt: (optional) The Python format string used to override -689 formatting for each word. -690 -691 @return: The IPv6 string form equal to the network byte order integer -692 value provided. -693 """ -694 # Use basic parent class implementation if compact string form is -695 # not required. -696 if not compact: -697 return super(self.__class__, self).str_to_int(ipv4_str) +682 ipv4_words = ST_IPV4.int_to_words(ipv4_int) +683 tokens.pop() +684 tokens.append(''.join(["%.2x" % i for i in ipv4_words[0:2]])) +685 tokens.append(''.join(["%.2x" % i for i in ipv4_words[2:4]])) +686 +687 values = ["%04x" % int(i, 16) for i in tokens] +688 else: +689 # non IPv4 compatiblility mode. +690 values = ["%04x" % int(i, 16) for i in addr.split(':')] +691 +692 value = int(''.join(values), 16) +693 +694 return value +
    695 +
    696 - def int_to_str(self, int_val, compact=True, word_fmt=None): +
    697 """ +698 @param int_val: A network byte order integer. +699 +700 @param compact: (optional) A boolean flag indicating if compact +701 formatting should be used. If True, this method uses the '::' +702 string to represent the first adjacent group of words with a value +703 of zero. Default: True +704 +705 @param word_fmt: (optional) The Python format string used to override +706 formatting for each word. +707 +708 @return: The IPv6 string form equal to the network byte order integer +709 value provided. +710 """ +711 # Use basic parent class implementation if compact string form is +712 # not required. +713 if not compact: +714 return super(self.__class__, self).int_to_str(int_val) -698 -699 the_word_fmt = self.word_fmt -700 if word_fmt is not None: -701 the_word_fmt = word_fmt -702 -703 if not self.valid_int(int_val): -704 raise ValueError('%r is not a valid integer value supported ' \ -705 'by this address type!' % int_val) -706 -707 tokens = [] -708 for i in range(self.word_count): -709 word = int_val & (2 ** self.word_size - 1) -710 tokens += [the_word_fmt % word] -711 int_val >>= self.word_size -712 -713 tokens.reverse() -714 -715 # This can probably be optimised. -716 if compact == True: -717 new_tokens = [] -718 compact_start = False -719 compact_end = False -720 for token in tokens: -721 if token == '0': -722 if compact_start == False and compact_end == False: -723 new_tokens += [''] -724 compact_start = True -725 elif compact_start == True and compact_end == False: -726 pass -727 else: -728 new_tokens += ['0'] -729 else: -730 if compact_start == True: -731 compact_end = True -732 new_tokens += [token] -733 -734 # Post loop fixups. -735 if len(new_tokens) == 1 and new_tokens[0] == '': -736 new_tokens += ['', ''] -737 elif new_tokens[-1] == '': -738 new_tokens += [''] -739 elif new_tokens[0] == '': -740 new_tokens.insert(0, '') -741 -742 tokens = new_tokens -743 -744 return ':'.join(tokens) -
    745 -
    746 - def int_to_arpa(self, int_val): -
    747 """ -748 @param int_val: A network byte order integer. -749 -750 @return: The reverse DNS lookup for an IPv6 address in network byte -751 order integer form. -752 """ -753 addr = self.int_to_str(int_val) +715 +716 _word_fmt = self.word_fmt +717 if word_fmt is not None: +718 _word_fmt = word_fmt +719 +720 if not self.valid_int(int_val): +721 raise ValueError('%r is not a valid integer value supported ' \ +722 'by this address type!' % int_val) +723 +724 tokens = [] +725 for i in range(self.num_words): +726 word = int_val & (2 ** self.word_size - 1) +727 tokens += [_word_fmt % word] +728 int_val >>= self.word_size +729 +730 tokens.reverse() +731 +732 if compact == True: +733 new_tokens = [] +734 +735 positions = [] +736 within_run = False +737 start_index = None +738 num_tokens = 0 +739 +740 # Discover all runs of zeros. +741 for idx, token in enumerate(tokens): +742 if token == '0': +743 within_run = True +744 if start_index is None: +745 start_index = idx +746 num_tokens += 1 +747 else: +748 if num_tokens > 1: +749 positions.append((num_tokens, start_index)) +750 within_run = False +751 start_index = None +752 num_tokens = 0 +753 +754 new_tokens.append(token) +755 +756 # Store any position not saved before loop exit. +757 if num_tokens > 1: +758 positions.append((num_tokens, start_index)) +759 +760 # Replace first longest run with an empty string. +761 if len(positions) != 0: +762 # Locate longest, left-most run of zeros. +763 positions.sort(lambda x, y: cmp(x[1], y[1])) +764 best_position = positions[0] +765 for position in positions: +766 if position[0] > best_position[0]: +767 best_position = position +768 # Replace chosen zero run. +769 (length, start_idx) = best_position +770 new_tokens = new_tokens[0:start_idx] + [''] + \ +771 new_tokens[start_idx+length:] +772 +773 # Add start and end blanks so join creates '::'. +774 if new_tokens[0] == '': +775 new_tokens.insert(0, '') +776 +777 if new_tokens[-1] == '': +778 new_tokens.append('') +779 +780 tokens = new_tokens +781 +782 return self.word_sep.join(tokens) +
    783 +
    784 - def int_to_arpa(self, int_val): +
    785 """ +786 @param int_val: A network byte order integer. +787 +788 @return: The reverse DNS lookup for an IPv6 address in network byte +789 order integer form. +790 """ +791 addr = self.int_to_str(int_val, word_fmt='%04x') -754 tokens = list(addr.replace(':', '')) -755 tokens.reverse() -756 # We won't support ip6.int here - see RFC 3152 for details. -757 tokens = tokens + ['ip6', 'arpa', ''] -758 return '.'.join(tokens) -
    759 -760 #----------------------------------------------------------------------------- -
    761 -class EUI48Strategy(AddrStrategy): -
    762 """ -763 Implements the operations that can be performed on an IEEE 48-bit EUI -764 (Extended Unique Identifer). For all intents and purposes here, a MAC -765 address. -766 -767 Supports most common MAC address formats including Cisco's string format. -768 """ -
    769 - def __init__(self): -
    770 """Constructor.""" -771 super(self.__class__, self).int_to_str(int_val, word_fmt='%04x') +792 tokens = list(addr.replace(':', '')) +793 tokens.reverse() +794 # We won't support ip6.int here - see RFC 3152 for details. +795 tokens = tokens + ['ip6', 'arpa', ''] +796 return '.'.join(tokens) +
    797 +798 #----------------------------------------------------------------------------- +
    799 -class EUI48Strategy(AddrStrategy): +
    800 """ +801 Implements the operations that can be performed on an IEEE 48-bit EUI +802 (Extended Unique Identifer) a.k.a. a MAC (Media Access Control) layer 2 +803 address. +804 +805 Supports all common (and some less common MAC string formats including +806 Cisco's 'triple hextet' format and also bare MACs that contain no +807 delimiters. +808 """ +809 # Regular expression to match the numerous different MAC formats. +810 RE_MAC_FORMATS = ( +811 # 2 bytes x 6 (UNIX, Windows, EUI-48) +812 '^' + ':'.join(['([0-9A-F]{1,2})'] * 6) + '$', +813 '^' + '-'.join(['([0-9A-F]{1,2})'] * 6) + '$', +814 +815 # 4 bytes x 3 (Cisco) +816 '^' + ':'.join(['([0-9A-F]{1,4})'] * 3) + '$', +817 '^' + '-'.join(['([0-9A-F]{1,4})'] * 3) + '$', +818 +819 # 6 bytes x 2 (PostgreSQL) +820 '^' + '-'.join(['([0-9A-F]{5,6})'] * 2) + '$', +821 '^' + ':'.join(['([0-9A-F]{5,6})'] * 2) + '$', +822 +823 # 12 bytes (bare, no delimiters) +824 '^(' + ''.join(['[0-9A-F]'] * 12) + ')$', +825 '^(' + ''.join(['[0-9A-F]'] * 11) + ')$', +826 ) +827 # For efficiency, replace each string regexp with its compiled +828 # equivalent. +829 RE_MAC_FORMATS = [_re.compile(_, _re.IGNORECASE) for _ in RE_MAC_FORMATS] +830 +
    831 - def __init__(self, word_fmt='%02x', word_sep='-', uppercase=True): +
    832 """ +833 Constructor. +834 +835 @param word_sep: separator between each word. +836 (Default: '-') +837 +838 @param word_fmt: format string for each hextet. +839 (Default: '%02x') +840 +841 @param uppercase: return uppercase MAC/EUI-48 addresses. +842 (Default: True) +843 """ +844 super(self.__class__, self).__init__(__init__(addr_type=AT_LINK, width=48, -772 word_size=8, word_fmt='%02x', delimiter='-', to_upper=True) -
    773 -
    774 - def valid_str(self, addr): -
    775 """ -776 @param addr: An EUI-48 or MAC address in string form. -777 -778 @return: C{True} if MAC address string is valid, C{False} otherwise. -779 """ -780 if not isinstance(addr, (str, unicode)): -781 return False -782 -783 try: -784 if '.' in addr: -785 # Cisco style. -786 words = [int("0x%s" % i, 0) for i in addr.split('.')] -787 if len(words) != 3: -788 return False -789 for i in words: -790 if not (0 <= i <= 0xffff): -791 return False -792 else: -793 if '-' in addr: -794 # Windows style. -795 words = [int("0x%s" % i, 0) for i in addr.split('-')] -796 elif ':' in addr: -797 # UNIX style. -798 words = [int("0x%s" % i, 0) for i in addr.split(':')] -799 else: -800 return False -801 if len(words) != 6: -802 return False -803 for i in words: -804 if not (0 <= i <= 0xff): -805 return False -806 except TypeError: -807 return False -808 except ValueError: -809 return False -810 -811 return True -
    812 -
    813 - def str_to_words(self, addr): -
    814 """ -815 @param addr: An EUI-48 or MAC address in string form. -816 -817 Returns an integer word sequence that is equivalent in value to MAC -818 address in string form. -819 """ -820 if not self.valid_str(addr): -821 raise ValueError('%r is not a recognised string representation' \ -822 ' of this address type!' % addr) -823 -824 if ':' in addr: -825 # UNIX style. -826 words = addr.split(':') -827 return tuple([ int(word, self.word_base) for word in words ]) -828 elif '-' in addr: -829 # Windows style. -830 words = addr.split('-') -831 return tuple([ int(word, self.word_base) for word in words ]) -832 elif '.' in addr: -833 # Cisco style. -834 words = [] -835 for num in addr.split('.'): -836 octets = [] -837 int_val = int(num, 16) -838 for i in range(2): -839 word = int_val & 0xff -840 octets.append(int(word)) -841 int_val >>= 8 -842 octets.reverse() -843 words.extend(octets) -844 return tuple(words) -
    845 -
    846 - def int_to_str(self, int_val, delimiter=None, word_fmt=None, -847 to_upper=True): -
    848 """ -849 @param int_val: A network byte order integer. -850 -851 @param delimiter: (optional) A delimiter string override to be used -852 instead of the default between words in string value returned. -853 -854 @param word_fmt: (optional) A Python format string override used to -855 format each word of address instead of the default. -856 -857 @return: A MAC address in string form that is equivalent to value -858 represented by a network byte order integer. -859 """ -860 the_delimiter = self.delimiter -861 if delimiter is not None: -862 the_delimiter = delimiter -863 -864 the_word_fmt = self.word_fmt -865 if word_fmt is not None: -866 the_word_fmt = word_fmt -867 -868 the_to_upper = self.to_upper -869 if to_upper is not True: -870 the_to_upper = to_upper -871 -872 words = self.int_to_words(int_val) -873 tokens = [the_word_fmt % i for i in words] -874 addr = the_delimiter.join(tokens) -875 -876 if the_to_upper is True: -877 return addr.upper() -878 -879 return addr -
    880 -881 #----------------------------------------------------------------------------- -882 # Shared strategy objects for supported address types. -883 #----------------------------------------------------------------------------- -884 -885 #: A shared strategy object supporting all operations on IPv4 addresses. -886 ST_IPV4 = None -887 # Use the right strategy class dependent upon Python implementation (work- -888 # around for various Python bugs). -889 if USE_IPV4_OPT is True: -890 ST_IPV4 = IPv4StrategyOpt() -891 else: -892 ST_IPV4 = IPv4StrategyStd() -893 -894 #: A shared strategy object supporting all operations on IPv6 addresses. -895 ST_IPV6 = IPv6Strategy() -896 #: A shared strategy object supporting all operations on EUI-48/MAC addresses. -897 ST_EUI48 = EUI48Strategy() -898 -899 #: A shared strategy object supporting all operations on EUI-64 addresses. -900 ST_EUI64 = AddrStrategy(addr_type=AT_LINK, width=48, +845 word_size=8, word_fmt=word_fmt, word_sep=word_sep, +846 uppercase=uppercase) +
    847 +
    848 - def valid_str(self, addr): +
    849 """ +850 @param addr: An EUI-48 or MAC address in string form. +851 +852 @return: C{True} if MAC address string is valid, C{False} otherwise. +853 """ +854 if not isinstance(addr, (str, unicode)): +855 return False +856 +857 for regexp in EUI48Strategy.RE_MAC_FORMATS: +858 match_result = regexp.findall(addr) +859 if len(match_result) != 0: +860 return True +861 return False +
    862 +
    863 - def str_to_int(self, addr): +
    864 """ +865 @param addr: An EUI-48 or MAC address in string form. +866 +867 @return: A network byte order integer that is equivalent to value +868 represented by EUI-48/MAC string address. +869 """ +870 words = [] +871 if isinstance(addr, (str, unicode)): +872 found_match = False +873 for regexp in EUI48Strategy.RE_MAC_FORMATS: +874 match_result = regexp.findall(addr) +875 if len(match_result) != 0: +876 found_match = True +877 if isinstance(match_result[0], tuple): +878 words = match_result[0] +879 else: +880 words = (match_result[0],) +881 break +882 if not found_match: +883 raise AddrFormatError('%r is not a supported MAC format!' \ +884 % addr) +885 else: +886 raise TypeError('%r is not str() or unicode()!' % addr) +887 +888 int_val = None +889 +890 if len(words) == 6: +891 # 2 bytes x 6 (UNIX, Windows, EUI-48) +892 int_val = int(''.join(['%02x' % int(w, 16) for w in words]), 16) +893 elif len(words) == 3: +894 # 4 bytes x 3 (Cisco) +895 int_val = int(''.join(['%04x' % int(w, 16) for w in words]), 16) +896 elif len(words) == 2: +897 # 6 bytes x 2 (PostgreSQL) +898 int_val = int(''.join(['%06x' % int(w, 16) for w in words]), 16) +899 elif len(words) == 1: +900 # 12 bytes (bare, no delimiters) +901 int_val = int('%012x' % int(words[0], 16), 16) +902 else: +903 raise AddrFormatError('unexpected word count in MAC address %r!' \ +904 % addr) +905 +906 return int_val +
    907 +
    908 - def int_to_str(self, int_val, word_sep=None, word_fmt=None): +
    909 """ +910 @param int_val: A network byte order integer. +911 +912 @param word_sep: (optional) The separator used between words in an +913 address string. +914 +915 @param word_fmt: (optional) A Python format string used to format +916 each word of address. +917 +918 @return: A MAC address in string form that is equivalent to value +919 represented by a network byte order integer. +920 """ +921 _word_sep = self.word_sep +922 if word_sep is not None: +923 _word_sep = word_sep +924 +925 _word_fmt = self.word_fmt +926 if word_fmt is not None: +927 _word_fmt = word_fmt +928 +929 words = self.int_to_words(int_val) +930 tokens = [_word_fmt % i for i in words] +931 addr = _word_sep.join(tokens) +932 +933 return addr.upper() +
    934 +935 #----------------------------------------------------------------------------- +936 # Shared strategy objects for supported address types. +937 #----------------------------------------------------------------------------- +938 +939 #: A shared strategy object supporting all operations on IPv4 addresses. +940 ST_IPV4 = None +941 # Use the right strategy class dependent upon Python implementation (work- +942 # around for various Python bugs). +943 if USE_IPV4_OPT is True: +944 ST_IPV4 = IPv4StrategyOpt() +945 else: +946 ST_IPV4 = IPv4StrategyStd() +947 +948 #: A shared strategy object supporting all operations on IPv6 addresses. +949 ST_IPV6 = IPv6Strategy() +950 #: A shared strategy object supporting all operations on EUI-48/MAC addresses. +951 ST_EUI48 = EUI48Strategy() +952 +953 #: A shared strategy object supporting all operations on EUI-64 addresses. +954 ST_EUI64 = AddrStrategy(addr_type=AT_EUI64, width=64, word_size=8, -901 word_fmt='%02x', delimiter='-', to_upper=True) -902 -903 #----------------------------------------------------------------------------- -904 if __name__ == '__main__': -905 pass -906 + + diff --git a/docs/api/toc-netaddr.eui-module.html b/docs/api/toc-netaddr.eui-module.html new file mode 100644 index 0000000..5d11039 --- /dev/null +++ b/docs/api/toc-netaddr.eui-module.html @@ -0,0 +1,30 @@ + + + + + eui + + + + + +

    Module eui

    +
    +

    Classes

    +

    Functions

    +

    Variables

    +
    + + + + diff --git a/docs/api/toc-netaddr.ip-module.html b/docs/api/toc-netaddr.ip-module.html new file mode 100644 index 0000000..860ba5f --- /dev/null +++ b/docs/api/toc-netaddr.ip-module.html @@ -0,0 +1,38 @@ + + + + + ip + + + + + +

    Module ip

    +
    +

    Classes

    + DictUpdater
    IPv4Parser
    IPv6Parser
    LineRecordParser
    MulticastParser

    Functions

    + load_iana_info
    query

    Variables

    + IANA_INFO
    + + + + diff --git a/docs/api/toc-netaddr.misc-module.html b/docs/api/toc-netaddr.misc-module.html new file mode 100644 index 0000000..00ee23a --- /dev/null +++ b/docs/api/toc-netaddr.misc-module.html @@ -0,0 +1,32 @@ + + + + + misc + + + + + +

    Module misc

    +
    +

    Functions

    + ipv4_cidr_prefixes
    ipv6_cidr_prefixes
    print_ipv4_cidr_prefixes
    print_ipv6_cidr_prefixes
    + + + + diff --git a/docs/api/toc.html b/docs/api/toc.html index 3a311a3..bb9da0c 100755 --- a/docs/api/toc.html +++ b/docs/api/toc.html @@ -16,7 +16,9 @@

    Modules

    netaddr
    + onclick="setFrame('toc-netaddr-module.html','netaddr-module.html');" >netaddr
    netaddr.ip
    netaddr.misc