# `uuid` — UUID objects according to RFC 9562

Вихідний код: Lib/uuid.py

This module provides immutable `UUID` objects (the `UUID` class) and functions for generating UUIDs corresponding to a specific UUID version as specified in RFC 9562 (which supersedes RFC 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.

Якщо все, що вам потрібно, це унікальний ідентифікатор, ви, ймовірно, повинні викликати `uuid1()` або `uuid4()`. Зауважте, що `uuid1()` може порушувати конфіденційність, оскільки створює UUID, що містить мережеву адресу комп’ютера. `uuid4()` створює випадковий 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 `is_safe` attribute which relays any information about the UUID’s safety, using this enumeration:

class uuid.SafeUUID

  Added in version 3.7.

  safe

    UUID було створено платформою безпечним для багатьох процесів способом.

  unsafe

    UUID не було створено безпечним для багатопроцесорної обробки способом.

  unknown

    Платформа не надає інформацію про те, чи UUID було створено безпечно чи ні.

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

  Створіть UUID із рядка з 32 шістнадцяткових цифр, рядка з 16 байтів у порядку старших як аргумент bytes, рядка з 16 байтів у порядку старших як аргумент bytes_le або кортежу з шести цілі числа (32-біт time_low, 16-біт time_mid, 16-біт time_hi_version, 8-біт clock_seq_hi_variant, 8-біт clock_seq_low, 48-біт node) як аргумент fields або одне 128-бітове ціле число як аргумент int. Коли вказано рядок шістнадцяткових цифр, фігурні дужки, дефіси та префікс URN є необов’язковими. Наприклад, усі ці вирази дають однаковий 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 RFC 9562, overriding bits in the given hex, bytes, bytes_le, fields, or int.

  Порівняння об’єктів UUID здійснюється шляхом порівняння їхніх атрибутів `UUID.int`. Порівняння з об’єктом, що не є UUID, викликає `TypeError`.

  `str(uuid)` повертає рядок у формі `12345678-1234-5678-1234-567812345678`, де 32 шістнадцяткові цифри представляють UUID.

Екземпляри `UUID` мають ці атрибути лише для читання:

UUID.bytes

  UUID як 16-байтовий рядок (що містить шість цілих полів у порядку байтів у порядку байтів).

UUID.bytes_le

  UUID як 16-байтовий рядок (з time_low, time_mid і time_hi_version у порядку байтів у порядку байтів).

UUID.fields

  Кортеж із шести цілих полів UUID, які також доступні як шість окремих атрибутів і два похідних атрибути:

Поле | Значення

UUID.time_low

The first 32 bits of the UUID. Only relevant to version 1.

UUID.time_mid

The next 16 bits of the UUID. Only relevant to version 1.

UUID.time_hi_version

The next 16 bits of the UUID. Only relevant to version 1.

UUID.clock_seq_hi_variant

The next 8 bits of the UUID. Only relevant to versions 1 and 6.

UUID.clock_seq_low

The next 8 bits of the UUID. Only relevant to versions 1 and 6.

UUID.node

The last 48 bits of the UUID. Only relevant to version 1.

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.

UUID.clock_seq

The 14-bit sequence number. Only relevant to versions 1 and 6.

UUID.hex

  UUID як 32-символьний шістнадцятковий рядок у нижньому регістрі.

UUID.int

  UUID як 128-бітне ціле число.

UUID.urn

  The UUID as a URN as specified in RFC 9562.

UUID.variant

  Варіант UUID, який визначає внутрішнє розташування UUID. Це буде одна з констант `RESERVED_NCS`, `RFC_4122`, `RESERVED_MICROSOFT` або `RESERVED_FUTURE`.

UUID.version

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

  Змінено в версії 3.14: Added UUID versions 6, 7 and 8.

UUID.is_safe

  Перелік `SafeUUID`, який вказує, чи платформа згенерувала UUID безпечним для багатьох процесів способом.

  Added in version 3.7.

Модуль `uuid` визначає такі функції:

uuid.getnode()

  Отримайте апаратну адресу як 48-розрядне позитивне ціле число. Під час першого запуску може запустити окрему програму, яка може працювати досить повільно. Якщо всі спроби отримати апаратну адресу зазнають невдачі, ми вибираємо випадкове 48-бітове число з бітом багатоадресної передачі (молодший значущий біт першого октету), встановленим на 1, як рекомендовано в RFC 4122. «Апаратна адреса» означає MAC-адресу мережевого інтерфейсу. На машині з декількома мережевими інтерфейсами MAC-адреси з універсальним адмініструванням (тобто де другий молодший біт першого октету не встановлено) матимуть перевагу над MAC-адресами з локальним адмініструванням, але без інших гарантій порядку.

  Змінено в версії 3.7: MAC-адреси з універсальним адмініструванням є кращими перед MAC-адресами з локальним адмініструванням, оскільки перші гарантовано є глобально унікальними, а другі – ні.

uuid.uuid1(node=None, clock_seq=None)

  Generate a UUID from a host ID, sequence number, and the current time according to RFC 9562, §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.

uuid.uuid3(namespace, name)

  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.

uuid.uuid4()

  Generate a random UUID in a cryptographically-secure method according to RFC 9562, §5.4.

uuid.uuid5(namespace, name)

  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.

uuid.uuid6(node=None, clock_seq=None)

  Generate a UUID from a sequence number and the current time according to RFC 9562, §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.

  Added in version 3.14.

uuid.uuid7()

  Generate a time-based UUID according to RFC 9562, §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.

  Added in version 3.14.

uuid.uuid8(a=None, b=None, c=None)

  Generate a pseudo-random UUID according to RFC 9562, §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.

  Added in version 3.14.

Модуль `uuid` визначає наступні ідентифікатори простору імен для використання з `uuid3()` або `uuid5()`.

uuid.NAMESPACE_DNS

  When this namespace is specified, the name string is a fully qualified domain name.

uuid.NAMESPACE_URL

  Якщо вказано цей простір імен, рядок name є URL-адресою.

uuid.NAMESPACE_OID

  Якщо вказано цей простір імен, рядок name є ідентифікатором ISO OID.

uuid.NAMESPACE_X500

  Якщо вказано цей простір імен, рядок name є X.500 DN у DER або текстовому форматі виводу.

The `uuid` module defines the following constants for the possible values of the `variant` attribute:

uuid.RESERVED_NCS

  Зарезервовано для сумісності з NCS.

uuid.RFC_4122

  Specifies the UUID layout given in RFC 4122. This constant is kept for backward compatibility even though RFC 4122 has been superseded by RFC 9562.

uuid.RESERVED_MICROSOFT

  Зарезервовано для сумісності з Microsoft.

uuid.RESERVED_FUTURE

  Зарезервовано для майбутнього визначення.

The `uuid` module defines the special Nil and Max UUID values:

uuid.NIL

  A special form of UUID that is specified to have all 128 bits set to zero according to RFC 9562, §5.9.

  Added in version 3.14.

uuid.MAX

  A special form of UUID that is specified to have all 128 bits set to one according to RFC 9562, §5.10.

  Added in version 3.14.

Дивись також

RFC 9562 - A Universally Unique IDentifier (UUID) URN Namespace

  Ця специфікація визначає простір імен Uniform Resource Name для UUID, внутрішній формат UUID і методи генерації UUID.

## Використання командного рядка

Added in version 3.12.

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]

Приймаються такі варіанти:

-h, --help

  Показати довідкове повідомлення та вийти.

-u <uuid>
--uuid <uuid>

  Specify the function name to use to generate the uuid. By default `uuid4()` is used.

  Змінено в версії 3.14: Allow generating UUID versions 6, 7 and 8.

-n <namespace>
--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.

-N <name>
--name <name>

  The name used as part of generating the uuid. Only required for `uuid3()` / `uuid5()` functions.

-C <num>
--count <num>

  Generate num fresh UUIDs.

  Added in version 3.14.

## приклад

Ось декілька прикладів типового використання модуля `uuid`:

    >>> 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 string
    >>> 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')

## 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