argparse库

引言

argparse-------python用于解析命令行参数的标准模块

快速上手

import argparse                                       
parser = argparse.ArgumentParser()     创建一个命令行解析器对象                        
parser.add_argument()                  向解析器中添加命令行参数和选项               
parser.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 try.py -h

 参数解释：

  1. 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: 指定action='store_true'或者‘store_False’之后，在运行程序添加参数时直接输入变量名，可以省略对应的默认值True或者False
• nargs: 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
• default: 不指定参数时该参数的默认值。
• type: 命令行参数应该被转换成的数据类型。
• required: 是否为必选参数或可选参数。
• help: 参数的帮助信息。
• metavar： 在 usage 说明中的参数名称，对于必选参数，默认就是参数名称，对于可选参数默认是全大写的参数名称。
• dest： 自定义ArgumentParser的参数属性名称
• choices： 将命令行参数的值限定在一个范围内，超出范围则报错。
• const： action 和 nargs 所需要的常量值。用于保存不从命令行读取但被action、nargs用到的常数值.
• store_const：表示赋值为const；
• append：将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
• append_const：将参数规范中定义的一个值保存到一个列表；
• count：统计参数出现次数

2. 解析命令行的参数：parse_args()

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

args = parser.parse_args()

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

参考：

python学习(05) - argparse的使用 - 知乎 (zhihu.com)