关于python：使用argparse模块打印程序用法示例

Print program usage example with argparse module

我正在学习如何使用Python的argparse模块。目前我的python脚本是：

1
2
3
4
5

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

其输出为：

1
2
3
4
5
6
7

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。像，

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

我的目的是打印上述使用示例以及-h参数的默认内容，以便用户了解如何使用test.pypython脚本。

那么，argparse模块中是否内置了这种功能？如果不是，那么解决这个问题的正确方法是什么？

使用parser.epilog在生成的-h文本之后显示内容。

1
2
3
4
5

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

output = parser.parse_args()

印刷品：

1
2
3
4
5
6

My first argparse attempt

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

Example of use