如何设置sys.argv以便对其进行单元测试？

Question

我想设置

sys.argv

所以我可以用不同的组合进行单元测试.以下不起作用:

#!/usr/bin/env python
import argparse, sys
def test_parse_args():
    global sys.argv
    sys.argv = ["prog", "-f", "/home/fenton/project/setup.py"]
    setup = get_setup_file()
    assert setup == "/home/fenton/project/setup.py"
def get_setup_file():
    parser = argparse.ArgumentParser()
    parser.add_argument('-f')
    args = parser.parse_args()
    return args.file
if __name__ == '__main__':
    test_parse_args()

然后运行文件:

pscripts % ./test.py                                                                                           
  File "./test.py", line 4
    global sys.argv
              ^
SyntaxError: invalid syntax
pscripts %  

Answer 1

在运行时更改sys.argv是一种非常脆弱的测试方法.您应该使用mock的补丁功能,它可以用作上下文管理器,在给定的代码块中将一个对象(或属性,方法,函数等)替换为另一个对象.

以下示例用于patch()有效地"替换" sys.argv指定的返回值(testargs).

try:
    # python 3.4+ should use builtin unittest.mock not mock package
    from unittest.mock import patch
except ImportError:
    from mock import patch

def test_parse_args():
    testargs = ["prog", "-f", "/home/fenton/project/setup.py"]
    with patch.object(sys, 'argv', testargs):
        setup = get_setup_file()
        assert setup == "/home/fenton/project/setup.py"

Answer 2

global仅公开全局变量的模块内,并且sys.argv是在sys,不是你的模块.而不是使用global sys.argv,使用import sys.

但是,您可以完全避免更改sys.argv:只需get_setup_file选择一个参数列表(默认为None)并将其传递给parse_args.当get_setup_file被称为不带参数,这样的说法会None,并且parse_args将回落到sys.argv.当使用列表调用它时,它将用作程序参数.

Answer 3

我喜欢用unittest.mock.patch(). 不同之处在于patch.object()，您不需要直接引用要修补的对象，而是使用字符串。

from unittest.mock import patch

with patch("sys.argv", ["file.py", "-h"]):
    print(sys.argv)

Answer 4

test_argparse.py，官方的argparseunittest文件，使用几种设置/使用方法argv：

parser.parse_args(args)

其中args是“单词”的列表，例如['--foo','test']或--foo test'.split()。

old_sys_argv = sys.argv
sys.argv = [old_sys_argv[0]] + args
try:
    return parser.parse_args()
finally:
    sys.argv = old_sys_argv

这将args推到sys.argv。

我刚刚遇到一个案例（使用mutually_exclusive_groups），该案例['--foo','test']产生的行为不同于'--foo test'.split()。这是一个涉及id诸如的字符串的微妙之处test。

Answer 5

它不起作用，因为你实际上并没有打电话get_setup_file。您的代码应为：

import argparse

def test_parse_args():
    sys.argv = ["prog", "-f", "/home/fenton/project/setup.py"]
    setup = get_setup_file()  # << You need the parentheses
    assert setup == "/home/fenton/project/setup.py"