【教程搬运】读懂github上的工程代码——带你熟悉Python中的Parser

我们经常会遇到类似于这样的训练命令，里面用“–”指定了很多option的名称和数值，例如python test.py --dataroot ./datasets/facades --name facades_pix2pix --model pix2pix --direction BtoA，如果要编写出这样的命令，就不得不用到一个叫Argparse的包，让我们来看看它是如何使用的。教程链接如下https://www.jb51.net/article/212035.htm，我来详细说明这个教程里的问题。

更为详细的说明文档在这里，但是也没必要把这个教程看一遍，需要的时候去查阅就可以了。https://docs.python.org/zh-cn/3/library/argparse.html

1.导入包

调用这个包的第一步永远是导入，所以代码如下：

import argparse

2.实例化ArgumentParser

# 实例化
# 创建一个 ArgumentParser 对象
# ArgumentParser 对象包含将命令行解析成 Python 数据类型所需的全部信息。
parser = argparse.ArgumentParser(description = 'test')

description里头写的是一些描述信息。这一点不难理解。这个参数简要描述这个程序做什么以及怎么做。在帮助消息中，这个描述会显示在命令行用法字符串和各种参数的帮助消息之间。

3.使用add_argument函数添加参数

我们首先看三行的样例：

parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
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(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])。
我们解释如下：

• name or flags
  这是选项字符串的名字或者列表，也就是命令行里头两个减号“- -”之后的部分。
• action
  命令行遇到参数时的动作，默认值是 store_true，什么意思呢？就是如果出发了前方name or flags里头的关键字，那么这个地方就会被显示为true，比方说parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')，之恩要我后面的命令是python xx.py --sparse，好了，触发了sparse，此处立刻变为true。
• type
  命令行参数应该被转换成的类型。
• choices
  参数可允许的值的一个容器，也就是说，参数只能取这些值。
• default
  不指定参数时的默认值。
• required
  可选参数是否可以省略 (仅针对可选参数)。

下面这些相比之下就不那么常见了。

• store_const
  表示赋值为const。
• append
  将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
• append_const
  将参数规范中定义的一个值保存到一个列表；
• count
  存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；
• nargs
  应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default—对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
• const
  action 和 nargs 所需要的常量值。
• help
  参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
• metavar
  在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
• dest
  解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

4.使用parse_args解析参数

ArgumentParser 通过 parse_args() 方法解析参数。它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。

# 解析参数
args = parser.parse_args()

这个时候，我们就可以看看下面例子，怎么样，懂了么？

#导入包
import argparse
#实例化
parser = argparse.ArgumentParser(description='test')
#添加选项（比如本例子中是添加了3个）
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
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)
'''
False
72
10000
'''