python parser.add_argument()用法

B站视频讲解https://www.bilibili.com/video/BV1at4y1p7Um/

官方文档https://docs.python.org/zh-cn/3/library/argparse.html#argumentparser-objects

一、代码示例

'''
B站：Python图像识别
'''

import argparse

# 创建一个 ArgumentParser 对象
parser = argparse.ArgumentParser(description='yolov5')

parser.add_argument('--weights', type=str, default='best.pt', help='initial weights path')
parser.add_argument('--save', action='store_true', help='GAT with sparse version or not.')
parser.add_argument('--epochs_c', type=int, default=100, help='Number of epochs to train.')
# parser.add_argument('--epochs-c', type=int, default=10, help='Number of epochs to train.')

# 解析添加的参数
args = parser.parse_args()

print(args.weights)
print(args.save)
print(args.epochs_c)

运行结果：

使用的三个步骤：

1、创建一个解析器——创建 ArgumentParser() 对象
2、添加参数——调用 add_argument() 方法添加参数
3、解析参数——使用 parse_args() 解析添加的参数

二、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: - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

重点说明：
action='store_true’的使用说明
action·- 命令行遇到参数时的动作，默认值是 store。

直接运行python test.py，输出结果False
运行python test.py --save，输出结果True

也就是说，action=‘store_true’，只要运行时该变量有传参就将该变量设为True。

结果如下：