使用argparse模块打印程序用法示例

时间:2012-06-07 11:11:03

标签: python 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模块中。如果不是解决这个问题的正确方法。

1 个答案:

答案 0 :(得分:41)

使用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