Skip to content

Commit

Permalink
gh-101640: Make argparse _print_message catch any write error (#101802)
Browse files Browse the repository at this point in the history
* In particular, don't exit when trying to print to stderr = None.
* Add tests

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
  • Loading branch information
arhadthedev and terryjreedy committed May 6, 2023
1 parent 92d8bff commit 42f54d1
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 3 deletions.
8 changes: 5 additions & 3 deletions Lib/argparse.py
Original file line number Diff line number Diff line change
Expand Up @@ -2605,9 +2605,11 @@ def print_help(self, file=None):

def _print_message(self, message, file=None):
if message:
if file is None:
file = _sys.stderr
file.write(message)
file = file or _sys.stderr
try:
file.write(message)
except (AttributeError, OSError):
pass

# ===============
# Exiting methods
Expand Down
31 changes: 31 additions & 0 deletions Lib/test/test_argparse.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Author: Steven J. Bethard <steven.bethard@gmail.com>.

import contextlib
import functools
import inspect
import io
import operator
Expand Down Expand Up @@ -35,6 +37,35 @@ def getvalue(self):
return self.buffer.raw.getvalue().decode('utf-8')


class StdStreamTest(unittest.TestCase):

def test_skip_invalid_stderr(self):
parser = argparse.ArgumentParser()
with (
contextlib.redirect_stderr(None),
mock.patch('argparse._sys.exit')
):
parser.exit(status=0, message='foo')

def test_skip_invalid_stdout(self):
parser = argparse.ArgumentParser()
for func in (
parser.print_usage,
parser.print_help,
functools.partial(parser.parse_args, ['-h'])
):
with (
self.subTest(func=func),
contextlib.redirect_stdout(None),
# argparse uses stderr as a fallback
StdIOBuffer() as mocked_stderr,
contextlib.redirect_stderr(mocked_stderr),
mock.patch('argparse._sys.exit'),
):
func()
self.assertRegex(mocked_stderr.getvalue(), r'usage:')


class TestCase(unittest.TestCase):

def setUp(self):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:class:`argparse.ArgumentParser` now catches errors when writing messages, such as when :data:`sys.stderr` is ``None``. Patch by Oleg Iarygin.

0 comments on commit 42f54d1

Please sign in to comment.