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