Python 标准库之 argparse 命令行解析参数

1. 简介

argparse 模块是 Python 内置的用于命令项选项与参数解析的模块，argparse 模块可以让人轻松编写用户友好的命令行接口，能够帮助程序员为模型定义参数。

2. 使用步骤

• 导入 argparse 包 —— import argparse
• 创建一个命令行解析器对象 ——创建 ArgumentParser() 对象
• 给解析器添加命令行参数 ——调用 add_argument() 方法添加参数
• 解析命令行的参数 ——使用 parse_args() 解析添加的参数

import argparse
# 1. 定义命令行解析器对象
parser = argparse.ArgumentParser(description="usage of demo")
# 2. 添加命令行参数
parser.add_argument("--year", type=int, default=2022, help="birthday of year")
# 3. 从命令行中结构化解析参数
args = parser.parse_args()
print(vars(args))
year = args.year
print(f"year is {year}")

执行结果：

$ python demo.py -h
usage: demo.py [-h] [--year YEAR]

usage of demo

optional arguments:
  -h, --help   show this help message and exit
  --year YEAR  birthday of year

$ python demo.py 
{'year': 2022}
year is 2022

3. 参数解析

3.1 ArgumentParser

parser = argparse.ArgumentParser(description="一般用于描述程序功能")

其它参数参考：
https://docs.python.org/zh-cn/3/library/argparse.html#argumentparser-objects

3.2 add_argument

解析命令行参数

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

每个参数解释如下:

• name or flag: 普通参数或 flag参数选项参数的名称或标签，例如 epochs 或者 -e, --epochs。Flag参数不需要指定参数值，只需要带有参数名即可。
• action: 命令行遇到 flags参数时的动作。有两个常见的动作，

1. store_true：设定 flag参数为 True；
2. store_false：设定 flag参数为 False。

注意：如果直接运行程序，默认不读取该变量，要使用必须要进行传参，例如：python try.py --epochs

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

详情参考：
https://docs.python.org/zh-cn/3/library/argparse.html#the-add-argument-method

3.2.1 位置参数

import argparse

parser = argparse.ArgumentParser(description="usage of demo")
parser.add_argument("num", type=int, help="position parameter")
args = parser.parse_args()

if args.num:
    print(f"args.num is {args.num}")
print(vars(args))

参数为 -h或 --help时，parser.parse_args()会输出命令行的位置参数 position arguments和可选参数 optional arguments。

num为一个位置参数，type表示参数的类型，参数默认都是 string类型的，help表示参数的描述。

运行结果：

$ python demo.py --help
usage: demo.py [-h] num

usage of demo

positional arguments:
  num         position parameter

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

位置参数为必填，否则会报错

$ python demo.py 
usage: demo.py [-h] num
demo.py: error: the following arguments are required: num


$ python demo.py 10
args.num is 10
{'num': 10}

3.2.2 可选参数

可选参数：以 - 或 --开头，参数非必填，一般用来作条件分支。

• -n 代表短选项，在命令行输入 -n和 --num的效果是一样的，作用是简化参数输入，需要注意的是如果想通过解析后的参数取出该值，必须使用带 --的名称。
• type 代表输入的参数类型，从命令行输入的参数，默认是字符串类型。
• default 代表如果该参数不输入，则会默认使用该值。

parser.add_argument("-n", "--num", type=int, help="number of digit")
args = parser.parse_args()

if args.num:
    print(f"args.num is {args.num}")

运行结果：

$ python demo.py -n 10
args.num is 10
{'num': 10}


$ python demo.py --num 10
args.num is 10
{'num': 10}

3.2.3 参数范围

parser.add_argument("-n", "--num", type=int, choices=[1, 2, 3], help="number of digit")

运行结果：

$ python demo.py -h
usage: demo.py [-h] [-n {1,2,3}]

usage of demo

optional arguments:
  -h, --help            show this help message and exit
  -n {1,2,3}, --num {1,2,3}
                        number of digit


$ python demo.py -n 1
args.num is 1
{'num': 1}


$ python demo.py -n 10
usage: demo.py [-h] [-n {1,2,3}]
demo.py: error: argument -n/--num: invalid choice: 10 (choose from 1, 2, 3)

3.2.4 可选参数 action

• store_true

有参数时为 true，没有为 false，有参数时不能指定参数的值。

import argparse

parser = argparse.ArgumentParser(description="usage of demo")
parser.add_argument("-n", "--num", action="store_true", help="number of digit")
args = parser.parse_args()

if args.num:
    print(f"args.num is {args.num}")
print(vars(args))

执行结果：

$ python demo.py -n
args.num is True
{'num': True}


$ python demo.py --num
args.num is True
{'num': True}


# 指定参数值时会报错
$ python demo.py --num 10
usage: demo.py [-h] [-n]
demo.py: error: unrecognized arguments: 10

# 没有参数时该值为 false
$ python demo.py 
{'num': False}

• store_false

与 store_true 的情况相反。

parser.add_argument("-n", "--num", action="store_false", help="number of digit")

如果 action = store_false时，--num表明参数值设定为 false。

执行结果：

$ python demo.py 
args.num is True
{'num': True}


$ python demo.py -n
{'num': False}

3.3 parse_args

解析命令行的参数，ArgumentParser对象通过 parse_args() 方法解析命令行的参数。它将检查命令行中每个参数，转换为适当的数据类型，然后调用相应的操作，并把参数结构化后存放在对象 args中。

args = parser.parse_args()

在脚本中，通常 parse_args() 会被不带参数调用，而 ArgumentParser 将自动从 sys.argv 中确定命令行参数。