:mod:`!uuid` --- UUID objects according to :rfc:`9562`
Python 3.14 Docs · نسخهٔ 3.14.10 · PSF License
:mod:!uuid --- UUID objects according to :rfc:9562
:synopsis: UUID objects (universally unique identifiers) according to RFC 9562
Source code: Lib/uuid.py
--------------
This module provides immutable UUID objects (the UUID class) and functions <uuid-factory-functions> for generating UUIDs corresponding to a specific UUID version as specified in 9562 (which supersedes 4122), for example, uuid1 for UUID version 1, uuid3 for UUID version 3, and so on. Note that UUID version 2 is deliberately omitted as it is outside the scope of the RFC.
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.
Depending on support from the underlying platform, uuid1 may or may not return a "safe" UUID. A safe UUID is one which is generated using synchronization methods that ensure no two processes can obtain the same UUID. All instances of UUID have an ~UUID.is_safe attribute which relays any information about the UUID's safety, using this enumeration:
The UUID was generated by the platform in a multiprocessing-safe way.
The UUID was not generated in a multiprocessing-safe way.
The platform does not provide information on whether the UUID was generated safely or not.
Create a UUID from either a string of 32 hexadecimal digits, a 16-byte bytes object in big-endian order as the *bytes* argument, a 16-byte bytes object in little-endian order as the *bytes_le* 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=b'\x12\x34\x56\x78'*4) UUID(bytes_le=b'\x78\x56\x34\x12\x34\x12\x78\x56' + b'\x12\x34\x56\x78\x12\x34\x56\x78') UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678)) UUID(int=0x12345678123456781234567812345678)
Exactly one of *hex*, *bytes*, *bytes_le*, *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 9562, overriding bits in the given *hex*, *bytes*, *bytes_le*, *fields*, or *int*.
Comparison of UUID objects are made by way of comparing their UUID.int attributes. Comparison with a non-UUID object raises a TypeError.
`str(uuid) returns a string in the form 12345678-1234-5678-1234-567812345678` where the 32 hexadecimal digits represent the UUID.
UUID instances have these read-only attributes:
The UUID as a 16-byte bytes object (containing the six integer fields in big-endian byte order).
The UUID as a 16-byte bytes object (with *time_low*, *time_mid*, and *time_hi_version* in little-endian byte order).
A tuple of the six integer fields of the UUID, which are also available as six individual attributes and two derived attributes:
- - Field
- Meaning
- - .. attribute:: UUID.time_low
- The first 32 bits of the UUID. Only relevant to version 1.
- - .. attribute:: UUID.time_mid
- The next 16 bits of the UUID. Only relevant to version 1.
- - .. attribute:: UUID.time_hi_version
- The next 16 bits of the UUID. Only relevant to version 1.
- - .. attribute:: UUID.clock_seq_hi_variant
- The next 8 bits of the UUID. Only relevant to versions 1 and 6.
- - .. attribute:: UUID.clock_seq_low
- The next 8 bits of the UUID. Only relevant to versions 1 and 6.
- - .. attribute:: UUID.node
- The last 48 bits of the UUID. Only relevant to version 1.
- - .. attribute:: UUID.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:00:00) for version 7.
- - .. attribute:: UUID.clock_seq
- The 14-bit sequence number. Only relevant to versions 1 and 6.
The UUID as a 32-character lowercase hexadecimal string.
The UUID as a 128-bit integer.
The UUID as a URN as specified in 9562.
The UUID variant, which determines the internal layout of the UUID. This will be one of the constants RESERVED_NCS, RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE.
The UUID version number (1 through 8, meaningful only when the variant is RFC_4122).
Added UUID versions 6, 7 and 8.
An enumeration of SafeUUID which indicates whether the platform generated the UUID in a multiprocessing-safe way.
The !uuid module defines the following functions:
Get the hardware address as a 48-bit positive 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 the multicast bit (least significant bit of the first octet) set to 1 as recommended in 4122. "Hardware address" means the MAC address of a network interface. On a machine with multiple network interfaces, universally administered MAC addresses (i.e. where the second least significant bit of the first octet is *unset*) will be preferred over locally administered MAC addresses, but with no other ordering guarantees.
Universally administered MAC addresses are preferred over locally administered MAC addresses, since the former are guaranteed to be globally unique, while the latter are not.
Generate a UUID from a host ID, sequence number, and the current time according to RFC 9562, §5.1 <9562#section-5.1>.
When *node* is not specified, getnode is used to obtain the hardware address as a 48-bit positive integer. When a sequence number *clock_seq* is not specified, a pseudo-random 14-bit positive integer is generated.
If *node* or *clock_seq* exceed their expected bit count, only their least significant bits are kept.
Generate a UUID based on the MD5 hash of a namespace identifier (which is a UUID) and a name (which is a bytes object or a string that will be encoded using UTF-8) according to RFC 9562, §5.3 <9562#section-5.3>.
Generate a random UUID in a cryptographically-secure method according to RFC 9562, §5.4 <9562#section-5.4>.
Generate a UUID based on the SHA-1 hash of a namespace identifier (which is a UUID) and a name (which is a bytes object or a string that will be encoded using UTF-8) according to RFC 9562, §5.5 <9562#section-5.5>.
Generate a UUID from a sequence number and the current time according to RFC 9562, §5.6 <9562#section-5.6>.
This is an alternative to uuid1 to improve database locality.
When *node* is not specified, getnode is used to obtain the hardware address as a 48-bit positive integer. When a sequence number *clock_seq* is not specified, a pseudo-random 14-bit positive integer is generated.
If *node* or *clock_seq* exceed their expected bit count, only their least significant bits are kept.
Generate a time-based UUID according to RFC 9562, §5.7 <9562#section-5.7>.
For portability across platforms lacking sub-millisecond precision, UUIDs produced by this function embed a 48-bit timestamp and use a 42-bit counter to guarantee monotonicity within a millisecond.
Generate a pseudo-random UUID according to RFC 9562, §5.8 <9562#section-5.8>.
When specified, the parameters *a*, *b* and *c* are expected to be positive integers of 48, 12 and 62 bits respectively. If they exceed their expected bit count, only their least significant bits are kept; non-specified arguments are substituted for a pseudo-random integer of appropriate size.
By default, *a*, *b* and *c* are not generated by a cryptographically secure pseudo-random number generator (CSPRNG). Use uuid4 when a UUID needs to be used in a security-sensitive context.
The !uuid module defines the following namespace identifiers for use with uuid3 or uuid5.
When this namespace is specified, the *name* string is a fully qualified domain name.
When this namespace is specified, the *name* string is a URL.
When this namespace is specified, the *name* string is an ISO OID.
When this namespace is specified, the *name* string is an X.500 DN in DER or a text output format.
The !uuid module defines the following constants for the possible values of the ~UUID.variant attribute:
Reserved for NCS compatibility.
Specifies the UUID layout given in 4122. This constant is kept for backward compatibility even though 4122 has been superseded by 9562.
Reserved for Microsoft compatibility.
Reserved for future definition.
The !uuid module defines the special Nil and Max UUID values:
A special form of UUID that is specified to have all 128 bits set to zero according to RFC 9562, §5.9 <9562#section-5.9>.
A special form of UUID that is specified to have all 128 bits set to one according to RFC 9562, §5.10 <9562#section-5.10>.
9562 - A Universally Unique IDentifier (UUID) URN Namespace This specification defines a Uniform Resource Name namespace for UUIDs, the internal format of UUIDs, and methods of generating UUIDs.
Command-Line Usage
The !uuid module can be executed as a script from the command line.
python -m uuid [-h] [-u {uuid1,uuid3,uuid4,uuid5,uuid6,uuid7,uuid8}] [-n NAMESPACE] [-N NAME]The following options are accepted:
Show the help message and exit.
--uuid <uuid>
Specify the function name to use to generate the uuid. By default uuid4 is used.
Allow generating UUID versions 6, 7 and 8.
--namespace <namespace>
The namespace is a `UUID, or @ns where ns is a well-known predefined UUID addressed by namespace name. Such as @dns, @url, @oid, and @x500. Only required for uuid3 / uuid5` functions.
--name <name>
The name used as part of generating the uuid. Only required for uuid3 / uuid5 functions.
--count <num>
Generate *num* fresh UUIDs.
Example
Here are some examples of typical usage of the !uuid module::
توجه: >> import uuid
توجه: >> # make a UUID based on the host ID and current time >> uuid.uuid1() # doctest: +SKIP
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() # doctest: +SKIP
UUID('1f0799c0-98b9-62db-92c6-a0d365b91053')
توجه: >> # get UUIDv7 creation (local) time as a timestamp in milliseconds >> u = uuid.uuid7() >> u.time # doctest: +SKIP
1743936859822
توجه: >> # get UUIDv7 creation (local) time as a datetime object >> import datetime as dt >> dt.datetime.fromtimestamp(u.time / 1000) # doctest: +SKIP
datetime.datetime(...)
توجه: >> # make a UUID with custom blocks >> uuid.uuid8(0x12345678, 0x9abcdef0, 0x11223344)
UUID('00001234-5678-8ef0-8000-000011223344')
Command-Line Example
Here are some examples of typical usage of the !uuid command-line interface:
# generate a random UUID - by default uuid4() is used
$ python -m uuid
# generate a UUID using uuid1()
$ python -m uuid -u uuid1
# generate a UUID using uuid5
$ python -m uuid -u uuid5 -n @url -N example.com
# generate 42 random UUIDs
$ python -m uuid -C 42