uuid --- RFC 9562 定義的 UUID 物件¶
原始碼：Lib/uuid.py
這個模組提供了不可變的 UUID 物件（UUID 類別）和用於生成對應於 RFC 9562（取代了 RFC 4122）中指定的特定 UUID 版本的 函式，例如 UUID 版本 1 的 uuid1()、UUID 版本 3 的 uuid3() 等等。需要注意的是，UUID 版本 2 被故意省略，因為它不在 RFC 的範圍內。
如果你只需要一個唯一的 ID，你應該呼叫 uuid1() 或 uuid4()。需要注意的是，uuid1() 可能會危害隱私，因為它會建立一個包含了電腦網路位址的 UUID。而 uuid4() 則會建立一個隨機的 UUID。
根據底層平台的支援情況，uuid1() 可能會也可能不會回傳一個「安全的」UUID。安全的 UUID 是使用同步方法生成的，以確保不會有兩個行程取得到相同的 UUID。所有 UUID 的實例都有一個 is_safe 屬性，該屬性使用下面這個列舉來傳遞有關 UUID 安全性的任何資訊：
- class uuid.SafeUUID¶
在 3.7 版被加入.
- safe¶
該 UUID 是由平台以多行程安全的 (multiprocessing-safe) 方式生成的。
- 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 個十六進位的數字組成的字串、以大端順序 (big-endian) 排列的 16 個位元組組成的字串作為 bytes 引數、以小端順序 (little-endian) 排列的 16 個位元組組成的字串作為 bytes_le 引數、由 6 個整數（32 位元的 time_low、16 位元的 time_mid、16 位元的 time_hi_version、8 位元的 clock_seq_hi_variant、8 位元的 clock_seq_low、48 位元的 node）組成的元組 (tuple) 作為 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)
必須正好給定其中一個引數 hex、bytes、bytes_le、fields 或 int。version 引數是選用的；如果給定了該引數，生成的 UUID 將根據 RFC 9562 設置其變體 (variant) 和版本號，覆蓋掉給定的 hex、bytes、bytes_le、fields 或 int 中的位元。
UUID 物件之間的比較是透過比較它們的
UUID.int屬性。與非 UUID 的物件進行比較會引發TypeError。str(uuid)會回傳一個像是12345678-1234-5678-1234-567812345678形式的字串，其中 32 個十六進位的數字代表 UUID。
UUID 實例有以下唯讀的屬性：
- UUID.bytes¶
UUID 以 16 位元組的字串表示（包含 6 個整數欄位，按照大端位元組順序排列）。
- UUID.bytes_le¶
UUID 以 16 位元組的字串表示（其中 time_low、time_mid 和 time_hi_version 按照小端位元組順序排列）。
- UUID.fields¶
UUID 以 6 個整數欄位所組成的元組表示，也可以看作有 6 個個別屬性和 2 個衍生屬性：
欄位 |
意義 |
|
UUID 的前 32 位元。只與版本 1 有關。 |
|
UUID 接下來的 16 位元。只與版本 1 有關。 |
|
UUID 接下來的 16 位元。只與版本 1 有關。 |
|
UUID 接下來的 8 位元。只與版本 1 和 6 有關。 |
|
UUID 接下來的 8 位元。只與版本 1 和 6 有關。 |
|
UUID 最後的 48 位元。只與版本 1 有關。 |
|
60 位元的時間戳記，對於版本 1 和 6 是自格里高利紀元 (Gregorian Epoch, 1582-10-15 00:00:00) 起以 100 奈秒為單位的計數，對於版本 7 是自 Unix 紀元 (1970-01-01 00:00:00) 起以毫秒為單位的計數。 |
|
14 位元的序列號。只與版本 1 和 6 有關。 |
- UUID.hex¶
UUID 以 32 個小寫十六進位字元組成的字串表示。
- UUID.int¶
UUID 以 128 位元的整數表示。
- UUID.variant¶
UUID 的變體，決定 UUID 內部的佈局 (layout)，是
RESERVED_NCS、RFC_4122、RESERVED_MICROSOFT或RESERVED_FUTURE其中一個常數。
uuid 模組定義了以下函式：
- uuid.getnode()¶
取得 48 位元正整數形式的硬體位址。第一次執行時，有可能會啟動一個獨立的程式，這也許會相當耗時。如果所有取得硬體位址的嘗試都失敗，我們會根據 RFC 4122 中的建議，使用一個 48 位元的隨機數，其中群播位元 (multicast bit)（第一個八位元組的最低有效位）設置為 1。「硬體位址」指的是網路介面 (network interface) 的 MAC 位址。在具有多個網路介面的機器上，將優先選擇通用管理 (universally administered) 的 MAC 位址（即第一個八位元組的第二個最低有效位是 未設置的），而不是本地管理 (locally administered) 的 MAC 位址，除此之外不保證任何選擇的順序。
在 3.7 版的變更: 通用管理的 MAC 位址優於本地管理的 MAC 位址，因為前者保證是全球唯一的，而後者不是。
- uuid.uuid1(node=None, clock_seq=None)¶
根據 RFC 9562, §5.1，從主機 ID、序列號碼和當前時間生成 UUID。
如果未指定 node，則使用
getnode()取得硬體位址，作為 48 位元的正整數。如果未指定序列號碼 clock_seq，則生成一個偽隨機的 14 位元正整數。如果 node 或 clock_seq 超過了預期的位元數，則只保留它們的最低有效位元。
- uuid.uuid3(namespace, name)¶
根據 RFC 9562, §5.3，基於命名空間識別碼 (namespace identifier)（一個 UUID）和名稱（一個
bytes物件或使用 UTF-8 編碼的字串）的 MD5 hash 來生成 UUID。
- uuid.uuid4()¶
根據 RFC 9562, §5.4，以加密安全的方式生成一個隨機 UUID。
- uuid.uuid5(namespace, name)¶
根據 RFC 9562, §5.5，基於命名空間識別碼（一個 UUID）和名稱（一個
bytes物件或使用 UTF-8 編碼的字串）的 SHA-1 hash 來生成 UUID。
- uuid.uuid6(node=None, clock_seq=None)¶
根據 RFC 9562, §5.6，從序列號和當前時間生成 UUID。
這是
uuid1()的替代方案，以改善資料庫的局部性 (locality)。如果未指定 node，則使用
getnode()取得硬體位址，作為 48 位元的正整數。如果未指定序列號碼 clock_seq，則生成一個偽隨機的 14 位元正整數。如果 node 或 clock_seq 超過了預期的位元數，則只保留它們的最低有效位元。
在 3.14 版被加入.
- uuid.uuid7()¶
根據 RFC 9562, §5.7，生成基於時間的 UUID。
為了在缺乏微秒精度的平台上具有可移植性，此函式生成的 UUID 嵌入了 48 位元的時間戳記，並使用 42 位元的計數器來保證在毫秒內的單調性。
在 3.14 版被加入.
- uuid.uuid8(a=None, b=None, c=None)¶
根據 RFC 9562, §5.8，生成一個偽隨機 UUID。
當指定時，參數 a、b 和 c 預期為分別為 48、12 和 62 位元的正整數。如果它們超過了預期的位元數，則只保留它們的最低有效位元；未指定的參數將被替換為適當大小的偽隨機整數。
預設情況下，a、b 和 c 並非由加密安全的偽隨機數生成器 (CSPRNG) 生成。當 UUID 需要在安全敏感的情境中使用時，請使用
uuid4()。在 3.14 版被加入.
uuid 模組為 uuid3() 或 uuid5() 定義了以下的命名空間識別碼。
- uuid.NAMESPACE_DNS¶
當指定這個命名空間時，name 字串是一個完整網域名稱 (fully qualified domain name)。
- uuid.NAMESPACE_URL¶
當指定這個命名空間時，name 字串是一個 URL。
- uuid.NAMESPACE_OID¶
當指定這個命名空間時，name 字串是一個 ISO OID。
- uuid.NAMESPACE_X500¶
當指定這個命名空間時，name 字串是以 DER 或文字輸出格式表示的 X.500 DN。
uuid 模組為 variant 屬性的可能值定義了以下常數：
- uuid.RESERVED_NCS¶
保留供 NCS 相容性使用。
- uuid.RESERVED_MICROSOFT¶
保留供 Microsoft 相容性使用。
- uuid.RESERVED_FUTURE¶
保留供未來定義使用。
uuid 模組定義了特殊的 Nil 和 Max UUID 值：
- uuid.NIL¶
根據 RFC 9562, §5.9，一種特殊形式的 UUID，被指定為所有 128 位元都設置為零。
在 3.14 版被加入.
- uuid.MAX¶
根據 RFC 9562, §5.10，一種特殊形式的 UUID，被指定為所有 128 位元都設置為一。
在 3.14 版被加入.
也參考
- RFC 9562 - 通用唯一辨識碼 (UUID, Universally Unique IDentifier) 的 URN 命名空間
這個規範定義了 UUID 的統一資源名稱 (Uniform Resource Name) 命名空間、UUID 的內部格式和生成 UUID 的方法。
命令列的用法¶
在 3.12 版被加入.
uuid 模組可以在命令列下作為腳本來執行。
python -m uuid [-h] [-u {uuid1,uuid3,uuid4,uuid5,uuid6,uuid7,uuid8}] [-n NAMESPACE] [-N NAME]
可以接受以下選項：
- -h, --help¶
顯示幫助訊息並退出。
範例¶
以下是一些 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')
命令列的範例¶
以下是一些 uuid 命令列介面的典型使用範例：
# 生成一個隨機的 UUID - 預設使用 uuid4()
$ python -m uuid
# 使用 uuid1() 生成一組 UUID
$ python -m uuid -u uuid1
# 使用 uuid5 生成一組 UUID
$ python -m uuid -u uuid5 -n @url -N example.com
# 生成 42 個隨機 UUID
$ python -m uuid -C 42