Skip to content

bpo-44431: Added command line functionality to UUID module. #26751

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

Closed
ephenix wants to merge 3 commits into from
Closed

bpo-44431: Added command line functionality to UUID module. #26751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8432c3
Added command line functionality to UUID module.
Jun 16, 2021
fe7fea1
Added whitespace and blurb entry.
ephenixaws Jun 17, 2021
d00cf6b
implemented -h --help which prints module doc string. Added command-l…
ephenixaws Jun 17, 2021
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
54 changes: 54 additions & 0 deletions Lib/uuid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,20 @@
# make a UUID from a 16-byte string
>>> uuid.UUID(bytes=x.bytes)
UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')

Command-Line usage:

python -m uuid [-h] | COMMAND [NAMESPACE] [NAME]

# generate a random uuid
>>> python -m uuid

# generate a uuid1
>>> python -m uuid uuid1

# generate a uuid3 or uuid5
>>> python -m uuid uuid5 NAMESPACE_DNS python.org

"""

import os
Expand Down Expand Up @@ -727,3 +741,43 @@ def uuid5(namespace, name):
NAMESPACE_URL = UUID('6ba7b811-9dad-11d1-80b4-00c04fd430c8')
NAMESPACE_OID = UUID('6ba7b812-9dad-11d1-80b4-00c04fd430c8')
NAMESPACE_X500 = UUID('6ba7b814-9dad-11d1-80b4-00c04fd430c8')

if __name__ == '__main__':
"""
Enables uuid to be called from the command line
Copy link
Contributor

@nanjekyejoannah nanjekyejoannah Jun 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we can move this logic into a helper method so that we just call the method here? Most libraries seem to follow this e.g Lib/timeit.py

"""

allowed_cmds = ['-h','--help','uuid1', 'uuid3', 'uuid4', 'uuid5']
if len(sys.argv) == 1:
# By default, print a random uuid.
print(uuid4())
else:
cmd = sys.argv[1]
if cmd not in allowed_cmds:
raise Exception(f"Command not found: [{cmd}]. Run `python -m uuid -h` for more information.")
if cmd in ['-h', '--help']:
print(__doc__)
if cmd == 'uuid1':
print(uuid1())
if cmd in ['uuid3', 'uuid5']:
if len(sys.argv) != 4:
raise Exception(f"Incorrect number of arguments. Example usage: \n python -m uuid {cmd} NAMESPACE NAME")
else:
namespace = sys.argv[2]
name = sys.argv[3]
if namespace == "NAMESPACE_DNS":
namespace = NAMESPACE_DNS
elif namespace == "NAMESPACE_URL":
namespace = NAMESPACE_URL
elif namespace == "NAMESPACE_OID":
namespace = NAMESPACE_OID
elif namespace == "NAMESPACE_X500":
namespace = NAMESPACE_X500
else:
namespace = UUID(namespace)
if cmd == "uuid3":
print(uuid3(namespace, name))
else:
print(uuid5(namespace, name))
if cmd == 'uuid4':
print(uuid4())
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2021-06-16-23-57-45.bpo-44431.nA8C9m.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
UUID module now supports being called from command line. ex > python -m uuid
Copy link
Contributor

@nanjekyejoannah nanjekyejoannah Jun 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need an example in a news entry. I would do way with ex > python -m uuid .