python - 如何使用具有 if __name__ == '__main__' : with arguments 的 pytest 测试 python 文件

Question

我想用 pytest 测试一个包含 if __name__ == '__main__': 的 python 文件它还在其中解析了参数。代码是这样的:

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Execute job.')

    parser.add_argument('--env', required=True, choices=['qa', 'staging', 'prod'])

    args = parser.parse_args()

    # some logic

这里的限制是我不能添加 main() 方法并将逻辑包装在 if __name__ == '__main__': 中并从那里运行它!该代码是遗留代码，无法更改!

我想用 pytest 测试这个，我想知道如何在我的测试中运行这个带有一些参数的 python 文件？

Answer 1

命令行参数是一种与其他任何输入/输出机制一样的输入/输出机制。关键是将它隔离在一个“边界层”中，让你的主程序不直接依赖它们。

在这种情况下，与其让你的程序直接访问 sys.argv(这本质上是一个全局变量)，不如让你的程序被包裹在一个“入口点”函数中(例如“main") 将 args 作为显式参数。

如果您不向 ArgumentParser.parse_args 传递任何参数，默认为您访问 sys.argv。相反，只需传递您的 args 参数即可。

它可能看起来像:

def main(args):
    # some logic
    pass

if __name__ == '__main__':
    main(sys.arv)

您的单元测试可以调用这个入口点函数并传入他们想要的任何参数:

def test_main_does_foo_when_bar():
   result = main(["bar"])
   assert "foo" == result