Python argparse中的metavar和action的含义

在本文中，我们将介绍Python中argparse模块中的两个重要概念：metavar和action。argparse模块是Python标准库中用于处理命令行参数的模块。通过使用argparse，我们可以轻松地解析命令行参数，并提供友好的命令行交互界面。

阅读更多：Python 教程

什么是metavar？

在argparse中，metavar用于指定参数在帮助信息中的显示形式。当定义一个参数时，我们可以通过添加metavar参数来指定参数的显示形式。metavar通常是一个字符串，表示参数的名称或占位符。

让我们通过一个示例来说明metavar的作用：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-n", "--name", metavar="FILE", help="input file name")

args = parser.parse_args()

print(args.name)

在上面的代码中，我们定义了一个名为”name”的参数，并通过metavar参数将其显示形式指定为”FILE”。当我们在命令行中执行这个脚本时，如果不提供”name”参数，则argparse会打印出如下的帮助信息：

usage: script.py [-h] [-n FILE]

optional arguments:
  -h, --help            show this help message and exit
  -n FILE, --name FILE  input file name

可以看到，帮助信息中使用metavar指定的显示形式来描述参数。

action参数的含义是什么？

在argparse中，action参数用于指定参数的行为。当定义一个参数时，我们可以通过添加action参数来指定参数的行为。action参数可以取多个不同的值，每个值都对应不同的行为。

下面是一些常见的action值及其对应的行为：

“store”：将参数值保存到args对象中的属性中，默认值为store。
“store_const”：将特定的常量值保存到args对象中的属性中。
“store_true”：将True保存到args对象中的属性中，如果命令行中不出现该参数，则为False。
“store_false”：将False保存到args对象中的属性中，如果命令行中不出现该参数，则为True。
“append”：将参数值追加到一个列表中，这样可以多次使用同一个参数，并将所有的值保存到列表中。

让我们通过一个示例来说明action的作用：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", action="store_true", help="increase output verbosity")
parser.add_argument("-l", "--list", action="append", help="list of values")

args = parser.parse_args()

if args.verbose:
    print("verbosity turned on")

if args.list:
    print("list of values:", args.list)