python - pydoc 内で argparse ヘルプを表示します

Question

argparse のヘルプの出力に pydoc を表示することについての質問を見たことがありますが、その逆については何も見ていません。

Python プログラムの概要と項目ごとのヘルプの説明を pydoc に自動的にレンダリングさせる方法はありますか?

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