Skip to main content

21.20. uuid —根据RFC 4122的UUID对象

源代码: Lib/uuid.py


此模块提供不可变的 UUID 对象(UUID 类)以及用于生成 RFC 4122 中指定的版本1,3,4和5的UUID的函数 uuid1()uuid3()uuid4()uuid5()

如果你想要的是一个唯一的ID,你应该可以调用 uuid1()uuid4()。请注意,uuid1() 可能会危及隐私,因为它会创建包含计算机网络地址的UUID。 uuid4() 创建随机UUID。

class uuid.UUID(hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None)

从32个十六进制数字的字符串,作为 bytes 参数的16字节的字符串,作为 bytes_le 参数的小端序顺序的16字节的字符串创建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)

必须给出 hexbytesbytes_lefieldsint 中的一个。 version 参数是可选的;如果给出,则所得到的UUID将根据RFC 4122设置其变体和版本号,覆盖给定 hexbytesbytes_lefieldsint 中的比特。

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

UUID.bytes

UUID为16字节字符串(包含大字节顺序字节顺序中的6个整数字段)。

UUID.bytes_le

UUID为16字节字符串(以 time_lowtime_midtime_hi_version 为小端字节顺序)。

UUID.fields

UUID的六个整数字段的元组,其也可作为六个单独的属性和两个导出的属性:

领域

含义

time_low

UUID的前32位

time_mid

接下来的16位的UUID

time_hi_version

接下来的16位的UUID

clock_seq_hi_variant

接下来的8位的UUID

clock_seq_low

接下来的8位的UUID

node

UUID的最后48位

time

60位时间戳

clock_seq

14位序列号

UUID.hex

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

UUID.int

UUID为128位整数。

UUID.urn

UUID作为RFC 4122中指定的URN。

UUID.variant

UUID变量,它确定UUID的内部布局。这将是整数常数 RESERVED_NCSRFC_4122RESERVED_MICROSOFTRESERVED_FUTURE 中的一个。

UUID.version

UUID版本号(1到5,仅当变量为 RFC_4122 时有意义)。

uuid 模块定义以下功能:

uuid.getnode()

获取硬件地址为48位正整数。第一次运行时,它可能启动一个单独的程序,这可能会很慢。如果所有尝试获取硬件地址失败,我们选择一个随机的48位数,其第八位设置为1,如RFC 4122建议的那样。“硬件地址”表示网络接口的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的方法。

21.20.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
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')