python的argparse模块

阅读论文的时候遇到了argparse模块，简单介绍一下它的作用和用法，以便日后学习。

argparse模块是python的一个内置模块，是用来解析命令行参数的，即传递参数用的。
在使用它的时候可以简单归纳为以下四个命令：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument()
opt = parser.parse_args()

第一个为导入argparse包；
第二个创建一个ArgumentParser对象，ArgumentParser对象包含将命令行解析成 Python 数据类型所需的全部信息；
第三个是通过调用 add_argument()方法添加参数；
第四个是通过parse_args()方法解析参数.

我们通过下面简单的例子来看看argoarse该怎能用，add_argument()传入的第一个参数是参数名，一般要在参数名前加一个--，表明该参数是可选参数，如果后面要使用该参数，直接调用args.参数名即可。

#-*- coding: UTF-8 -*-
import argparse   #步骤一

def parse_args():
    parser = argparse.ArgumentParser(description="parameters")  #步骤二
    parser.add_argument("--n_epochs", type=int, default=200, help="number of epochs of training")  #步骤三
    parser.add_argument("--batch_size", type=int, default=64, help="size of the batches")  #步骤三
    parser.add_argument("--lr", type=float, default=0.0002, help="adam: learning rate")  #步骤三
    args = parser.parse_args()  #步骤四
    return args

if __name__ == '__main__':
    args = parse_args()
    print(args)
    print(args.batch_size)

输出结果为：

Namespace(batch_size=64, lr=0.0002, n_epochs=200)
64

使用argparse模块的好处就是我们在运行该文件时不需要打开文件修改参数，直接在terminal进行修改就行。
例如我们将上述代码保存并命名为1.py，我们需要修改学习率将它改为0.2，则在terminal中的操作如下:

python 1.py --lr 0.2

可以看到输出结果为：

Namespace(n_epochs=200, batch_size=64, lr=0.2)
64

可以看到学习率已经改为了0.2。

我们需要额外留意的一个是参数action，假设我们需要一个bool型变量，默认为True，则可以用如下方法：

#-*- coding: UTF-8 -*-
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("--flag", action='store_false')
config = parser.parse_args()
print(config.flag)

在terminal中的操作如下

python 1.py

输出结果为：

True

如果我们想要它变为False，则在terminal中的操作如下：

python 1.py --flag

可以看到我们并不需要传入参数就可以得到如下输出：

False

如果我们想要默认为

---

Reference:
argparse — 命令行选项、参数和子命令解析器