Python 随手记录 (6) Argparse——命令行选项、参数和子命令解析器

1、简介

argparse模块可以让人轻松编写用户友好的命令行接口。此模块是 Python 标准库中推荐的命令行解析模块。
主要也是自己学习记录，大家可以前往官方教程：argparse教程

2、举个完整例子

这是在训练神经网络时通过命令行设置参数时比较常用的一段代码。可以看到主要分三步：实例化对象；添加参数；解析对象。然后就可以通过参数对象，选择使用相应的参数。接下来，选择重要的功能系统性的介绍argparse的功能。

import argparse
def main():
    # Training settings
    # （1）实例化一个对象 
    parser = argparse.ArgumentParser(description='PyTorch MNIST Example')

    # （2）添加参数
    parser.add_argument('--batch-size', type=int, default=64, metavar='N',
                        help='input batch size for training (default: 64)')
    parser.add_argument('--test-batch-size', type=int, default=1000, metavar='N',
                        help='input batch size for testing (default: 1000)')
    parser.add_argument('--epochs', type=int, default=14, metavar='N',
                        help='number of epochs to train (default: 14)')
    parser.add_argument('--lr', type=float, default=1.0, metavar='LR',
                        help='learning rate (default: 1.0)')
    parser.add_argument('--gamma', type=float, default=0.7, metavar='M',
                        help='Learning rate step gamma (default: 0.7)')
    parser.add_argument('--no-cuda', action='store_true', default=False,
                        help='disables CUDA training')
    parser.add_argument('--seed', type=int, default=1, metavar='S',
                        help='random seed (default: 1)')
    parser.add_argument('--log-interval', type=int, default=10, metavar='N',
                        help='how many batches to wait before logging training status')

    parser.add_argument('--save-model', action='store_true', default=False,
                        help='For Saving the current Model')
    # （3）解析
    args = parser.parse_args()
    print(args)

if __name__ == '__main__':
    main()

2.5 add_argument() 方法

add_argument()可以说是argparse的核心方法，除了定义ArgumentParser()对象和解析parse_args()方法之外，这部分的参数是我们所需要掌握的。
完整方法：

ArgumentParser.add_argument(*name or flags...*[, *action*][, *nargs*][, *const*][, *default*][, *type*][, *choices*][, *required*][, *help*][, *metavar*][, *dest*])[¶](https://docs.python.org/zh-cn/3/library/argparse.html#argparse.ArgumentParser.add_argument "永久链接至目标")

常用的参数：

• name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。必选。

• action - 当参数在命令行中出现时使用的动作基本类型。制定了action="action_store"之后，参数就是True 或者 False，出现了参数名字就是True。 常用

• nargs - 命令行参数应当消耗的数目。

• const - 被一些 action 和 nargs 选择所需求的常数。

• default - 当参数未在命令行中出现时使用的值。

• type - 命令行参数应当被转换成的类型。通常在使用数字的时候需要指定 type=int/float。（常用）

• choices - 可用的参数的容器。 通过数组指定参数的范围。

• required - 此命令行选项是否可省略 （仅选项可用）。

• help - 一个此选项作用的简单描述。（常用）

• metavar - 在使用方法消息中使用的参数值示例。

3、位置参数介绍

按照命令行中参数的位置自动分配给对象。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo",help="echo the string you use here")
args = parser.parse_args()
print(args.echo)

运行程序：

#syntax01: -h --help 可以查看信息
$ python args_py.py -h
usage: args_py.py [-h] echo

positional arguments:
  echo        echo the string you use here

optional arguments:
  -h, --help  show this help message and exit

#syntax02  正常参数，指定“test_echo”，正常输出
$ python args_py.py test_echo
test_echo

##syntax03 不带参数，报错。
$ python args_py.py          
usage: args_py.py [-h] echo
args_py.py: error: the following arguments are required: echo

• 定义了一个叫echo的参数，默认必选。
• 添加help参数，显示参数的介绍。

另外比较简单的两点:

• 指定default，可以指定默认值，即使命令行中没有输入，也不会报错。
• 指定type，可以输入数字(int,float)和字符串，默认为字符串。比如你想进行计算，不指定type=int，直接计算，就会报错。看前面的例子中，大多数参数都是int、float。

4、可选参数

有些时候参数太多，我们希望可以在输入命令行的时候明确输入给那个参数，这个时候就可以使用可选参数：

• 一种是通过一个-来指定的短参数，如-h；
• 一种是通过--来指定的长参数，如--help。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v","--verbosity", help="increase output verbosity",default="2")
args = parser.parse_args()
if args.verbosity:
    print("verbosity turned on")

运行程序：

# 短参数
$ python args_py.py -v 1     
verbosity turned on

# 长参数
$ python args_py.py --verbosity 1
verbosity turned on

# 没有指定参数，报错
$ python args_py.py --verbosity  
usage: args_py.py [-h] [-v VERBOSITY]
args_py.py: error: argument -v/--verbosity: expected one argument

5、 action='store_true'

上面一个例子中，我们出现了--verbosity，但是报错了。假设我们希望只要出现了就是True，没有出现就是False，就可以使用action='store_true'命令。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v","--verbosity", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbosity:
    print("verbosity turned on")

运行程序：

# 没有指定具体的参数，可以运行，只要出现了参数的名字，就是True，否则为False
$ python args_py.py --verbosity
verbosity turned on

6、choice 选项。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print "the square of {} equals {}".format(args.square, answer)
elif args.verbosity == 1:
    print "{}^2 == {}".format(args.square, answer)
else:
    print answer

运行结果：

$ python prog.py 4 -v 0
16
$ python prog.py 4 -v 1
4^2 == 16
$ python prog.py 4 -v 2
the square of 4 equals 16

$ python prog.py 4 -v 3
usage: prog.py [-h] [-v {0,1,2}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)


$ python prog.py -h
usage: prog.py [-h] [-v {0,1,2}] square
positional arguments:
  square                display a square of a given number

optional arguments:
  -h, --help            show this help message and exit
  -v {0,1,2}, --verbosity {0,1,2}
                        increase output verbosity

指定0\1\2的时候都是正常运行，但是指定3的时候报错，因为通过choices=[0,1,2]制定了范围。

7、互斥参数 —— add_mutually_exclusive_group()方法

到目前为止，我们一直在使用 argparse.ArgumentParser 实例的两个方法。 让我们再介绍第三个方法 add_mutually_exclusive_group()。 它允许我们指定彼此相互冲突的选项。 让我们再更改程序的其余部分以便使用新功能更有意义：我们将引入 --quiet 选项，它将与 --verbose 正好相反:

import argparse

parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print(answer)
elif args.verbose:
    print("{} to the power {} equals {}".format(args.x, args.y, answer))
else:
    print("{}^{} == {}".format(args.x, args.y, answer))

运行程序：

# 两个参数都没有选择
$ python3 prog_py.py 4 2
4^2 == 16

# 选择了 -q 
$ python3 prog_py.py 4 2 -q
16

# 选择了 -v 
$ python3 prog_py.py 4 2 -v
4 to the power 2 equals 16

# 以下，同时选择-v 和 -q ，结果报错
$ python3 prog_py.py 4 2 -vq
usage: prog_py.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
$ python3 prog_py.py 4 2 -v --quiet
usage: prog_py.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose

8 后记

除了这里显示的内容，argparse 模块还提供了更多功能。 它的文档相当详细和完整，包含大量示例。