From: Serhiy Storchaka <storchaka@gmail.com>
Date: Sat, 12 Oct 2024 11:46:28 +0000 (+0300)
Subject: gh-59330: Improve error message for dest= for positionals (GH-125215)
X-Git-Tag: v3.14.0a1~65
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a6c0c64de0ade400df7995f1e9480b6fc0f863aa;p=thirdparty%2FPython%2Fcpython.git

gh-59330: Improve error message for dest= for positionals (GH-125215)

Also improve the documentation. Specify how dest and metavar are derived
from add_argument() positional arguments.

Co-authored-by: Simon Law <sfllaw@sfllaw.ca>
---

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index d337de87ca8f..19f832051a9e 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -636,6 +636,25 @@ be positional::
    usage: PROG [-h] [-f FOO] bar
    PROG: error: the following arguments are required: bar
 
+By default, argparse automatically handles the internal naming and
+display names of arguments, simplifying the process without requiring
+additional configuration.
+As such, you do not need to specify the dest_ and metavar_ parameters.
+The dest_ parameter defaults to the argument name with underscores ``_``
+replacing hyphens ``-`` . The metavar_ parameter defaults to the
+upper-cased name. For example::
+
+   >>> parser = argparse.ArgumentParser(prog='PROG')
+   >>> parser.add_argument('--foo-bar')
+   >>> parser.parse_args(['--foo-bar', 'FOO-BAR']
+   Namespace(foo_bar='FOO-BAR')
+   >>> parser.print_help()
+   usage:  [-h] [--foo-bar FOO-BAR]
+
+   optional arguments:
+    -h, --help  show this help message and exit
+    --foo-bar FOO-BAR
+
 
 .. _action:
 
diff --git a/Lib/argparse.py b/Lib/argparse.py
index 208c1827f9ac..64dbd7149e76 100644
--- a/Lib/argparse.py
+++ b/Lib/argparse.py
@@ -1424,7 +1424,8 @@ class _ActionsContainer(object):
         chars = self.prefix_chars
         if not args or len(args) == 1 and args[0][0] not in chars:
             if args and 'dest' in kwargs:
-                raise ValueError('dest supplied twice for positional argument')
+                raise ValueError('dest supplied twice for positional argument,'
+                                 ' did you mean metavar?')
             kwargs = self._get_positional_kwargs(*args, **kwargs)
 
         # otherwise, we're adding an optional argument
diff --git a/Lib/test/test_argparse.py b/Lib/test/test_argparse.py
index 000b810454f5..61ddb5f16cc4 100644
--- a/Lib/test/test_argparse.py
+++ b/Lib/test/test_argparse.py
@@ -5411,7 +5411,8 @@ class TestInvalidArgumentConstructors(TestCase):
         parser.add_argument(dest='foo')
         with self.assertRaises(ValueError) as cm:
             parser.add_argument('bar', dest='baz')
-        self.assertIn('dest supplied twice for positional argument',
+        self.assertIn('dest supplied twice for positional argument,'
+                      ' did you mean metavar?',
                       str(cm.exception))
 
     def test_no_argument_actions(self):