Skip to content

GH-88597: Rename uuid's new CLI args to be in line with uuidgen. #101248

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

Merged
merged 2 commits into from
Jan 25, 2023
Merged

GH-88597: Rename uuid's new CLI args to be in line with uuidgen. #101248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bad954e
GH-88597: Rename uuid cli args and parameters to be in line with uuid…
achhina Jan 22, 2023
f271cc6
updated a missed -n to -N change in the docs.
gpshead Jan 23, 2023
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
23 changes: 12 additions & 11 deletions Doc/library/uuid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ 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]
python -m uuid [-h] [-u {uuid1,uuid3,uuid4,uuid5}] [-n NAMESPACE] [-N NAME]

The following options are accepted:

Expand All @@ -288,13 +288,14 @@ The following options are accepted:
Specify the function name to use to generate the uuid. By default :func:`uuid4`
is used.

.. cmdoption:: -ns <namespace>
.. cmdoption:: -n <namespace>
--namespace <namespace>

The namespace used as part of generating the uuid. Only required for
:func:`uuid3` / :func:`uuid5` functions.
The namespace is a ``UUID``, or ``@ns`` where ``ns`` is a well-known predefined UUID
addressed by namespace name. Such as ``@dns``, ``@url``, ``@oid``, and ``@x500``.
Only required for :func:`uuid3` / :func:`uuid5` functions.

.. cmdoption:: -n <name>
.. cmdoption:: -N <name>
--name <name>

The name used as part of generating the uuid. Only required for
Expand Down Expand Up @@ -351,12 +352,12 @@ Here are some examples of typical usage of the :mod:`uuid` command line interfac

.. code-block:: shell

# generate a random uuid - by default uuid4() is used
$ python -m uuid
# 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 uuid1()
$ python -m uuid -u uuid1

# generate a uuid using uuid5
$ python -m uuid -u uuid5 -ns NAMESPACE_URL -n example.com
# generate a uuid using uuid5
$ python -m uuid -u uuid5 -n @url -N example.com

8 changes: 4 additions & 4 deletions Lib/test/test_uuid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,15 +675,15 @@ def test_uuid_weakref(self):
weak = weakref.ref(strong)
self.assertIs(strong, weak())

@mock.patch.object(sys, "argv", ["", "-u", "uuid3", "-ns", "NAMESPACE_DNS"])
@mock.patch.object(sys, "argv", ["", "-u", "uuid3", "-n", "@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"])
@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()
Expand All @@ -705,7 +705,7 @@ def test_cli_uuid4_outputted_with_no_args(self):
self.assertEqual(uuid_output.version, 4)

@mock.patch.object(sys, "argv",
["", "-u", "uuid3", "-ns", "NAMESPACE_DNS", "-n", "python.org"])
["", "-u", "uuid3", "-n", "@dns", "-N", "python.org"])
def test_cli_uuid3_ouputted_with_valid_namespace_and_name(self):
stdout = io.StringIO()
with contextlib.redirect_stdout(stdout):
Expand All @@ -719,7 +719,7 @@ def test_cli_uuid3_ouputted_with_valid_namespace_and_name(self):
self.assertEqual(uuid_output.version, 3)

@mock.patch.object(sys, "argv",
["", "-u", "uuid5", "-ns", "NAMESPACE_DNS", "-n", "python.org"])
["", "-u", "uuid5", "-n", "@dns", "-N", "python.org"])
def test_cli_uuid5_ouputted_with_valid_namespace_and_name(self):
stdout = io.StringIO()
with contextlib.redirect_stdout(stdout):
Expand Down
28 changes: 16 additions & 12 deletions Lib/uuid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,28 +731,32 @@ def uuid5(namespace, name):

def main():
"""Run the uuid command line interface."""
uuid_funcs = {"uuid1": uuid1,
"uuid3": uuid3,
"uuid4": uuid4,
"uuid5": uuid5}
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
"@dns": NAMESPACE_DNS,
"@url": NAMESPACE_URL,
"@oid": NAMESPACE_OID,
"@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. "
"By default uuid4 function is used.")
parser.add_argument("-n", "--namespace",
help="The namespace is a UUID, or '@ns' where 'ns' is a "
"well-known predefined UUID addressed by namespace name. "
"Such as @dns, @url, @oid, and @x500. "
"Only required for uuid3/uuid5 functions.")
parser.add_argument("-n", "--name",
parser.add_argument("-N", "--name",
help="The name used as part of generating the uuid. "
"Only required for uuid3/uuid5 functions.")

Expand Down