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

this way they match an existing uuidgen command line tool.
This commit is contained in:
achhina 2023-01-25 12:39:42 -05:00 committed by GitHub
parent 1417712812
commit 952a1d9cc9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 32 additions and 27 deletions

View file

@ -272,7 +272,7 @@ The :mod:`uuid` module can be executed as a script from the command line.
.. code-block:: sh .. 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: The following options are accepted:
@ -288,13 +288,14 @@ The following options are accepted:
Specify the function name to use to generate the uuid. By default :func:`uuid4` Specify the function name to use to generate the uuid. By default :func:`uuid4`
is used. is used.
.. cmdoption:: -ns <namespace> .. cmdoption:: -n <namespace>
--namespace <namespace> --namespace <namespace>
The namespace used as part of generating the uuid. Only required for The namespace is a ``UUID``, or ``@ns`` where ``ns`` is a well-known predefined UUID
:func:`uuid3` / :func:`uuid5` functions. 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> --name <name>
The name used as part of generating the uuid. Only required for The name used as part of generating the uuid. Only required for
@ -351,12 +352,12 @@ Here are some examples of typical usage of the :mod:`uuid` command line interfac
.. code-block:: shell .. code-block:: shell
# generate a random uuid - by default uuid4() is used # generate a random uuid - by default uuid4() is used
$ python -m uuid $ python -m uuid
# generate a uuid using uuid1() # generate a uuid using uuid1()
$ python -m uuid -u uuid1 $ python -m uuid -u uuid1
# generate a uuid using uuid5 # generate a uuid using uuid5
$ python -m uuid -u uuid5 -ns NAMESPACE_URL -n example.com $ python -m uuid -u uuid5 -n @url -N example.com

View file

@ -675,7 +675,7 @@ class BaseTestUUID:
weak = weakref.ref(strong) weak = weakref.ref(strong)
self.assertIs(strong, weak()) 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): def test_cli_namespace_required_for_uuid3(self):
with self.assertRaises(SystemExit) as cm: with self.assertRaises(SystemExit) as cm:
self.uuid.main() self.uuid.main()
@ -683,7 +683,7 @@ class BaseTestUUID:
# Check that exception code is the same as argparse.ArgumentParser.error # Check that exception code is the same as argparse.ArgumentParser.error
self.assertEqual(cm.exception.code, 2) 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): def test_cli_name_required_for_uuid3(self):
with self.assertRaises(SystemExit) as cm: with self.assertRaises(SystemExit) as cm:
self.uuid.main() self.uuid.main()
@ -705,7 +705,7 @@ class BaseTestUUID:
self.assertEqual(uuid_output.version, 4) self.assertEqual(uuid_output.version, 4)
@mock.patch.object(sys, "argv", @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): def test_cli_uuid3_ouputted_with_valid_namespace_and_name(self):
stdout = io.StringIO() stdout = io.StringIO()
with contextlib.redirect_stdout(stdout): with contextlib.redirect_stdout(stdout):
@ -719,7 +719,7 @@ class BaseTestUUID:
self.assertEqual(uuid_output.version, 3) self.assertEqual(uuid_output.version, 3)
@mock.patch.object(sys, "argv", @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): def test_cli_uuid5_ouputted_with_valid_namespace_and_name(self):
stdout = io.StringIO() stdout = io.StringIO()
with contextlib.redirect_stdout(stdout): with contextlib.redirect_stdout(stdout):

View file

@ -731,16 +731,18 @@ def uuid5(namespace, name):
def main(): def main():
"""Run the uuid command line interface.""" """Run the uuid command line interface."""
uuid_funcs = {"uuid1": uuid1, uuid_funcs = {
"uuid3": uuid3, "uuid1": uuid1,
"uuid4": uuid4, "uuid3": uuid3,
"uuid5": uuid5} "uuid4": uuid4,
"uuid5": uuid5
}
uuid_namespace_funcs = ("uuid3", "uuid5") uuid_namespace_funcs = ("uuid3", "uuid5")
namespaces = { namespaces = {
"NAMESPACE_DNS": NAMESPACE_DNS, "@dns": NAMESPACE_DNS,
"NAMESPACE_URL": NAMESPACE_URL, "@url": NAMESPACE_URL,
"NAMESPACE_OID": NAMESPACE_OID, "@oid": NAMESPACE_OID,
"NAMESPACE_X500": NAMESPACE_X500 "@x500": NAMESPACE_X500
} }
import argparse import argparse
@ -748,11 +750,13 @@ def main():
description="Generates a uuid using the selected uuid function.") description="Generates a uuid using the selected uuid function.")
parser.add_argument("-u", "--uuid", choices=uuid_funcs.keys(), default="uuid4", parser.add_argument("-u", "--uuid", choices=uuid_funcs.keys(), default="uuid4",
help="The function to use to generate the uuid. " help="The function to use to generate the uuid. "
"By default uuid4 function is used.") "By default uuid4 function is used.")
parser.add_argument("-ns", "--namespace", parser.add_argument("-n", "--namespace",
help="The namespace used as part of generating the uuid. " 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.") "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. " help="The name used as part of generating the uuid. "
"Only required for uuid3/uuid5 functions.") "Only required for uuid3/uuid5 functions.")