python - 如何在需要命令行参数的脚本上使用 pdoc？

Question

我正在尝试使用 pdoc 来记录我的 python 脚本，但由于我的程序需要使用命令行参数，所以我遇到了问题。

我的程序调用如下：myprogram.py -p arg1 -s arg2

我尝试按如下方式运行 pdoc：pdoc --html myprogram

但我得到一个错误说pdoc: error: the following arguments are required: -p

但是，如果我尝试像这样运行 pdoc: pdoc --html myprogram.py -p arg1 -s arg2，我会收到此错误：

pdoc: error: unrecognized arguments: -p arg1 -s arg2

有没有办法在需要命令行参数的模块上运行 pdoc？

Answer 1

由于pdoc导入了文档化的模块，因此您需要将 CLI 程序的执行嵌套在一个主守卫下：

def main():
    from argparse import ArgumentParser
    parser = ArgumentParser(...)
    args = parser.parse_args()
    ...

if __name__ == '__main__':
    # Run main entry point only if the script was run as a program
    # and not if it was merely imported
    main()