mirror of
https://github.com/python/cpython.git
synced 2025-07-23 11:15:24 +00:00
[3.13] gh-59317: Improve parsing optional positional arguments in argparse (GH-124303) (GH-124436)
Fix parsing positional argument with nargs equal to '?' or '*' if it is
preceded by an option and another positional argument.
(cherry picked from commit 4a5e4aade4)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
This commit is contained in:
Miss Islington (bot)
GitHub
parent
03ae82d0d3
commit
16127de2eb
3 changed files with 102 additions and 42 deletions
|
|
@ -280,16 +280,18 @@ class ParserTesterMetaclass(type):
|
|||
parser = self._get_parser(tester)
|
||||
for args_str in tester.failures:
|
||||
args = args_str.split()
|
||||
with tester.assertRaises(ArgumentParserError, msg=args):
|
||||
parser.parse_args(args)
|
||||
with tester.subTest(args=args):
|
||||
with tester.assertRaises(ArgumentParserError, msg=args):
|
||||
parser.parse_args(args)
|
||||
|
||||
def test_successes(self, tester):
|
||||
parser = self._get_parser(tester)
|
||||
for args, expected_ns in tester.successes:
|
||||
if isinstance(args, str):
|
||||
args = args.split()
|
||||
result_ns = self._parse_args(parser, args)
|
||||
tester.assertEqual(expected_ns, result_ns)
|
||||
with tester.subTest(args=args):
|
||||
result_ns = self._parse_args(parser, args)
|
||||
tester.assertEqual(expected_ns, result_ns)
|
||||
|
||||
# add tests for each combination of an optionals adding method
|
||||
# and an arg parsing method
|
||||
|
|
@ -1132,57 +1134,87 @@ class TestPositionalsNargs2None(ParserTestCase):
|
|||
class TestPositionalsNargsNoneZeroOrMore(ParserTestCase):
|
||||
"""Test a Positional with no nargs followed by one with unlimited"""
|
||||
|
||||
argument_signatures = [Sig('foo'), Sig('bar', nargs='*')]
|
||||
failures = ['', '--foo']
|
||||
argument_signatures = [Sig('-x'), Sig('foo'), Sig('bar', nargs='*')]
|
||||
failures = ['', '--foo', 'a b -x X c']
|
||||
successes = [
|
||||
('a', NS(foo='a', bar=[])),
|
||||
('a b', NS(foo='a', bar=['b'])),
|
||||
('a b c', NS(foo='a', bar=['b', 'c'])),
|
||||
('a', NS(x=None, foo='a', bar=[])),
|
||||
('a b', NS(x=None, foo='a', bar=['b'])),
|
||||
('a b c', NS(x=None, foo='a', bar=['b', 'c'])),
|
||||
('-x X a', NS(x='X', foo='a', bar=[])),
|
||||
('a -x X', NS(x='X', foo='a', bar=[])),
|
||||
('-x X a b', NS(x='X', foo='a', bar=['b'])),
|
||||
('a -x X b', NS(x='X', foo='a', bar=['b'])),
|
||||
('a b -x X', NS(x='X', foo='a', bar=['b'])),
|
||||
('-x X a b c', NS(x='X', foo='a', bar=['b', 'c'])),
|
||||
('a -x X b c', NS(x='X', foo='a', bar=['b', 'c'])),
|
||||
('a b c -x X', NS(x='X', foo='a', bar=['b', 'c'])),
|
||||
]
|
||||
|
||||
|
||||
class TestPositionalsNargsNoneOneOrMore(ParserTestCase):
|
||||
"""Test a Positional with no nargs followed by one with one or more"""
|
||||
|
||||
argument_signatures = [Sig('foo'), Sig('bar', nargs='+')]
|
||||
failures = ['', '--foo', 'a']
|
||||
argument_signatures = [Sig('-x'), Sig('foo'), Sig('bar', nargs='+')]
|
||||
failures = ['', '--foo', 'a', 'a b -x X c']
|
||||
successes = [
|
||||
('a b', NS(foo='a', bar=['b'])),
|
||||
('a b c', NS(foo='a', bar=['b', 'c'])),
|
||||
('a b', NS(x=None, foo='a', bar=['b'])),
|
||||
('a b c', NS(x=None, foo='a', bar=['b', 'c'])),
|
||||
('-x X a b', NS(x='X', foo='a', bar=['b'])),
|
||||
('a -x X b', NS(x='X', foo='a', bar=['b'])),
|
||||
('a b -x X', NS(x='X', foo='a', bar=['b'])),
|
||||
('-x X a b c', NS(x='X', foo='a', bar=['b', 'c'])),
|
||||
('a -x X b c', NS(x='X', foo='a', bar=['b', 'c'])),
|
||||
('a b c -x X', NS(x='X', foo='a', bar=['b', 'c'])),
|
||||
]
|
||||
|
||||
|
||||
class TestPositionalsNargsNoneOptional(ParserTestCase):
|
||||
"""Test a Positional with no nargs followed by one with an Optional"""
|
||||
|
||||
argument_signatures = [Sig('foo'), Sig('bar', nargs='?')]
|
||||
argument_signatures = [Sig('-x'), Sig('foo'), Sig('bar', nargs='?')]
|
||||
failures = ['', '--foo', 'a b c']
|
||||
successes = [
|
||||
('a', NS(foo='a', bar=None)),
|
||||
('a b', NS(foo='a', bar='b')),
|
||||
('a', NS(x=None, foo='a', bar=None)),
|
||||
('a b', NS(x=None, foo='a', bar='b')),
|
||||
('-x X a', NS(x='X', foo='a', bar=None)),
|
||||
('a -x X', NS(x='X', foo='a', bar=None)),
|
||||
('-x X a b', NS(x='X', foo='a', bar='b')),
|
||||
('a -x X b', NS(x='X', foo='a', bar='b')),
|
||||
('a b -x X', NS(x='X', foo='a', bar='b')),
|
||||
]
|
||||
|
||||
|
||||
class TestPositionalsNargsZeroOrMoreNone(ParserTestCase):
|
||||
"""Test a Positional with unlimited nargs followed by one with none"""
|
||||
|
||||
argument_signatures = [Sig('foo', nargs='*'), Sig('bar')]
|
||||
failures = ['', '--foo']
|
||||
argument_signatures = [Sig('-x'), Sig('foo', nargs='*'), Sig('bar')]
|
||||
failures = ['', '--foo', 'a -x X b', 'a -x X b c', 'a b -x X c']
|
||||
successes = [
|
||||
('a', NS(foo=[], bar='a')),
|
||||
('a b', NS(foo=['a'], bar='b')),
|
||||
('a b c', NS(foo=['a', 'b'], bar='c')),
|
||||
('a', NS(x=None, foo=[], bar='a')),
|
||||
('a b', NS(x=None, foo=['a'], bar='b')),
|
||||
('a b c', NS(x=None, foo=['a', 'b'], bar='c')),
|
||||
('-x X a', NS(x='X', foo=[], bar='a')),
|
||||
('a -x X', NS(x='X', foo=[], bar='a')),
|
||||
('-x X a b', NS(x='X', foo=['a'], bar='b')),
|
||||
('a b -x X', NS(x='X', foo=['a'], bar='b')),
|
||||
('-x X a b c', NS(x='X', foo=['a', 'b'], bar='c')),
|
||||
('a b c -x X', NS(x='X', foo=['a', 'b'], bar='c')),
|
||||
]
|
||||
|
||||
|
||||
class TestPositionalsNargsOneOrMoreNone(ParserTestCase):
|
||||
"""Test a Positional with one or more nargs followed by one with none"""
|
||||
|
||||
argument_signatures = [Sig('foo', nargs='+'), Sig('bar')]
|
||||
failures = ['', '--foo', 'a']
|
||||
argument_signatures = [Sig('-x'), Sig('foo', nargs='+'), Sig('bar')]
|
||||
failures = ['', '--foo', 'a', 'a -x X b c', 'a b -x X c']
|
||||
successes = [
|
||||
('a b', NS(foo=['a'], bar='b')),
|
||||
('a b c', NS(foo=['a', 'b'], bar='c')),
|
||||
('a b', NS(x=None, foo=['a'], bar='b')),
|
||||
('a b c', NS(x=None, foo=['a', 'b'], bar='c')),
|
||||
('-x X a b', NS(x='X', foo=['a'], bar='b')),
|
||||
('a -x X b', NS(x='X', foo=['a'], bar='b')),
|
||||
('a b -x X', NS(x='X', foo=['a'], bar='b')),
|
||||
('-x X a b c', NS(x='X', foo=['a', 'b'], bar='c')),
|
||||
('a b c -x X', NS(x='X', foo=['a', 'b'], bar='c')),
|
||||
]
|
||||
|
||||
|
||||
|
|
@ -1267,14 +1299,21 @@ class TestPositionalsNargsNoneZeroOrMore1(ParserTestCase):
|
|||
"""Test three Positionals: no nargs, unlimited nargs and 1 nargs"""
|
||||
|
||||
argument_signatures = [
|
||||
Sig('-x'),
|
||||
Sig('foo'),
|
||||
Sig('bar', nargs='*'),
|
||||
Sig('baz', nargs=1),
|
||||
]
|
||||
failures = ['', '--foo', 'a']
|
||||
failures = ['', '--foo', 'a', 'a b -x X c']
|
||||
successes = [
|
||||
('a b', NS(foo='a', bar=[], baz=['b'])),
|
||||
('a b c', NS(foo='a', bar=['b'], baz=['c'])),
|
||||
('a b', NS(x=None, foo='a', bar=[], baz=['b'])),
|
||||
('a b c', NS(x=None, foo='a', bar=['b'], baz=['c'])),
|
||||
('-x X a b', NS(x='X', foo='a', bar=[], baz=['b'])),
|
||||
('a -x X b', NS(x='X', foo='a', bar=[], baz=['b'])),
|
||||
('a b -x X', NS(x='X', foo='a', bar=[], baz=['b'])),
|
||||
('-x X a b c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
||||
('a -x X b c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
||||
('a b c -x X', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
||||
]
|
||||
|
||||
|
||||
|
|
@ -1282,14 +1321,22 @@ class TestPositionalsNargsNoneOneOrMore1(ParserTestCase):
|
|||
"""Test three Positionals: no nargs, one or more nargs and 1 nargs"""
|
||||
|
||||
argument_signatures = [
|
||||
Sig('-x'),
|
||||
Sig('foo'),
|
||||
Sig('bar', nargs='+'),
|
||||
Sig('baz', nargs=1),
|
||||
]
|
||||
failures = ['', '--foo', 'a', 'b']
|
||||
failures = ['', '--foo', 'a', 'b', 'a b -x X c d', 'a b c -x X d']
|
||||
successes = [
|
||||
('a b c', NS(foo='a', bar=['b'], baz=['c'])),
|
||||
('a b c d', NS(foo='a', bar=['b', 'c'], baz=['d'])),
|
||||
('a b c', NS(x=None, foo='a', bar=['b'], baz=['c'])),
|
||||
('a b c d', NS(x=None, foo='a', bar=['b', 'c'], baz=['d'])),
|
||||
('-x X a b c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
||||
('a -x X b c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
||||
('a b -x X c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
||||
('a b c -x X', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
||||
('-x X a b c d', NS(x='X', foo='a', bar=['b', 'c'], baz=['d'])),
|
||||
('a -x X b c d', NS(x='X', foo='a', bar=['b', 'c'], baz=['d'])),
|
||||
('a b c d -x X', NS(x='X', foo='a', bar=['b', 'c'], baz=['d'])),
|
||||
]
|
||||
|
||||
|
||||
|
|
@ -1297,14 +1344,21 @@ class TestPositionalsNargsNoneOptional1(ParserTestCase):
|
|||
"""Test three Positionals: no nargs, optional narg and 1 nargs"""
|
||||
|
||||
argument_signatures = [
|
||||
Sig('-x'),
|
||||
Sig('foo'),
|
||||
Sig('bar', nargs='?', default=0.625),
|
||||
Sig('baz', nargs=1),
|
||||
]
|
||||
failures = ['', '--foo', 'a']
|
||||
failures = ['', '--foo', 'a', 'a b -x X c']
|
||||
successes = [
|
||||
('a b', NS(foo='a', bar=0.625, baz=['b'])),
|
||||
('a b c', NS(foo='a', bar='b', baz=['c'])),
|
||||
('a b', NS(x=None, foo='a', bar=0.625, baz=['b'])),
|
||||
('a b c', NS(x=None, foo='a', bar='b', baz=['c'])),
|
||||
('-x X a b', NS(x='X', foo='a', bar=0.625, baz=['b'])),
|
||||
('a -x X b', NS(x='X', foo='a', bar=0.625, baz=['b'])),
|
||||
('a b -x X', NS(x='X', foo='a', bar=0.625, baz=['b'])),
|
||||
('-x X a b c', NS(x='X', foo='a', bar='b', baz=['c'])),
|
||||
('a -x X b c', NS(x='X', foo='a', bar='b', baz=['c'])),
|
||||
('a b c -x X', NS(x='X', foo='a', bar='b', baz=['c'])),
|
||||
]
|
||||
|
||||
|
||||
|
|
@ -1520,6 +1574,9 @@ class TestNargsRemainder(ParserTestCase):
|
|||
successes = [
|
||||
('X', NS(x='X', y=[], z=None)),
|
||||
('-z Z X', NS(x='X', y=[], z='Z')),
|
||||
('-z Z X A B', NS(x='X', y=['A', 'B'], z='Z')),
|
||||
('X -z Z A B', NS(x='X', y=['-z', 'Z', 'A', 'B'], z=None)),
|
||||
('X A -z Z B', NS(x='X', y=['A', '-z', 'Z', 'B'], z=None)),
|
||||
('X A B -z Z', NS(x='X', y=['A', 'B', '-z', 'Z'], z=None)),
|
||||
('X Y --foo', NS(x='X', y=['Y', '--foo'], z=None)),
|
||||
]
|
||||
|
|
@ -5986,8 +6043,8 @@ class TestIntermixedArgs(TestCase):
|
|||
|
||||
args, extras = parser.parse_known_args(argv)
|
||||
# cannot parse the '1,2,3'
|
||||
self.assertEqual(NS(bar='y', cmd='cmd', foo='x', rest=[]), args)
|
||||
self.assertEqual(["1", "2", "3"], extras)
|
||||
self.assertEqual(NS(bar='y', cmd='cmd', foo='x', rest=[1]), args)
|
||||
self.assertEqual(["2", "3"], extras)
|
||||
|
||||
argv = 'cmd --foo x 1 --error 2 --bar y 3'.split()
|
||||
args, extras = parser.parse_known_intermixed_args(argv)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue