20.15. "uuid" --- RFC 4122 に準拠した UUID オブジェクト
*******************************************************

バージョン 2.5 で追加.

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

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

class uuid.UUID([hex[, bytes[, bytes_le[, fields[, int[, version]]]]]])

   Create a UUID from either a string of 32 hexadecimal digits, a
   string of 16 bytes in big-endian order 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='\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)

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

"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

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

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

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

uuid.uuid1([node[, clock_seq]])

   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" モジュールは "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 の生成方法を定義しています。


20.15.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
   '\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')
