summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKa-Ping Yee <ping@zesty.ca>2006-06-12 23:47:52 (GMT)
committerKa-Ping Yee <ping@zesty.ca>2006-06-12 23:47:52 (GMT)
commitf9eb82f2520058c60d63e5f4faa13f8471d391c3 (patch)
treee0cc186187b7bf6f9832d10db32204a650c2e080
parentc2da9945852785c7da3c0becc7edd586b5ec628b (diff)
downloadcpython-f9eb82f2520058c60d63e5f4faa13f8471d391c3.zip
cpython-f9eb82f2520058c60d63e5f4faa13f8471d391c3.tar.gz
cpython-f9eb82f2520058c60d63e5f4faa13f8471d391c3.tar.bz2
Add the uuid module.
This module has been tested so far on Windows XP (Python 2.4 and 2.5a2), Mac OS X (Python 2.3, 2.4, and 2.5a2), and Linux (Python 2.4 and 2.5a2).
-rw-r--r--Lib/test/test_uuid.py396
-rw-r--r--Lib/uuid.py477
2 files changed, 873 insertions, 0 deletions
diff --git a/Lib/test/test_uuid.py b/Lib/test/test_uuid.py
new file mode 100644
index 0000000..ac2c99f
--- /dev/null
+++ b/Lib/test/test_uuid.py
@@ -0,0 +1,396 @@
+from unittest import TestCase, main
+import uuid
+
+def importable(name):
+ try:
+ __import__(name)
+ return True
+ except:
+ return False
+
+class TestUUID(TestCase):
+ last_node = None
+
+ def test_UUID(self):
+ equal = self.assertEqual
+ ascending = []
+ for (string, curly, hex, bytes, fields, integer, urn,
+ time, clock_seq, variant, version) in [
+ ('00000000-0000-0000-0000-000000000000',
+ '{00000000-0000-0000-0000-000000000000}',
+ '00000000000000000000000000000000',
+ '\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0',
+ (0, 0, 0, 0, 0, 0),
+ 0,
+ 'urn:uuid:00000000-0000-0000-0000-000000000000',
+ 0, 0, uuid.RESERVED_NCS, None),
+ ('00010203-0405-0607-0809-0a0b0c0d0e0f',
+ '{00010203-0405-0607-0809-0a0b0c0d0e0f}',
+ '000102030405060708090a0b0c0d0e0f',
+ '\0\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\x0d\x0e\x0f',
+ (0x00010203L, 0x0405, 0x0607, 8, 9, 0x0a0b0c0d0e0fL),
+ 0x000102030405060708090a0b0c0d0e0fL,
+ 'urn:uuid:00010203-0405-0607-0809-0a0b0c0d0e0f',
+ 0x607040500010203L, 0x809, uuid.RESERVED_NCS, None),
+ ('02d9e6d5-9467-382e-8f9b-9300a64ac3cd',
+ '{02d9e6d5-9467-382e-8f9b-9300a64ac3cd}',
+ '02d9e6d59467382e8f9b9300a64ac3cd',
+ '\x02\xd9\xe6\xd5\x94\x67\x38\x2e\x8f\x9b\x93\x00\xa6\x4a\xc3\xcd',
+ (0x02d9e6d5L, 0x9467, 0x382e, 0x8f, 0x9b, 0x9300a64ac3cdL),
+ 0x02d9e6d59467382e8f9b9300a64ac3cdL,
+ 'urn:uuid:02d9e6d5-9467-382e-8f9b-9300a64ac3cd',
+ 0x82e946702d9e6d5L, 0xf9b, uuid.RFC_4122, 3),
+ ('12345678-1234-5678-1234-567812345678',
+ '{12345678-1234-5678-1234-567812345678}',
+ '12345678123456781234567812345678',
+ '\x12\x34\x56\x78'*4,
+ (0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678),
+ 0x12345678123456781234567812345678,
+ 'urn:uuid:12345678-1234-5678-1234-567812345678',
+ 0x678123412345678L, 0x1234, uuid.RESERVED_NCS, None),
+ ('6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+ '{6ba7b810-9dad-11d1-80b4-00c04fd430c8}',
+ '6ba7b8109dad11d180b400c04fd430c8',
+ '\x6b\xa7\xb8\x10\x9d\xad\x11\xd1\x80\xb4\x00\xc0\x4f\xd4\x30\xc8',
+ (0x6ba7b810L, 0x9dad, 0x11d1, 0x80, 0xb4, 0x00c04fd430c8L),
+ 0x6ba7b8109dad11d180b400c04fd430c8L,
+ 'urn:uuid:6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+ 0x1d19dad6ba7b810L, 0xb4, uuid.RFC_4122, 1),
+ ('6ba7b811-9dad-11d1-80b4-00c04fd430c8',
+ '{6ba7b811-9dad-11d1-80b4-00c04fd430c8}',
+ '6ba7b8119dad11d180b400c04fd430c8',
+ '\x6b\xa7\xb8\x11\x9d\xad\x11\xd1\x80\xb4\x00\xc0\x4f\xd4\x30\xc8',
+ (0x6ba7b811L, 0x9dad, 0x11d1, 0x80, 0xb4, 0x00c04fd430c8L),
+ 0x6ba7b8119dad11d180b400c04fd430c8L,
+ 'urn:uuid:6ba7b811-9dad-11d1-80b4-00c04fd430c8',
+ 0x1d19dad6ba7b811L, 0xb4, uuid.RFC_4122, 1),
+ ('6ba7b812-9dad-11d1-80b4-00c04fd430c8',
+ '{6ba7b812-9dad-11d1-80b4-00c04fd430c8}',
+ '6ba7b8129dad11d180b400c04fd430c8',
+ '\x6b\xa7\xb8\x12\x9d\xad\x11\xd1\x80\xb4\x00\xc0\x4f\xd4\x30\xc8',
+ (0x6ba7b812L, 0x9dad, 0x11d1, 0x80, 0xb4, 0x00c04fd430c8L),
+ 0x6ba7b8129dad11d180b400c04fd430c8L,
+ 'urn:uuid:6ba7b812-9dad-11d1-80b4-00c04fd430c8',
+ 0x1d19dad6ba7b812L, 0xb4, uuid.RFC_4122, 1),
+ ('6ba7b814-9dad-11d1-80b4-00c04fd430c8',
+ '{6ba7b814-9dad-11d1-80b4-00c04fd430c8}',
+ '6ba7b8149dad11d180b400c04fd430c8',
+ '\x6b\xa7\xb8\x14\x9d\xad\x11\xd1\x80\xb4\x00\xc0\x4f\xd4\x30\xc8',
+ (0x6ba7b814L, 0x9dad, 0x11d1, 0x80, 0xb4, 0x00c04fd430c8L),
+ 0x6ba7b8149dad11d180b400c04fd430c8L,
+ 'urn:uuid:6ba7b814-9dad-11d1-80b4-00c04fd430c8',
+ 0x1d19dad6ba7b814L, 0xb4, uuid.RFC_4122, 1),
+ ('7d444840-9dc0-11d1-b245-5ffdce74fad2',
+ '{7d444840-9dc0-11d1-b245-5ffdce74fad2}',
+ '7d4448409dc011d1b2455ffdce74fad2',
+ '\x7d\x44\x48\x40\x9d\xc0\x11\xd1\xb2\x45\x5f\xfd\xce\x74\xfa\xd2',
+ (0x7d444840L, 0x9dc0, 0x11d1, 0xb2, 0x45, 0x5ffdce74fad2L),
+ 0x7d4448409dc011d1b2455ffdce74fad2L,
+ 'urn:uuid:7d444840-9dc0-11d1-b245-5ffdce74fad2',
+ 0x1d19dc07d444840L, 0x3245, uuid.RFC_4122, 1),
+ ('e902893a-9d22-3c7e-a7b8-d6e313b71d9f',
+ '{e902893a-9d22-3c7e-a7b8-d6e313b71d9f}',
+ 'e902893a9d223c7ea7b8d6e313b71d9f',
+ '\xe9\x02\x89\x3a\x9d\x22\x3c\x7e\xa7\xb8\xd6\xe3\x13\xb7\x1d\x9f',
+ (0xe902893aL, 0x9d22, 0x3c7e, 0xa7, 0xb8, 0xd6e313b71d9fL),
+ 0xe902893a9d223c7ea7b8d6e313b71d9fL,
+ 'urn:uuid:e902893a-9d22-3c7e-a7b8-d6e313b71d9f',
+ 0xc7e9d22e902893aL, 0x27b8, uuid.RFC_4122, 3),
+ ('eb424026-6f54-4ef8-a4d0-bb658a1fc6cf',
+ '{eb424026-6f54-4ef8-a4d0-bb658a1fc6cf}',
+ 'eb4240266f544ef8a4d0bb658a1fc6cf',
+ '\xeb\x42\x40\x26\x6f\x54\x4e\xf8\xa4\xd0\xbb\x65\x8a\x1f\xc6\xcf',
+ (0xeb424026L, 0x6f54, 0x4ef8, 0xa4, 0xd0, 0xbb658a1fc6cfL),
+ 0xeb4240266f544ef8a4d0bb658a1fc6cfL,
+ 'urn:uuid:eb424026-6f54-4ef8-a4d0-bb658a1fc6cf',
+ 0xef86f54eb424026L, 0x24d0, uuid.RFC_4122, 4),
+ ('f81d4fae-7dec-11d0-a765-00a0c91e6bf6',
+ '{f81d4fae-7dec-11d0-a765-00a0c91e6bf6}',
+ 'f81d4fae7dec11d0a76500a0c91e6bf6',
+ '\xf8\x1d\x4f\xae\x7d\xec\x11\xd0\xa7\x65\x00\xa0\xc9\x1e\x6b\xf6',
+ (0xf81d4faeL, 0x7dec, 0x11d0, 0xa7, 0x65, 0x00a0c91e6bf6L),
+ 0xf81d4fae7dec11d0a76500a0c91e6bf6L,
+ 'urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6',
+ 0x1d07decf81d4faeL, 0x2765, uuid.RFC_4122, 1),
+ ('fffefdfc-fffe-fffe-fffe-fffefdfcfbfa',
+ '{fffefdfc-fffe-fffe-fffe-fffefdfcfbfa}',
+ 'fffefdfcfffefffefffefffefdfcfbfa',
+ '\xff\xfe\xfd\xfc\xff\xfe\xff\xfe\xff\xfe\xff\xfe\xfd\xfc\xfb\xfa',
+ (0xfffefdfcL, 0xfffe, 0xfffe, 0xff, 0xfe, 0xfffefdfcfbfaL),
+ 0xfffefdfcfffefffefffefffefdfcfbfaL,
+ 'urn:uuid:fffefdfc-fffe-fffe-fffe-fffefdfcfbfa',
+ 0xffefffefffefdfcL, 0x3ffe, uuid.RESERVED_FUTURE, None),
+ ('ffffffff-ffff-ffff-ffff-ffffffffffff',
+ '{ffffffff-ffff-ffff-ffff-ffffffffffff}',
+ 'ffffffffffffffffffffffffffffffff',
+ '\xff'*16,
+ (0xffffffffL, 0xffffL, 0xffffL, 0xff, 0xff, 0xffffffffffffL),
+ 0xffffffffffffffffffffffffffffffffL,
+ 'urn:uuid:ffffffff-ffff-ffff-ffff-ffffffffffff',
+ 0xfffffffffffffffL, 0x3fff, uuid.RESERVED_FUTURE, None),
+ ]:
+ equivalents = []
+ # Construct each UUID in several different ways.
+ for u in [uuid.UUID(string), uuid.UUID(curly), uuid.UUID(hex),
+ uuid.UUID(bytes=bytes), uuid.UUID(fields=fields),
+ uuid.UUID(int=integer), uuid.UUID(urn)]:
+ # Test all conversions and properties of the UUID object.
+ equal(str(u), string)
+ equal(int(u), integer)
+ equal(u.bytes, bytes)
+ equal(u.fields, fields)
+ equal(u.time_low, fields[0])
+ equal(u.time_mid, fields[1])
+ equal(u.time_hi_version, fields[2])
+ equal(u.clock_seq_hi_variant, fields[3])
+ equal(u.clock_seq_low, fields[4])
+ equal(u.node, fields[5])
+ equal(u.hex, hex)
+ equal(u.int, integer)
+ equal(u.urn, urn)
+ equal(u.time, time)
+ equal(u.clock_seq, clock_seq)
+ equal(u.variant, variant)
+ equal(u.version, version)
+ equivalents.append(u)
+
+ # Different construction methods should give the same UUID.
+ for u in equivalents:
+ for v in equivalents:
+ equal(u, v)
+ ascending.append(u)
+
+ # Test comparison of UUIDs.
+ for i in range(len(ascending)):
+ for j in range(len(ascending)):
+ equal(cmp(i, j), cmp(ascending[i], ascending[j]))
+
+ # Test sorting of UUIDs (above list is in ascending order).
+ resorted = ascending[:]
+ resorted.reverse()
+ resorted.sort()
+ equal(ascending, resorted)
+
+ def test_exceptions(self):
+ badvalue = lambda f: self.assertRaises(ValueError, f)
+ badtype = lambda f: self.assertRaises(TypeError, f)
+
+ # Badly formed hex strings.
+ badvalue(lambda: uuid.UUID(''))
+ badvalue(lambda: uuid.UUID('abc'))
+ badvalue(lambda: uuid.UUID('1234567812345678123456781234567'))
+ badvalue(lambda: uuid.UUID('123456781234567812345678123456789'))
+ badvalue(lambda: uuid.UUID('123456781234567812345678z2345678'))
+
+ # Badly formed bytes.
+ badvalue(lambda: uuid.UUID(bytes='abc'))
+ badvalue(lambda: uuid.UUID(bytes='\0'*15))
+ badvalue(lambda: uuid.UUID(bytes='\0'*17))
+
+ # Badly formed fields.
+ badvalue(lambda: uuid.UUID(fields=(1,)))
+ badvalue(lambda: uuid.UUID(fields=(1, 2, 3, 4, 5)))
+ badvalue(lambda: uuid.UUID(fields=(1, 2, 3, 4, 5, 6, 7)))
+
+ # Field values out of range.
+ badvalue(lambda: uuid.UUID(fields=(-1, 0, 0, 0, 0, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0x100000000L, 0, 0, 0, 0, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, -1, 0, 0, 0, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0x10000L, 0, 0, 0, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0, -1, 0, 0, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0, 0x10000L, 0, 0, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0, 0, -1, 0, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0x100L, 0, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0, -1, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0, 0x100L, 0)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0, 0, -1)))
+ badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0, 0, 0x1000000000000L)))
+
+ # Version number out of range.
+ badvalue(lambda: uuid.UUID('00'*16, version=0))
+ badvalue(lambda: uuid.UUID('00'*16, version=6))
+
+ # Integer value out of range.
+ badvalue(lambda: uuid.UUID(int=-1))
+ badvalue(lambda: uuid.UUID(int=1<<128L))
+
+ # Must supply exactly one of hex, bytes, fields, int.
+ h, b, f, i = '00'*16, '\0'*16, (0, 0, 0, 0, 0, 0), 0
+ uuid.UUID(h)
+ uuid.UUID(hex=h)
+ uuid.UUID(bytes=b)
+ uuid.UUID(fields=f)
+ uuid.UUID(int=i)
+
+ # Wrong number of arguments (positional).
+ badtype(lambda: uuid.UUID())
+ badtype(lambda: uuid.UUID(h, b))
+ badtype(lambda: uuid.UUID(h, b, f))
+ badtype(lambda: uuid.UUID(h, b, f, i))
+
+ # Duplicate arguments (named).
+ badtype(lambda: uuid.UUID(hex=h, bytes=b))
+ badtype(lambda: uuid.UUID(hex=h, fields=f))
+ badtype(lambda: uuid.UUID(hex=h, int=i))
+ badtype(lambda: uuid.UUID(bytes=b, fields=f))
+ badtype(lambda: uuid.UUID(bytes=b, int=i))
+ badtype(lambda: uuid.UUID(fields=f, int=i))
+ badtype(lambda: uuid.UUID(hex=h, bytes=b, fields=f))
+ badtype(lambda: uuid.UUID(hex=h, bytes=b, int=i))
+ badtype(lambda: uuid.UUID(hex=h, fields=f, int=i))
+ badtype(lambda: uuid.UUID(bytes=b, int=i, fields=f))
+ badtype(lambda: uuid.UUID(hex=h, bytes=b, int=i, fields=f))
+
+ # Duplicate arguments (positional and named).
+ badtype(lambda: uuid.UUID(h, hex=h))
+ badtype(lambda: uuid.UUID(h, bytes=b))
+ badtype(lambda: uuid.UUID(h, fields=f))
+ badtype(lambda: uuid.UUID(h, int=i))
+ badtype(lambda: uuid.UUID(h, hex=h, bytes=b))
+ badtype(lambda: uuid.UUID(h, hex=h, fields=f))
+ badtype(lambda: uuid.UUID(h, hex=h, int=i))
+ badtype(lambda: uuid.UUID(h, bytes=b, fields=f))
+ badtype(lambda: uuid.UUID(h, bytes=b, int=i))
+ badtype(lambda: uuid.UUID(h, fields=f, int=i))
+ badtype(lambda: uuid.UUID(h, hex=h, bytes=b, fields=f))
+ badtype(lambda: uuid.UUID(h, hex=h, bytes=b, int=i))
+ badtype(lambda: uuid.UUID(h, hex=h, fields=f, int=i))
+ badtype(lambda: uuid.UUID(h, bytes=b, int=i, fields=f))
+ badtype(lambda: uuid.UUID(h, hex=h, bytes=b, int=i, fields=f))
+
+ # Immutability.
+ u = uuid.UUID(h)
+ badtype(lambda: setattr(u, 'hex', h))
+ badtype(lambda: setattr(u, 'bytes', b))
+ badtype(lambda: setattr(u, 'fields', f))
+ badtype(lambda: setattr(u, 'int', i))
+
+ def check_node(self, node, source=''):
+ individual_group_bit = (node >> 40L) & 1
+ universal_local_bit = (node >> 40L) & 2
+ message = "%012x doesn't look like a real MAC address" % node
+ self.assertEqual(individual_group_bit, 0, message)
+ self.assertEqual(universal_local_bit, 0, message)
+ self.assertNotEqual(node, 0, message)
+ self.assertNotEqual(node, 0xffffffffffffL, message)
+ self.assert_(0 <= node, message)
+ self.assert_(node < 1<<48L, message)
+
+ import sys
+ if source:
+ sys.stderr.write('(%s: %012x)' % (source, node))
+ if TestUUID.last_node:
+ self.assertEqual(TestUUID.last_node, node, 'inconsistent node IDs')
+ else:
+ TestUUID.last_node = node
+
+ def test_ifconfig_getnode(self):
+ import os
+ if os.name == 'posix':
+ self.check_node(uuid._ifconfig_getnode(), 'ifconfig')
+
+ def test_ipconfig_getnode(self):
+ import os
+ if os.name == 'nt':
+ self.check_node(uuid._ipconfig_getnode(), 'ipconfig')
+
+ def test_netbios_getnode(self):
+ if importable('win32wnet') and importable('netbios'):
+ self.check_node(uuid._netbios_getnode(), 'netbios')
+
+ def test_random_getnode(self):
+ node = uuid._random_getnode()
+ self.assert_(0 <= node)
+ self.assert_(node < 1<<48L)
+
+ def test_unixdll_getnode(self):
+ import os
+ if importable('ctypes') and os.name == 'posix':
+ self.check_node(uuid._unixdll_getnode(), 'unixdll')
+
+ def test_windll_getnode(self):
+ import os
+ if importable('ctypes') and os.name == 'nt':
+ self.check_node(uuid._windll_getnode(), 'windll')
+
+ def test_getnode(self):
+ self.check_node(uuid.getnode())
+
+ # Test it again to ensure consistency.
+ self.check_node(uuid.getnode())
+
+ def test_uuid1(self):
+ equal = self.assertEqual
+
+ # Make sure uuid4() generates UUIDs that are actually version 1.
+ for u in [uuid.uuid1() for i in range(10)]:
+ equal(u.variant, uuid.RFC_4122)
+ equal(u.version, 1)
+
+ # Make sure the supplied node ID appears in the UUID.
+ u = uuid.uuid1(0)
+ equal(u.node, 0)
+ u = uuid.uuid1(0x123456789abc)
+ equal(u.node, 0x123456789abc)
+ u = uuid.uuid1(0xffffffffffff)
+ equal(u.node, 0xffffffffffff)
+
+ # Make sure the supplied clock sequence appears in the UUID.
+ u = uuid.uuid1(0x123456789abc, 0)
+ equal(u.node, 0x123456789abc)
+ equal(((u.clock_seq_hi_variant & 0x3f) << 8) | u.clock_seq_low, 0)
+ u = uuid.uuid1(0x123456789abc, 0x1234)
+ equal(u.node, 0x123456789abc)
+ equal(((u.clock_seq_hi_variant & 0x3f) << 8) |
+ u.clock_seq_low, 0x1234)
+ u = uuid.uuid1(0x123456789abc, 0x3fff)
+ equal(u.node, 0x123456789abc)
+ equal(((u.clock_seq_hi_variant & 0x3f) << 8) |
+ u.clock_seq_low, 0x3fff)
+
+ def test_uuid3(self):
+ equal = self.assertEqual
+
+ # Test some known version-3 UUIDs.
+ for u, v in [(uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org'),
+ '6fa459ea-ee8a-3ca4-894e-db77e160355e'),
+ (uuid.uuid3(uuid.NAMESPACE_URL, 'http://python.org/'),
+ '9fe8e8c4-aaa8-32a9-a55c-4535a88b748d'),
+ (uuid.uuid3(uuid.NAMESPACE_OID, '1.3.6.1'),
+ 'dd1a1cef-13d5-368a-ad82-eca71acd4cd1'),
+ (uuid.uuid3(uuid.NAMESPACE_X500, 'c=ca'),
+ '658d3002-db6b-3040-a1d1-8ddd7d189a4d'),
+ ]:
+ equal(u.variant, uuid.RFC_4122)
+ equal(u.version, 3)
+ equal(u, uuid.UUID(v))
+ equal(str(u), v)
+
+ def test_uuid4(self):
+ equal = self.assertEqual
+
+ # Make sure uuid4() generates UUIDs that are actually version 4.
+ for u in [uuid.uuid4() for i in range(10)]:
+ equal(u.variant, uuid.RFC_4122)
+ equal(u.version, 4)
+
+ def test_uuid5(self):
+ equal = self.assertEqual
+
+ # Test some known version-5 UUIDs.
+ for u, v in [(uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org'),
+ '886313e1-3b8a-5372-9b90-0c9aee199e5d'),
+ (uuid.uuid5(uuid.NAMESPACE_URL, 'http://python.org/'),
+ '4c565f0d-3f5a-5890-b41b-20cf47701c5e'),
+ (uuid.uuid5(uuid.NAMESPACE_OID, '1.3.6.1'),
+ '1447fa61-5277-5fef-a9b3-fbc6e44f4af3'),
+ (uuid.uuid5(uuid.NAMESPACE_X500, 'c=ca'),
+ 'cc957dd1-a972-5349-98cd-874190002798'),
+ ]:
+ equal(u.variant, uuid.RFC_4122)
+ equal(u.version, 5)
+ equal(u, uuid.UUID(v))
+ equal(str(u), v)
+
+if __name__ == '__main__':
+ main()
diff --git a/Lib/uuid.py b/Lib/uuid.py
new file mode 100644
index 0000000..75d189f
--- /dev/null
+++ b/Lib/uuid.py
@@ -0,0 +1,477 @@
+r"""UUID objects (universally unique identifiers) according to RFC 4122.
+
+This module provides immutable UUID objects (class UUID) and the functions
+uuid1(), uuid3(), uuid4(), uuid5() for generating version 1, 3, 4, and 5
+UUIDs as specified in RFC 4122.
+
+If all you want is a unique ID, you should probably call uuid1() or uuid4().
+Note that uuid1() may compromise privacy since it creates a UUID containing
+the computer's network address. uuid4() creates a random UUID.
+
+Typical usage:
+
+ >>> import uuid
+
+ # make a UUID based on the host ID and current time
+ >>> uuid.uuid1()
+ UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')
+
+ # make a UUID using an MD5 hash of a namespace UUID and a name
+ >>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
+ UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
+
+ # make a random UUID
+ >>> uuid.uuid4()
+ UUID('16fd2706-8baf-433b-82eb-8c7fada847da')
+
+ # make a UUID using a SHA-1 hash of a namespace UUID and a name
+ >>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
+ UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
+
+ # make a UUID from a string of hex digits (braces and hyphens ignored)
+ >>> x = uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}')
+
+ # convert a UUID to a string of hex digits in standard form
+ >>> str(x)
+ '00010203-0405-0607-0809-0a0b0c0d0e0f'
+
+ # get the raw 16 bytes of the UUID
+ >>> x.bytes
+ '\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'
+
+ # make a UUID from a 16-byte string
+ >>> uuid.UUID(bytes=x.bytes)
+ UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
+
+This module works with Python 2.3 or higher."""
+
+__author__ = 'Ka-Ping Yee <ping@zesty.ca>'
+__date__ = '$Date: 2006/06/12 23:15:40 $'.split()[1].replace('/', '-')
+__version__ = '$Revision: 1.30 $'.split()[1]
+
+RESERVED_NCS, RFC_4122, RESERVED_MICROSOFT, RESERVED_FUTURE = [
+ 'reserved for NCS compatibility', 'specified in RFC 4122',
+ 'reserved for Microsoft compatibility', 'reserved for future definition']
+
+class UUID(object):
+ """Instances of the UUID class represent UUIDs as specified in RFC 4122.
+ UUID objects are immutable, hashable, and usable as dictionary keys.
+ Converting a UUID to a string with str() yields something in the form
+ '12345678-1234-1234-1234-123456789abc'. The UUID constructor accepts
+ four possible forms: a similar string of hexadecimal digits, or a
+ string of 16 raw bytes as an argument named 'bytes', or a tuple of
+ six integer fields (with 32-bit, 16-bit, 16-bit, 8-bit, 8-bit, and
+ 48-bit values respectively) as an argument named 'fields', or a single
+ 128-bit integer as an argument named 'int'.
+
+ UUIDs have these read-only attributes:
+
+ bytes the UUID as a 16-byte string
+
+ fields a tuple of the six integer fields of the UUID,
+ which are also available as six individual attributes
+ and two derived attributes:
+
+ time_low the first 32 bits of the UUID
+ time_mid the next 16 bits of the UUID
+ time_hi_version the next 16 bits of the UUID
+ clock_seq_hi_variant the next 8 bits of the UUID
+ clock_seq_low the next 8 bits of the UUID
+ node the last 48 bits of the UUID
+
+ time the 60-bit timestamp
+ clock_seq the 14-bit sequence number
+
+ hex the UUID as a 32-character hexadecimal string
+
+ int the UUID as a 128-bit integer
+
+ urn the UUID as a URN as specified in RFC 4122
+
+ variant the UUID variant (one of the constants RESERVED_NCS,
+ RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE)
+
+ version the UUID version number (1 through 5, meaningful only
+ when the variant is RFC_4122)
+ """
+
+ def __init__(self, hex=None, bytes=None, fields=None, int=None,
+ version=None):
+ r"""Create a UUID from either a string of 32 hexadecimal digits,
+ a string of 16 bytes as the 'bytes' argument, a tuple of six
+ integers (32-bit time_low, 16-bit time_mid, 16-bit time_hi_version,
+ 8-bit clock_seq_hi_variant, 8-bit clock_seq_low, 48-bit node) as
+ the 'fields' argument, or a single 128-bit integer as the 'int'
+ argument. When a string of hex digits is given, curly braces,
+ hyphens, and a URN prefix are all optional. For example, these
+ expressions all yield the same UUID:
+
+ UUID('{12345678-1234-5678-1234-567812345678}')
+ UUID('12345678123456781234567812345678')
+ UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
+ UUID(bytes='\x12\x34\x56\x78'*4)
+ UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
+ UUID(int=0x12345678123456781234567812345678)
+
+ Exactly one of 'hex', 'bytes', 'fields', or 'int' must be given.
+ The 'version' argument is optional; if given, the resulting UUID
+ will have its variant and version number set according to RFC 4122,
+ overriding bits in the given 'hex', 'bytes', 'fields', or 'int'.
+ """
+
+ if [hex, bytes, fields, int].count(None) != 3:
+ raise TypeError('need just one of hex, bytes, fields, or int')
+ if hex is not None:
+ hex = hex.replace('urn:', '').replace('uuid:', '')
+ hex = hex.strip('{}').replace('-', '')
+ if len(hex) != 32:
+ raise ValueError('badly formed hexadecimal UUID string')
+ int = long(hex, 16)
+ if bytes is not None:
+ if len(bytes) != 16:
+ raise ValueError('bytes is not a 16-char string')
+ int = long(('%02x'*16) % tuple(map(ord, bytes)), 16)
+ if fields is not None:
+ if len(fields) != 6:
+ raise ValueError('fields is not a 6-tuple')
+ (time_low, time_mid, time_hi_version,
+ clock_seq_hi_variant, clock_seq_low, node) = fields
+ if not 0 <= time_low < 1<<32L:
+ raise ValueError('field 1 out of range (need a 32-bit value)')
+ if not 0 <= time_mid < 1<<16L:
+ raise ValueError('field 2 out of range (need a 16-bit value)')
+ if not 0 <= time_hi_version < 1<<16L:
+ raise ValueError('field 3 out of range (need a 16-bit value)')
+ if not 0 <= clock_seq_hi_variant < 1<<8L:
+ raise ValueError('field 4 out of range (need an 8-bit value)')
+ if not 0 <= clock_seq_low < 1<<8L:
+ raise ValueError('field 5 out of range (need an 8-bit value)')
+ if not 0 <= node < 1<<48L:
+ raise ValueError('field 6 out of range (need a 48-bit value)')
+ clock_seq = (clock_seq_hi_variant << 8L) | clock_seq_low
+ int = ((time_low << 96L) | (time_mid << 80L) |
+ (time_hi_version << 64L) | (clock_seq << 48L) | node)
+ if int is not None:
+ if not 0 <= int < 1<<128L:
+ raise ValueError('int is out of range (need a 128-bit value)')
+ if version is not None:
+ if not 1 <= version <= 5:
+ raise ValueError('illegal version number')
+ # Set the variant to RFC 4122.
+ int &= ~(0xc000 << 48L)
+ int |= 0x8000 << 48L
+ # Set the version number.
+ int &= ~(0xf000 << 64L)
+ int |= version << 76L
+ self.__dict__['int'] = int
+
+ def __cmp__(self, other):
+ if isinstance(other, UUID):
+ return cmp(self.int, other.int)
+ return NotImplemented
+
+ def __hash__(self):
+ return hash(self.int)
+
+ def __int__(self):
+ return self.int
+
+ def __repr__(self):
+ return 'UUID(%r)' % str(self)
+
+ def __setattr__(self, name, value):
+ raise TypeError('UUID objects are immutable')
+
+ def __str__(self):
+ hex = '%032x' % self.int
+ return '%s-%s-%s-%s-%s' % (
+ hex[:8], hex[8:12], hex[12:16], hex[16:20], hex[20:])
+
+ def get_bytes(self):
+ bytes = ''
+ for shift in range(0, 128, 8):
+ bytes = chr((self.int >> shift) & 0xff) + bytes
+ return bytes
+
+ bytes = property(get_bytes)
+
+ def get_fields(self):
+ return (self.time_low, self.time_mid, self.time_hi_version,
+ self.clock_seq_hi_variant, self.clock_seq_low, self.node)
+
+ fields = property(get_fields)
+
+ def get_time_low(self):
+ return self.int >> 96L
+
+ time_low = property(get_time_low)
+
+ def get_time_mid(self):
+ return (self.int >> 80L) & 0xffff
+
+ time_mid = property(get_time_mid)
+
+ def get_time_hi_version(self):
+ return (self.int >> 64L) & 0xffff
+
+ time_hi_version = property(get_time_hi_version)
+
+ def get_clock_seq_hi_variant(self):
+ return (self.int >> 56L) & 0xff
+
+ clock_seq_hi_variant = property(get_clock_seq_hi_variant)
+
+ def get_clock_seq_low(self):
+ return (self.int >> 48L) & 0xff
+
+ clock_seq_low = property(get_clock_seq_low)
+
+ def get_time(self):
+ return (((self.time_hi_version & 0x0fffL) << 48L) |
+ (self.time_mid << 32L) | self.time_low)
+
+ time = property(get_time)
+
+ def get_clock_seq(self):
+ return (((self.clock_seq_hi_variant & 0x3fL) << 8L) |
+ self.clock_seq_low)
+
+ clock_seq = property(get_clock_seq)
+
+ def get_node(self):
+ return self.int & 0xffffffffffff
+
+ node = property(get_node)
+
+ def get_hex(self):
+ return '%032x' % self.int
+
+ hex = property(get_hex)
+
+ def get_urn(self):
+ return 'urn:uuid:' + str(self)
+
+ urn = property(get_urn)
+
+ def get_variant(self):
+ if not self.int & (0x8000 << 48L):
+ return RESERVED_NCS
+ elif not self.int & (0x4000 << 48L):
+ return RFC_4122
+ elif not self.int & (0x2000 << 48L):
+ return RESERVED_MICROSOFT
+ else:
+ return RESERVED_FUTURE
+
+ variant = property(get_variant)
+
+ def get_version(self):
+ # The version bits are only meaningful for RFC 4122 UUIDs.
+ if self.variant == RFC_4122:
+ return int((self.int >> 76L) & 0xf)
+
+ version = property(get_version)
+
+def _ifconfig_getnode():
+ """Get the hardware address on Unix by running ifconfig."""
+ import os
+ for dir in ['', '/sbin/', '/usr/sbin']:
+ try:
+ pipe = os.popen(os.path.join(dir, 'ifconfig'))
+ except IOError:
+ continue
+ for line in pipe:
+ words = line.lower().split()
+ for i in range(len(words)):
+ if words[i] in ['hwaddr', 'ether']:
+ return int(words[i + 1].replace(':', ''), 16)
+
+def _ipconfig_getnode():
+ """Get the hardware address on Windows by running ipconfig.exe."""
+ import os, re
+ dirs = ['', r'c:\windows\system32', r'c:\winnt\system32']
+ try:
+ import ctypes
+ buffer = ctypes.create_string_buffer(300)
+ ctypes.windll.kernel32.GetSystemDirectoryA(buffer, 300)
+ dirs.insert(0, buffer.value.decode('mbcs'))
+ except:
+ pass
+ for dir in dirs:
+ try:
+ pipe = os.popen(os.path.join(dir, 'ipconfig') + ' /all')
+ except IOError:
+ continue
+ for line in pipe:
+ value = line.split(':')[-1].strip().lower()
+ if re.match('([0-9a-f][0-9a-f]-){5}[0-9a-f][0-9a-f]', value):
+ return int(value.replace('-', ''), 16)
+
+def _netbios_getnode():
+ """Get the hardware address on Windows using NetBIOS calls.
+ See http://support.microsoft.com/kb/118623 for details."""
+ import win32wnet, netbios
+ ncb = netbios.NCB()
+ ncb.Command = netbios.NCBENUM
+ ncb.Buffer = adapters = netbios.LANA_ENUM()
+ adapters._pack()
+ if win32wnet.Netbios(ncb) != 0:
+ return
+ adapters._unpack()
+ for i in range(adapters.length):
+ ncb.Reset()
+ ncb.Command = netbios.NCBRESET
+ ncb.Lana_num = ord(adapters.lana[i])
+ if win32wnet.Netbios(ncb) != 0:
+ continue
+ ncb.Reset()
+ ncb.Command = netbios.NCBASTAT
+ ncb.Lana_num = ord(adapters.lana[i])
+ ncb.Callname = '*'.ljust(16)
+ ncb.Buffer = status = netbios.ADAPTER_STATUS()
+ if win32wnet.Netbios(ncb) != 0:
+ continue
+ status._unpack()
+ bytes = map(ord, status.adapter_address)
+ return ((bytes[0]<<40L) + (bytes[1]<<32L) + (bytes[2]<<24L) +
+ (bytes[3]<<16L) + (bytes[4]<<8L) + bytes[5])
+
+# Thanks to Thomas Heller for ctypes and for his help with its use here.
+
+# If ctypes is available, use it to find system routines for UUID generation.
+_uuid_generate_random = _uuid_generate_time = _UuidCreate = None
+try:
+ import ctypes, ctypes.util
+ _buffer = ctypes.create_string_buffer(16)
+
+ # The uuid_generate_* routines are provided by libuuid on at least
+ # Linux and FreeBSD, and provided by libc on Mac OS X.
+ for libname in ['uuid', 'c']:
+ try:
+ lib = ctypes.CDLL(ctypes.util.find_library(libname))
+ except:
+ continue
+ if hasattr(lib, 'uuid_generate_random'):
+ _uuid_generate_random = lib.uuid_generate_random
+ if hasattr(lib, 'uuid_generate_time'):
+ _uuid_generate_time = lib.uuid_generate_time
+
+ # On Windows prior to 2000, UuidCreate gives a UUID containing the
+ # hardware address. On Windows 2000 and later, UuidCreate makes a
+ # random UUID and UuidCreateSequential gives a UUID containing the
+ # hardware address. These routines are provided by the RPC runtime.
+ try:
+ lib = ctypes.windll.rpcrt4
+ except:
+ lib = None
+ _UuidCreate = getattr(lib, 'UuidCreateSequential',
+ getattr(lib, 'UuidCreate', None))
+except:
+ pass
+
+def _unixdll_getnode():
+ """Get the hardware address on Unix using ctypes."""
+ _uuid_generate_time(_buffer)
+ return UUID(bytes=_buffer.raw).node
+
+def _windll_getnode():
+ """Get the hardware address on Windows using ctypes."""
+ if _UuidCreate(_buffer) == 0:
+ return UUID(bytes=_buffer.raw).node
+
+def _random_getnode():
+ """Get a random node ID, with eighth bit set as suggested by RFC 4122."""
+ import random
+ return random.randrange(0, 1<<48L) | 0x010000000000L
+
+_node = None
+
+def getnode():
+ """Get the hardware address as a 48-bit integer. The first time this
+ runs, it may launch a separate program, which could be quite slow. If
+ all attempts to obtain the hardware address fail, we choose a random
+ 48-bit number with its eighth bit set to 1 as recommended in RFC 4122."""
+
+ global _node
+ if _node is not None:
+ return _node
+
+ import sys
+ if sys.platform == 'win32':
+ getters = [_windll_getnode, _netbios_getnode, _ipconfig_getnode]
+ else:
+ getters = [_unixdll_getnode, _ifconfig_getnode]
+
+ for getter in getters + [_random_getnode]:
+ try:
+ _node = getter()
+ except:
+ continue
+ if _node is not None:
+ return _node
+
+def uuid1(node=None, clock_seq=None):
+ """Generate a UUID from a host ID, sequence number, and the current time.
+ If 'node' is not given, getnode() is used to obtain the hardware
+ address. If 'clock_seq' is given, it is used as the sequence number;
+ otherwise a random 14-bit sequence number is chosen."""
+
+ # When the system provides a version-1 UUID generator, use it (but don't
+ # use UuidCreate here because its UUIDs don't conform to RFC 4122).
+ if _uuid_generate_time and node is clock_seq is None:
+ _uuid_generate_time(_buffer)
+ return UUID(bytes=_buffer.raw)
+
+ import time
+ nanoseconds = int(time.time() * 1e9)
+ # 0x01b21dd213814000 is the number of 100-ns intervals between the
+ # UUID epoch 1582-10-15 00:00:00 and the Unix epoch 1970-01-01 00:00:00.
+ timestamp = int(nanoseconds/100) + 0x01b21dd213814000L
+ if clock_seq is None:
+ import random
+ clock_seq = random.randrange(1<<14L) # instead of stable storage
+ time_low = timestamp & 0xffffffffL
+ time_mid = (timestamp >> 32L) & 0xffffL
+ time_hi_version = (timestamp >> 48L) & 0x0fffL
+ clock_seq_low = clock_seq & 0xffL
+ clock_seq_hi_variant = (clock_seq >> 8L) & 0x3fL
+ if node is None:
+ node = getnode()
+ return UUID(fields=(time_low, time_mid, time_hi_version,
+ clock_seq_hi_variant, clock_seq_low, node), version=1)
+
+def uuid3(namespace, name):
+ """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
+ import md5
+ hash = md5.md5(namespace.bytes + name).digest()
+ return UUID(bytes=hash[:16], version=3)
+
+def uuid4():
+ """Generate a random UUID."""
+
+ # When the system provides a version-4 UUID generator, use it.
+ if _uuid_generate_random:
+ _uuid_generate_random(_buffer)
+ return UUID(bytes=_buffer.raw)
+
+ # Otherwise, get randomness from urandom or the 'random' module.
+ try:
+ import os
+ return UUID(bytes=os.urandom(16), version=4)
+ except:
+ import random
+ bytes = [chr(random.randrange(256)) for i in range(16)]
+ return UUID(bytes=bytes, version=4)
+
+def uuid5(namespace, name):
+ """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
+ import sha
+ hash = sha.sha(namespace.bytes + name).digest()
+ return UUID(bytes=hash[:16], version=5)
+
+# The following standard UUIDs are for use with uuid3() or uuid5().
+
+NAMESPACE_DNS = UUID('6ba7b810-9dad-11d1-80b4-00c04fd430c8')
+NAMESPACE_URL = UUID('6ba7b811-9dad-11d1-80b4-00c04fd430c8')
+NAMESPACE_OID = UUID('6ba7b812-9dad-11d1-80b4-00c04fd430c8')
+NAMESPACE_X500 = UUID('6ba7b814-9dad-11d1-80b4-00c04fd430c8')