mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 19:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.13] gh-58282: Fix support of tuple metavar for positional arguments in argparse (GH-124782) (GH-124882)

Browse source 
Previously, formatting help output or error message for positional argument
with a tuple metavar raised exception.

(cherry picked from commit 9b31a2d83f)

Co-authored-by: Cyker Way <cykerway@gmail.com>
This commit is contained in:
Serhiy Storchaka 2024-10-08 09:36:38 +03:00 • committed by GitHub
parent 1e820e63e7
commit e28f2c6705
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 109 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

98
Lib/test/test_argparse.py
View file

@ -4893,7 +4893,7 @@ class TestHelpNone(HelpTestCase):
version = ''
class TestHelpTupleMetavar(HelpTestCase):
class TestHelpTupleMetavarOptional(HelpTestCase):
"""Test specifying metavar as a tuple"""
parser_signature = Sig(prog='PROG')
@ -4920,6 +4920,34 @@ class TestHelpTupleMetavar(HelpTestCase):
version = ''
class TestHelpTupleMetavarPositional(HelpTestCase):
"""Test specifying metavar on a Positional as a tuple"""
parser_signature = Sig(prog='PROG')
argument_signatures = [
Sig('w', help='w help', nargs='+', metavar=('W1', 'W2')),
Sig('x', help='x help', nargs='*', metavar=('X1', 'X2')),
Sig('y', help='y help', nargs=3, metavar=('Y1', 'Y2', 'Y3')),
Sig('z', help='z help', nargs='?', metavar=('Z1',)),
]
argument_group_signatures = []
usage = '''\
usage: PROG [-h] W1 [W2 ...] [X1 [X2 ...]] Y1 Y2 Y3 [Z1]
'''
help = usage + '''\
positional arguments:
W1 W2 w help
X1 X2 x help
Y1 Y2 Y3 y help
Z1 z help
options:
-h, --help show this help message and exit
'''
version = ''
class TestHelpRawText(HelpTestCase):
"""Test the RawTextHelpFormatter"""
@ -6516,6 +6544,27 @@ class TestExitOnError(TestCase):
'the following arguments are required: bar, baz$',
self.parser.parse_args, [])
def test_required_args_with_metavar(self):
self.parser.add_argument('bar')
self.parser.add_argument('baz', metavar='BaZ')
self.assertRaisesRegex(argparse.ArgumentError,
'the following arguments are required: bar, BaZ$',
self.parser.parse_args, [])
def test_required_args_n(self):
self.parser.add_argument('bar')
self.parser.add_argument('baz', nargs=3)
self.assertRaisesRegex(argparse.ArgumentError,
'the following arguments are required: bar, baz$',
self.parser.parse_args, [])
def test_required_args_n_with_metavar(self):
self.parser.add_argument('bar')
self.parser.add_argument('baz', nargs=3, metavar=('B', 'A', 'Z'))
self.assertRaisesRegex(argparse.ArgumentError,
'the following arguments are required: bar, B, A, Z$',
self.parser.parse_args, [])
def test_required_args_optional(self):
self.parser.add_argument('bar')
self.parser.add_argument('baz', nargs='?')
@ -6530,6 +6579,20 @@ class TestExitOnError(TestCase):
'the following arguments are required: bar$',
self.parser.parse_args, [])
def test_required_args_one_or_more(self):
self.parser.add_argument('bar')
self.parser.add_argument('baz', nargs='+')
self.assertRaisesRegex(argparse.ArgumentError,
'the following arguments are required: bar, baz$',
self.parser.parse_args, [])
def test_required_args_one_or_more_with_metavar(self):
self.parser.add_argument('bar')
self.parser.add_argument('baz', nargs='+', metavar=('BaZ1', 'BaZ2'))
self.assertRaisesRegex(argparse.ArgumentError,
r'the following arguments are required: bar, BaZ1\[, BaZ2]$',
self.parser.parse_args, [])
def test_required_args_remainder(self):
self.parser.add_argument('bar')
self.parser.add_argument('baz', nargs='...')
@ -6545,6 +6608,39 @@ class TestExitOnError(TestCase):
'one of the arguments --bar --baz is required',
self.parser.parse_args, [])
def test_conflicting_mutually_exclusive_args_optional_with_metavar(self):
group = self.parser.add_mutually_exclusive_group()
group.add_argument('--bar')
group.add_argument('baz', nargs='?', metavar='BaZ')
self.assertRaisesRegex(argparse.ArgumentError,
'argument BaZ: not allowed with argument --bar$',
self.parser.parse_args, ['--bar', 'a', 'b'])
self.assertRaisesRegex(argparse.ArgumentError,
'argument --bar: not allowed with argument BaZ$',
self.parser.parse_args, ['a', '--bar', 'b'])
def test_conflicting_mutually_exclusive_args_zero_or_more_with_metavar1(self):
group = self.parser.add_mutually_exclusive_group()
group.add_argument('--bar')
group.add_argument('baz', nargs='*', metavar=('BAZ1',))
self.assertRaisesRegex(argparse.ArgumentError,
'argument BAZ1: not allowed with argument --bar$',
self.parser.parse_args, ['--bar', 'a', 'b'])
self.assertRaisesRegex(argparse.ArgumentError,
'argument --bar: not allowed with argument BAZ1$',
self.parser.parse_args, ['a', '--bar', 'b'])
def test_conflicting_mutually_exclusive_args_zero_or_more_with_metavar2(self):
group = self.parser.add_mutually_exclusive_group()
group.add_argument('--bar')
group.add_argument('baz', nargs='*', metavar=('BAZ1', 'BAZ2'))
self.assertRaisesRegex(argparse.ArgumentError,
r'argument BAZ1\[, BAZ2]: not allowed with argument --bar$',
self.parser.parse_args, ['--bar', 'a', 'b'])
self.assertRaisesRegex(argparse.ArgumentError,
r'argument --bar: not allowed with argument BAZ1\[, BAZ2]$',
self.parser.parse_args, ['a', '--bar', 'b'])
def test_ambiguous_option(self):
self.parser.add_argument('--foobaz')
self.parser.add_argument('--fooble', action='store_true')