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)

从以下几种形式创建一个 UUID：一个包含 32 个十六进制数字的字符串、一个包含 16 个字节且按大端序排列的字符串作为 bytes 参数、一个包含 16 个字节且按小端序排列的字符串作为 bytes_le 参数、一个包含六个整数的元组（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 中的位。

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.time_low	UUID 的前 32 位。
UUID.time_mid	UUID 的接下来的 16 位。
UUID.time_hi_version	UUID 的接下来的 16 位。
UUID.clock_seq_hi_variant	UUID 的接下来的 8 位。
UUID.clock_seq_low	UUID 的接下来的 8 位。
UUID.node	UUID 的最后 48 位。
UUID.time	60 位的时间戳。
UUID.clock_seq	14 位序列号。

UUID.hex

UUID，以 32 个字符的小写十六进制字符串表示。

UUID.int

UUID，以 128 位整数表示。

UUID.urn

UUID，以 RFC 4122 中指定的 URN 表示。

UUID.variant

UUID 变体，它决定了 UUID 的内部布局。它将是常量 RESERVED_NCS、RFC_4122、RESERVED_MICROSOFT 或 RESERVED_FUTURE 之一。

UUID.version

UUID 版本号（1 到 5，仅在变体为 RFC_4122 时才有意义）。

UUID.is_safe

SafeUUID 的枚举，指示平台生成 UUID 的方式是否线程安全。

3.7 版新增。

uuid 模块定义了以下函数

uuid.getnode()

获取硬件地址，以 48 位正整数表示。首次运行时，它可能会启动一个单独的程序，这可能会非常慢。如果所有获取硬件地址的尝试都失败，我们将选择一个随机的 48 位数字，并按照 RFC 4122 中的建议将多播位（第一个字节的最低有效位）设置为 1。“硬件地址”是指网络接口的 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.RFC_4122

指定 RFC 4122 中给出的 UUID 布局。

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

显示帮助信息并退出。

-u <uuid>

--uuid <uuid>

指定用于生成 UUID 的函数名称。默认情况下，使用 uuid4()。

-n <namespace>

--namespace <namespace>

命名空间是一个 UUID，或者 @ns，其中 ns 是一个由命名空间名称寻址的众所周知的预定义 UUID。例如 @dns、@url、@oid 和 @x500。仅对 uuid3() / uuid5() 函数必需。

-N <name>

--name <name>

用作生成 UUID 一部分的名称。仅对 uuid3() / uuid5() 函数必需。

示例

以下是一些 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