UUID

uuid

class (source)

UUID(hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown)

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
five possible forms: a similar string of hexadecimal digits, 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 16-byte
bytes object (with all the integer fields in big-endian order) as an
argument named 'bytes', or a 16-byte bytes object (with the first three
fields in little-endian order) as an argument named 'bytes_le', or a single
128-bit integer as an argument named 'int'.

UUIDs have these read-only attributes:

    bytes       the UUID as a 16-byte bytes object (containing the six
                integer fields in big-endian byte order)

    bytes_le    the UUID as a 16-byte bytes object (with time_low,
                time_mid, and time_hi_version in little-endian byte order)

    fields      a tuple of the six integer fields of the UUID,
                which are also available as six individual attributes
                and two derived attributes. Those attributes are not
                always relevant to all UUID versions:

                    The 'time_*' attributes are only relevant to version 1.

                    The 'clock_seq*' and 'node' attributes are only relevant
                    to versions 1 and 6.

                    The 'time' attribute is only relevant to versions 1, 6
                    and 7.

        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 for UUIDv1/v6,
                                or the 48-bit timestamp for UUIDv7
        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/9562

    variant     the UUID variant (one of the constants RESERVED_NCS,
                RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE)

    version     the UUID version number (1 through 8, meaningful only
                when the variant is RFC_4122)

    is_safe     An enum indicating whether the UUID has been generated in
                a way that is safe for multiprocessing applications, via
                uuid_generate_time_safe(3).

Members of UUID

b

bytes: The UUID as a 16-byte bytes object (containing the six integer fields in big-endian byte order).
bytes_le: The UUID as a 16-byte bytes object (with time_low, time_mid, and time_hi_version in little-endian byte order).

c

clock_seq: The 14-bit sequence number.
clock_seq_hi_variant: The next 8 bits of the UUID.
clock_seq_low: The next 8 bits of the UUID.

f

fields: A tuple of the six integer fields of the UUID, which are also available as six individual attributes and two derived attributes:

h

hex: The UUID as a 32-character lowercase hexadecimal string.

i

int: The UUID as a 128-bit integer.
is_safe: An enumeration of SafeUUID which indicates whether the platform generated the UUID in a multiprocessing-safe way.

n

node: The last 48 bits of the UUID.

t

time: The 60-bit timestamp as a count of 100-nanosecond intervals since Gregorian epoch (1582-10-15 00:00:00) for versions 1 and 6, or the 48-bit timestamp in milliseconds since Unix epoch (1970-01-01 00:0…
time_hi_version: The next 16 bits of the UUID.
time_low: The first 32 bits of the UUID.
time_mid: The next 16 bits of the UUID.

u

urn: The UUID as a URN as specified in RFC 9562.

v

variant: The UUID variant, which determines the internal layout of the UUID.
version: The UUID version number (1 through 8, meaningful only when the variant is RFC_4122).

1 Example

link / history / report

>>> 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
b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'

>>> # make a UUID from a 16-byte bytes object
>>> uuid.UUID(bytes=x.bytes)
UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')

>>> # get the Nil UUID
>>> uuid.NIL
UUID('00000000-0000-0000-0000-000000000000')

>>> # get the Max UUID
>>> uuid.MAX
UUID('ffffffff-ffff-ffff-ffff-ffffffffffff')

>>> # same as UUIDv1 but with fields reordered to improve DB locality
>>> uuid.uuid6()
UUID('1f0799c0-98b9-62db-92c6-a0d365b91053')

>>> # get UUIDv7 creation (local) time as a timestamp in milliseconds
>>> u = uuid.uuid7()
>>> u.time
1743936859822

>>> # get UUIDv7 creation (local) time as a datetime object
>>> import datetime as dt
>>> dt.datetime.fromtimestamp(u.time / 1000)
datetime.datetime(...)

>>> # make a UUID with custom blocks
>>> uuid.uuid8(0x12345678, 0x9abcdef0, 0x11223344)
UUID('00001234-5678-8ef0-8000-000011223344')

from the Python docs

PyDocs

Nav

Internet Protocols and Support

Nav

Internet Protocols and Support

All modules

UUID

uuid

Members of UUID

b

c

f

h

i

n

t

u

v

1 Example

See Also

0 Notes