uuid — 根据 RFC 4122 的 UUID 对象 — Python 文档

来自菜鸟教程
Python/docs/3.7/library/uuid
跳转至:导航、​搜索

uuid — 根据 RFC 4122 的 UUID 对象

源代码: :source:`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 安全性的任何信息:

class uuid.SafeUUID

3.7 版中的新功能。

safe

UUID 是由平台以多处理安全的方式生成的。

unsafe

UUID 不是以多处理安全的方式生成的。

unknown

该平台不提供有关 UUID 是否安全生成的信息。

class uuid.UUID(hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown)

从 32 个十六进制数字的字符串、大端顺序的 16 字节字符串作为 bytes 参数、小端顺序的 16 字节字符串作为 bytes_le[ X197X] 参数,六个整数的元组(32 位 time_low、16 位 time_mid、16 位 time_hi_version、8 位 ' 、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)

必须给出 hexbytesbytes_lefieldsint 中的一个。 version 参数是可选的; 如果给定,则生成的 UUID 将根据 RFC 4122 设置其变体和版本号,覆盖给定 hexbytes 中的位]、bytes_lefieldsint

UUID 对象的比较是通过比较它们的 UUID.int 属性来进行的。 与非 UUID 对象进行比较会引发 TypeError

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

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

UUID.bytes
作为 16 字节字符串的 UUID(包含大端字节序中的六个整数字段)。
UUID.bytes_le
作为 16 字节字符串的 UUID(具有 time_lowtime_midtime_hi_version 以小端字节顺序)。
UUID.fields

UUID 的六个整数字段的元组,也可用作六个单独的属性和两个派生属性:

领域

意义

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
UUID 作为 32 个字符的十六进制字符串。
UUID.int
作为 128 位整数的 UUID。
UUID.urn
UUID 作为 RFC 4122 中指定的 URN。
UUID.variant
UUID 变体,它决定了 UUID 的内部布局。 这将是常量 RESERVED_NCSRFC_4122RESERVED_MICROSOFTRESERVED_FUTURE 之一。
UUID.version
UUID 版本号(1 到 5,仅当变体为 RFC_4122 时才有意义)。
UUID.is_safe

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

3.7 版中的新功能。

uuid 模块定义了以下函数:

uuid.getnode()

以 48 位正整数形式获取硬件地址。 第一次运行时,它可能会启动一个单独的程序,这可能会很慢。 如果所有获取硬件地址的尝试都失败,我们选择一个随机的 48 位数字,其中多播位(第一个八位字节的最低有效位)设置为 1,如 RFC 4122 ]。 “硬件地址”是指网络接口的 MAC 地址。 在具有多个网络接口的机器上,通用管理的 MAC 地址(即 其中第一个八位字节的第二个最低有效位是 unset) 将优先于本地管理的 MAC 地址,但没有其他排序保证。

3.7 版更改: 通用管理的 MAC 地址优于本地管理的 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
保留以供将来定义。

也可以看看

RFC 4122 - 通用唯一标识符 (UUID) URN 命名空间
该规范定义了 UUID 的统一资源名称命名空间、UUID 的内部格式以及生成 UUID 的方法。


示例

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