如何在需要命令行參數的腳本上使用 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()