uuid --- UUID objects according to RFC 4122

源代码: Lib/uuid.py


此模块提供不可变的 UUID 对象(对象) UUID 类)和函数 uuid1()uuid3()uuid4()uuid5() 用于生成第1、3、4和5版UUID,如 RFC 4122 .

如果你只想要一个唯一的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个字节的字符串,按big-endian顺序)创建UUID 字节 参数,一个16字节的字符串,以小尾数顺序作为 bytes_le 参数,六个整数(32位)的元组 time_low ,16位 time_mid ,16位 time_hi_version ,8位 clock_seq_hi_variant ,8位 clock_seq_low ,48位 noderealm 参数,或单个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_lerealmint 必须给予。这个 版本 参数是可选的;如果给定,则生成的UUID将根据 RFC 4122 在给定的范围内重写位 hex字节bytes_lerealmint .

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

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

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

UUID.bytes

uuid是一个16字节的字符串(包含六个以big-endian字节顺序排列的整数字段)。

UUID.bytes_le

UUID作为16字节字符串(带有 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

UUID为128位整数。

UUID.urn

uuid作为在中指定的urn RFC 4122 .

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地址(即第一个八位字节的第二个最低有效位是 未定式 )将优先于本地管理的MAC地址,但没有其他订购保证。

在 3.7 版更改: 通用管理的MAC地址优先于本地管理的MAC地址,因为前者保证全局唯一,而后者则不唯一。

uuid.uuid1(node=None, clock_seq=None)

从主机ID、序列号和当前时间生成UUID。如果 node 没有给出, getnode() 用于获取硬件地址。如果 clock_seq 如果给定,则将其用作序列号;否则将选择随机的14位序列号。

uuid.uuid3(namespace, name)

基于命名空间标识符(UUID)的MD5hash和名称(字符串)生成UUID。

uuid.uuid4()

生成随机UUID。

uuid.uuid5(namespace, name)

根据命名空间标识符(UUID)的sha-1hash和名称(字符串)生成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

指定中给定的UUID布局 RFC 4122 .

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