uuid.py
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:19k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. """
  2. @file uuid.py
  3. @brief 
  4. $LicenseInfo:firstyear=2007&license=mit$
  5. Copyright (c) 2007-2010, Linden Research, Inc.
  6. Permission is hereby granted, free of charge, to any person obtaining a copy
  7. of this software and associated documentation files (the "Software"), to deal
  8. in the Software without restriction, including without limitation the rights
  9. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. copies of the Software, and to permit persons to whom the Software is
  11. furnished to do so, subject to the following conditions:
  12. The above copyright notice and this permission notice shall be included in
  13. all copies or substantial portions of the Software.
  14. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. THE SOFTWARE.
  21. $/LicenseInfo$
  22. """
  23. r"""UUID objects (universally unique identifiers) according to RFC 4122.
  24. This module provides immutable UUID objects (class UUID) and the functions
  25. uuid1(), uuid3(), uuid4(), uuid5() for generating version 1, 3, 4, and 5
  26. UUIDs as specified in RFC 4122.
  27. If all you want is a unique ID, you should probably call uuid1() or uuid4().
  28. Note that uuid1() may compromise privacy since it creates a UUID containing
  29. the computer's network address.  uuid4() creates a random UUID.
  30. Typical usage:
  31.     >>> import uuid
  32.     # make a UUID based on the host ID and current time
  33.     >>> uuid.uuid1()
  34.     UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')
  35.     # make a UUID using an MD5 hash of a namespace UUID and a name
  36.     >>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
  37.     UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
  38.     # make a random UUID
  39.     >>> uuid.uuid4()
  40.     UUID('16fd2706-8baf-433b-82eb-8c7fada847da')
  41.     # make a UUID using a SHA-1 hash of a namespace UUID and a name
  42.     >>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
  43.     UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
  44.     # make a UUID from a string of hex digits (braces and hyphens ignored)
  45.     >>> x = uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}')
  46.     # convert a UUID to a string of hex digits in standard form
  47.     >>> str(x)
  48.     '00010203-0405-0607-0809-0a0b0c0d0e0f'
  49.     # get the raw 16 bytes of the UUID
  50.     >>> x.bytes
  51.     'x00x01x02x03x04x05x06x07x08tnx0bx0crx0ex0f'
  52.     # make a UUID from a 16-byte string
  53.     >>> uuid.UUID(bytes=x.bytes)
  54.     UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
  55. This module works with Python 2.3 or higher."""
  56. __author__ = 'Ka-Ping Yee <ping@zesty.ca>'
  57. __date__ = '$Date: 2006/06/12 23:15:40 $'.split()[1].replace('/', '-')
  58. __version__ = '$Revision: 1.30 $'.split()[1]
  59. RESERVED_NCS, RFC_4122, RESERVED_MICROSOFT, RESERVED_FUTURE = [
  60.     'reserved for NCS compatibility', 'specified in RFC 4122',
  61.     'reserved for Microsoft compatibility', 'reserved for future definition']
  62. class UUID(object):
  63.     """Instances of the UUID class represent UUIDs as specified in RFC 4122.
  64.     UUID objects are immutable, hashable, and usable as dictionary keys.
  65.     Converting a UUID to a string with str() yields something in the form
  66.     '12345678-1234-1234-1234-123456789abc'.  The UUID constructor accepts
  67.     four possible forms: a similar string of hexadecimal digits, or a
  68.     string of 16 raw bytes as an argument named 'bytes', or a tuple of
  69.     six integer fields (with 32-bit, 16-bit, 16-bit, 8-bit, 8-bit, and
  70.     48-bit values respectively) as an argument named 'fields', or a single
  71.     128-bit integer as an argument named 'int'.
  72.     
  73.     UUIDs have these read-only attributes:
  74.         bytes       the UUID as a 16-byte string
  75.         fields      a tuple of the six integer fields of the UUID,
  76.                     which are also available as six individual attributes
  77.                     and two derived attributes:
  78.             time_low                the first 32 bits of the UUID
  79.             time_mid                the next 16 bits of the UUID
  80.             time_hi_version         the next 16 bits of the UUID
  81.             clock_seq_hi_variant    the next 8 bits of the UUID
  82.             clock_seq_low           the next 8 bits of the UUID
  83.             node                    the last 48 bits of the UUID
  84.             time                    the 60-bit timestamp
  85.             clock_seq               the 14-bit sequence number
  86.         hex         the UUID as a 32-character hexadecimal string
  87.         int         the UUID as a 128-bit integer
  88.         urn         the UUID as a URN as specified in RFC 4122
  89.         variant     the UUID variant (one of the constants RESERVED_NCS,
  90.                     RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE)
  91.         version     the UUID version number (1 through 5, meaningful only
  92.                     when the variant is RFC_4122)
  93.     """
  94.     def __init__(self, hex=None, bytes=None, fields=None, int=None,
  95.                        version=None):
  96.         r"""Create a UUID from either a string of 32 hexadecimal digits,
  97.         a string of 16 bytes as the 'bytes' argument, a tuple of six
  98.         integers (32-bit time_low, 16-bit time_mid, 16-bit time_hi_version,
  99.         8-bit clock_seq_hi_variant, 8-bit clock_seq_low, 48-bit node) as
  100.         the 'fields' argument, or a single 128-bit integer as the 'int'
  101.         argument.  When a string of hex digits is given, curly braces,
  102.         hyphens, and a URN prefix are all optional.  For example, these
  103.         expressions all yield the same UUID:
  104.         UUID('{12345678-1234-5678-1234-567812345678}')
  105.         UUID('12345678123456781234567812345678')
  106.         UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
  107.         UUID(bytes='x12x34x56x78'*4)
  108.         UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
  109.         UUID(int=0x12345678123456781234567812345678)
  110.         Exactly one of 'hex', 'bytes', 'fields', or 'int' must be given.
  111.         The 'version' argument is optional; if given, the resulting UUID
  112.         will have its variant and version number set according to RFC 4122,
  113.         overriding bits in the given 'hex', 'bytes', 'fields', or 'int'.
  114.         """
  115.         if [hex, bytes, fields, int].count(None) != 3:
  116.             raise TypeError('need just one of hex, bytes, fields, or int')
  117.         if hex is not None:
  118.             hex = hex.replace('urn:', '').replace('uuid:', '')
  119.             hex = hex.strip('{}').replace('-', '')
  120.             if len(hex) != 32:
  121.                 raise ValueError('badly formed hexadecimal UUID string')
  122.             int = long(hex, 16)
  123.         if bytes is not None:
  124.             if len(bytes) != 16:
  125.                 raise ValueError('bytes is not a 16-char string')
  126.             int = long(('%02x'*16) % tuple(map(ord, bytes)), 16)
  127.         if fields is not None:
  128.             if len(fields) != 6:
  129.                 raise ValueError('fields is not a 6-tuple')
  130.             (time_low, time_mid, time_hi_version,
  131.              clock_seq_hi_variant, clock_seq_low, node) = fields
  132.             if not 0 <= time_low < 1<<32L:
  133.                 raise ValueError('field 1 out of range (need a 32-bit value)')
  134.             if not 0 <= time_mid < 1<<16L:
  135.                 raise ValueError('field 2 out of range (need a 16-bit value)')
  136.             if not 0 <= time_hi_version < 1<<16L:
  137.                 raise ValueError('field 3 out of range (need a 16-bit value)')
  138.             if not 0 <= clock_seq_hi_variant < 1<<8L:
  139.                 raise ValueError('field 4 out of range (need an 8-bit value)')
  140.             if not 0 <= clock_seq_low < 1<<8L:
  141.                 raise ValueError('field 5 out of range (need an 8-bit value)')
  142.             if not 0 <= node < 1<<48L:
  143.                 raise ValueError('field 6 out of range (need a 48-bit value)')
  144.             clock_seq = (clock_seq_hi_variant << 8L) | clock_seq_low
  145.             int = ((time_low << 96L) | (time_mid << 80L) |
  146.                    (time_hi_version << 64L) | (clock_seq << 48L) | node)
  147.         if int is not None:
  148.             if not 0 <= int < 1<<128L:
  149.                 raise ValueError('int is out of range (need a 128-bit value)')
  150.         if version is not None:
  151.             if not 1 <= version <= 5:
  152.                 raise ValueError('illegal version number')
  153.             # Set the variant to RFC 4122.
  154.             int &= ~(0xc000 << 48L)
  155.             int |= 0x8000 << 48L
  156.             # Set the version number.
  157.             int &= ~(0xf000 << 64L)
  158.             int |= version << 76L
  159.         self.__dict__['int'] = int
  160.     def __cmp__(self, other):
  161.         if isinstance(other, UUID):
  162.             return cmp(self.int, other.int)
  163.         return NotImplemented
  164.     def __hash__(self):
  165.         return hash(self.int)
  166.     def __int__(self):
  167.         return self.int
  168.     def __repr__(self):
  169.         return 'UUID(%r)' % str(self)
  170.     def __setattr__(self, name, value):
  171.         raise TypeError('UUID objects are immutable')
  172.     def __str__(self):
  173.         hex = '%032x' % self.int
  174.         return '%s-%s-%s-%s-%s' % (
  175.             hex[:8], hex[8:12], hex[12:16], hex[16:20], hex[20:])
  176.     def get_bytes(self):
  177.         bytes = ''
  178.         for shift in range(0, 128, 8):
  179.             bytes = chr((self.int >> shift) & 0xff) + bytes
  180.         return bytes
  181.     bytes = property(get_bytes)
  182.     def get_fields(self):
  183.         return (self.time_low, self.time_mid, self.time_hi_version,
  184.                 self.clock_seq_hi_variant, self.clock_seq_low, self.node)
  185.     fields = property(get_fields)
  186.     def get_time_low(self):
  187.         return self.int >> 96L
  188.    
  189.     time_low = property(get_time_low)
  190.     def get_time_mid(self):
  191.         return (self.int >> 80L) & 0xffff
  192.     time_mid = property(get_time_mid)
  193.     def get_time_hi_version(self):
  194.         return (self.int >> 64L) & 0xffff
  195.     
  196.     time_hi_version = property(get_time_hi_version)
  197.     def get_clock_seq_hi_variant(self):
  198.         return (self.int >> 56L) & 0xff
  199.     clock_seq_hi_variant = property(get_clock_seq_hi_variant)
  200.     
  201.     def get_clock_seq_low(self):
  202.         return (self.int >> 48L) & 0xff
  203.     clock_seq_low = property(get_clock_seq_low)
  204.     def get_time(self):
  205.         return (((self.time_hi_version & 0x0fffL) << 48L) |
  206.                 (self.time_mid << 32L) | self.time_low)
  207.     time = property(get_time)
  208.     def get_clock_seq(self):
  209.         return (((self.clock_seq_hi_variant & 0x3fL) << 8L) |
  210.                 self.clock_seq_low)
  211.     clock_seq = property(get_clock_seq)
  212.     
  213.     def get_node(self):
  214.         return self.int & 0xffffffffffff
  215.     node = property(get_node)
  216.     def get_hex(self):
  217.         return '%032x' % self.int
  218.     hex = property(get_hex)
  219.     def get_urn(self):
  220.         return 'urn:uuid:' + str(self)
  221.     urn = property(get_urn)
  222.     def get_variant(self):
  223.         if not self.int & (0x8000 << 48L):
  224.             return RESERVED_NCS
  225.         elif not self.int & (0x4000 << 48L):
  226.             return RFC_4122
  227.         elif not self.int & (0x2000 << 48L):
  228.             return RESERVED_MICROSOFT
  229.         else:
  230.             return RESERVED_FUTURE
  231.     variant = property(get_variant)
  232.     def get_version(self):
  233.         # The version bits are only meaningful for RFC 4122 UUIDs.
  234.         if self.variant == RFC_4122:
  235.             return int((self.int >> 76L) & 0xf)
  236.     version = property(get_version)
  237. def _ifconfig_getnode():
  238.     """Get the hardware address on Unix by running ifconfig."""
  239.     import os
  240.     for dir in ['', '/sbin/', '/usr/sbin']:
  241.         try:
  242.             path = os.path.join(dir, 'ifconfig')
  243.             if os.path.exists(path):
  244.                 pipe = os.popen(path)
  245.             else:
  246.                 continue
  247.         except IOError:
  248.             continue
  249.         for line in pipe:
  250.             words = line.lower().split()
  251.             for i in range(len(words)):
  252.                 if words[i] in ['hwaddr', 'ether']:
  253.                     return int(words[i + 1].replace(':', ''), 16)
  254. def _ipconfig_getnode():
  255.     """Get the hardware address on Windows by running ipconfig.exe."""
  256.     import os, re
  257.     dirs = ['', r'c:windowssystem32', r'c:winntsystem32']
  258.     try:
  259.         import ctypes
  260.         buffer = ctypes.create_string_buffer(300)
  261.         ctypes.windll.kernel32.GetSystemDirectoryA(buffer, 300)
  262.         dirs.insert(0, buffer.value.decode('mbcs'))
  263.     except:
  264.         pass
  265.     for dir in dirs:
  266.         try:
  267.             pipe = os.popen(os.path.join(dir, 'ipconfig') + ' /all')
  268.         except IOError:
  269.             continue
  270.         for line in pipe:
  271.             value = line.split(':')[-1].strip().lower()
  272.             if re.match('([0-9a-f][0-9a-f]-){5}[0-9a-f][0-9a-f]', value):
  273.                 return int(value.replace('-', ''), 16)
  274. def _netbios_getnode():
  275.     """Get the hardware address on Windows using NetBIOS calls.
  276.     See http://support.microsoft.com/kb/118623 for details."""
  277.     import win32wnet, netbios
  278.     ncb = netbios.NCB()
  279.     ncb.Command = netbios.NCBENUM
  280.     ncb.Buffer = adapters = netbios.LANA_ENUM()
  281.     adapters._pack()
  282.     if win32wnet.Netbios(ncb) != 0:
  283.         return
  284.     adapters._unpack()
  285.     for i in range(adapters.length):
  286.         ncb.Reset()
  287.         ncb.Command = netbios.NCBRESET
  288.         ncb.Lana_num = ord(adapters.lana[i])
  289.         if win32wnet.Netbios(ncb) != 0:
  290.             continue
  291.         ncb.Reset()
  292.         ncb.Command = netbios.NCBASTAT
  293.         ncb.Lana_num = ord(adapters.lana[i])
  294.         ncb.Callname = '*'.ljust(16)
  295.         ncb.Buffer = status = netbios.ADAPTER_STATUS()
  296.         if win32wnet.Netbios(ncb) != 0:
  297.             continue
  298.         status._unpack()
  299.         bytes = map(ord, status.adapter_address)
  300.         return ((bytes[0]<<40L) + (bytes[1]<<32L) + (bytes[2]<<24L) +
  301.                 (bytes[3]<<16L) + (bytes[4]<<8L) + bytes[5])
  302. # Thanks to Thomas Heller for ctypes and for his help with its use here.
  303. # If ctypes is available, use it to find system routines for UUID generation.
  304. _uuid_generate_random = _uuid_generate_time = _UuidCreate = None
  305. try:
  306.     import ctypes, ctypes.util
  307.     _buffer = ctypes.create_string_buffer(16)
  308.     # The uuid_generate_* routines are provided by libuuid on at least
  309.     # Linux and FreeBSD, and provided by libc on Mac OS X.
  310.     for libname in ['uuid', 'c']:
  311.         try:
  312.             lib = ctypes.CDLL(ctypes.util.find_library(libname))
  313.         except:
  314.             continue
  315.         if hasattr(lib, 'uuid_generate_random'):
  316.             _uuid_generate_random = lib.uuid_generate_random
  317.         if hasattr(lib, 'uuid_generate_time'):
  318.             _uuid_generate_time = lib.uuid_generate_time
  319.     # On Windows prior to 2000, UuidCreate gives a UUID containing the
  320.     # hardware address.  On Windows 2000 and later, UuidCreate makes a
  321.     # random UUID and UuidCreateSequential gives a UUID containing the
  322.     # hardware address.  These routines are provided by the RPC runtime.
  323.     try:
  324.         lib = ctypes.windll.rpcrt4
  325.     except:
  326.         lib = None
  327.     _UuidCreate = getattr(lib, 'UuidCreateSequential',
  328.                           getattr(lib, 'UuidCreate', None))
  329. except:
  330.     pass
  331. def _unixdll_getnode():
  332.     """Get the hardware address on Unix using ctypes."""
  333.     _uuid_generate_time(_buffer)
  334.     return UUID(bytes=_buffer.raw).node
  335. def _windll_getnode():
  336.     """Get the hardware address on Windows using ctypes."""
  337.     if _UuidCreate(_buffer) == 0:
  338.         return UUID(bytes=_buffer.raw).node
  339. def _random_getnode():
  340.     """Get a random node ID, with eighth bit set as suggested by RFC 4122."""
  341.     import random
  342.     return random.randrange(0, 1<<48L) | 0x010000000000L
  343. _node = None
  344. def getnode():
  345.     """Get the hardware address as a 48-bit integer.  The first time this
  346.     runs, it may launch a separate program, which could be quite slow.  If
  347.     all attempts to obtain the hardware address fail, we choose a random
  348.     48-bit number with its eighth bit set to 1 as recommended in RFC 4122."""
  349.     global _node
  350.     if _node is not None:
  351.         return _node
  352.     import sys
  353.     if sys.platform == 'win32':
  354.         getters = [_windll_getnode, _netbios_getnode, _ipconfig_getnode]
  355.     else:
  356.         getters = [_unixdll_getnode, _ifconfig_getnode]
  357.     for getter in getters + [_random_getnode]:
  358.         try:
  359.             _node = getter()
  360.         except:
  361.             continue
  362.         if _node is not None:
  363.             return _node
  364. def uuid1(node=None, clock_seq=None):
  365.     """Generate a UUID from a host ID, sequence number, and the current time.
  366.     If 'node' is not given, getnode() is used to obtain the hardware
  367.     address.  If 'clock_seq' is given, it is used as the sequence number;
  368.     otherwise a random 14-bit sequence number is chosen."""
  369.     # When the system provides a version-1 UUID generator, use it (but don't
  370.     # use UuidCreate here because its UUIDs don't conform to RFC 4122).
  371.     if _uuid_generate_time and node is clock_seq is None:
  372.         _uuid_generate_time(_buffer)
  373.         return UUID(bytes=_buffer.raw)
  374.     import time
  375.     nanoseconds = int(time.time() * 1e9)
  376.     # 0x01b21dd213814000 is the number of 100-ns intervals between the
  377.     # UUID epoch 1582-10-15 00:00:00 and the Unix epoch 1970-01-01 00:00:00.
  378.     timestamp = int(nanoseconds/100) + 0x01b21dd213814000L
  379.     if clock_seq is None:
  380.         import random
  381.         clock_seq = random.randrange(1<<14L) # instead of stable storage
  382.     time_low = timestamp & 0xffffffffL
  383.     time_mid = (timestamp >> 32L) & 0xffffL
  384.     time_hi_version = (timestamp >> 48L) & 0x0fffL
  385.     clock_seq_low = clock_seq & 0xffL
  386.     clock_seq_hi_variant = (clock_seq >> 8L) & 0x3fL
  387.     if node is None:
  388.         node = getnode()
  389.     return UUID(fields=(time_low, time_mid, time_hi_version,
  390.                         clock_seq_hi_variant, clock_seq_low, node), version=1)
  391. def uuid3(namespace, name):
  392.     """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
  393.     import md5
  394.     hash = md5.md5(namespace.bytes + name).digest()
  395.     return UUID(bytes=hash[:16], version=3)
  396. def uuid4():
  397.     """Generate a random UUID."""
  398.     # When the system provides a version-4 UUID generator, use it.
  399.     if _uuid_generate_random:
  400.         _uuid_generate_random(_buffer)
  401.         return UUID(bytes=_buffer.raw)
  402.     # Otherwise, get randomness from urandom or the 'random' module.
  403.     try:
  404.         import os
  405.         return UUID(bytes=os.urandom(16), version=4)
  406.     except:
  407.         import random
  408.         bytes = [chr(random.randrange(256)) for i in range(16)]
  409.         return UUID(bytes=bytes, version=4)
  410. def uuid5(namespace, name):
  411.     """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
  412.     import sha
  413.     hash = sha.sha(namespace.bytes + name).digest()
  414.     return UUID(bytes=hash[:16], version=5)
  415. # The following standard UUIDs are for use with uuid3() or uuid5().
  416. NAMESPACE_DNS = UUID('6ba7b810-9dad-11d1-80b4-00c04fd430c8')
  417. NAMESPACE_URL = UUID('6ba7b811-9dad-11d1-80b4-00c04fd430c8')
  418. NAMESPACE_OID = UUID('6ba7b812-9dad-11d1-80b4-00c04fd430c8')
  419. NAMESPACE_X500 = UUID('6ba7b814-9dad-11d1-80b4-00c04fd430c8')