gh-53834: Fix support of arguments with choices in argparse (GH-124495)

Positional arguments with nargs equal to '?' or '*' no longer check
default against choices.
Optional arguments with nargs equal to '?' no longer check const
against choices.
This commit is contained in:
Serhiy Storchaka 2024-09-29 10:52:52 +03:00 committed by GitHub
parent 61180446ee
commit dac4ec5286
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 13 additions and 13 deletions

View file

@ -2487,7 +2487,6 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer):
value = action.default value = action.default
if isinstance(value, str) and value is not SUPPRESS: if isinstance(value, str) and value is not SUPPRESS:
value = self._get_value(action, value) value = self._get_value(action, value)
self._check_value(action, value)
# when nargs='*' on a positional, if there were no command-line # when nargs='*' on a positional, if there were no command-line
# args, use the default if it is anything other than None # args, use the default if it is anything other than None
@ -2495,11 +2494,8 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer):
not action.option_strings): not action.option_strings):
if action.default is not None: if action.default is not None:
value = action.default value = action.default
self._check_value(action, value)
else: else:
# since arg_strings is always [] at this point value = []
# there is no need to use self._check_value(action, value)
value = arg_strings
# single argument or optional argument produces a single value # single argument or optional argument produces a single value
elif len(arg_strings) == 1 and action.nargs in [None, OPTIONAL]: elif len(arg_strings) == 1 and action.nargs in [None, OPTIONAL]:

View file

@ -628,9 +628,9 @@ class TestOptionalsNargsOptional(ParserTestCase):
Sig('-w', nargs='?'), Sig('-w', nargs='?'),
Sig('-x', nargs='?', const=42), Sig('-x', nargs='?', const=42),
Sig('-y', nargs='?', default='spam'), Sig('-y', nargs='?', default='spam'),
Sig('-z', nargs='?', type=int, const='42', default='84'), Sig('-z', nargs='?', type=int, const='42', default='84', choices=[1, 2]),
] ]
failures = ['2'] failures = ['2', '-z a', '-z 42', '-z 84']
successes = [ successes = [
('', NS(w=None, x=None, y='spam', z=84)), ('', NS(w=None, x=None, y='spam', z=84)),
('-w', NS(w=None, x=None, y='spam', z=84)), ('-w', NS(w=None, x=None, y='spam', z=84)),
@ -1027,8 +1027,8 @@ class TestPositionalsNargsZeroOrMore(ParserTestCase):
class TestPositionalsNargsZeroOrMoreDefault(ParserTestCase): class TestPositionalsNargsZeroOrMoreDefault(ParserTestCase):
"""Test a Positional that specifies unlimited nargs and a default""" """Test a Positional that specifies unlimited nargs and a default"""
argument_signatures = [Sig('foo', nargs='*', default='bar')] argument_signatures = [Sig('foo', nargs='*', default='bar', choices=['a', 'b'])]
failures = ['-x'] failures = ['-x', 'bar', 'a c']
successes = [ successes = [
('', NS(foo='bar')), ('', NS(foo='bar')),
('a', NS(foo=['a'])), ('a', NS(foo=['a'])),
@ -1061,8 +1061,8 @@ class TestPositionalsNargsOptional(ParserTestCase):
class TestPositionalsNargsOptionalDefault(ParserTestCase): class TestPositionalsNargsOptionalDefault(ParserTestCase):
"""Tests an Optional Positional with a default value""" """Tests an Optional Positional with a default value"""
argument_signatures = [Sig('foo', nargs='?', default=42)] argument_signatures = [Sig('foo', nargs='?', default=42, choices=['a', 'b'])]
failures = ['-x', 'a b'] failures = ['-x', 'a b', '42']
successes = [ successes = [
('', NS(foo=42)), ('', NS(foo=42)),
('a', NS(foo='a')), ('a', NS(foo='a')),
@ -1075,9 +1075,9 @@ class TestPositionalsNargsOptionalConvertedDefault(ParserTestCase):
""" """
argument_signatures = [ argument_signatures = [
Sig('foo', nargs='?', type=int, default='42'), Sig('foo', nargs='?', type=int, default='42', choices=[1, 2]),
] ]
failures = ['-x', 'a b', '1 2'] failures = ['-x', 'a b', '1 2', '42']
successes = [ successes = [
('', NS(foo=42)), ('', NS(foo=42)),
('1', NS(foo=1)), ('1', NS(foo=1)),

View file

@ -0,0 +1,4 @@
Fix support of arguments with :ref:`choices` in :mod:`argparse`. Positional
arguments with :ref:`nargs` equal to ``'?'`` or ``'*'`` no longer check
:ref:`default` against ``choices``. Optional arguments with ``nargs`` equal
to ``'?'`` no longer check :ref:`const` against ``choices``.