GeezerVison is showing github.com — GH-88597: Added command line interface to UUID module. by achhina · Pull Request #99463 · python/cpython
GH-88597: Added command line interface to UUID module.
#99463
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.
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
Uh oh!
There was an error while loading. Please reload this page.
Show file tree
Hide file tree
Changes from all commits
Commits
File filter
Filter by extension
.py
(2)
.rst
(3)
No extension
(1)
All 3 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Hide whitespace
Diff view
Hide whitespace
There are no files selected for viewing
Original file line number
Diff line number
Diff line change
Expand Up
@@ -261,6 +261,46 @@ of the :attr:`variant` attribute:
internal format of UUIDs, and methods of generating UUIDs.
.. _uuid-cli:
Command-Line Usage
------------------
.. versionadded:: 3.12
The :mod:`uuid` module can be executed as a script from the command line.
.. code-block:: sh
python -m uuid [-h] [-u {uuid1,uuid3,uuid4,uuid5}] [-ns NAMESPACE] [-n NAME]
The following options are accepted:
.. program:: uuid
.. cmdoption:: -h, --help
Show the help message and exit.
.. cmdoption:: -u <uuid>
--uuid <uuid>
Specify the function name to use to generate the uuid. By default :func:`uuid4`
is used.
.. cmdoption:: -ns <namespace>
--namespace <namespace>
The namespace used as part of generating the uuid. Only required for
:func:`uuid3` / :func:`uuid5` functions.
.. cmdoption:: -n <name>
--name <name>
The name used as part of generating the uuid. Only required for
:func:`uuid3` / :func:`uuid5` functions.
.. _uuid-example:
Example
Expand Down
Expand Up
@@ -301,3 +341,22 @@ Here are some examples of typical usage of the :mod:`uuid` module::
>>> uuid.UUID(bytes=x.bytes)
UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
.. _uuid-cli-example:
Command-Line Example
--------------------
Here are some examples of typical usage of the :mod:`uuid` command line interface:
Comment thread
achhina marked this conversation as resolved.
Resolved
Uh oh!
There was an error while loading. Please reload this page.
.. code-block:: shell
# generate a random uuid - by default uuid4() is used
$ python -m uuid
# generate a uuid using uuid1()
$ python -m uuid -u uuid1
# generate a uuid using uuid5
$ python -m uuid -u uuid5 -ns NAMESPACE_URL -n example.com
Original file line number
Diff line number
Diff line change
Expand Up
@@ -327,6 +327,12 @@ unicodedata
* The Unicode database has been updated to version 15.0.0. (Contributed by
Benjamin Peterson in :gh:`96734`).
uuid
----
* Add a :ref:`command-line interface <uuid-cli>`.
(Contributed by Adam Chhina in :gh:`88597`.)
tempfile
--------
Expand Down
Original file line number
Diff line number
Diff line change
Expand Up
@@ -675,6 +675,64 @@ def test_uuid_weakref(self):
weak = weakref.ref(strong)
self.assertIs(strong, weak())
@mock.patch.object(sys, "argv", ["", "-u", "uuid3", "-ns", "NAMESPACE_DNS"])
def test_cli_namespace_required_for_uuid3(self):
with self.assertRaises(SystemExit) as cm:
self.uuid.main()
# Check that exception code is the same as argparse.ArgumentParser.error
self.assertEqual(cm.exception.code, 2)
@mock.patch.object(sys, "argv", ["", "-u", "uuid3", "-n", "python.org"])
def test_cli_name_required_for_uuid3(self):
with self.assertRaises(SystemExit) as cm:
self.uuid.main()
# Check that exception code is the same as argparse.ArgumentParser.error
self.assertEqual(cm.exception.code, 2)
@mock.patch.object(sys, "argv", [""])
def test_cli_uuid4_outputted_with_no_args(self):
stdout = io.StringIO()
with contextlib.redirect_stdout(stdout):
self.uuid.main()
output = stdout.getvalue().strip()
uuid_output = self.uuid.UUID(output)
# Output uuid should be in the format of uuid4
self.assertEqual(output, str(uuid_output))
self.assertEqual(uuid_output.version, 4)
@mock.patch.object(sys, "argv",
["", "-u", "uuid3", "-ns", "NAMESPACE_DNS", "-n", "python.org"])
def test_cli_uuid3_ouputted_with_valid_namespace_and_name(self):
stdout = io.StringIO()
with contextlib.redirect_stdout(stdout):
self.uuid.main()
output = stdout.getvalue().strip()
uuid_output = self.uuid.UUID(output)
# Output should be in the form of uuid5
self.assertEqual(output, str(uuid_output))
self.assertEqual(uuid_output.version, 3)
@mock.patch.object(sys, "argv",
["", "-u", "uuid5", "-ns", "NAMESPACE_DNS", "-n", "python.org"])
def test_cli_uuid5_ouputted_with_valid_namespace_and_name(self):
stdout = io.StringIO()
with contextlib.redirect_stdout(stdout):
self.uuid.main()
output = stdout.getvalue().strip()
uuid_output = self.uuid.UUID(output)
# Output should be in the form of uuid5
self.assertEqual(output, str(uuid_output))
self.assertEqual(uuid_output.version, 5)
class TestUUIDWithoutExtModule(BaseTestUUID, unittest.TestCase):
uuid = py_uuid
Expand Down
Original file line number
Diff line number
Diff line change
Expand Up
@@ -728,9 +728,58 @@ def uuid5(namespace, name):
hash = sha1(namespace.bytes + bytes(name, "utf-8")).digest()
return UUID(bytes=hash[:16], version=5)
def main():
"""Run the uuid command line interface."""
uuid_funcs = {"uuid1": uuid1,
"uuid3": uuid3,
"uuid4": uuid4,
"uuid5": uuid5}
uuid_namespace_funcs = ("uuid3", "uuid5")
namespaces = {
"NAMESPACE_DNS": NAMESPACE_DNS,
"NAMESPACE_URL": NAMESPACE_URL,
"NAMESPACE_OID": NAMESPACE_OID,
"NAMESPACE_X500": NAMESPACE_X500
}
import argparse
parser = argparse.ArgumentParser(
description="Generates a uuid using the selected uuid function.")
parser.add_argument("-u", "--uuid", choices=uuid_funcs.keys(), default="uuid4",
help="The function to use to generate the uuid. "
"By default uuid4 function is used.")
parser.add_argument("-ns", "--namespace",
help="The namespace used as part of generating the uuid. "
"Only required for uuid3/uuid5 functions.")
parser.add_argument("-n", "--name",
help="The name used as part of generating the uuid. "
"Only required for uuid3/uuid5 functions.")
args = parser.parse_args()
uuid_func = uuid_funcs[args.uuid]
namespace = args.namespace
name = args.name
if args.uuid in uuid_namespace_funcs:
if not namespace or not name:
parser.error(
"Incorrect number of arguments. "
f"{args.uuid} requires a namespace and a name. "
"Run 'python -m uuid -h' for more information."
)
namespace = namespaces[namespace] if namespace in namespaces else UUID(namespace)
print(uuid_func(namespace, name))
else:
print(uuid_func())
# The following standard UUIDs are for use with uuid3() or uuid5().
NAMESPACE_DNS = UUID('6ba7b810-9dad-11d1-80b4-00c04fd430c8')
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__":
main()
1 change: 1 addition & 0 deletions
1
Misc/ACKS
Original file line number
Diff line number
Diff line change
Expand Up
@@ -315,6 +315,7 @@ Nicolas Chauvat
Jerry Chen
Michael Chermside
Ingrid Cheung
Adam Chhina
Terry Chia
Albert Chin-A-Young
Adal Chiriliuc
Expand Down
Original file line number
Diff line number
Diff line change
@@ -0,0 +1 @@
:mod:`uuid` now has a command line interface. Try ``python -m uuid -h``.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.