Python(1)——命令行参数解析argparse

1 argparse

argparse 是 Python 内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，argparse 将会从 sys.argv 中解析出这些参数，并自动生成帮助和使用信息。
官方教程: https://docs.python.org/2/library/argparse.html#module-argparse.

基本框架：

import argparse
import sys


def main(args):
    if args.random_rotate:
        print("random_rotate")
    if args.random_crop:
        print("random_crop")


def parse_arguments(argv):
    parser = argparse.ArgumentParser(description="Demo of argparse")

    parser.add_argument('models_base_dir', type=str, default='./models/facenet',
                        help='Directory where to write trained models and checkpoints.')

    parser.add_argument('--batch_size', type=int, 
                        help='Number of images to process in a batch.')
                        
    parser.add_argument('--image_size', type=int, default=160,
                        help='Image size (height, width) in pixels.')

    parser.add_argument('--random_crop', action='store_true',
                        help='Performs random cropping of training images.')
                        
    parser.add_argument('--random_flip', type=bool, default="True",
                        help='Performs random horizontal flipping of training images.')

    parser.add_argument('--weight_decay', type=float, default=4e-5,
                        help='L2 weight regularization.')

    parser.add_argument('--optimizer', type=str, default='RMSPROP',
                        choices=['ADAGRAD', 'ADADELTA', 'ADAM', 'RMSPROP', 'MOM'],
                        help='The optimization algorithm to use')
                        
    return parser.parse_args(argv)


if __name__ == '__main__':
    main(parse_arguments(sys.argv[1:]))

以上是使用argparse模块获取命令行参数的基本框架，在编程时，可以作为标准范例来使用。该标准范例几乎涵盖了argparse的各种使用方法和技巧，下面将进行详细的讲解。

使用 argparse 的3个步骤：

• 创建 ArgumentParser() 对象
• 调用 add_argument() 方法添加参数
• 使用 parse_args() 解析添加的参数

1.1 生成参数解析器

parser = argparse.ArgumentParser(description="Demo of argparse")

先导入模块argparse，并利用argparse中的ArgumentParser类生成一个parser对象，该对象即为参数解析器，其中的可选参数description描述这个参数解析器是干什么的，当我们在命令行显示帮助信息的时候会看到description描述的信息。

1.2 添加参数

使用ArgumentParser类的add_argument()方法来添加参数，其调用形式如下：

parser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

常用参数解释如下:

• name or flags - 选项字符串的名字或者列表，例如 foo 或者 -f, --foo。
• type - 命令行参数应该被转换成的类型。例如int, str, float, bool。
• default - 不指定参数时的默认值。
• choices - 参数可允许的值的一个容器。
• action - 命令行遇到参数时的动作，默认值是 store。
• required - 可选参数是否可以省略 (仅针对可选参数)。
• help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.

下面进行多组实验，对上述参数的具体用法进行说明

1.2.1 name

import argparse
import sys

def main(args):
    print(args.models_base_dir)
    print(args.batch_size)

def parse_arguments(argv):
    parser = argparse.ArgumentParser()

    parser.add_argument('models_base_dir', type=str, default='./models/facenet',
                        help='Directory where to write trained models and checkpoints.')

    parser.add_argument('--batch_size', type=int,
                        help='Number of images to process in a batch.')

    return parser.parse_args(argv)


if __name__ == '__main__':
    main(parse_arguments(sys.argv[1:]))

在添加命令行参数时，可指定所添加的参数是否为可选参数：在参数名前有--的，表示该参数为可选参数，否则为必填参数。如上述代码中，models_base_dir为必填参数，batch_size为可选参数。

在运行程序时，必须给出必填参数，否则将报错（不管该参数是否有默认值），如运行上述代码：

python testfile.py

此时会报错：

usage: testfile.py [-h] [--batch_size BATCH_SIZE] models_base_dir
testfile.py: error: the following arguments are required: models_base_dir

上述信息显示了testfile.py的用法：[--batch_size BATCH_SIZE]是可选参数， models_base_dir是必填参数。

重新输入：

 python src/testfile.py "model_dir"

输出结果（batch_size 没有默认值，也没有给参数，所以为None）：

model_dir
None

参考资料：
[1]: python add_argument()用法解析.

2 将命令行参数保存在txt文件中

作为一个深度学习的调参下，总是需要不断的调整超参数，让模型有更好的性能，于是，我们很有必要将所用超参数保存起来，方便调参。