Lokasi ngalangkungan proxy:   [ UP ]  
[Ngawartoskeun bug]   [Panyetelan cookie]                
Skip to content

Doc: Clarify UUID bytes attributes #149972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
savagemechanic wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −21
Open

Doc: Clarify UUID bytes attributes #149972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions Doc/library/uuid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@ which relays any information about the UUID's safety, using this enumeration:

.. class:: UUID(hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown)

Create a UUID from either a string of 32 hexadecimal digits, a string of 16
bytes in big-endian order as the *bytes* argument, a string of 16 bytes in
little-endian order as the *bytes_le* argument, a tuple of six integers
Create a UUID from either a string of 32 hexadecimal digits, a 16-byte
:class:`bytes` object in big-endian order as the *bytes* argument, a
16-byte :class:`bytes` object in little-endian order as the *bytes_le*
argument, a tuple of six integers
(32-bit *time_low*, 16-bit *time_mid*, 16-bit *time_hi_version*,
8-bit *clock_seq_hi_variant*, 8-bit *clock_seq_low*, 48-bit *node*) as the
*fields* argument, or a single 128-bit integer as the *int* argument.
Expand Down Expand Up @@ -80,14 +81,14 @@ which relays any information about the UUID's safety, using this enumeration:

.. attribute:: UUID.bytes

The UUID as a 16-byte string (containing the six integer fields in big-endian
byte order).
The UUID as a 16-byte :class:`bytes` object (containing the six integer
fields in big-endian byte order).


.. attribute:: UUID.bytes_le

The UUID as a 16-byte string (with *time_low*, *time_mid*, and *time_hi_version*
in little-endian byte order).
The UUID as a 16-byte :class:`bytes` object (with *time_low*, *time_mid*,
and *time_hi_version* in little-endian byte order).


.. attribute:: UUID.fields
Expand Down Expand Up @@ -435,7 +436,7 @@ Here are some examples of typical usage of the :mod:`!uuid` module::
>>> 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
>>> # make a UUID from a 16-byte bytes object
>>> uuid.UUID(bytes=x.bytes)
UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')

Expand Down
26 changes: 13 additions & 13 deletions Lib/uuid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
>>> 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
# make a UUID from a 16-byte bytes object
>>> uuid.UUID(bytes=x.bytes)
UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')

Expand Down Expand Up @@ -118,19 +118,19 @@ class UUID:
'12345678-1234-1234-1234-123456789abc'. The UUID constructor accepts
five possible forms: a similar string of hexadecimal digits, or a tuple
of six integer fields (with 32-bit, 16-bit, 16-bit, 8-bit, 8-bit, and
48-bit values respectively) as an argument named 'fields', or a string
of 16 bytes (with all the integer fields in big-endian order) as an
argument named 'bytes', or a string of 16 bytes (with the first three
fields in little-endian order) as an argument named 'bytes_le', or a
single 128-bit integer as an argument named 'int'.
48-bit values respectively) as an argument named 'fields', or a 16-byte
bytes object (with all the integer fields in big-endian order) as an
argument named 'bytes', or a 16-byte bytes object (with the first three
fields in little-endian order) as an argument named 'bytes_le', or a single
128-bit integer as an argument named 'int'.

UUIDs have these read-only attributes:

bytes the UUID as a 16-byte string (containing the six
bytes the UUID as a 16-byte bytes object (containing the six
integer fields in big-endian byte order)

bytes_le the UUID as a 16-byte string (with time_low, time_mid,
and time_hi_version in little-endian byte order)
bytes_le the UUID as a 16-byte bytes object (with time_low,
time_mid, and time_hi_version in little-endian byte order)

fields a tuple of the six integer fields of the UUID,
which are also available as six individual attributes
Expand Down Expand Up @@ -179,7 +179,7 @@ def __init__(self, hex=None, bytes=None, bytes_le=None, fields=None,
int=None, version=None,
*, is_safe=SafeUUID.unknown):
r"""Create a UUID from either a string of 32 hexadecimal digits,
a string of 16 bytes as the 'bytes' argument, a string of 16 bytes
a 16-byte bytes object as the 'bytes' argument, a 16-byte bytes object
in little-endian order as the 'bytes_le' argument, a tuple of six
integers (32-bit time_low, 16-bit time_mid, 16-bit time_hi_version,
8-bit clock_seq_hi_variant, 8-bit clock_seq_low, 48-bit node) as
Expand All @@ -191,9 +191,9 @@ def __init__(self, hex=None, bytes=None, bytes_le=None, fields=None,
UUID('{12345678-1234-5678-1234-567812345678}')
UUID('12345678123456781234567812345678')
UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
UUID(bytes='\x12\x34\x56\x78'*4)
UUID(bytes_le='\x78\x56\x34\x12\x34\x12\x78\x56' +
'\x12\x34\x56\x78\x12\x34\x56\x78')
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)

Expand Down
Loading