Merged revisions 72173 via svnmerge from

svn+ssh://pythondev@svn.python.org/python/trunk

........
  r72173 | gregory.p.smith | 2009-05-01 12:59:52 -0700 (Fri, 01 May 2009) | 5 lines

  Adds the ipaddr module to the standard library.  Issue #3959.
  Based off of subversion r69 from http://code.google.com/p/ipaddr-py/

  This code is 2to3 safe, I'll merge it into py3k later this afternoon.
........
This commit is contained in:
Gregory P. Smith 2009-05-01 22:13:48 +00:00
parent 435b0f2491
commit e54dff5e63
4 changed files with 2262 additions and 0 deletions

327
Doc/library/ipaddr.rst Normal file
View File

@ -0,0 +1,327 @@
:mod:`ipaddr` --- IP address manipulation library
=================================================
.. module:: ipaddr
:synopsis: IPv4 and IPv6 network address manipulation classes.
.. moduleauthor:: Google, Inc.
.. sectionauthor:: Gregory P. Smith <greg@krypto.org>
.. versionadded:: 2.7
.. index::
single: IP address, IPv4, IPv6, netmask
This module implements classes for working with IP host and network addresses,
both IPv4 and IPv6.
.. function:: IP(ipaddr)
Take an IP string or int and return an object of the correct type.
Returns an :class:`IPv4` or :class:`IPv6` object.
The ``ipaddr`` parameter must be a string or integer representing the IP
address. Either IPv4 or IPv6 addresses may be supplied. Integers less
than 2**32 will be considered to be IPv4.
Raises :exc:`ValueError` if the ipaddr passed is not either an IPv4 or an
IPv6 address.
.. function:: collapse_address_list(addresses)
Collapses a sequence of :class:`IPv4` or :class:`IPv6` objects into
the most concise representation. Returns a list of :class:`IPv4`
or :class:`IPv6` objects.
Example usage::
>>> collapse_address_list([IPv4('1.1.0.0/24'), IPv4('1.1.1.0/24')])
[IPv4('1.1.0.0/23')]
.. class:: BaseIP()
A generic IP address object. This base class defines the API and contains
common code. Most authors should either use the :func:`IP` function or
create :class:`IPv4` or :class:`IPv6` objects directly rather than using
this base class.
IP address objects support the following python operators:
``=``, ``!=``, ``<``, ``>``, ``<=``, ``>=``, and ``in``.
An IP address object may be used as a sequence index or as a hash key
and can be converted back to an integer representation using ``int()``.
It may also be used as a sequence that yeilds the string
representation of every IP address within the object's subnet.
The following properties are available on all IP address objects:
.. data:: broadcast
Integer representation of the broadcast address. Read only.
.. data:: broadcast_ext
Dotted decimal or colon string version of the broadcast address. Read only.
.. data:: hostmask
Integer representation of the hostmask. Read only.
.. data:: hostmask_ext
Dotted decimal or colon string version of the hostmask. Read only.
.. data:: ip
Integer representation of the IP address. Read only.
.. data:: ip_ext
Dotted decimal or colon string version of the IP address. Read only.
.. data:: ip_ext_full
Canonical string version of the IP address. Read only.
.. data:: is_loopback
True if the address is a loopback address as defined in IPv4 :rfc:`3330`
or IPv6 :rfc:`2373` section 2.5.3.
.. data:: is_link_local
True if the address is a link-local address as defined in IPv4 :rfc:`3927`
or IPv6 :rfc:`4291`.
.. data:: is_multicast
True if the address is reserved for multicast use.
See IPv4 :rfc:`3171` or IPv6 :rfc:`2373` section 2.7 for details.
.. data:: is_private
True if the address is reserved for private networks as defined in
IPv4 :rfc:`1918` or IPv6 :rfc:`4193`.
.. data:: netmask
Integer representation of the netmask. Read only.
.. data:: netmask_ext
Dotted decimal or colon string version of the netmask. Read only.
.. data:: network
Integer representation of the network. Read only.
.. data:: network_ext
Dotted decimal or colon string version of the network. Read only.
.. data:: numhosts
Number of hosts in the current subnet. Read only.
.. data:: packed
The packed network byte order representation of this network address. Read only.
.. data:: prefixlen
A property to get and set the prefix length. Readable and writeable.
.. data:: version
Integer IP version number. Read only.
The following methods are available on all IP address objects:
.. method:: address_exclude(other)
Remove an address from within a larger block.
Returns a sorted list of IP address objects representing networks.
Examples::
>>> addr1 = IP('10.1.1.0/24')
>>> addr2 = IP('10.1.1.0/26')
>>> addr1.address_exclude(addr2)
[IP('10.1.1.64/26'), IP('10.1.1.128/25')]
>>> addr1 = IP('::1/32')
>>> addr2 = IP('::1/128')
>>> addr1.address_exclude(addr2)
[IP('::0/128'), IP('::2/127'), IP('::4/126'), IP('::8/125'),
... IP('0:0:8000::/33')]
Raises :exc:`ValueError` if `other` is not completely contained by self.
.. method:: compare_networks(other)
Compare this IP object's network to another IP network.
Returns -1, 0 or 1.
This compares the integer representation of the network addresses.
The host bits are not considered by this method.
If you want to compare host bits, you can use ``host_a.ip < host_b.ip``.
If the IP versions of self and other are the same, returns:
-1 if self < other
eg: IPv4('1.1.1.0/24') < IPv4('1.1.2.0/24')
IPv6('1080::200C:417A') < IPv6('1080::200B:417B')
0 if self == other
eg: IPv4('1.1.1.1/24') == IPv4('1.1.1.2/24')
IPv6('1080::200C:417A/96') == IPv6('1080::200C:417B/96')
1 if self > other
eg: IPv4('1.1.1.0/24') > IPv4('1.1.0.0/24')
IPv6('1080::1:200C:417A/112') > IPv6('1080::0:200C:417A/112')
If the IP versions of self and other are different, returns:
-1 if self.version < other.version
eg: IPv4('10.0.0.1/24') < IPv6('::1/128')
1 if self.version > other.version
eg: IPv6('::1/128') > IPv4('255.255.255.0/24')
.. method:: subnet(prefixlen_diff=1)
Returns a list of subnets which when joined make up the current subnet.
The optional ``prefixlen_diff`` argument specifies how many bits the prefix
length should be increased by. Given a /24 network and prefixlen_diff=3,
for example, 8 subnets of size /27 will be returned.
If called on a host IP address rather than a network, a list containing
the host itself will be returned.
Raises :exc:`PrefixlenDiffInvalidError` if the prefixlen_diff is out of
range.
.. method:: supernet(prefixlen_diff=1)
Returns a single IP object representing the supernet containing the
current network.
The optional ``prefixlen_diff`` argument specifies how many bits the prefix
length should be decreased by. Given a /24 network and prefixlen_diff=3,
for example, a supernet with a 21 bit netmask is returned.
Raises :exc:`PrefixlenDiffInvalidError` if the prefixlen_diff is out of
range.
.. class:: IPv4()
This class represents and manipulates 32-bit IPv4 addresses.
Attributes::
# These examples for IPv4('1.2.3.4/27')
.ip: 16909060
.ip_ext: '1.2.3.4'
.ip_ext_full: '1.2.3.4'
.network: 16909056
.network_ext: '1.2.3.0'
.hostmask: 31 (0x1F)
.hostmask_ext: '0.0.0.31'
.broadcast: 16909087 (0x102031F)
.broadcast_ext: '1.2.3.31'
.netmask: 4294967040 (0xFFFFFFE0)
.netmask_ext: '255.255.255.224'
.prefixlen: 27
.. class:: IPv6()
This class respresents and manipulates 128-bit IPv6 addresses.
Attributes::
# These examples are for IPv6('2001:658:22A:CAFE:200::1/64')
.ip: 42540616829182469433547762482097946625
.ip_ext: '2001:658:22a:cafe:200::1'
.ip_ext_full: '2001:0658:022a:cafe:0200:0000:0000:0001'
.network: 42540616829182469433403647294022090752
.network_ext: '2001:658:22a:cafe::'
.hostmask: 18446744073709551615
.hostmask_ext: '::ffff:ffff:ffff:ffff'
.broadcast: 42540616829182469451850391367731642367
.broadcast_ext: '2001:658:22a:cafe:ffff:ffff:ffff:ffff'
.netmask: 340282366920938463444927863358058659840
.netmask_ext: 64
.prefixlen: 64
.. data:: is_site_local
True if the address was reserved as site-local in :rfc:`3513` section 2.5.6.
.. note::
The IPv6 site-local address space has been deprecated by :rfc:`3879`.
Use :data:`is_private` to test if this address is in the space of
unique local addresses as defined by :rfc:`4193`.
.. data:: is_unspecified
True if this is the unspecified address as defined in :rfc:`2373` section 2.5.2.
The following exceptions are defined by this module:
.. exception:: Error
Base class for all exceptions defined in this module.
.. exception:: IPTypeError
Tried to perform a v4 action on v6 object or vice versa.
.. exception:: IPAddressExclusionError
An Error we should never see occurred in address exclusion.
.. exception:: IPv4IpValidationError
Raised when an IPv4 address is invalid.
.. exception:: IPv4NetmaskValidationError
Raised when a netmask is invalid.
.. exception:: IPv6IpValidationError
Raised when an IPv6 address is invalid.
.. exception:: IPv6NetmaskValidationError
Raised when an IPv6 netmask is invalid.
.. exception:: PrefixlenDiffInvalidError
Raised when :meth:`BaseIP.subnet` or :meth:`BaseIP.supernet` is called with a bad
``prefixlen_diff``.
.. seealso::
http://code.google.com/p/ipaddr-py/
The original source of this module and a place to download it as
a package for use on earlier versions of Python.

1365
Lib/ipaddr.py Normal file

File diff suppressed because it is too large Load Diff

567
Lib/test/test_ipaddr.py Executable file
View File

@ -0,0 +1,567 @@
# Copyright 2007 Google Inc.
# Licensed to PSF under a Contributor Agreement.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# See also: http://code.google.com/p/ipaddr-py/
"""Unittest for ipaddr module."""
import unittest
import ipaddr
# Compatibility function to cast str to bytes objects
if ipaddr._compat_has_real_bytes:
_cb = lambda bytestr: bytes(bytestr, 'charmap')
else:
_cb = str
class IpaddrUnitTest(unittest.TestCase):
def setUp(self):
self.ipv4 = ipaddr.IPv4('1.2.3.4/24')
self.ipv4_hostmask = ipaddr.IPv4('10.0.0.1/0.255.255.255')
self.ipv6 = ipaddr.IPv6('2001:658:22a:cafe:200:0:0:1/64')
def testRepr(self):
self.assertEqual("IPv4('1.2.3.4/32')", repr(ipaddr.IPv4('1.2.3.4')))
self.assertEqual("IPv6('::1/128')", repr(ipaddr.IPv6('::1')))
def testInvalidStrings(self):
self.assertRaises(ValueError, ipaddr.IP, '')
self.assertRaises(ValueError, ipaddr.IP, 'www.google.com')
self.assertRaises(ValueError, ipaddr.IP, '1.2.3')
self.assertRaises(ValueError, ipaddr.IP, '1.2.3.4.5')
self.assertRaises(ValueError, ipaddr.IP, '301.2.2.2')
self.assertRaises(ValueError, ipaddr.IP, '1:2:3:4:5:6:7')
self.assertRaises(ValueError, ipaddr.IP, '1:2:3:4:5:6:7:')
self.assertRaises(ValueError, ipaddr.IP, ':2:3:4:5:6:7:8')
self.assertRaises(ValueError, ipaddr.IP, '1:2:3:4:5:6:7:8:9')
self.assertRaises(ValueError, ipaddr.IP, '1:2:3:4:5:6:7:8:')
self.assertRaises(ValueError, ipaddr.IP, '1::3:4:5:6::8')
self.assertRaises(ValueError, ipaddr.IP, 'a:')
self.assertRaises(ValueError, ipaddr.IP, ':')
self.assertRaises(ValueError, ipaddr.IP, ':::')
self.assertRaises(ValueError, ipaddr.IP, '::a:')
self.assertRaises(ValueError, ipaddr.IP, '1ffff::')
self.assertRaises(ValueError, ipaddr.IP, '0xa::')
self.assertRaises(ValueError, ipaddr.IP, '1:2:3:4:5:6:1a.2.3.4')
self.assertRaises(ValueError, ipaddr.IP, '1:2:3:4:5:1.2.3.4:8')
self.assertRaises(ipaddr.IPv4IpValidationError, ipaddr.IPv4, '')
self.assertRaises(ipaddr.IPv4IpValidationError, ipaddr.IPv4,
'google.com')
self.assertRaises(ipaddr.IPv4IpValidationError, ipaddr.IPv4,
'::1.2.3.4')
self.assertRaises(ipaddr.IPv6IpValidationError, ipaddr.IPv6, '')
self.assertRaises(ipaddr.IPv6IpValidationError, ipaddr.IPv6,
'google.com')
self.assertRaises(ipaddr.IPv6IpValidationError, ipaddr.IPv6,
'1.2.3.4')
def testGetNetwork(self):
self.assertEqual(self.ipv4.network, 16909056)
self.assertEqual(self.ipv4.network_ext, '1.2.3.0')
self.assertEqual(self.ipv4_hostmask.network_ext, '10.0.0.0')
self.assertEqual(self.ipv6.network,
42540616829182469433403647294022090752)
self.assertEqual(self.ipv6.network_ext,
'2001:658:22a:cafe::')
self.assertEqual(self.ipv6.hostmask_ext,
'::ffff:ffff:ffff:ffff')
def testIpFromInt(self):
self.assertEqual(self.ipv4.ip, ipaddr.IPv4(16909060).ip)
self.assertRaises(ipaddr.IPv4IpValidationError,
ipaddr.IPv4, 2**32)
self.assertRaises(ipaddr.IPv4IpValidationError,
ipaddr.IPv4, -1)
self.assertEqual(self.ipv6.ip,
ipaddr.IPv6(42540616829182469433547762482097946625).ip)
self.assertRaises(ipaddr.IPv6IpValidationError,
ipaddr.IPv6, 2**128)
self.assertRaises(ipaddr.IPv6IpValidationError,
ipaddr.IPv6, -1)
self.assertEqual(ipaddr.IP(self.ipv4.ip).version, 4)
self.assertEqual(ipaddr.IP(self.ipv6.ip).version, 6)
if ipaddr._compat_has_real_bytes: # on python3+
def testIpFromPacked(self):
ip = ipaddr.IP
self.assertEqual(self.ipv4.ip,
ip(_cb('\x01\x02\x03\x04')).ip)
self.assertEqual(ip('255.254.253.252'),
ip(_cb('\xff\xfe\xfd\xfc')))
self.assertRaises(ValueError, ipaddr.IP, _cb('\x00' * 3))
self.assertRaises(ValueError, ipaddr.IP, _cb('\x00' * 5))
self.assertEqual(self.ipv6.ip,
ip(_cb('\x20\x01\x06\x58\x02\x2a\xca\xfe'
'\x02\x00\x00\x00\x00\x00\x00\x01')).ip)
self.assertEqual(ip('ffff:2:3:4:ffff::'),
ip(_cb('\xff\xff\x00\x02\x00\x03\x00\x04' +
'\xff\xff' + '\x00' * 6)))
self.assertEqual(ip('::'),
ip(_cb('\x00' * 16)))
self.assertRaises(ValueError, ip, _cb('\x00' * 15))
self.assertRaises(ValueError, ip, _cb('\x00' * 17))
def testGetIp(self):
self.assertEqual(self.ipv4.ip, 16909060)
self.assertEqual(self.ipv4.ip_ext, '1.2.3.4')
self.assertEqual(self.ipv4.ip_ext_full, '1.2.3.4')
self.assertEqual(self.ipv4_hostmask.ip_ext, '10.0.0.1')
self.assertEqual(self.ipv6.ip, 42540616829182469433547762482097946625)
self.assertEqual(self.ipv6.ip_ext,
'2001:658:22a:cafe:200::1')
self.assertEqual(self.ipv6.ip_ext_full,
'2001:0658:022a:cafe:0200:0000:0000:0001')
def testGetNetmask(self):
self.assertEqual(self.ipv4.netmask, 4294967040)
self.assertEqual(self.ipv4.netmask_ext, '255.255.255.0')
self.assertEqual(self.ipv4_hostmask.netmask_ext, '255.0.0.0')
self.assertEqual(self.ipv6.netmask,
340282366920938463444927863358058659840)
self.assertEqual(self.ipv6.netmask_ext, 64)
def testZeroNetmask(self):
ipv4_zero_netmask = ipaddr.IPv4('1.2.3.4/0')
self.assertEqual(ipv4_zero_netmask.netmask, 0)
self.assert_(ipv4_zero_netmask._is_valid_netmask(str(0)))
ipv6_zero_netmask = ipaddr.IPv6('::1/0')
self.assertEqual(ipv6_zero_netmask.netmask, 0)
self.assert_(ipv6_zero_netmask._is_valid_netmask(str(0)))
def testGetBroadcast(self):
self.assertEqual(self.ipv4.broadcast, 16909311)
self.assertEqual(self.ipv4.broadcast_ext, '1.2.3.255')
self.assertEqual(self.ipv6.broadcast,
42540616829182469451850391367731642367)
self.assertEqual(self.ipv6.broadcast_ext,
'2001:658:22a:cafe:ffff:ffff:ffff:ffff')
def testGetPrefixlen(self):
self.assertEqual(self.ipv4.prefixlen, 24)
self.assertEqual(self.ipv6.prefixlen, 64)
def testGetSupernet(self):
self.assertEqual(self.ipv4.supernet().prefixlen, 23)
self.assertEqual(self.ipv4.supernet().network_ext, '1.2.2.0')
self.assertEqual(ipaddr.IPv4('0.0.0.0/0').supernet(),
ipaddr.IPv4('0.0.0.0/0'))
self.assertEqual(self.ipv6.supernet().prefixlen, 63)
self.assertEqual(self.ipv6.supernet().network_ext,
'2001:658:22a:cafe::')
self.assertEqual(ipaddr.IPv6('::0/0').supernet(), ipaddr.IPv6('::0/0'))
def testGetSupernet3(self):
self.assertEqual(self.ipv4.supernet(3).prefixlen, 21)
self.assertEqual(self.ipv4.supernet(3).network_ext, '1.2.0.0')
self.assertEqual(self.ipv6.supernet(3).prefixlen, 61)
self.assertEqual(self.ipv6.supernet(3).network_ext,
'2001:658:22a:caf8::')
def testGetSubnet(self):
self.assertEqual(self.ipv4.subnet()[0].prefixlen, 25)
self.assertEqual(self.ipv4.subnet()[0].network_ext, '1.2.3.0')
self.assertEqual(self.ipv4.subnet()[1].network_ext, '1.2.3.128')
self.assertEqual(self.ipv6.subnet()[0].prefixlen, 65)
def testGetSubnetForSingle32(self):
ip = ipaddr.IPv4('1.2.3.4/32')
subnets1 = [str(x) for x in ip.subnet()]
subnets2 = [str(x) for x in ip.subnet(2)]
self.assertEqual(subnets1, ['1.2.3.4/32'])
self.assertEqual(subnets1, subnets2)
def testGetSubnetForSingle128(self):
ip = ipaddr.IPv6('::1/128')
subnets1 = [str(x) for x in ip.subnet()]
subnets2 = [str(x) for x in ip.subnet(2)]
self.assertEqual(subnets1, ['::1/128'])
self.assertEqual(subnets1, subnets2)
def testSubnet2(self):
ips = [str(x) for x in self.ipv4.subnet(2)]
self.assertEqual(
ips,
['1.2.3.0/26', '1.2.3.64/26', '1.2.3.128/26', '1.2.3.192/26'])
ipsv6 = [str(x) for x in self.ipv6.subnet(2)]
self.assertEqual(
ipsv6,
['2001:658:22a:cafe::/66',
'2001:658:22a:cafe:4000::/66',
'2001:658:22a:cafe:8000::/66',
'2001:658:22a:cafe:c000::/66'])
def testSubnetFailsForLargeCidrDiff(self):
self.assertRaises(ipaddr.PrefixlenDiffInvalidError, self.ipv4.subnet, 9)
self.assertRaises(ipaddr.PrefixlenDiffInvalidError, self.ipv6.subnet,
65)
def testSupernetFailsForLargeCidrDiff(self):
self.assertRaises(ipaddr.PrefixlenDiffInvalidError, self.ipv4.supernet,
25)
self.assertRaises(ipaddr.PrefixlenDiffInvalidError, self.ipv6.supernet,
65)
def testSubnetFailsForNegativeCidrDiff(self):
self.assertRaises(ipaddr.PrefixlenDiffInvalidError, self.ipv4.subnet,
-1)
self.assertRaises(ipaddr.PrefixlenDiffInvalidError, self.ipv6.subnet,
-1)
def testGetNumHosts(self):
self.assertEqual(self.ipv4.numhosts, 256)
self.assertEqual(self.ipv4.subnet()[0].numhosts, 128)
self.assertEqual(self.ipv4.supernet().numhosts, 512)
self.assertEqual(self.ipv6.numhosts, 18446744073709551616)
self.assertEqual(self.ipv6.subnet()[0].numhosts, 9223372036854775808)
self.assertEqual(self.ipv6.supernet().numhosts, 36893488147419103232)
def testContains(self):
self.assertTrue(ipaddr.IPv4('1.2.3.128/25') in self.ipv4)
self.assertFalse(ipaddr.IPv4('1.2.4.1/24') in self.ipv4)
self.assertFalse(self.ipv4 in self.ipv6)
self.assertFalse(self.ipv6 in self.ipv4)
self.assertTrue(self.ipv4 in self.ipv4)
self.assertTrue(self.ipv6 in self.ipv6)
def testBadAddress(self):
self.assertRaises(ipaddr.IPv4IpValidationError, ipaddr.IPv4, 'poop')
self.assertRaises(ipaddr.IPv4IpValidationError,
ipaddr.IPv4, '1.2.3.256')
self.assertRaises(ipaddr.IPv6IpValidationError, ipaddr.IPv6, 'poopv6')
self.assertRaises(ipaddr.IPv4IpValidationError,
ipaddr.IPv4, '1.2.3.4/32/24')
def testBadNetMask(self):
self.assertRaises(ipaddr.IPv4NetmaskValidationError,
ipaddr.IPv4, '1.2.3.4/')
self.assertRaises(ipaddr.IPv4NetmaskValidationError,
ipaddr.IPv4, '1.2.3.4/33')
self.assertRaises(ipaddr.IPv4NetmaskValidationError,
ipaddr.IPv4, '1.2.3.4/254.254.255.256')
self.assertRaises(ipaddr.IPv6NetmaskValidationError,
ipaddr.IPv6, '::1/')
self.assertRaises(ipaddr.IPv6NetmaskValidationError,
ipaddr.IPv6, '::1/129')
def testNth(self):
self.assertEqual(self.ipv4[5], '1.2.3.5')
self.assertRaises(IndexError, self.ipv4.__getitem__, 256)
self.assertEqual(self.ipv6[5],
'2001:658:22a:cafe::5')
def testEquals(self):
self.assertTrue(self.ipv4 == ipaddr.IPv4('1.2.3.4/24'))
self.assertFalse(self.ipv4 == ipaddr.IPv4('1.2.3.4/23'))
self.assertFalse(self.ipv4 == ipaddr.IPv4('1.2.3.5/24'))
self.assertFalse(self.ipv4 == ipaddr.IPv6('::1.2.3.4/24'))
self.assertFalse(self.ipv4 == '')
self.assertFalse(self.ipv4 == [])
self.assertFalse(self.ipv4 == 2)
self.assertTrue(self.ipv6 ==
ipaddr.IPv6('2001:658:22a:cafe:200::1/64'))
self.assertFalse(self.ipv6 ==
ipaddr.IPv6('2001:658:22a:cafe:200::1/63'))
self.assertFalse(self.ipv6 ==
ipaddr.IPv6('2001:658:22a:cafe:200::2/64'))
self.assertFalse(self.ipv6 == ipaddr.IPv4('1.2.3.4/23'))
self.assertFalse(self.ipv6 == '')
self.assertFalse(self.ipv6 == [])
self.assertFalse(self.ipv6 == 2)
def testNotEquals(self):
self.assertFalse(self.ipv4 != ipaddr.IPv4('1.2.3.4/24'))
self.assertTrue(self.ipv4 != ipaddr.IPv4('1.2.3.4/23'))
self.assertTrue(self.ipv4 != ipaddr.IPv4('1.2.3.5/24'))
self.assertTrue(self.ipv4 != ipaddr.IPv6('::1.2.3.4/24'))
self.assertTrue(self.ipv4 != '')
self.assertTrue(self.ipv4 != [])
self.assertTrue(self.ipv4 != 2)
self.assertFalse(self.ipv6 !=
ipaddr.IPv6('2001:658:22a:cafe:200::1/64'))
self.assertTrue(self.ipv6 !=
ipaddr.IPv6('2001:658:22a:cafe:200::1/63'))
self.assertTrue(self.ipv6 !=
ipaddr.IPv6('2001:658:22a:cafe:200::2/64'))
self.assertTrue(self.ipv6 != ipaddr.IPv4('1.2.3.4/23'))
self.assertTrue(self.ipv6 != '')
self.assertTrue(self.ipv6 != [])
self.assertTrue(self.ipv6 != 2)
def testSlash32Constructor(self):
self.assertEquals(str(ipaddr.IPv4('1.2.3.4/255.255.255.255')),
'1.2.3.4/32')
def testSlash128Constructor(self):
self.assertEquals(str(ipaddr.IPv6('::1/128')),
'::1/128')
def testSlash0Constructor(self):
self.assertEquals(str(ipaddr.IPv4('1.2.3.4/0.0.0.0')), '1.2.3.4/0')
def testCollapsing(self):
ip1 = ipaddr.IPv4('1.1.0.0/24')
ip2 = ipaddr.IPv4('1.1.1.0/24')
ip3 = ipaddr.IPv4('1.1.2.0/24')
ip4 = ipaddr.IPv4('1.1.3.0/24')
ip5 = ipaddr.IPv4('1.1.4.0/24')
# stored in no particular order b/c we want CollapseAddr to call [].sort
ip6 = ipaddr.IPv4('1.1.0.0/22')
# check that addreses are subsumed properlly.
collapsed = ipaddr.collapse_address_list([ip1, ip2, ip3, ip4, ip5, ip6])
self.assertEqual(collapsed, [ipaddr.IPv4('1.1.0.0/22'),
ipaddr.IPv4('1.1.4.0/24')])
# test that two addresses are supernet'ed properlly
collapsed = ipaddr.collapse_address_list([ip1, ip2])
self.assertEqual(collapsed, [ipaddr.IPv4('1.1.0.0/23')])
ip_same1 = ip_same2 = ipaddr.IPv4('1.1.1.1/32')
self.assertEqual(ipaddr.collapse_address_list([ip_same1, ip_same2]),
[ip_same1])
ip1 = ipaddr.IPv6('::2001:1/100')
ip2 = ipaddr.IPv6('::2002:1/120')
ip3 = ipaddr.IPv6('::2001:1/96')
# test that ipv6 addresses are subsumed properly.
collapsed = ipaddr.collapse_address_list([ip1, ip2, ip3])
self.assertEqual(collapsed, [ip3])
def testNetworkComparison(self):
# ip1 and ip2 have the same network address
ip1 = ipaddr.IPv4('1.1.1.0/24')
ip2 = ipaddr.IPv4('1.1.1.1/24')
ip3 = ipaddr.IPv4('1.1.2.0/24')
self.assertTrue(ip1 < ip3)
self.assertTrue(ip3 > ip2)
self.assertEquals(ip1.compare_networks(ip2), 0)
self.assertTrue(ip1._get_networks_key() == ip2._get_networks_key())
self.assertEquals(ip1.compare_networks(ip3), -1)
self.assertTrue(ip1._get_networks_key() < ip3._get_networks_key())
ip1 = ipaddr.IPv6('2001::2000/96')
ip2 = ipaddr.IPv6('2001::2001/96')
ip3 = ipaddr.IPv6('2001:ffff::2000/96')
self.assertTrue(ip1 < ip3)
self.assertTrue(ip3 > ip2)
self.assertEquals(ip1.compare_networks(ip2), 0)
self.assertTrue(ip1._get_networks_key() == ip2._get_networks_key())
self.assertEquals(ip1.compare_networks(ip3), -1)
self.assertTrue(ip1._get_networks_key() < ip3._get_networks_key())
# Test comparing different protocols
ipv6 = ipaddr.IPv6('::/0')
ipv4 = ipaddr.IPv4('0.0.0.0/0')
self.assertTrue(ipv6 > ipv4)
self.assertTrue(ipv4 < ipv6)
def testEmbeddedIpv4(self):
ipv4_string = '192.168.0.1'
ipv4 = ipaddr.IPv4(ipv4_string)
v4compat_ipv6 = ipaddr.IPv6('::%s' % ipv4_string)
self.assertEquals(v4compat_ipv6.ip, ipv4.ip)
v4mapped_ipv6 = ipaddr.IPv6('::ffff:%s' % ipv4_string)
self.assertNotEquals(v4mapped_ipv6.ip, ipv4.ip)
self.assertRaises(ipaddr.IPv6IpValidationError, ipaddr.IPv6,
'2001:1.1.1.1:1.1.1.1')
def testIPVersion(self):
self.assertEqual(self.ipv4.version, 4)
self.assertEqual(self.ipv6.version, 6)
def testPacked(self):
self.assertEqual(self.ipv4.packed,
_cb('\x01\x02\x03\x04'))
self.assertEqual(ipaddr.IPv4('255.254.253.252').packed,
_cb('\xff\xfe\xfd\xfc'))
self.assertEqual(self.ipv6.packed,
_cb('\x20\x01\x06\x58\x02\x2a\xca\xfe'
'\x02\x00\x00\x00\x00\x00\x00\x01'))
self.assertEqual(ipaddr.IPv6('ffff:2:3:4:ffff::').packed,
_cb('\xff\xff\x00\x02\x00\x03\x00\x04\xff\xff'
+ '\x00' * 6))
self.assertEqual(ipaddr.IPv6('::1:0:0:0:0').packed,
_cb('\x00' * 6 + '\x00\x01' + '\x00' * 8))
def testIpStrFromPrefixlen(self):
ipv4 = ipaddr.IPv4('1.2.3.4/24')
self.assertEquals(ipv4._ip_string_from_prefix(), '255.255.255.0')
self.assertEquals(ipv4._ip_string_from_prefix(28), '255.255.255.240')
def testIpType(self):
ipv4 = ipaddr.IP('1.2.3.4')
ipv6 = ipaddr.IP('::1.2.3.4')
self.assertEquals(ipaddr.IPv4, type(ipv4))
self.assertEquals(ipaddr.IPv6, type(ipv6))
def testReservedIpv4(self):
self.assertEquals(True, ipaddr.IP('224.1.1.1/31').is_multicast)
self.assertEquals(False, ipaddr.IP('240.0.0.0').is_multicast)
self.assertEquals(True, ipaddr.IP('192.168.1.1/17').is_private)
self.assertEquals(False, ipaddr.IP('192.169.0.0').is_private)
self.assertEquals(True, ipaddr.IP('10.255.255.255').is_private)
self.assertEquals(False, ipaddr.IP('11.0.0.0').is_private)
self.assertEquals(True, ipaddr.IP('172.31.255.255').is_private)
self.assertEquals(False, ipaddr.IP('172.32.0.0').is_private)
self.assertEquals(True, ipaddr.IP('169.254.100.200/24').is_link_local)
self.assertEquals(False, ipaddr.IP('169.255.100.200/24').is_link_local)
self.assertEquals(True, ipaddr.IP('127.100.200.254/32').is_loopback)
self.assertEquals(True, ipaddr.IP('127.42.0.0/16').is_loopback)
self.assertEquals(False, ipaddr.IP('128.0.0.0').is_loopback)
def testReservedIpv6(self):
ip = ipaddr.IP
self.assertEquals(True, ip('ffff::').is_multicast)
self.assertEquals(True, ip(2**128-1).is_multicast)
self.assertEquals(True, ip('ff00::').is_multicast)
self.assertEquals(False, ip('fdff::').is_multicast)
self.assertEquals(True, ip('fecf::').is_site_local)
self.assertEquals(True, ip('feff:ffff:ffff:ffff::').is_site_local)
self.assertEquals(False, ip('fbf:ffff::').is_site_local)
self.assertEquals(False, ip('ff00::').is_site_local)
self.assertEquals(True, ip('fc00::').is_private)
self.assertEquals(True, ip('fc00:ffff:ffff:ffff::').is_private)
self.assertEquals(False, ip('fbff:ffff::').is_private)
self.assertEquals(False, ip('fe00::').is_private)
self.assertEquals(True, ip('fea0::').is_link_local)
self.assertEquals(True, ip('febf:ffff::').is_link_local)
self.assertEquals(False, ip('fe7f:ffff::').is_link_local)
self.assertEquals(False, ip('fec0::').is_link_local)
self.assertEquals(True, ip('0:0::0:01').is_loopback)
self.assertEquals(False, ip('::1/127').is_loopback)
self.assertEquals(False, ip('::').is_loopback)
self.assertEquals(False, ip('::2').is_loopback)
self.assertEquals(True, ip('0::0').is_unspecified)
self.assertEquals(False, ip('::1').is_unspecified)
self.assertEquals(False, ip('::/127').is_unspecified)
def testAddrExclude(self):
addr1 = ipaddr.IP('10.1.1.0/24')
addr2 = ipaddr.IP('10.1.1.0/26')
addr3 = ipaddr.IP('10.2.1.0/24')
self.assertEqual(addr1.address_exclude(addr2),
[ipaddr.IP('10.1.1.64/26'),
ipaddr.IP('10.1.1.128/25')])
self.assertRaises(ValueError, addr1.address_exclude, addr3)
def testHash(self):
self.assertEquals(hash(ipaddr.IP('10.1.1.0/24')),
hash(ipaddr.IP('10.1.1.0/24')))
dummy = {}
dummy[self.ipv4] = None
dummy[self.ipv6] = None
self.assertTrue(self.ipv4 in dummy)
def testIPv4PrefixFromInt(self):
addr1 = ipaddr.IP('10.1.1.0/24')
addr2 = ipaddr.IPv4(addr1.ip) # clone prefix
addr2.prefixlen = addr1.prefixlen
addr3 = ipaddr.IP(123456)
self.assertEqual(123456, addr3.ip)
self.assertRaises(ipaddr.IPv4NetmaskValidationError,
addr2._set_prefix, -1)
self.assertEqual(addr1, addr2)
self.assertEqual(str(addr1), str(addr2))
def testIPv6PrefixFromInt(self):
addr1 = ipaddr.IP('2001:0658:022a:cafe:0200::1/64')
addr2 = ipaddr.IPv6(addr1.ip) # clone prefix
addr2.prefixlen = addr1.prefixlen
addr3 = ipaddr.IP(123456)
self.assertEqual(123456, addr3.ip)
self.assertRaises(ipaddr.IPv6NetmaskValidationError,
addr2._set_prefix, -1)
self.assertEqual(addr1, addr2)
self.assertEqual(str(addr1), str(addr2))
def testCopyConstructor(self):
addr1 = ipaddr.IP('10.1.1.0/24')
addr2 = ipaddr.IP(addr1)
addr3 = ipaddr.IP('2001:658:22a:cafe:200::1/64')
addr4 = ipaddr.IP(addr3)
self.assertEqual(addr1, addr2)
self.assertEqual(addr3, addr4)
def testCompressIPv6Address(self):
test_addresses = {
'1:2:3:4:5:6:7:8': '1:2:3:4:5:6:7:8/128',
'2001:0:0:4:0:0:0:8': '2001:0:0:4::8/128',
'2001:0:0:4:5:6:7:8': '2001::4:5:6:7:8/128',
'2001:0:3:4:5:6:7:8': '2001:0:3:4:5:6:7:8/128',
'2001:0::3:4:5:6:7:8': '2001:0:3:4:5:6:7:8/128',
'0:0:3:0:0:0:0:ffff': '0:0:3::ffff/128',
'0:0:0:4:0:0:0:ffff': '::4:0:0:0:ffff/128',
'0:0:0:0:5:0:0:ffff': '::5:0:0:ffff/128',
'1:0:0:4:0:0:7:8': '1::4:0:0:7:8/128',
'0:0:0:0:0:0:0:0': '::/128',
'0:0:0:0:0:0:0:0/0': '::/0',
'0:0:0:0:0:0:0:1': '::1/128',
'2001:0658:022a:cafe:0000:0000:0000:0000/66':
'2001:658:22a:cafe::/66',
}
for uncompressed, compressed in test_addresses.items():
self.assertEquals(compressed, str(ipaddr.IPv6(uncompressed)))
def testExplodeShortHandIpStr(self):
addr1 = ipaddr.IPv6('2001::1')
self.assertEqual('2001:0000:0000:0000:0000:0000:0000:0001',
addr1._explode_shorthand_ip_string(addr1.ip_ext))
def testIntRepresentation(self):
self.assertEqual(16909060, int(self.ipv4))
self.assertEqual(42540616829182469433547762482097946625, int(self.ipv6))
def testHexRepresentation(self):
self.assertEqual(hex(0x1020304), hex(self.ipv4))
self.assertEqual(hex(0x20010658022ACAFE0200000000000001),
hex(self.ipv6))
if __name__ == '__main__':
unittest.main()

View File

@ -107,6 +107,9 @@ Installation
Library
-------
- Issue #3959: The ipaddr module has been added to the standard library.
Contributed by Google.
- Issue #3002: ``shutil.copyfile()`` and ``shutil.copytree()`` now raise an
error when a named pipe is encountered, rather than blocking infinitely.