argparse是 Python 标准库中推荐的命令行解析模块。它可以让人轻松编写用户友好的命令行接口。对于深度学习等需要大量更换参数的工作，它可以将参数和代码分开，让工作更加简洁。本文主要参考官方文档，并根据官方文档重新进行了一些梳理。

1 创建一个 ArgumentParser对象

import argparse
parser = argparse.ArgumentParser()

2 位置参数

位置参数：基于位置的参数。如定义一个函数def multiply(m,n), m和n就是位置参数。在argparse中，判断位置参数的方法非常简单，即不需要前缀以 - 或 -- 开头的都是位置参数

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)

我们将上述文件保存为prog.py。对于mac系统的话，假设我们将文件保存于桌面，打开终端，按照如下程序运行。若保存于别的位置可以将prog.py文件拖入终端，可以直接显示文件的绝对路径。

$ cd /Users/xxx/Desktop
$ python3 prog.py --help
usage: prog.py [-h] echo

positional arguments:
  echo

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

通过help属性我们发现，位置参数为echo，可选参数为-h，--help，实际上-h为--help的简写，这个后面会说到。

$ python3 prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo

这时我们发现程序报错。这是因为位置参数需要制定内容。我们不妨给echo随意指定一个词 'foo'

$ python3 prog.py foo
foo

接下来我们可以继续丰富echo属性的功能

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

$ python3 prog.py -h
usage: prog.py [-h] echo

positional arguments:
  echo        echo the string you use here

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

相比之前，除了位置参数和可选参数，我们还看到了对位置参数echo的描述。

接下来我们定义一些更有实际意义的属性

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)

$ python3 prog.py 4
Traceback (most recent call last):
  File "prog.py", line 13, in <module>
    print(args.square**2)
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

报错，因为程序把输入自动处理成了str，而str是不能做数值运算了，我们告诉 argparse来把这一输入视为整数

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
                    type=int)
args = parser.parse_args()
print(args.square**2)

$ python3 prog.py 4
16

3 可选参数

可选参数：在argparse中，凡是用 - 或者 -- 开头定义的命令行参数。这里有一个约定俗成的惯例：单个字母只是用一个 - ，多个字母使用两个 - （--）。对于可选参数来说，如果没有被使用的话，如就默认为None，下面我们来定义一个可选参数

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

test1

$ python3 prog.py --verbosity 1
verbosity turned on

我们给verbosity指定1，if条件判断为True

test2

$ python3 prog.py

我们没有使用verbosity属性，args.verbosity == None，if条件判断为false

test3

$ python3 prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument

我们使用了verbosity属性，但是没有给其赋值，报错

上述例子接受任何整数值作为 --verbosity 的参数，但对于我们的简单程序而言，只有两个值有实际意义：True 或者 False。让我们据此修改代码：

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

现在指定了一个新的关键词 action，并赋值为 "store_true"。这意味着，当这一选项存在时，为 args.verbose 赋值为 True。没有指定时则隐含地赋值为 False

test1

$ python3 prog.py --verbose
verbosity turned on

test2

$ python3 prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1

给verbose指定了具体的值报错

test3

$ python3 prog.py --help
usage: prog.py [-h] [--verbose]

optional arguments:
  -h, --help  show this help message and exit
  --verbose   increase output verbosity

4 短选项

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

这里-v为--verbose的缩写，

$ python3 prog.py -v
verbosity turned on

我们通过-v也可以调用verbose属性

$ python3 prog.py --help
usage: prog.py [-h] [-v]

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity

5 结合位置参数和可选参数

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number") #增加一个位置参数
parser.add_argument("-v", "--verbose", action="store_true",
                    help="increase output verbosity") #增加一个可选参数
args = parser.parse_args()
answer = args.square**2
if args.verbose:
    print("the square of {} equals {}".format(args.square, answer))
else:
    print(answer)

test1

$ python3 prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square

没有给位置参数square指定值

test2

$ python3 prog.py 4
16

没有使用可选参数，位置参数传入4

test3

$ python3 prog.py 4 --verbose
the square of 4 equals 16

使用了可选参数verbose，位置参数square为4

test4

$ python3 prog.py --verbose 4
the square of 4 equals 16

改变传入参数的顺序，结果不变
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

假设我们想限定verbose的输入选择

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") #这里我们限定verbose只接受三个input：0 , 1, 2
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)

test

$ python3 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)

给verbose传入3程序报错

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
我们引入了另一种动作 count，来数某一个可选参数出现了几次

parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display the square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity") #这里action从store_ture变成了count
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)

$ python3 prog.py 4 #0次
16
$ python3 prog.py 4 -v #1次
4^2 == 16
$ python3 prog.py 4 -vv #2次
the square of 4 equals 16
$ python3 prog.py 4 --verbosity --verbosity #2次
the square of 4 equals 16
$ python3 prog.py 4 -v 1
usage: prog.py [-h] [-v] square
prog.py: error: unrecognized arguments: 1
$ python3 prog.py 4 -h
usage: prog.py [-h] [-v] square

positional arguments:
  square           display a square of a given number

optional arguments:
  -h, --help       show this help message and exit
  -v, --verbosity  increase output verbosity
$ python3 prog.py 4 -vvv #三次
16

对于上述程序做进一步改进，我们想统计所有大于等于0的次数

parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2

# bugfix: replace == with >=
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)

$ python3 prog.py 4 -vvv
the square of 4 equals 16
$ python3 prog.py 4 -vvvv
the square of 4 equals 16
$ python3 prog.py 4
Traceback (most recent call last):
  File "prog.py", line 11, in <module>
    if args.verbosity >= 2:
TypeError: '>=' not supported between instances of 'NoneType' and 'int'

我们看到最后一次报错，这是因为不使用verbosity属性的话默认值是None，而None是不能进行数值比较的，所以不妨令不使用verbosity的默认值为0

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count", default=0,
                    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)

再次测试

$ python3 prog.py 4
16

Reference：
[https://docs.python.org/zh-cn/3/library/argparse.html]
[https://docs.python.org/zh-cn/3/howto/argparse.html]

Argparse入门

Argparse入门

1 创建一个 ArgumentParser对象

2 位置参数

3 可选参数

4 短选项

5 结合位置参数和可选参数