如何重构使用argparse在另一个Python脚本中可调用的脚本？

Question

我有一个脚本找到测试名称,并在我们公司广泛使用.它在命令行上运行,如下所示:

find_test.py --type <type> --name <testname>

在脚本内部相当于:

import argparse

parser = argparse.ArgumentParser(description='Get Test Path')
parser.add_argument('--type',      dest='TYPE',      type=str,            default=None,  help="TYPE [REQUIRED]")
parser.add_argument('--name',      dest='test_name', type=str,            default=None,  help="Test Name (Slow)")
parser.add_argument('--id',        dest='test_id',   type=str,            default=None,  help="Test ID (Fast)")
parser.add_argument('--normalise', dest='normalise', action="store_true", default=False, help="Replace '/' with '.' in Test Name")
args = parser.parse_args()

(不确定所有这些论点的作用,我个人只使用前两个).然后,这些行由使用这些参数的代码继续.

我想重构这个脚本,以便我可以将其作为模块导入,但也保留其命令行功能 - 因为很多人使用这个脚本,并且在我们的一些csh脚本中也调用它.

到目前为止我已经重构了它,就像这样:

def _main():
    <all the former code that was in find_test.py>

if __name__ == "__main__":
    _main()

这仍然可以从命令行运行.但我不知道如何在我的父脚本中将相关开关的参数传递给它.

如何进一步重构,然后在父脚本中调用它？这可能吗？

我也不愿意使用我读过的docopts是新的argparse,除非必要 - 即不能用argparse完成,因为它没有在公司范围内安装,这可能是一个艰巨的过程.

Answer 1

您不应该只是将所有代码直接移至函数中；而是应该将所有代码直接移至函数中。那根本没有帮助。

您应该做的是将需要运行任何发生的事情的代码移动到函数中。（并且由于它是外部接口，所以它不应该以 开头_。）只需要从命令行运行的代码（即解析器内容）应该保留在__name__ == '__main__'块中，并且应该将其结果传递给main()。

所以：

def main(TYPE, test_name, test_id=None, normalise=False):
    # ... body of script...

if __name__ == "__main__":
    parser = ...
    ...
    args = parser.parse_args()
    main(**vars(args))

（docopt 并不是什么新东西；它是一些人喜欢的外部库。）