argparse之活学活用

argparse之活学活用

标签（空格分隔）： Python

---

tutorials:

argparse.html
Argparse Tutorial

---

Argparse Turorial

argparse是一个非常好用的输入参数解析模块，与其功能相似的还有getopt和optparse。如果你厌倦了用sys.argv[0],sys.argv[1]…获取输入参数，argparse是一个非常简单且智能的替代方案。

The basics

argparse的起手式非常简单：
prog.py

# 这段代码仅仅初始化了一个ArgumentParser对象，什么也没做。
import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

running the code：

$ python3 prog.py

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

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

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

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

以上运行结果说明：

• -h或–help：optional arguments（可选参数），而且不需要添加(add_argument)就可以使用的，用于显示帮助信息。
• –verbose，由于没有添加，所以无法识别。
• foo：positional arguments，该参数跟出现的位置有关，同样没有添加也无法识别

---

接下来分别介绍Positional arguments和Optional arguments。

Introducing Positional arguments

A example:

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

And running the code:

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

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

positional arguments:
  echo          echo the string you use here

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

$ python3 prog.py "Hello,World!"
Hello,World!

这个例子说明：

• 如果添加了positional arguments，则在调用prog.py时必须指定positional arguments。
• 指定的”Hello,World!”赋值给了echo对象。
• 可以通过help=”displayed messages”来指定帮助信息
  
  

Another example:

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)

Following is a result of running the code:

$ python3 prog.py 4
16

$ python3 prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

这个例子说明：

• 可以通过type来指定输入参数的类型

---

Introducing Optional arguments

举个例子：

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

And the output:

$ python3 main.py -v 1
verbosity turned on

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

$ python3 prog.py

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

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

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

这个例子说明：

• –verbosity或-v是可选参数，可以指定或者不指定，但一旦指定则后面必须要跟一个值。

action=”store_true”

example:

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")

And the output:

$ python3 prog.py --verbose
verbosity turned on

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

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

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

the value “store_true”. This means that, if the option is specified, assign the value True to args.verbose. Not specifying it implies False.

也就是说，如果有–verbose，则该值为True；如果没有，则该值为False

action=”count”

import argparse
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")
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)

We have introduced another action, “count”, to count the number of occurrences of a specific optional arguments:

$ python3 prog.py 4
16

$ python3 prog.py 4 -v
4^2 == 16

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

$ python3 prog.py 4 --verbosity --verbosity
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

action=”count”，可以对该参数进行计数（例如：-vv,-v -v等），可选参数后面不需接具体值。

---

Short options

通常，我们发现输入参数会有完整参数和简写参数两种形式，分别用’–’和’-‘作前缀，如下面这个例子中的”–verbose”和”-v”。

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")

And here goes:

$ python3 prog.py -v
verbosity turned on

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

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

Combining Positional and Optional arguments

下面，我们尝试将位置参数和可选参数一起混合使用。

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)

And now the output:

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

$ python3 prog.py 4
16

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

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

• 如果添加了位置参数，则必须指定位置参数。
• 位置参数和可选参数的顺序可以交换

Conflicting options

parser.add_mutually_exclusive_group(): optional arguments互斥，不能同时使用。

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

here’s the output:

$ python3 prog.py 4 2
4^2 == 16
$ python3 prog.py 4 2 -q
16
$ python3 prog.py 4 2 -v
4 to the power 2 equals 16
$ python3 prog.py 4 2 -vq
usage: prog.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
$ python3 prog.py 4 2 -v --quiet
usage: prog.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose

• [-v | -q]表明我们可以指定-v或者-q，但不能两个同时指定。

Conclusion

以上几个小节的内容，介绍argparse模块的基本用法，通过附带的实例，差不多可以应对日常使用的需要。
总结起来，主要有三个步骤：
1. 实例化：argparse.ArgumentParser
2. 添加位置参数或可选参数：add_argument
3. 提取参数：parse_args
对argparse的进一步探索，继续看下一篇。