web-dev-qa-db-ja.com

argparseモジュールを使用してプログラムの使用例を出力する

私はpythonのargparseモジュールの使い方を学ぼうとしています。現在私のpythonスクリプトは:

parser = argparse.ArgumentParser(description='My first argparse attempt',
                                add_help=True)
parser.add_argument("-q", action ="store", dest='argument',
                    help="First argument")
output = parser.parse_args()

そしてそれは出力を次のように与えます:

usage: test.py [-h] [-q ARGUMENT]

My first argparse attempt

optional arguments:
  -h, --help   show this help message and exit
  -q ARGUMENT  First argument

ここで、-h or --help引数にusage exampleも出力させたいとします。お気に入り、

   Usage: python test.py -q "First Argument for test.py"

私の目的は、上記の使用例を-h引数のデフォルトの内容とともに印刷して、ユーザーがtest.py python脚本。

したがって、この機能はargparseモジュールに組み込まれていますか?この問題に取り組むための正しい方法は何ですか。

38
RanRag

使用する - parser.epilog 生成された後に何かを表示する-hテキスト。

parser = argparse.ArgumentParser(
    description='My first argparse attempt',
    epilog='Example of use')

output = parser.parse_args()

プリント:

My first argparse attempt

optional arguments:
  -h, --help  show this help message and exit

Example of use
47
georg