18.16 uuid -- RFC 4122 に準拠した UUID オブジェクト

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

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

クラス UUID( [hex[, bytes[, bytes_le[, fields[, int[, version]]]]]])

32 桁の 16 進数文字列、bytes に 16 バイトの文字列、bytes_le 引数に 16 バイトのリトルエンディアンの文字列、field 引数に 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='\x12\x34\x56\x78'*4)
UUID(bytes_le='\x78\x56\x34\x12\x34\x12\x78\x56' +
              '\x12\x34\x56\x78\x12\x34\x56\x78')
UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
UUID(int=0x12345678123456781234567812345678)

hexbytesbytes_lefields、または int のうち、どれかただ一つだけが与えられなければいけません。 version 引数は オプションです;与えられた場合、結果の UUID は与えられた hexbytesbytes_lefields、または int をオーバーライドして、 RFC 4122 に準拠した variant と version ナンバーのセットを持つことになります。 bytes_le, fields, or int.

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

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

bytes_le
16 バイト文字列(time_lowtime_midtime_hi_version を リトルエンディアンで持つ)の 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 ビットのシーケンス番号

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

int
128 ビット整数での UUID。

urn
RFC 4122 で規定される URN での UUID。

variant
UUID の内部レイアウトを決定する UUID の variant。 これは整数の定数 The UUID variant, which determines the internal layout of the UUID. This will be one of the integer constants RESERVED_NCSRFC_4122RESERVED_MICROSOFT、又は RESERVED_FUTURE のいずれかになります。

version
UUID の version 番号(1 から 5、variant が RFC_4122 である 場合だけ意味があります)。

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

getnode( )
48 ビットの正の整数としてハードウェアアドレスを取得します。 最初にこれを起動すると、別個のプログラムが立ち上がって非常に遅くなることがあります。 もしハードウェアを取得する試みが全て失敗すると、ランダムな 48 ビットに RFC 4122 で推奨されているように 8 番目のビットを 1 に設定した数を使います。 "ハードウェアアドレス" とはネットワークインターフェースの MAC アドレスを指し、 複数のネットワークインターフェースを持つマシンの場合、それらのどれか一つの MAC アドレスが返るでしょう。

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

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

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

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

uuid モジュールは uuid3() または uuid5() で利用するために 次の名前空間識別子を定義しています。

NAMESPACE_DNS
この名前空間が指定された場合、 name 文字列は完全修飾ドメイン名です。

NAMESPACE_URL
この名前空間が指定された場合、 name 文字列は URL です。

NAMESPACE_OID
この名前空間が指定された場合、 name 文字列は ISO OID です。

NAMESPACE_X500
この名前空間が指定された場合、 name 文字列は X.500 DN の DER またはテキスト出力形式です。

The uuid モジュールは以下の定数を variant 属性が取りうる値として定義しています:

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

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

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

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

参考:

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



Subsections
ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。