我们在写python脚本的时候，有时候需要在运行的时候传入参数，而不是写死在程序里，这个时候就要用到argparse模块。argparse 是 Python 内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，argparse 将会从sys.argv 中解析出这些参数，并自动生成帮助和使用信息。

1 使用步骤

该模块使用主要分三步：

  • 创建 ArgumentParser() 对象
  • 调用 add_argument() 方法添加参数
  • 使用 parse_args() 解析添加的参数

2 定位参数

根据以上步骤简单示例如下

# -*- coding: utf-8 -*-

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('integer', type=int, help='display an integer')
args = parser.parse_args()

print('the parameter is: ',args.integer)

将上面的代码保存为文件 argtest.py，在终端运行，结果如下：

usage: argtest.py [-h] integer
argtest.py: error: too few arguments

原因是没有给定位参数integer传递int类型的值，重新运行 python argtest.py 666，则输出如下

the parameter is:  666

3 可选参数

刚才介绍的参数是定位参数，是在运行中必须输入的参数。该模块还有一种叫可选参数，可以设置默认值，使用方法如下

# -*- coding: utf-8 -*-
import argparse
parser = argparse.ArgumentParser()
#parser.add_argument('integer', type=int, help='display an integer')
parser.add_argument('--gpu',help='GPU device id to use [0]',default=0, type=int) 
args = parser.parse_args()
print('the parameter is: ',args)

运行不同的指令效果如下

$ python3 argtest.py 
the parameter is:  Namespace(gpu=0)
$ python3 argtest.py -h
usage: argtest.py [-h] [--gpu GPU]

optional arguments:
  -h, --help  show this help message and exit
  --gpu GPU   GPU device id to use [0]
$ python3 argtest.py --gpu 1
the parameter is:  Namespace(gpu=1)

4 参数含义

在上边的方法中，我们调用了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 - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.