https://github.com/python/cpython/commit/b881e3db1eb501980c43161d7361d8892c94ac81
commit: b881e3db1eb501980c43161d7361d8892c94ac81
branch: main
author: Weilin Du <108666168+lamentxu...@users.noreply.github.com>
committer: picnixz <10796600+picn...@users.noreply.github.com>
date: 2025-06-20T11:03:41Z
summary:
gh-89083: add links to RFC 9562 sections in UUID docs (#135684)
We also sync the docs for UUIDv1 and UUIDv6 concerning the node address and
clock sequence.
---------
Co-authored-by: Bénédikt Tran <10796600+picn...@users.noreply.github.com>
files:
M Doc/library/uuid.rst
diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst
index 92d58024e84d4e..6698e6d3f43c43 100644
--- a/Doc/library/uuid.rst
+++ b/Doc/library/uuid.rst
@@ -193,43 +193,52 @@ The :mod:`uuid` module defines the following functions:
.. function:: uuid1(node=None, clock_seq=None)
- Generate a UUID from a host ID, sequence number, and the current time. If
*node*
- is not given, :func:`getnode` is used to obtain the hardware address. If
- *clock_seq* is given, it is used as the sequence number; otherwise a random
- 14-bit sequence number is chosen.
+ Generate a UUID from a host ID, sequence number, and the current time
+ according to :rfc:`RFC 9562, §5.1 <9562#section-5.1>`.
+
+ When *node* is not specified, :func:`getnode` is used to obtain the hardware
+ address as a 48-bit positive integer. When a sequence number *clock_seq* is
+ not specified, a pseudo-random 14-bit positive integer is generated.
+
+ If *node* or *clock_seq* exceed their expected bit count,
+ only their least significant bits are kept.
.. function:: uuid3(namespace, name)
Generate a UUID based on the MD5 hash of a namespace identifier (which is a
UUID) and a name (which is a :class:`bytes` object or a string
- that will be encoded using UTF-8).
+ that will be encoded using UTF-8)
+ according to :rfc:`RFC 9562, §5.3 <9562#section-5.3>`.
.. function:: uuid4()
- Generate a random UUID.
+ Generate a random UUID in a cryptographically-secure method
+ according to :rfc:`RFC 9562, §5.4 <9562#section-5.4>`.
.. function:: uuid5(namespace, name)
Generate a UUID based on the SHA-1 hash of a namespace identifier (which is
a
UUID) and a name (which is a :class:`bytes` object or a string
- that will be encoded using UTF-8).
+ that will be encoded using UTF-8)
+ according to :rfc:`RFC 9562, §5.5 <9562#section-5.5>`.
.. function:: uuid6(node=None, clock_seq=None)
Generate a UUID from a sequence number and the current time according to
- :rfc:`9562`.
+ :rfc:`RFC 9562, §5.6 <9562#section-5.6>`.
+
This is an alternative to :func:`uuid1` to improve database locality.
When *node* is not specified, :func:`getnode` is used to obtain the hardware
address as a 48-bit positive integer. When a sequence number *clock_seq* is
not specified, a pseudo-random 14-bit positive integer is generated.
- If *node* or *clock_seq* exceed their expected bit count, only their least
- significant bits are kept.
+ If *node* or *clock_seq* exceed their expected bit count,
+ only their least significant bits are kept.
.. versionadded:: 3.14
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: arch...@mail-archive.com
