深度学习代码块之argparse命令行选项

0 引言

​😄今天毛毛张总结一个深度学习代码块中的一个小知识点argparse，毛毛张认为这个知识点不需要学习太深入，需要用的时候再调用就行。

1 argparse介绍

argparse模块是Python内置的一个用于命令项选项与参数解析的模块，argparse模块可以让人轻松编写用户友好的命令行接口。通过在程序中定义好我们需要的参数，然后argparse将会从sys.argv解析出这些参数。argparse模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

2 argparse使用

三个步骤：

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

import argparse
# 1.创建一个解析器 | 创建ArgumentParser()对象
parser = argparse.ArgumentParser(description='test')
# 2.添加参数 | 调用add_argument()方法添加参数
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version')
parser.add_argument('--seed', type=int, default=72, help='Random seed.')
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train.')
# 3.解析参数 | 使用parse_args()解析添加的参数
args = parser.parse_args()
print(args.sparse)
print(args.seed)
print(args.epochs)

1.创建对象

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

解释：ArgumentParser对象包含将命令行解析成Python数据类型所需的全部信息。大多数对ArgumentParser构造方法的调用都会使用description= “关键字参数“，这个参数简要描述这个程度做什么以及怎么做；在帮助消息中，这个描述会显示在命令行用法字符串和各种参数的帮助消息之间。

2.添加参数

parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version')
parser.add_argument('--seed', type=int, default=72, help='Random seed')
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train')

解释： 给一个ArgumentParser添加程序参数信息是通过调用add_argument()方法完成的。通常，这些调用指定ArgumentParser如何获取命令行字符串并将其转换为对象。这些信息在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
• default：不指定参数时的默认值
• type：命令行参数应该被转换成的类型
• choices：参数可允许的值的一个容器
• required：可选参数是否可以省略 (仅针对可选参数)
• help：用来描述获取该参数的帮助，使用-h或者–help命令可以查看帮助，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息
• dest：解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线
• append：将遇到的值存储成列表，也就是如果参数重复则会保存多个值
• append_const：将参数规范中定义的一个值保存到一个列表
• count：计数某一可选参数出现次数
• nargs：应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数
• const：action 和 nargs 所需要的常量值
• metavar：在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称

3.解析参数

args = parser.parse_args()

解释：ArgumentParser通过parse_args()方法解析参数，它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。在大多数情况下，这意味着一个简单的Namespace对象将从命令行解析出的属性构建。在脚本中，通常parse_args()会被不带参数调用，而ArgumentParser将自动从sys.argv中确定命令行参数。

3 结果测试

import argparse
parser = argparse.ArgumentParser(description='test')
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version')
parser.add_argument('--seed', type=int, default=72, help='Random seed.')
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train.')
args = parser.parse_args()
print(args.sparse)
print(args.seed)
print(args.epochs)

• 显示帮助文档：
  
• 输错命令会告诉你usage用法：
  
• 使用命令修改参数：
  
• action='store_true’的使用说明：只要运行时该变量有传参就将该变量设为True。
  

4 报错与问题

1.error: the following arguments are required: xxx

usage: test.py [-h] xxx
test.py: error: the following arguments are required: xxx

原因：

• args分为可选参数（用--指定）和必选参数（不加--指定）。
• 如果你定义参数xxx时，没有用--指定，那么该参数为需要在命令行内手动指定。此时即使通过default设置默认参数，也还是会报错。

2.下划线_和横线-的区别

Q1：第一个位置参数假如说是--max_episode_len,然后也有人写是--max-episode-len,但是他在调用的时候仍然用的是args.max_episode_len，也没报错，请问这个下划线_和-的区别在哪里呢？
A1：没啥区别，在这里表示同一个意思，-对应_，代码里写的不一样或者都改成一样的都可以

3.debug怎么进行

Q2：这种运行是不是脱离IDE，那debug怎么进行啊？
A2：有linux下，命令行单点调试的方法，python -m pdb test.py

5 完整案例

import argparse

args = argparse.ArgumentParser(description='Personal Information ', epilog='Information end ')
# 必写属性,第一位
args.add_argument("name", type=str, help="Your name")
# 必写属性,第二位
args.add_argument("birth", type=str, help="birthday")
# 可选属性,默认为None
args.add_argument("-r", '--race', type=str, dest="race", help=u"民族")
# 可选属性,默认为0,范围必须在0~150
args.add_argument("-a", "--age", type=int, dest="age", help="Your age", default=0, choices=range(150))
# 可选属性,默认为male
args.add_argument('-s', "--sex", type=str, dest="sex", help='Your sex', default='male', choices=['male', 'female'])
# 可选属性,默认为None,-p后可接多个参数
args.add_argument("-p", "--parent", type=str, dest='parent', help="Your parent", default="None", nargs='*')
# 可选属性,默认为None,-o后可接多个参数
args.add_argument("-o", "--other", type=str, dest='other', help="other Information", required=False, nargs='*')
args = args.parse_args()  # 返回一个命名空间,如果想要使用变量,可用args.attr
print("argparse.args=", args, type(args))
print('name = %s' % args.name)
d = args.__dict__
for key, value in d.iteritems():
    print('%s = %s' % (key, value))

输入命令示例：

python argv_argparse.py -h
python argv_argparse.py xiaoming 1991.11.11
python argv_argparse.py xiaoming 1991.11.11 -p xiaohong xiaohei -a 25 -r han -s female -o 1 2 3 4 5 6

6 参考文献

• https://blog.csdn.net/qq_34243930/article/details/106517985
• https://zhuanlan.zhihu.com/p/34395749
• https://zhuanlan.zhihu.com/p/133285373