Skip to content

[3.12] gh-85935: Improve tests for invalid arguments in test_argparse (GH-124891) #124898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 42 additions & 35 deletions Lib/test/test_argparse.py
Original file line number Diff line number Diff line change
Expand Up @@ -5069,15 +5069,15 @@ def custom_formatter(prog):
class TestInvalidArgumentConstructors(TestCase):
"""Test a bunch of invalid Argument constructors"""

def assertTypeError(self, *args, **kwargs):
def assertTypeError(self, *args, errmsg=None, **kwargs):
parser = argparse.ArgumentParser()
self.assertRaises(TypeError, parser.add_argument,
*args, **kwargs)
self.assertRaisesRegex(TypeError, errmsg, parser.add_argument,
*args, **kwargs)

def assertValueError(self, *args, **kwargs):
def assertValueError(self, *args, errmsg=None, **kwargs):
parser = argparse.ArgumentParser()
self.assertRaises(ValueError, parser.add_argument,
*args, **kwargs)
self.assertRaisesRegex(ValueError, errmsg, parser.add_argument,
*args, **kwargs)

def test_invalid_keyword_arguments(self):
self.assertTypeError('-x', bar=None)
Expand All @@ -5087,8 +5087,9 @@ def test_invalid_keyword_arguments(self):

def test_missing_destination(self):
self.assertTypeError()
for action in ['append', 'store']:
self.assertTypeError(action=action)
for action in ['store', 'append', 'extend']:
with self.subTest(action=action):
self.assertTypeError(action=action)

def test_invalid_option_strings(self):
self.assertValueError('--')
Expand All @@ -5102,10 +5103,8 @@ def test_invalid_action(self):
self.assertValueError('-x', action='foo')
self.assertValueError('foo', action='baz')
self.assertValueError('--foo', action=('store', 'append'))
parser = argparse.ArgumentParser()
with self.assertRaises(ValueError) as cm:
parser.add_argument("--foo", action="store-true")
self.assertIn('unknown action', str(cm.exception))
self.assertValueError('--foo', action="store-true",
errmsg='unknown action')

def test_multiple_dest(self):
parser = argparse.ArgumentParser()
Expand All @@ -5118,39 +5117,47 @@ def test_multiple_dest(self):
def test_no_argument_actions(self):
for action in ['store_const', 'store_true', 'store_false',
'append_const', 'count']:
for attrs in [dict(type=int), dict(nargs='+'),
dict(choices=['a', 'b'])]:
self.assertTypeError('-x', action=action, **attrs)
with self.subTest(action=action):
for attrs in [dict(type=int), dict(nargs='+'),
dict(choices=['a', 'b'])]:
with self.subTest(attrs=attrs):
self.assertTypeError('-x', action=action, **attrs)
self.assertTypeError('x', action=action, **attrs)
self.assertTypeError('-x', action=action, nargs=0)
self.assertTypeError('x', action=action, nargs=0)

def test_no_argument_no_const_actions(self):
# options with zero arguments
for action in ['store_true', 'store_false', 'count']:
with self.subTest(action=action):
# const is always disallowed
self.assertTypeError('-x', const='foo', action=action)

# const is always disallowed
self.assertTypeError('-x', const='foo', action=action)

# nargs is always disallowed
self.assertTypeError('-x', nargs='*', action=action)
# nargs is always disallowed
self.assertTypeError('-x', nargs='*', action=action)

def test_more_than_one_argument_actions(self):
for action in ['store', 'append']:

# nargs=0 is disallowed
self.assertValueError('-x', nargs=0, action=action)
self.assertValueError('spam', nargs=0, action=action)

# const is disallowed with non-optional arguments
for nargs in [1, '*', '+']:
self.assertValueError('-x', const='foo',
nargs=nargs, action=action)
self.assertValueError('spam', const='foo',
nargs=nargs, action=action)
for action in ['store', 'append', 'extend']:
with self.subTest(action=action):
# nargs=0 is disallowed
action_name = 'append' if action == 'extend' else action
self.assertValueError('-x', nargs=0, action=action,
errmsg=f'nargs for {action_name} actions must be != 0')
self.assertValueError('spam', nargs=0, action=action,
errmsg=f'nargs for {action_name} actions must be != 0')

# const is disallowed with non-optional arguments
for nargs in [1, '*', '+']:
self.assertValueError('-x', const='foo',
nargs=nargs, action=action)
self.assertValueError('spam', const='foo',
nargs=nargs, action=action)

def test_required_const_actions(self):
for action in ['store_const', 'append_const']:

# nargs is always disallowed
self.assertTypeError('-x', nargs='+', action=action)
with self.subTest(action=action):
# nargs is always disallowed
self.assertTypeError('-x', nargs='+', action=action)

def test_parsers_action_missing_params(self):
self.assertTypeError('command', action='parsers')
Expand Down
Loading