FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-41255: handle argparse errors with exit_on_error=False consistently by joshmeranda · Pull Request #27295 · python/cpython · GitHub

/ cpython Public

bpo-41255: handle argparse errors with exit_on_error=False consistently #27295

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
joshmeranda wants to merge 4 commits into from
Conversation 6 Commits 4 Checks 0 Files changed
Closed

bpo-41255: handle argparse errors with exit_on_error=False consistently #27295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
45ac2a7
bpo-41255: unify hanling of exit_on_error
joshmeranda Jul 22, 2021
c846f72
📜🤖 Added by blurb_it.
blurb-it[bot] Jul 22, 2021
bca0bf5
bpo-41255: resolve suspicious reST construct in modified docs
joshmeranda Jul 23, 2021
2655026
Merge branch 'main' into issue-41255
joshmeranda Mar 14, 2022
File filter

Filter by extension

Filter by extension .py  (2) .rst  (2) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
5 changes: 3 additions & 2 deletions Doc/library/argparse.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -2090,8 +2090,9 @@ Exiting methods

.. method:: ArgumentParser.error(message)

This method prints a usage message including the *message* to the
standard error and terminates the program with a status code of 2.
When exit on error is ``True`` this method prints a usage message including
the *message* to the standard error and terminates the program with a status
code of 2, otherwise raises an ArgumentError.


Intermixed parsing
Expand Down
18 changes: 10 additions & 8 deletions Lib/argparse.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1872,13 +1872,11 @@ def parse_known_args(self, args=None, namespace=None):
setattr(namespace, dest, self._defaults[dest])

# parse the arguments and exit if there are any errors
if self.exit_on_error:
try:
namespace, args = self._parse_known_args(args, namespace)
except ArgumentError as err:
self.error(str(err))
else:
try:
namespace, args = self._parse_known_args(args, namespace)
except ArgumentError:
err = _sys.exc_info()[1]
self.error(str(err))

if hasattr(namespace, _UNRECOGNIZED_ARGS_ATTR):
args.extend(getattr(namespace, _UNRECOGNIZED_ARGS_ATTR))
Expand Down Expand Up @@ -2588,12 +2586,16 @@ def exit(self, status=0, message=None):
def error(self, message):
"""error(message: string)

Prints a usage message incorporating the message to stderr and
exits.
When exit_on_error is true prints a usage message
incorporating the message to stderr and exits, otherwise raises
an ArgumentError.

If you override this in a subclass, it should not return -- it
should either exit or raise an exception.
"""
if not self.exit_on_error:
raise ArgumentError(None, message)

self.print_usage(_sys.stderr)
args = {'prog': self.prog, 'message': message}
self.exit(2, _('%(prog)s: error: %(message)s\n') % args)
10 changes: 9 additions & 1 deletion Lib/test/test_argparse.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -5541,7 +5541,7 @@ 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 @@ -5551,6 +5551,14 @@ 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_args(self):
with self.assertRaises(argparse.ArgumentError):
self.parser.parse_args([])

def test_exit_on_error_unknown_args(self):
with self.assertRaises(argparse.ArgumentError):
self.parser.parse_args("--integers 1 --unknown-arg".split())


def tearDownModule():
# Remove global references to avoid looking like we have refleaks.
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2021-07-22-21-56-34.bpo-41255.tbSAVo.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
fixed errors with argparse exit_on_error causing unexpected behavior
Back | FazBrowse Home | New Git URL