argparse的用法

news2025/1/14 18:35:45

一、使用argparse

二、参数详解

参考

一、使用argparse

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

argparse定义包括四个步骤：

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

完整代码：

import argparse

# 1.创建解释器
parser = argparse.ArgumentParser(description="可写可不写，只是在命令行参数出现错误的时候，随着错误信息打印出来。")
# 2.添加需要的参数
parser.add_argument('-l', '--loss',choices=['Adam', 'SGD'])
# 参数解释
# -l 代表短选项，在命令行输入-l和--loss的效果是一样的，作用是简化参数输入
#--loss 代表完整的参数名称，可以尽量做到让人见名知意，需要注意的是如果想通过解析后的参数取出该值，必须使用带--的名称
# choices 代表输入参数的只能是这个choices里面的内容，其他内容则会保错
parser.add_argument('--batchsize', type=int, default=8)
# 参数解释
# --batchsize 代表参数名称
# type  代表输入的参数类型，从命令行输入的参数，默认是字符串类型
# default 代表如果该参数不输入，则会默认使用该值
parser.add_argument('data_path')
# 参数解释
# 该种方式则要求必须输入该参数
# 输入该参数不需要指定参数名称，指定反而报错，解释器会自动将输入的参数赋值给data_path

# 3.进行参数解析
args = parser.parse_args()
print(args)
print(f'loss为{args.loss}')
print(f'batchsize为{args.batchsize}')
print(f'data_path为{args.data_path}')

我们通过在命令行中输入相关指令运行代码：

运行结果如下：

# 只运行python文件，不输入参数时

python main.py

提示必须要输入data_path这个必选参数，并列出的其他参入使用方式

# 当将必选参数data_path也写入命令行时

python main.py data_path E:\args -l Adam

提示，不需要键入‘data_path’，只需要键入‘data_path’的内容，argparse会自动将该内容分配给‘data_path’。

python main.py E:\args -l Adam

打印如下信息，可以看到，未给‘batchsize’分配内容时，argparse会自动调用‘batchsize’的默认值‘default=8’

二、参数详解

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

name or flags: 普通参数或flag参数选项参数的名称或标签，例如 epochs 或者 -e, --epochs。Flag参数不需要指定参数值，只需要带有参数名即可。
action: 命令行遇到flags参数时的动作。有两个常见的动作，store_true：设定flag参数为true；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 自定义参数解析