【python】argparse

一、argparse模块简介

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

步骤

1. 导入argparse包：import ~
2. 创建命令行解析器对象：创建==ArgumentParse（）==对象
3. 给解析器添加命令行参数：调用==add_argument()==方法添加参数
4. 解析命令行的参数：使用==parse_args()==解析添加的参数

例子

import argparse

# 1.定义命令行解析器对象
parser = argparse.ArgumentParser(description = 'Demo of argparse')  #参数可选

# 2.添加命令行参数
parser.add_argument('--epochs', type=int, default=30)
parser.add_argument('--batch', type=int, default=4)

# 3.从命令行中结构化解析参数
args = parser.parse_args()
print(args)
epochs = args.epochs
batch = args.batch
print('show {}  {}'.format(epochs, batch))

# 或者执行命令python test.py --epochs 30 --batch 4

二、参数详解

1. 添加命令行参数

给一个ArgumentParser添加程序参数信息，是通过调用add_argument()方法完成的。这些信息在parse_args()调用时被存储在ArgumentParser实例化对象中，以供后续使用。

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

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。注意：如果直接运行程序，默认不读取该变量，要使用必须要进行传参。例如：python test.py --epochs
• nargs：应该读取的命令行参数个数，
• default：不指定参数时该参数的默认值。
• type：命令行参数应该被转换成的数据类型。
• required：是否为必选参数或可选参数。
• help：参数的帮助信息。
• metavar：在usage说明中的参数名称，对于必选参数，默认就是参数名称，对于可选参数默认是全大写的参数名称。
• dest：解析后的参数名称，默认情况下，对于可选参数选取最长的名称中划线转换为下划线。
• choices：参数可允许的值的一个容器。