python - Argparse 单元测试 : Suppress the help message

Question

我正在为 argparse 实现编写测试用例。我打算测试“-h”功能。下面的代码就是这样做的。但它也会输出脚本的用法。有没有办法抑制它？

self.assertRaises(SystemExit, arg_parse_obj.parse_known_args, ['-h'])

此外，我们可以检查抛出的异常编号吗？例如 '-h' 抛出 SystemExit: 0，而无效或不充分的参数抛出 SystemExit: 2。有没有办法检查数字代码？

Answer 1

测试异常代码时，使用 self.assertRaises() as a context manager ;这使您可以访问引发的异常，让您测试 .code 属性:

with self.assertRaises(SystemExit) as cm:
    arg_parse_obj.parse_known_args(['-h'])

self.assertEqual(cm.exception.code, 0)

要“抑制”或测试输出，您必须捕获 sys.stdout 或 sys.stderr，具体取决于 argparse 输出(帮助文本转到 stdout)。您可以为此使用上下文管理器:

from contextlib import contextmanager
from StringIO import StringIO

@contextmanager
def capture_sys_output():
    capture_out, capture_err = StringIO(), StringIO()
    current_out, current_err = sys.stdout, sys.stderr
    try:
        sys.stdout, sys.stderr = capture_out, capture_err
        yield capture_out, capture_err
    finally:
        sys.stdout, sys.stderr = current_out, current_err

并将它们用作:

with self.assertRaises(SystemExit) as cm:
    with capture_sys_output() as (stdout, stderr):
        arg_parse_obj.parse_known_args(['-h'])

self.assertEqual(cm.exception.code, 0)

self.assertEqual(stderr.getvalue(), '')
self.assertEqual(stdout.getvalue(), 'Some help value printed')

我在这里嵌套了上下文管理器，但在 Python 2.7 和更新版本中，您也可以将它们组合成一行；不过，这往往会很快超出建议的 79 个字符限制。