FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-137847: Add typical usage for uuid 6,7,8 in `/lib/uuid.py` by LamentXU123 · Pull Request #137801 · python/cpython · GitHub

/ cpython Public

gh-137847: Add typical usage for uuid 6,7,8 in /lib/uuid.py - #137801

Closed
LamentXU123 wants to merge 1 commit into
python:mainfrom
LamentXU123:add-typical-usage-in-lib-uuid-for-uuid-6,7,8
Closed

gh-137847: Add typical usage for uuid 6,7,8 in /lib/uuid.py#137801
LamentXU123 wants to merge 1 commit into
python:mainfrom
LamentXU123:add-typical-usage-in-lib-uuid-for-uuid-6,7,8

Conversation

LamentXU123 commented Aug 15, 2025
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

Before we've got some typical usage in the very beginning of uuid.py

r"""UUID objects (universally unique identifiers) according to RFC 4122/9562.

This module provides immutable UUID objects (class UUID) and functions for
generating UUIDs corresponding to a specific UUID version as specified in
RFC 4122/9562, e.g., uuid1() for UUID version 1, uuid3() for UUID version 3,
and so on.

Note that UUID version 2 is deliberately omitted as it is outside the scope
of the RFC.

If all you want is a unique ID, you should probably call uuid1() or uuid4().
Note that uuid1() may compromise privacy since it creates a UUID containing
the computer's network address.  uuid4() creates a random UUID.

Typical usage:

    >>> import uuid

    # make a UUID based on the host ID and current time
    >>> uuid.uuid1()    # doctest: +SKIP
    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()    # doctest: +SKIP
    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')

    # get the Nil UUID
    >>> uuid.NIL
    UUID('00000000-0000-0000-0000-000000000000')

    # get the Max UUID
    >>> uuid.MAX
    UUID('ffffffff-ffff-ffff-ffff-ffffffffffff')
"""

but the typical usage stops at uuid5. This PR add more for newly uuids (6, 7, 8)
I'm using the old issue here XD.
skipping news.

picnixz commented Aug 15, 2025

Copy link
Copy Markdown
Member

I don't think we really need to really expand the docstring. I'm more interested in having it online instead. Also, could you open a separate issue for this? (namely updating the rst and possible the py file) keeping the now-closed issue would be too much now.

LamentXU123 changed the title gh-89083: Add typical usage for uuid 6,7,8 in /lib/uuid.py gh-137847: Add typical usage for uuid 6,7,8 in /lib/uuid.py Aug 16, 2025
AA-Turner closed this Aug 16, 2025

Copy link
Copy Markdown
Member

I agree with @picnixz here, closing.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants


Back | FazBrowse Home | New Git URL