你如何编写python模块的argparse部分的测试？

Question

我有一个使用argparse库的Python模块.如何为代码库的该部分编写测试？

Answer 1

您应该重构代码并将解析移动到函数:

def parse_args(args):
    parser = argparse.ArgumentParser(...)
    parser.add_argument...
    # ...Create your parser as you like...
    return parser.parse_args(args)

然后在你的main函数中你应该用它调用它:

parser = parse_args(sys.argv[1:])

(其中sys.argv表示脚本名称的第一个元素被删除,以便在CLI操作期间不将其作为附加开关发送.)

在测试中,您可以使用您要测试它的任何参数列表来调用解析器函数:

def test_parser(self):
    parser = parse_args(['-l', '-m'])
    self.assertTrue(parser.long)
    # ...and so on.

这样,您就不必执行应用程序的代码来测试解析器.

如果以后需要在应用程序中更改和/或向解析器添加选项,请创建工厂方法:

def create_parser():
    parser = argparse.ArgumentParser(...)
    parser.add_argument...
    # ...Create your parser as you like...
    return parser

如果需要,您可以稍后操作它,测试可能如下所示:

class ParserTest(unittest.TestCase):
    def setUp(self):
        self.parser = create_parser()

    def test_something(self):
        parsed = self.parser.parse_args(['--something', 'test'])
        self.assertEqual(parsed.something, 'test')

Answer 2

"argparse部分"有点模糊,所以这个答案集中在一个部分:parse_args方法.这是与命令行交互并获取所有传递值的方法.基本上,您可以模拟parse_args返回的内容,这样就不需要从命令行实际获取值.该mock 软件包可以通过pip安装,用于python版本2.6-3.2.unittest.mock从版本3.3开始,它是标准库的一部分.

import argparse
try:
    from unittest import mock  # python 3.3+
except ImportError:
    import mock  # python 2.6-3.2


@mock.patch('argparse.ArgumentParser.parse_args',
            return_value=argparse.Namespace(kwarg1=value, kwarg2=value))
def test_command(mock_args):
    pass

Namespace 即使它们没有被传递,你也必须包含所有命令方法的args .给那些args一个值None.(请参阅文档)此样式对于快速对每个方法参数传递不同值的情况进行测试非常有用.如果您选择在测试中模拟Namespace自身的总argparse不依赖,请确保它的行为与实际Namespace类相似.

Answer 3

使您的main()函数argv作为参数而不是默认情况下将其读取sys.argv:

# mymodule.py
import argparse
import sys


def main(args):
    parser = argparse.ArgumentParser()
    parser.add_argument('-a')
    process(**vars(parser.parse_args(args)))
    return 0


def process(a=None):
    pass

if __name__ == "__main__":
    sys.exit(main(sys.argv[1:]))

然后你可以正常测试.

import mock

from mymodule import main


@mock.patch('mymodule.process')
def test_main(process):
    main([])
    process.assert_call_once_with(a=None)


@mock.patch('foo.process')
def test_main_a(process):
    main(['-a', '1'])
    process.assert_call_once_with(a='1')

Answer 4

测试解析器的一种简单方法是：

parser = ...
parser.add_argument('-a',type=int)
...
argv = '-a 1 foo'.split()  # or ['-a','1','foo']
args = parser.parse_args(argv)
assert(args.a == 1)
...

另一种方法是修改sys.argv，并调用args = parser.parse_args()

有很多的测试的例子argparse在lib/test/test_argparse.py

Answer 5

parse_argsthrows aSystemExit并打印到 stderr，您可以同时捕获这两个：

import contextlib
import io
import sys

@contextlib.contextmanager
def captured_output():
    new_out, new_err = io.StringIO(), io.StringIO()
    old_out, old_err = sys.stdout, sys.stderr
    try:
        sys.stdout, sys.stderr = new_out, new_err
        yield sys.stdout, sys.stderr
    finally:
        sys.stdout, sys.stderr = old_out, old_err

def validate_args(args):
    with captured_output() as (out, err):
        try:
            parser.parse_args(args)
            return True
        except SystemExit as e:
            return False

您检查 stderr （使用err.seek(0); err.read()但通常不需要粒度。

现在您可以使用assertTrue或任何您喜欢的测试：

assertTrue(validate_args(["-l", "-m"]))

或者，您可能希望捕获并重新抛出不同的错误（而不是SystemExit）：

def validate_args(args):
    with captured_output() as (out, err):
        try:
            return parser.parse_args(args)
        except SystemExit as e:
            err.seek(0)
            raise argparse.ArgumentError(err.read())

Answer 6

1. 使用sys.argv.append()然后调用 填充您的arg列表parse(),检查结果并重复.
2. 使用您的标志和dump args标志从批处理/ bash文件调用.
3. 将所有参数解析放在一个单独的文件中,并在if __name__ == "__main__":调用解析中转储/评估结果,然后从批处理/ bash文件中测试它.

Answer 7

我不想修改原始的服务脚本，所以我只是sys.argv在argparse中模拟了该部分。

from unittest.mock import patch

with patch('argparse._sys.argv', ['python', 'serve.py']):
    ...  # your test code here

如果argparse实现更改但足以进行快速测试脚本，则此操作会中断。无论如何，在测试脚本中，敏感性比特异性要重要得多。