不通过命令行将变量分配给 argparse

Posted 2023-03-25

【中文标题】不通过命令行将变量分配给 argparse

【英文标题】：assign variables to argparse not through command line

【发布时间】：2019-10-17 09:22:23

【问题描述】：

我正在尝试为脚本编写测试（使用 pytest），但我不知道如何创建 / 将参数传递给 main()，尤其是当它不接收参数时。即使我将其更改为def main(args = None):，它也会在第一行启动它。

tests.py

def test_main(capfd):
    main()
    out, err = capfd.readouterr()
    assert out == "my expected output"

script.py

def init_parser():
    parser = argparse.ArgumentParser(description="The script searches one or \
                                     more named input files for lines \
                                     containing a match to a regular \
                                     expression pattern.")
    parser.add_argument('regex', help='the regular expression.')
    parser.add_argument('infile', nargs='*', type=argparse.FileType('r'), default=[sys.stdin],
                        help='the name of the file(s) to search.')
    group = parser.add_mutually_exclusive_group()
    group.add_argument('-u', '--underscore', action='store_true', help='prints \
                       "^" under the matching text.')
    group.add_argument('-c', '--color', action='store_true', help='highlights \
                       matching text.')
    group.add_argument('-m', '--machine', action='store_true', help='generates \
                       machine readable output.')

    return parser


def main():
    args = init_parser().parse_args()
    for file in args.infile:
        for i, line in enumerate(iter(file.readline, '')):
            for substring in re.finditer(args.regex, line):
                    if args.underscore:
                        underscore_output(file.name, i + 1, line[:-1],
                                          substring.start(), substring.end())
                    elif args.color:
                        color_output(file.name, i + 1, line[:-1],
                                     substring.group())
                    elif args.machine:
                        machine_output(file.name, i + 1, substring.start(),
                                       substring.group())
                    else:
                        print_line(file.name, i + 1, line[:-1])```

【参考方案1】：

parse_args 可以采用显式的None 参数来告诉它解析sys.argv[1:]。编写您的代码，使其易于测试：

def main(args=None):
    args = init_parser().parse_args(args)
    ...

在生产使用中，您将调用main() 让它解析sys.argv。对于测试，您将传递一组特定参数。

def test_main(capfd):
    main(['[a-z]*', 'foo.txt', '-u'])  # For example
    out, err = capfd.readouterr()
    assert out == "my expected output"

【参考方案2】：

在测试代码中，你会在调用main之前将patch输出sys.argv：

def test_main(monkeypatch):
    monkeypatch.setattr("sys.argv", ["script.py", "test_regex", "test_infile"])
    main()
    # put your assertions here