在pydoc中顯示argparse幫助

Question

我已經在argparse的幫助輸出中看到了顯示pydoc的問題，但是我沒有看到任何有關反轉的信息，對我而言，這似乎更有用。

有沒有辦法讓pydoc自動呈現Python程序的提要和每項幫助描述？

Answer 1

您可以使用format_help()方法訪問幫助字符串。你可以使用它來添加到你的腳本的文檔字符串。一個簡單的例子：

""" 
This is my script. 
""" 

import argparse 

def _make_parser(): 
    p = argparse.ArgumentParser() 
    p.add_argument("foo", help="Specify foo") 
    x = p.add_mutually_exclusive_group(required=True) 
    x.add_argument('--uid') 
    x.add_argument('--username') 
    return p 

_p = _make_parser() 

__doc__ += _p.format_help() 

if __name__ == '__main__': 
    args = _p.parse_args()