uuid (version 1.30, 2006-06-12)
index
/Users/ping/dev/python/uuid.py

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.

 
Classes
       
__builtin__.object
UUID

 
class UUID(__builtin__.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)
 
  Methods defined here:
__cmp__(self, other)
__hash__(self)
__init__(self, hex=None, bytes=None, fields=None, int=None, version=None)
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'.
__int__(self)
__repr__(self)
__setattr__(self, name, value)
__str__(self)
get_bytes(self)
get_clock_seq(self)
get_clock_seq_hi_variant(self)
get_clock_seq_low(self)
get_fields(self)
get_hex(self)
get_node(self)
get_time(self)
get_time_hi_version(self)
get_time_low(self)
get_time_mid(self)
get_urn(self)
get_variant(self)
get_version(self)

Properties defined here:
bytes
get = get_bytes(self)
clock_seq
get = get_clock_seq(self)
clock_seq_hi_variant
get = get_clock_seq_hi_variant(self)
clock_seq_low
get = get_clock_seq_low(self)
fields
get = get_fields(self)
hex
get = get_hex(self)
node
get = get_node(self)
time
get = get_time(self)
time_hi_version
get = get_time_hi_version(self)
time_low
get = get_time_low(self)
time_mid
get = get_time_mid(self)
urn
get = get_urn(self)
variant
get = get_variant(self)
version
get = get_version(self)

Data and other attributes defined here:
__dict__ = <dictproxy object at 0xd6790>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'UUID' objects>
list of weak references to the object (if defined)

 
Functions
       
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.
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.
uuid3(namespace, name)
Generate a UUID from the MD5 hash of a namespace UUID and a name.
uuid4()
Generate a random UUID.
uuid5(namespace, name)
Generate a UUID from the SHA-1 hash of a namespace UUID and a name.

 
Data
        NAMESPACE_DNS = UUID('6ba7b810-9dad-11d1-80b4-00c04fd430c8')
NAMESPACE_OID = UUID('6ba7b812-9dad-11d1-80b4-00c04fd430c8')
NAMESPACE_URL = UUID('6ba7b811-9dad-11d1-80b4-00c04fd430c8')
NAMESPACE_X500 = UUID('6ba7b814-9dad-11d1-80b4-00c04fd430c8')
RESERVED_FUTURE = 'reserved for future definition'
RESERVED_MICROSOFT = 'reserved for Microsoft compatibility'
RESERVED_NCS = 'reserved for NCS compatibility'
RFC_4122 = 'specified in RFC 4122'
__author__ = 'Ka-Ping Yee <ping@zesty.ca>'
__date__ = '2006-06-12'
__version__ = '1.30'

 
Author
        Ka-Ping Yee <ping@zesty.ca>