python第三方库-argparse的使用（简单实用）

前言

argparse 模块是 Python 内置的一个用于命令项选项与参数解析的模块，argparse 模块可以让人轻松编写用户友好的命令行接口。

argparse能够帮助程序员为模型定义参数、通过sys.argv 解析命令行参数。模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

安装

直接按照python第三方库的安装方法
用 pip install argparse 命令安装

argparse 三个步骤

创建命令行解析器对象 – 创建 ArgumentParser() 对象

parser = argparse.ArgumentParser(description='test')
1

给解析器添加命令行参数 --调用add_argument() 方法添加参数

通过调用 add_argument() 方法给ArgumentParser() 对象添加程序参数信息
通常，这些调用指定 ArgumentParser 如何获取命令行字符串并将其转换为对象。
这些信息在 parse_args() 调用时被存储在ArgumentParser实例化对象中，以供后续使用。

参数解释：

1. name or flags：普通参数或flag参数选项参数的名称或标签，例如 foo 或者 -f, --foo。Flag参数不需要指定参数值，只需要带有参数名即可
2. action： 命令行遇到flags参数时的动作。有两个常见的动作，store_true：设定flag参数为true；store_false：设定flag参数为False
3. nargs：应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数
4. default：不指定参数时该参数的默认值
5. type：命令行参数应该被转换成的数据类型
6. required：是否为必选参数或可选参数
7. help：参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息
8. metavar：在 usage 说明中的参数名称，对于必选参数，默认就是参数名称，对于可选参数默认是全大写的参数名称
9. dest：解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线
10. choices：参数可允许的值的一个容器
11. const： action 和 nargs 所需要的常量值
12. store_const：表示赋值为const
13. append：将遇到的值存储成列表，也就是如果参数重复则会保存多个值
14. append_const：将参数规范中定义的一个值保存到一个列表
15. count：存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析

解析命令行的参数 --使用 parse_args() 解析添加的参数

检查命令行中每个参数，转换为适当的数据类型，然后调用相应的操作，并把参数结构化后存放在对象args中

args = parser.parse_args()
1

代码示例

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-t", "--timer_name", help="timer name")
parser.add_argument("-p", "--project", help="project name")
parser.add_argument('-s', '--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
parser.add_argument('-d', '--seed', type=int, default=72, help='Random seed.')
parser.add_argument('-e', '--epochs', type=int, default=10000, help='Number of epochs to train.')

args = parser.parse_args()
print(args.timer_name)
print(args.sparse)
print(args.seed)
print(args.epochs)
1
2
3
4
5
6
7
8
9
10
11
12
13
14