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。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 个十六进制数字的字符串、作为 bytes 参数的大端顺序的 16 字节字符串、作为 bytes_le 参数的小端顺序的 16 字节字符串、六个整数（32 位 time_low、16 位 time_mid、16 位 time_hi_version、8 位 clock_seq_hi_variant、8 位 clock_seq_low、48 位 node）的元组（作为 fields 参数）或单个 128 位整数（作为 int 参数）创建一个 UUID。当给出十六进制数字字符串时，花括号、连字符和 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 中的位。
UUID 对象的比较是通过比较它们的
UUID.int属性进行的。与非 UUID 对象比较会引发TypeError。str(uuid)返回一个形如12345678-1234-5678-1234-567812345678的字符串，其中 32 个十六进制数字表示 UUID。
UUID 实例具有以下只读属性
- UUID.bytes¶
UUID 作为 16 字节字符串（包含大端字节顺序的六个整数域）。
- UUID.bytes_le¶
UUID 作为 16 字节字符串（time_low、time_mid 和 time_hi_version 采用小端字节顺序）。
- UUID.fields¶
UUID 的六个整数域的元组，也可作为六个单独的属性和两个派生属性使用
字段 |
含义 |
|
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 的内部布局。这将是常量
RESERVED_NCS、RFC_4122、RESERVED_MICROSOFT或RESERVED_FUTURE之一。
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）和一个名称（是一个
bytes对象或一个将使用 UTF-8 编码的字符串）的 MD5 哈希生成 UUID。
- uuid.uuid4()¶
生成一个随机 UUID。
- uuid.uuid5(namespace, name)¶
基于命名空间标识符（是一个 UUID）和一个名称（是一个
bytes对象或一个将使用 UTF-8 编码的字符串）的 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.RESERVED_MICROSOFT¶
保留用于 Microsoft 兼容性。
- uuid.RESERVED_FUTURE¶
保留用于未来定义。
另请参阅
- RFC 4122 - 通用唯一标识符 (UUID) URN 命名空间
本规范定义了 UUID 的统一资源名称命名空间、UUID 的内部格式以及生成 UUID 的方法。
命令行用法¶
在 3.12 版本中新增。
uuid 模块可以从命令行作为脚本执行。
python -m uuid [-h] [-u {uuid1,uuid3,uuid4,uuid5}] [-n NAMESPACE] [-N NAME]
接受以下选项
- -h, --help¶
显示帮助消息并退出。
示例¶
以下是 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')
命令行示例¶
以下是 uuid 命令行界面的典型用法的一些示例
# generate a random uuid - by default uuid4() is used
$ python -m uuid
# generate a uuid using uuid1()
$ python -m uuid -u uuid1
# generate a uuid using uuid5
$ python -m uuid -u uuid5 -n @url -N example.com