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 安全的所有信息:

  • 类别 uuid. SafeUUID

    • 3.7 版中的新Function。
  • safe

    • UUID 是由平台以 multiprocessing 安全方式生成的。
  • unsafe

    • UUID 不是以 multiprocessing 安全方式生成的。
  • unknown

    • 该平台不提供有关是否已安全生成 UUID 的信息。
    • class * uuid. UUID(* hex = None bytes = None bytes_le = None fields = None int = None version = None **,* is_safe = SafeUUID .unknown *)
    • 使用 32 个十六进制数字的字符串,以 big-endianSequences 的 16 个字节的字符串作为* bytes 参数,以 little-endianSequences 的 16 个字节的字符串作为* bytes_le 参数,一个六 Tuples 来创建 UUID 整数(32 位 time_low ,16 位 time_mid ,16 位 time_hi_version ,8 位 clock_seq_hi_variant ,8 位 clock_seq_low ,48 位 node )作为 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设置其变体和版本号,并覆盖给定 hex bytes bytes_le fields int *中的位。

pass比较 UUID 对象的UUID.int属性来进行比较。与非 UUID 对象进行比较会产生TypeError

str(uuid)返回格式为12345678-1234-5678-1234-567812345678的字符串,其中 32 个十六进制数字表示 UUID。

UUID个实例具有以下只读属性:

  • UUID. bytes

    • UUID 为 16 字节的字符串(包含按 big-endian 字节 Sequences 排列的六个整数字段)。
  • UUID. bytes_le

    • UUID 为 16 字节的字符串(带有* time_low time_mid time_hi_version *的字节序为 little-endian)。
  • UUID. fields

    • UUID 的六个整数字段的 Tuples,也可以作为六个单独的属性和两个派生的属性使用:
FieldMeaning
time_lowUUID 的前 32 位
time_midUUID 的后 16 位
time_hi_versionUUID 的后 16 位
clock_seq_hi_variantUUID 的后 8 位
clock_seq_lowUUID 的后 8 位
nodeUUID 的最后 48 位
time60 位时间戳
clock_seq14 位序号
  • UUID. hex

    • UUID 为 32 个字符的十六进制字符串。
  • UUID. int

    • UUID 为 128 位整数。
  • UUID. urn

    • RFC 4122中指定的作为 URN 的 UUID。
  • UUID. variant

  • UUID. version

    • UUID 版本号(1 到 5,仅在变体为RFC_4122时才有意义)。
  • UUID. is_safe

    • SafeUUID的枚举,指示平台是否以 multiprocessing 安全的方式生成 UUID。

3.7 版中的新Function。

uuid模块定义以下Function:

  • uuid. getnode ( )
    • 以 48 位正整数的形式获取硬件地址。第一次运行时,它可能会启动一个单独的程序,这可能会很慢。如果所有try获取硬件地址的try均失败,我们将按照 RFC 4122的建议选择一个随机的 48 位数字,并将多播位(第一个八位位组的最低有效位)设置为 1. “硬件地址”是指网络接口的 MAC 地址。在具有多个网络接口的计算机上,与本地 Management 的 MAC 地址相比,通用 Management 的 MAC 地址(即,第一个八位位组的第二个最低有效位是* unset *)更可取,但是没有其他排序保证。

在版本 3.7 中更改:与本地 Management 的 MAC 地址相比,通用 Management 的 MAC 地址更受青睐,因为保证前者在全局上是唯一的,而后者则不是全局唯一。

  • uuid. uuid1(* node = None clock_seq = None *)
    • 根据主机 ID,序列号和当前时间生成 UUID。如果未指定* node ,则使用getnode()获取硬件地址。如果给出了 clock_seq *,它将用作序列号;否则,选择一个随机的 14 位序列号。
  • uuid. uuid3(* namespace name *)
    • 根据名称空间标识符(是 UUID)和名称(是字符串)的 MD5 哈希值生成 UUID。
  • 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 *字符串是 DER 或文本输出格式的 X.500 DN。

uuid模块为variant属性的可能值定义以下常量:

  • uuid. RESERVED_NCS

    • 保留用于 NCS 兼容性。
  • uuid. RFC_4122

    • 指定 RFC 4122中给出的 UUID 布局。
  • uuid. RESERVED_MICROSOFT

    • 保留用于 Microsoft 兼容性。
  • uuid. RESERVED_FUTURE

    • 保留以供将来定义。

See also

  • RFC 4122-通用唯一标识符(UUID)URN 命名空间

  • 该规范定义了 UUID 的统一资源名称名称空间,UUID 的内部格式以及生成 UUID 的方法。

Example

以下是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')