diff options
| author | Berker Peksag <berker.peksag@gmail.com> | 2016-12-31 17:08:16 (GMT) |
|---|---|---|
| committer | Berker Peksag <berker.peksag@gmail.com> | 2016-12-31 17:08:16 (GMT) |
| commit | 6b5e4a86a7f53bcdc565d1eb6d88c17d16b64a2f (patch) | |
| tree | f19e1963258a91169e42528dc56c18f693fe1ec6 /Doc | |
| parent | 195319e6bb605e882d942f2268dbb0408c896ee1 (diff) | |
| download | cpython-6b5e4a86a7f53bcdc565d1eb6d88c17d16b64a2f.zip cpython-6b5e4a86a7f53bcdc565d1eb6d88c17d16b64a2f.tar.gz cpython-6b5e4a86a7f53bcdc565d1eb6d88c17d16b64a2f.tar.bz2 | |
Issue #26267: Improve uuid.UUID documentation
* Document how comparison of UUID objects work
* Document str(uuid) returns the braceless standard form
* Add a test for comparison of a UUID object with a non-UUID object
Patch by Ammar Askar.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/uuid.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst index 53cbd6c..91dbca2 100644 --- a/Doc/library/uuid.rst +++ b/Doc/library/uuid.rst @@ -45,6 +45,13 @@ random UUID. variant and version number set according to RFC 4122, overriding bits in the given *hex*, *bytes*, *bytes_le*, *fields*, or *int*. + Comparison of UUID objects are made by way of comparing their + :attr:`UUID.int` attributes. Comparison with a non-UUID object + raises a :exc:`TypeError`. + + ``str(uuid)`` returns a string in the form + ``12345678-1234-5678-1234-567812345678`` where the 32 hexadecimal digits + represent the UUID. :class:`UUID` instances have these read-only attributes: |