uuid
---RFC 4122 定義的 UUID 物件¶
原始碼:Lib/uuid.py
這個模組提供了不可變的UUID
物件(UUID
類別)和uuid1()
、uuid3()
、uuid4()
、uuid5()
等函式,用於生成RFC 4122 定義的第 1、3、4、5 版本的 UUID。
如果你只需要一個唯一的 ID,你應該呼叫uuid1()
或uuid4()
。需要注意的是,uuid1()
可能會危害隱私,因為它會建立一個包含了電腦網路位址的 UUID。而uuid4()
則會建立一個隨機的 UUID。
根據底層平台的支援情況,uuid1()
可能會也可能不會回傳一個「安全的」UUID。安全的 UUID 是使用同步方法生成的,以確保不會有兩個行程取得到相同的 UUID。所有UUID
的實例都有一個is_safe
屬性,該屬性使用下面這個列舉來傳遞有關 UUID 安全性的任何資訊:
- classuuid.SafeUUID¶
在 3.7 版被加入.
- safe¶
該 UUID 是由平台以多行程安全的 (multiprocessing-safe) 方式生成的。
- unsafe¶
該 UUID 不是以多行程安全的方式生成的。
- unknown¶
該平台不提供 UUID 是否為安全生成的資訊。
- classuuid.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 4122 設置其變體 (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 位元。 |
| UUID 接下來的 16 位元。 |
| UUID 接下來的 16 位元。 |
| UUID 接下來的 8 位元。 |
| UUID 接下來的 8 位元。 |
| UUID 最後的 48 位元。 |
| 60 位元的時間戳。 |
| 14 位元的序列號。 |
- 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)¶
從主機 ID、序列號和目前時間生成 UUID。如果未給定node,將使用
getnode()
取得硬體位址。如果給定clock_seq,會將其用作序列號;否則將使用一個隨機 14 位元的序列號。
- uuid.uuid3(namespace,name)¶
基於命名空間識別碼 (namespace identifier)(一個 UUID)和名稱(一個
bytes
物件或使用 UTF-8 編碼的字串)的 MD5 hash 來生成 UUID。
- uuid.uuid4()¶
生成一個隨機的 UUID。
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¶
保留供未來定義使用。
也參考
- RFC 4122 - 通用唯一辨識碼 (UUID, Universally Unique IDentifier) 的 URN 命名空間
這個規範定義了 UUID 的統一資源名稱 (Uniform Resource Name) 命名空間、UUID 的內部格式和生成 UUID 的方法。
命令列的用法¶
在 3.12 版被加入.
uuid
模組可以在命令列下作為腳本來執行。
python-muuid[-h][-u{uuid1,uuid3,uuid4,uuid5}][-nNAMESPACE][-NNAME]
可以接受以下選項:
- -h,--help¶
顯示幫助訊息並退出。
範例¶
以下是一些uuid
模組的典型使用範例:
>>>importuuid>>># 基於主機 ID 和目前時間生成 UUID>>>uuid.uuid1()UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')>>># 使用命名空間 UUID 的 MD5 雜湊和一個名稱生成 UUID>>>uuid.uuid3(uuid.NAMESPACE_DNS,'python.org')UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')>>># 生成一個隨機的 UUID>>>uuid.uuid4()UUID('16fd2706-8baf-433b-82eb-8c7fada847da')>>># 使用命名空間 UUID 的 SHA-1 雜湊和一個名稱生成 UUID>>>uuid.uuid5(uuid.NAMESPACE_DNS,'python.org')UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')>>># 從十六進位數字組成的字串生成 UUID(大括號和連字符號會被忽略)>>>x=uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}')>>># 將 UUID 轉換為標準形式的十六進位數字字串>>>str(x)'00010203-0405-0607-0809-0a0b0c0d0e0f'>>># 取得 UUID 的原始 16 位元組>>>x.bytesb'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'>>># 從 16 位元組的字串生成 UUID>>>uuid.UUID(bytes=x.bytes)UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
命令列的範例¶
以下是一些uuid
命令列介面的典型使用範例:
# 生成一個隨機的 uuid - 預設使用 uuid4()$python-muuid# 使用 uuid1() 生成一組 uuid$python-muuid-uuuid1# 使用 uuid5 生成一組 uuid$python-muuid-uuuid5-n@url-Nexample.com