在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()