21.20. `uuid` --- UUID objects according to RFC 4122¶

ソースコード: Lib/uuid.py

このモジュールでは immutable (変更不能) な UUID オブジェクト (UUID クラス) と RFC 4122 の定めるバージョン 1、3、4、5 の UUID を生成するための uuid1(), uuid3(), uuid4(), uuid5(), が提供されています。

もしユニークな ID が必要なだけであれば、おそらく uuid1() か uuid4() を呼び出せば良いでしょう。 uuid1() はコンピュータのネットワークアドレスを含む UUID を生成するためにプライバシーを侵害するかもしれない点に注意してください。 uuid4() はランダムな UUID を生成します。

class uuid.UUID(hex=None, bytes=None, bytes_le=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 string of 16 bytes 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 RFC 4122, 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 つの派生した属性としても取得可能です:

フィールド	意味
`time_low`	UUID の最初の 32 ビット
`time_mid`	UUID の次の 16 ビット
`time_hi_version`	UUID の次の 16 ビット
`clock_seq_hi_variant`	UUID の次の 8 ビット
`clock_seq_low`	UUID の次の 8 ビット
`node`	UUID の最後の 48 ビット
`time`	60 ビットのタイムスタンプ
`clock_seq`	14 ビットのシーケンス番号

UUID.hex¶: 32 文字の 16 進数文字列での UUID。

UUID.int¶: 128 ビット整数での UUID。

UUID.urn¶: The UUID as a URN as specified in RFC 4122.

UUID.variant¶: UUID の内部レイアウトを決定する UUID の variant。これは定数 RESERVED_NCS, RFC_4122, RESERVED_MICROSOFT, RESERVED_FUTURE のいずれかです。

UUID.version¶: UUID の version 番号（1 から 5、variant が RFC_4122 である場合だけ意味があります）。

The uuid モジュールには以下の関数があります:

uuid.getnode()¶: 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 its eighth bit set to 1 as recommended in RFC 4122. "Hardware address" means the MAC address of a network interface, and on a machine with multiple network interfaces the MAC address of any one of them may be returned.

uuid.uuid1(node=None, clock_seq=None)¶: UUID をホスト ID、シーケンス番号、現在時刻から生成します。 node が与えられなければ、 getnode() がハードウェアアドレス取得のために使われます。 clock_seq が与えられると、これはシーケンス番号として使われます; さもなくば 14 ビットのランダムなシーケンス番号が選ばれます。

uuid.uuid3(namespace, name)¶: UUID を名前空間識別子 (UUID) と名前 (文字列) の MD5 ハッシュから生成します。

uuid.uuid4()¶: ランダムな UUID を生成します。

uuid.uuid5(namespace, name)¶: 名前空間識別子(これは UUID です)と名前(文字列です)の SHA-1 ハッシュからUUIDを生成します。

uuid モジュールは uuid3() または 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 モジュールは以下の定数を variant 属性が取りうる値として定義しています:

uuid.RESERVED_NCS¶: NCS 互換性のために予約されています。

uuid.RFC_4122¶: RFC 4122 で与えられた UUID レイアウトを指定します。

uuid.RESERVED_MICROSOFT¶: Microsoft の互換性のために予約されています。

uuid.RESERVED_FUTURE¶: 将来のために予約されています。

参考

RFC 4122 - Universally Unique IDentifier (UUID) の URN 名前空間: この仕様は UUID のための Uniform Resource Name 名前空間、UUID の内部フォーマットと UUID の生成方法を定義しています。

21.20.1. 使用例¶

典型的な 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')

21.20. `uuid` --- UUID objects according to RFC 4122¶

21.20.1. 使用例¶

Table of Contents

前のトピックへ

次のトピックへ

このページ

21.20. uuid --- UUID objects according to RFC 4122¶

21.20.1. 使用例¶

21.20. `uuid` --- UUID objects according to RFC 4122¶