# `uuid` --- RFC 9562 に基づく UUID オブジェクト

ソースコード: 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.

もしユニークな ID が必要なだけであれば、おそらく `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)

  32 桁の 16 進数文字列、bytes に 16 バイトのビッグエンディアンの文字列、bytes_le 引数に 16 バイトのリトルエンディアンの文字列、fields 引数に 6 つの整数のタプル（32ビット time_low, 16 ビット time_mid, 16ビット time_hi_version, 8ビット clock_seq_hi_variant, 8ビット clock_seq_low, 48ビット node ）、または int に一つの 128 ビット整数のいずれかから UUID を生成します。16 進数が与えられた時、波括弧、ハイフン、それと 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.

  2つのUUIDオブジェクトの比較は、`UUID.int` 属性の比較によって行われます。UUIDではないオブジェクトとの比較は、 `TypeError` を送出します。

  `str(uuid)` は 32桁の16進でUUIDを表す``12345678-1234-5678-1234-567812345678`` 形式の文字列を返します。

`UUID` インスタンスは以下の読み出し専用属性を持ちます:

UUID.bytes

  16 バイト文字列（バイトオーダーがビッグエンディアンの 6 つの整数フィールドを持つ）のUUID。

UUID.bytes_le

  16 バイト文字列（ time_low, time_mid, time_hi_version をリトルエンディアンで持つ）の UUID。

UUID.fields

  UUID の 6 つの整数フィールドを持つタプルで、これは 6 つの個別の属性と 2 つの派生した属性としても取得可能です:

フィールド | 意味
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

  32 文字の小文字 16 進数文字列での UUID。

UUID.int

  128 ビット整数での UUID。

UUID.urn

  The UUID as a URN as specified in RFC 9562.

UUID.variant

  UUID の内部レイアウトを決定する UUID の variant。これは定数 `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.

The `uuid` module defines the following functions:

uuid.getnode()

  48 ビットの正の整数としてハードウェアアドレスを取得します。最初にこれを起動すると、別個のプログラムが立ち上がって非常に遅くなることがあります。もしハードウェアを取得する試みが全て失敗すると、ランダムな 48 ビットを、RFC 4122 で推奨されているように、マルチキャストビット (最初のオクテットの最下位ビット) を 1 に設定して使います。"ハードウェアアドレス" とはネットワークインターフェースの MAC アドレスを指します。複数のネットワークインターフェースを持つマシンの場合、全域管理されたMACアドレス (最初のオクテットの下位より2番目のビットが 設定されていない MACアドレス) が、他の個別管理アドレスよりも優先的に使用されます。この優先順序は保証されません。

  バージョン 3.7 で変更: 全域管理された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.

The `uuid` module defines the following namespace identifiers for use with `uuid3()` or `uuid5()`.

uuid.NAMESPACE_DNS

  この名前空間が指定された場合、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

  この仕様は UUID のための Uniform Resource Name 名前空間、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.

## 使用例

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()
    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