]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-137847: Add examples for UUIDv6-8 (#137848)
authorWeilin Du <108666168+LamentXU123@users.noreply.github.com>
Mon, 18 Aug 2025 11:24:19 +0000 (19:24 +0800)
committerGitHub <noreply@github.com>
Mon, 18 Aug 2025 11:24:19 +0000 (11:24 +0000)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Doc/library/uuid.rst

index 6698e6d3f43c4387c209a9aba0b44e2cbceabcaa..aa4f1bf940bc5cfc0ec5dcebf35cfcc1f1862eaa 100644 (file)
@@ -411,7 +411,7 @@ Here are some examples of typical usage of the :mod:`uuid` module::
    >>> import uuid
 
    >>> # make a UUID based on the host ID and current time
-   >>> uuid.uuid1()
+   >>> uuid.uuid1()  # doctest: +SKIP
    UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')
 
    >>> # make a UUID using an MD5 hash of a namespace UUID and a name
@@ -449,15 +449,24 @@ Here are some examples of typical usage of the :mod:`uuid` module::
    >>> uuid.MAX
    UUID('ffffffff-ffff-ffff-ffff-ffffffffffff')
 
+   >>> # same as UUIDv1 but with fields reordered to improve DB locality
+   >>> uuid.uuid6()  # doctest: +SKIP
+   UUID('1f0799c0-98b9-62db-92c6-a0d365b91053')
+
    >>> # get UUIDv7 creation (local) time as a timestamp in milliseconds
    >>> u = uuid.uuid7()
    >>> u.time  # doctest: +SKIP
    1743936859822
+
    >>> # get UUIDv7 creation (local) time as a datetime object
    >>> import datetime as dt
    >>> dt.datetime.fromtimestamp(u.time / 1000)  # doctest: +SKIP
    datetime.datetime(...)
 
+   >>> # make a UUID with custom blocks
+   >>> uuid.uuid8(0x12345678, 0x9abcdef0, 0x11223344)
+   UUID('00001234-5678-8ef0-8000-000011223344')
+
 
 .. _uuid-cli-example: