argparse模块使用

argparse

argparse用于编写命令行接口。argparse利用引数Argument改变程序中的变量。

示例

#videos.py
import argparse

parser = argparse.ArgumentParser(description='Videos to images')
parser.add_argument('indir', type=str, help='Input dir for videos')
parser.add_argument('outdir', type=str, help='Output dir for image')

args = parser.parse_args()

print(args.indir)

执行python video.py  /videos /images

一般步骤

1. 导入argparse模块

2. 利用argparse.ArgumentParser实例化parser对象

3. 使用add_argument方法创建变量

4. 使用parser.parse_args()解析

注意：传递变量时候，不必对/videos和/images添加引号。

位置参数

每一次调用parser.add_argument将创建一个位置参数。在python中位置参数的顺序很重要，命令行中第一个值传递给第一个

位置参数，第二个值传递给第二个位置参数。

当用户给程序提供无效参数时，argparse模块还会自动生成帮助和使用消息并发出错误。例如,直接在终端执行

python video.py将会得到错误：videos.py: error: the following arguments are required: indir, outdir.

可选参数

可选参数和位置参数的创建类似，除了他们在名字开头有'--'（或者是’-‘和一个额外的缩写字母）。例如，

你可以创建一个可选参数通过

# my_example.py
import argparse

parser = argparse.ArgumentParser(description='My example explanation')
parser.add_argument(
    '--my_optional',
    default=2,
    help='provide an integer (default: 2)'
)

my_namespace = parser.parse_args()
print(my_namespace.my_optional)

可选参数可以有默认值，执行python my_example.py输出2,执行python my_example.py --my_optional=3输出3

add_argument() 方法

add_argument() 方法定义如何解析命令行参数：

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

每个参数解释如下:

• name or flags - 选项字符串的名字或者列表，例如 foo 或者 -f, --foo。
• action - 命令行遇到参数时的动作，默认值是 store。
  • store_const，表示赋值为const；
  • append，将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
  • append_const，将参数规范中定义的一个值保存到一个列表；
  • count，存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；
• nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
• const - action 和 nargs 所需要的常量值。
• default - 不指定参数时的默认值。
• type - 命令行参数应该被转换成的类型。
• choices - 参数可允许的值的一个容器。
• required - 可选参数是否可以省略 (仅针对可选参数)。
• help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
• metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
• dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

具体示例参考https://www.jianshu.com/p/fef2d215b91d