gh-85427: Prevent exits if `ArgumentParser.exit_on_error` is False by jacobtylerwalls · Pull Request #30832 · python/cpython · GitHub
Skip to content

gh-85427: Prevent exits if ArgumentParser.exit_on_error is False #30832

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.

Sign up for GitHub

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

Closed
jacobtylerwalls wants to merge 8 commits into from
+44 −5
Closed

gh-85427: Prevent exits if ArgumentParser.exit_on_error is False #30832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a2a1462
bpo-46440: Prevent all exits if `ArgumentParser.exit_on_error` is False
jacobtylerwalls Jan 23, 2022
0fc30d3
Make all error paths raise ArgumentError
jacobtylerwalls Jan 24, 2022
f3e173c
Extend solution
jacobtylerwalls Jan 29, 2022
10c748a
Guard according to `exit_on_error`
jacobtylerwalls Jan 29, 2022
7b83cf6
Additional regression tests
jacobtylerwalls Jan 29, 2022
742bede
Merge branch 'main' into argparse-exit-on-error
jacobtylerwalls Jun 7, 2022
e41aa7c
Merge branch 'main' into argparse-exit-on-error
jacobtylerwalls Apr 15, 2023
7e16f62
Extend solution to parse_intermixed_args()
jacobtylerwalls Apr 15, 2023
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
22 changes: 18 additions & 4 deletions Lib/argparse.py
View file
Open in desktop
25 changes: 24 additions & 1 deletion Lib/test/test_argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5594,7 +5594,8 @@ class TestExitOnError(TestCase):

def setUp(self):
self.parser = argparse.ArgumentParser(exit_on_error=False)
self.parser.add_argument('--integers', metavar='N', type=int)
self.parser.add_argument(
'--integers', metavar='N', type=int, required=True)

def test_exit_on_error_with_good_args(self):
ns = self.parser.parse_args('--integers 4'.split())
Expand All @@ -5604,6 +5605,28 @@ def test_exit_on_error_with_bad_args(self):
with self.assertRaises(argparse.ArgumentError):
self.parser.parse_args('--integers a'.split())

def test_exit_on_error_missing_required_arg(self):
msg = 'the following arguments are required: --integers'
with self.assertRaisesRegex(argparse.ArgumentError, msg):
self.parser.parse_args([])

def test_exit_on_error_unknown_arg(self):
msg = 'unrecognized arguments: --unknown'
with self.assertRaisesRegex(argparse.ArgumentError, msg):
self.parser.parse_args('--integers 4 --unknown'.split())
with self.assertRaisesRegex(argparse.ArgumentError, msg.replace('--', '')):
self.parser.parse_intermixed_args('--integers 4 unknown'.split())

def test_exit_on_error_mutually_exclusive_group(self):
other_parser = argparse.ArgumentParser(exit_on_error=False)
group = other_parser.add_mutually_exclusive_group(required=True)
group.add_argument('--up', action='store_true')
group.add_argument('--down', action='store_true')

msg = 'one of the arguments --up --down is required'
with self.assertRaisesRegex(argparse.ArgumentError, msg):
other_parser.parse_args([])


def tearDownModule():
# Remove global references to avoid looking like we have refleaks.
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2022-01-23-11-58-40.bpo-46440.tMts6U.rst
View file
Open in desktop