PYTHON2.7 中文手册翻译：Argparse从入门到精通

最新推荐文章于 2024-04-22 21:20:57 发布
最新推荐文章于 2024-04-22 21:20:57 发布
阅读量824 收藏 1
点赞数
分类专栏： python语言 文章标签： python argparse howto

本文主要介绍python标准库中推荐的命令行解析模块argparse。本文主要针对 Python 3. 所以和python 2.x会有一些细节上的差异, 特别对于一些在python 3.x中得到改进的exception消息方面.

 

本文收录在我的博客，欢迎访问： http://www.sskywatcher.com/blog/

 

Note

 

还有两个类似功能的模块, 分别是getopt(类似C语言中的getopt()) 和optparse。其实argparse是基于optparse, 所以这两个模块的用法很相似。

概念

我们首先用LS命令做一个实例，来看一下本中即将介绍的一系列功能:

$ ls
cpython  devguide  prog.py  pypy  rm-unused-function.patch
$ ls pypy
ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide
-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy
-rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.
...

以上四个命令中我们可以了解一些概念:

  • ls没有任何参数时，ls命令依然可以发挥作用。 I默认显示该目录中所有上下文。
  • 如果想让ls干一些超出默认功能的活，那么必须给ls更新的信息。比如我想让他显示一个其他目录pypy。只需要指定一个位置参数（position argument）。之所以叫位置参数是纯粹根据他在命令行中出现的位置，程序即可知道怎么处理这个参数。在一些其他的命令中这话中阐述具有更加重大的意义，比如cp, 它的基本用法即为：cp SRC DEST。第一个参数表示你想拷贝的，第二个位置参数指定你需要拷贝到哪里去。
  • 我们让系统显示每个文件的更多信息，而不是仅仅列出文件名。-l 参数被称为一个可选参数（optional argument）。
  • 这是帮助信息的片段节选.。当你偶然遇到一个以前从未用过的程序时这非常有用, 通过阅读帮助即可简单了解这个程序如何工作。

基础用法

首先来一个基本不做任何事情的实例:

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

执行结果:

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

optional arguments:
  -h, --help  show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo

Here is what is happening:

  • 不带任何参数执行这个脚本时，标准输出没有任何内容。
  • 第二个命令即可发现argparse的一些用处。即什么都不用做，即可让你获得一个漂亮的帮助界面
  • --help选项, 也可用用段选项-h, 是唯一一个不需要做任何代码即可实现的功能。指定任何其他的参数执行该脚本都会报错。

位置参数（Positional arguments）

例子:

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

执行结果:

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

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit
$ python prog.py foo
foo

解释一下:

  •  add_argument() 指定该命令行将会接受的参数。 这里指定了一个参数名为 echo 。
  • 执行该程序将会需要指定一个参数。
  • parse_args() 方法会精确返回参数的值, 此例中即返回echo。
  • 这是一个 argparse 内建支持的‘magic’类型变量(i.e. 无需指定变量来存储参数值)。你应该注意到 参数的名字 matches the string argument given to the method, echo.

修改help信息使其更有用:

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

执行结果:

$ python 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

尝试一些更有用的操作:

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

执行结果出错了!

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

 argparse 将会默认将参数传来的值作为strings处理, 除非我们指定它作为其他类型。接下来使用 argparse 将参数值作为int类型处理:

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

执行结果:

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

OK！

可选参数（Optional arguments）

接下来看看如何添加一个可选参数:

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

执行结果:

$ python prog.py --verbosity 1
verbosity turned on
$ python prog.py
$ python prog.py --help
usage: prog.py [-h] [--verbosity VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  --verbosity VERBOSITY
                        increase output verbosity
$ python prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument

解释一下:

  • 这么编写程序是为了让他在指定 --verbosity 参数显示一些信息，没有指定时则不显示。
  • 即使没加这个参数也可以执行这个程序并没有任何报错，可以确定这确实一个可选参数。默认情况下，当一个可选参数没有被使用时, 他的相关变量 args.verbosity,将会使用 None 作为值,从代码中if语句判断的结果我们可以得出该结论。
  • 注意帮助信息的变化。
  • 使用 --verbosity 选项时, 你必须指定一个任意值。

上面例子中参数--verbosity接受任意值，但是实际中我们只接受两个可用的参数值，比如True or 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"

执行结果:

$ python prog.py --verbose
verbosity turned on
$ python prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1
$ python prog.py --help
usage: prog.py [-h] [--verbose]

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

 

  • 这个选项相对于参数来说更像一个flag。 应该是用一个更贴近这种性质的参数名，比如 action，并 将其设置为 "store_true"。 这么做的后果是：当你写带该参数，那么将会将args.verbose赋值为True. 反之则赋值为False.
  • 注意帮助信息的变化。

短选项（short options）

例子:

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"

执行结果:

$ python prog.py -v
verbosity turned on
$ python prog.py --help
usage: prog.py [-h] [-v]

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

以上实现了同时指定 长选项名和短选项名。

结合位置参数和可选参数

我们的示例程序的复杂度进一步提升了:

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

来看一看执行结果:

$ python prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python prog.py 4
16
$ python prog.py 4 --verbose
the square of 4 equals 16
$ python prog.py --verbose 4
the square of 4 equals 16
  • 以上程序指定了一个位置参数，一个可选参数。
  • 执行命令时参数的顺序不影响。

下来我们赋予程序拥有多种详细值得能力:

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,
                    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
16
$ python prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ 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
16

注意下当-v的值为3的时候, 这是程序的一个bug。如何让改善呢？现在我们通过add_argument()方法的choices入参来限制参数可用的值范围。 

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

注意一下，我们的修改同时影响出错信息和帮助信息。

接下来，我们学习一个新的花样，使用 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

执行结果

$ python prog.py 4
16
$ python prog.py 4 -v
4^2 == 16
$ python prog.py 4 -vv
the square of 4 equals 16
$ python prog.py 4 --verbosity --verbosity
the square of 4 equals 16
$ python prog.py 4 -v 1
usage: prog.py [-h] [-v] square
prog.py: error: unrecognized arguments: 1
$ python 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
$ python prog.py 4 -vvv
16
  • 比起上个版本这个参数更加像一个flag (类似action="store_true")；
  • 该方法的实现效果有点类似“store_true” action；
  • 和“store_true” action一样如果你没有指定-v flag,这个参数将被赋予None；
  • 使用参数的长选项模式，可以得到一样的结果；
  • 帮助信息并不能自动的更新这种新的用法, 我们可以修改代码来完善帮助信息（使用help关键字).
  • 最后一种调用方式图片那个样暴露了程序没有对超过预定次数重复制定该参数的处理方式的bug。

修复:

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

执行:

$ python prog.py 4 -vvv
the square of 4 equals 16
$ python prog.py 4 -vvvv
the square of 4 equals 16
$ python prog.py 4
Traceback (most recent call last):
  File "prog.py", line 11, in <module>
    if args.verbosity >= 2:
TypeError: unorderable types: NoneType() >= int()
  • 修复的方式是当value >= 2 选用同样的输出；
  • 新的bug，没有对不指定该flag的处理方式

修复:

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

使用一个新的关键字default。将其设置为0， 使其可以和其他整型值作比较。请记住，在阐述没有指定值的时候，他将被默认赋值为None, 这将导致没法和整型值作比较操作（将会产生TypeError exception).

现在再看一下:

$ python prog.py 4
16

到这里，你已经可用argparse做很多事呢。除了这些基础的只是，本文还将继续讨论一些argparse深层次的用法。 

再次深入

再次扩展我们的程序，添加一些其他的功能:

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print "{} to the power {} equals {}".format(args.x, args.y, answer)
elif args.verbosity >= 1:
    print "{}^{} == {}".format(args.x, args.y, answer)
else:
    print answer

执行:

$ python prog.py
usage: prog.py [-h] [-v] x y
prog.py: error: the following arguments are required: x, y
$ python prog.py -h
usage: prog.py [-h] [-v] x y

positional arguments:
  x                the base
  y                the exponent

optional arguments:
  -h, --help       show this help message and exit
  -v, --verbosity
$ python prog.py 4 2 -v
4^2 == 16

注意，到现在我怕们都是使用verbosity的等级来改变输出文本的格式。接下来将会使用不同的verbosity等级来改变输出的内容:

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print "Running '{}'".format(__file__)
if args.verbosity >= 1:
    print "{}^{} ==".format(args.x, args.y),
print answer

执行以下:

$ python prog.py 4 2
16
$ python prog.py 4 2 -v
4^2 == 16
$ python prog.py 4 2 -vv
Running 'prog.py'
4^2 == 16

冲突选项

以上我们已经讨论了argparse.ArgumentParser 其中的2个方法。接下来学习第三个方法add_mutually_exclusive_group()。I这个方法用来让用户指定各个选项之间的冲突关系.。现在修改代码让大家更直观地认识到这个方法的作用。

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

执行:

$ python prog.py 4 2
4^2 == 16
$ python prog.py 4 2 -q
16
$ python prog.py 4 2 -v
4 to the power 2 equals 16
$ python 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
$ python 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

注意几种不同的调用方式，无论是分别同时指定短选项还是混合长选项和短选项，程序都可以正常工作.

在初始化ArgumentParser类实例时，加入description参数可以在程序中添加信息告知用户关于该程序的主要信息。

示例:

import argparse

parser = argparse.ArgumentParser(description="calculate X to the power of Y")
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)

注意usage信息。用法中指出了 [-v | -q]，这就是说明用户可以指定-v或者-q，但是却不能同时指定:

$ python prog.py --help
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet

总结

  argparse 提供了远比上文丰富的特性。本文仅仅是一个基础使用的教程。

Note

 

还有两个类似功能的模块, 分别是getopt(类似C语言中的getopt()) 和optparse。其实argparse是基于optparse, 所以这两个模块的用法很相似。

概念

我们首先用LS命令做一个实例，来看一下本中即将介绍的一系列功能:

$ ls
cpython  devguide  prog.py  pypy  rm-unused-function.patch
$ ls pypy
ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide
-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy
-rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.
...

以上四个命令中我们可以了解一些概念:

  • ls没有任何参数时，ls命令依然可以发挥作用。 I默认显示该目录中所有上下文。
  • 如果想让ls干一些超出默认功能的活，那么必须给ls更新的信息。比如我想让他显示一个其他目录pypy。只需要指定一个位置参数（position argument）。之所以叫位置参数是纯粹根据他在命令行中出现的位置，程序即可知道怎么处理这个参数。在一些其他的命令中这话中阐述具有更加重大的意义，比如cp, 它的基本用法即为：cp SRC DEST。第一个参数表示你想拷贝的，第二个位置参数指定你需要拷贝到哪里去。
  • 我们让系统显示每个文件的更多信息，而不是仅仅列出文件名。-l 参数被称为一个可选参数（optional argument）。
  • 这是帮助信息的片段节选.。当你偶然遇到一个以前从未用过的程序时这非常有用, 通过阅读帮助即可简单了解这个程序如何工作。

基础用法

首先来一个基本不做任何事情的实例:

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

执行结果:

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

optional arguments:
  -h, --help  show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo

Here is what is happening:

  • 不带任何参数执行这个脚本时，标准输出没有任何内容。
  • 第二个命令即可发现argparse的一些用处。即什么都不用做，即可让你获得一个漂亮的帮助界面
  • --help选项, 也可用用段选项-h, 是唯一一个不需要做任何代码即可实现的功能。指定任何其他的参数执行该脚本都会报错。

位置参数（Positional arguments）

例子:

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

执行结果:

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

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit
$ python prog.py foo
foo

解释一下:

  •  add_argument() 指定该命令行将会接受的参数。 这里指定了一个参数名为 echo 。
  • 执行该程序将会需要指定一个参数。
  • parse_args() 方法会精确返回参数的值, 此例中即返回echo。
  • 这是一个 argparse 内建支持的‘magic’类型变量(i.e. 无需指定变量来存储参数值)。你应该注意到 参数的名字 matches the string argument given to the method, echo.

修改help信息使其更有用:

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

执行结果:

$ python 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

尝试一些更有用的操作:

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

执行结果出错了!

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

 argparse 将会默认将参数传来的值作为strings处理, 除非我们指定它作为其他类型。接下来使用 argparse 将参数值作为int类型处理:

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

执行结果:

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

OK！

可选参数（Optional arguments）

接下来看看如何添加一个可选参数:

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

执行结果:

$ python prog.py --verbosity 1
verbosity turned on
$ python prog.py
$ python prog.py --help
usage: prog.py [-h] [--verbosity VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  --verbosity VERBOSITY
                        increase output verbosity
$ python prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument

解释一下:

  • 这么编写程序是为了让他在指定 --verbosity 参数显示一些信息，没有指定时则不显示。
  • 即使没加这个参数也可以执行这个程序并没有任何报错，可以确定这确实一个可选参数。默认情况下，当一个可选参数没有被使用时, 他的相关变量 args.verbosity,将会使用 None 作为值,从代码中if语句判断的结果我们可以得出该结论。
  • 注意帮助信息的变化。
  • 使用 --verbosity 选项时, 你必须指定一个任意值。

上面例子中参数--verbosity接受任意值，但是实际中我们只接受两个可用的参数值，比如True or 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"

执行结果:

$ python prog.py --verbose
verbosity turned on
$ python prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1
$ python prog.py --help
usage: prog.py [-h] [--verbose]

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

 

  • 这个选项相对于参数来说更像一个flag。 应该是用一个更贴近这种性质的参数名，比如 action，并 将其设置为 "store_true"。 这么做的后果是：当你写带该参数，那么将会将args.verbose赋值为True. 反之则赋值为False.
  • 注意帮助信息的变化。

短选项（short options）

例子:

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"

执行结果:

$ python prog.py -v
verbosity turned on
$ python prog.py --help
usage: prog.py [-h] [-v]

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

以上实现了同时指定 长选项名和短选项名。

结合位置参数和可选参数

我们的示例程序的复杂度进一步提升了:

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

来看一看执行结果:

$ python prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python prog.py 4
16
$ python prog.py 4 --verbose
the square of 4 equals 16
$ python prog.py --verbose 4
the square of 4 equals 16
  • 以上程序指定了一个位置参数，一个可选参数。
  • 执行命令时参数的顺序不影响。

下来我们赋予程序拥有多种详细值得能力:

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,
                    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
16
$ python prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ 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
16

注意下当-v的值为3的时候, 这是程序的一个bug。如何让改善呢？现在我们通过add_argument()方法的choices入参来限制参数可用的值范围。 

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

注意一下，我们的修改同时影响出错信息和帮助信息。

接下来，我们学习一个新的花样，使用 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

执行结果

$ python prog.py 4
16
$ python prog.py 4 -v
4^2 == 16
$ python prog.py 4 -vv
the square of 4 equals 16
$ python prog.py 4 --verbosity --verbosity
the square of 4 equals 16
$ python prog.py 4 -v 1
usage: prog.py [-h] [-v] square
prog.py: error: unrecognized arguments: 1
$ python 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
$ python prog.py 4 -vvv
16
  • 比起上个版本这个参数更加像一个flag (类似action="store_true")；
  • 该方法的实现效果有点类似“store_true” action；
  • 和“store_true” action一样如果你没有指定-v flag,这个参数将被赋予None；
  • 使用参数的长选项模式，可以得到一样的结果；
  • 帮助信息并不能自动的更新这种新的用法, 我们可以修改代码来完善帮助信息（使用help关键字).
  • 最后一种调用方式图片那个样暴露了程序没有对超过预定次数重复制定该参数的处理方式的bug。

修复:

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

执行:

$ python prog.py 4 -vvv
the square of 4 equals 16
$ python prog.py 4 -vvvv
the square of 4 equals 16
$ python prog.py 4
Traceback (most recent call last):
  File "prog.py", line 11, in <module>
    if args.verbosity >= 2:
TypeError: unorderable types: NoneType() >= int()
  • 修复的方式是当value >= 2 选用同样的输出；
  • 新的bug，没有对不指定该flag的处理方式

修复:

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

使用一个新的关键字default。将其设置为0， 使其可以和其他整型值作比较。请记住，在阐述没有指定值的时候，他将被默认赋值为None, 这将导致没法和整型值作比较操作（将会产生TypeError exception).

现在再看一下:

$ python prog.py 4
16

到这里，你已经可用argparse做很多事呢。除了这些基础的只是，本文还将继续讨论一些argparse深层次的用法。 

再次深入

再次扩展我们的程序，添加一些其他的功能:

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print "{} to the power {} equals {}".format(args.x, args.y, answer)
elif args.verbosity >= 1:
    print "{}^{} == {}".format(args.x, args.y, answer)
else:
    print answer

执行:

$ python prog.py
usage: prog.py [-h] [-v] x y
prog.py: error: the following arguments are required: x, y
$ python prog.py -h
usage: prog.py [-h] [-v] x y

positional arguments:
  x                the base
  y                the exponent

optional arguments:
  -h, --help       show this help message and exit
  -v, --verbosity
$ python prog.py 4 2 -v
4^2 == 16

注意，到现在我怕们都是使用verbosity的等级来改变输出文本的格式。接下来将会使用不同的verbosity等级来改变输出的内容:

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print "Running '{}'".format(__file__)
if args.verbosity >= 1:
    print "{}^{} ==".format(args.x, args.y),
print answer

执行以下:

$ python prog.py 4 2
16
$ python prog.py 4 2 -v
4^2 == 16
$ python prog.py 4 2 -vv
Running 'prog.py'
4^2 == 16

冲突选项

以上我们已经讨论了argparse.ArgumentParser 其中的2个方法。接下来学习第三个方法add_mutually_exclusive_group()。I这个方法用来让用户指定各个选项之间的冲突关系.。现在修改代码让大家更直观地认识到这个方法的作用。

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

执行:

$ python prog.py 4 2
4^2 == 16
$ python prog.py 4 2 -q
16
$ python prog.py 4 2 -v
4 to the power 2 equals 16
$ python 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
$ python 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

注意几种不同的调用方式，无论是分别同时指定短选项还是混合长选项和短选项，程序都可以正常工作.

在初始化ArgumentParser类实例时，加入description参数可以在程序中添加信息告知用户关于该程序的主要信息。

示例:

import argparse

parser = argparse.ArgumentParser(description="calculate X to the power of Y")
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)

注意usage信息。用法中指出了 [-v | -q]，这就是说明用户可以指定-v或者-q，但是却不能同时指定:

$ python prog.py --help
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet

总结

  argparse 提供了远比上文丰富的特性。本文仅仅是一个基础使用的教程。

sskywatcher
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
python 2.7中文手册（chm版）
04-11
python学习手册chm版小巧方便，适合日常查询使用。不适合作为一个学习文档来读，更偏向于工具方向
python　argparse　（２）
wuguangbin1230的博客
08-23 3237
python中的命令行解析最简单最原始的方法是使用sys.argv来实现，更高级的可以使用argparse这个模块。argparse从python 2.7开始被加入到标准库中，所以如果你的python版本还在2.7以下，那么需要先手动安装。 基本使用 import argparse parser=argparse.ArgumentParser() parser.add_argument("e...
argparse模块（详解）
shinuone的博客
04-22 1737
argparse 是 Python 标准库中用于解析命令行参数的模块。提供了一种简单而灵活的方式来处理命令行输入，并帮助用户构建具有参数选项和帮助信息的命令行界面。
python 2.7 中文教程-1：简介
07-04 5477
Python是一门简单易学，功能强大的编程语言。它具有高效的高层次数据结构，简单但有效的方式支持面向对象编程，语法优雅，动态类型，解释执行。使之成为多数平台上很多领域的脚本和快速应用开发的理想语言。它的设计理念强调代码的可读性, 跟C ++或Java等语言比可以用更少的代码实现同样的概念。Python能清晰地实现小型和大型程序。 Python解释器及其丰富的标准库的源码或者二进制版本可以从htt
python是一种跨平台开源免费的高级动态编程语言_python是高级动态编程语言-python是一种跨平台、开源、免费的高级动态编程语言，对么......
weixin_39617685的博客
12-03 609
python是一种跨平台、开源、免费的高级动态编程语言，对。python具有容易、易学、速度快、免费、开源、可移植性、可扩展性、丰富的库等优点。python语言极其容易上手，它是一种代表容易主义思想的语言。python是一种跨平台、开源、免费的高级动态编程语言，对。(推荐教程：python教程)相关介绍：python的优点：容易：Python是一种代表容易主义思想的语言。它使你能够专注于解决问题而...
python学习之argparse模块
阅微草堂
07-04 9514
argparse是python用于解析命令行参数和选项的标准模块，用于代替已经过时的optparse模块。argparse模块的作用是用于解析命令行参数 效果如下图： 代码如下： 学习步骤： Argparse Tutorial author: Tshepang Lekhonkhobe This tutorial is
python背记手册 从入门到精通
最新发布
04-23
python背记手册 从入门到精通
python2.7 windows版zip文件
08-30
Python 2.7是Python编程语言的一个早期稳定版本，尤其对于Windows用户来说，它提供了在该操作系统上进行开发和执行Python程序的能力。本压缩包包含了Python 2.7的Windows版安装所需的所有基本组件和库。 `README....
全网最全Python课程，从入门到精通！.pdf
06-13
这是一份全面的Python学习资源，涵盖了从初学者到高级开发者所需的知识点，共计637集的视频课程。课程分为四个部分，旨在帮助学习者逐步掌握Python编程技能，从基础到实战，全面提升编程能力。 1. **Python基础** ...
Python 2.7帮助手册
08-26
Python 2.7.10版本的官方帮助手册，并且是CHM格式 :)
python args parse_args() 报错 xxx.py: error: the following arguments are required: xxx
热门推荐
Hello Word!
09-05 4万+
python parse_args() 报错 xxx.py: error: the following arguments are required: xxx 报错形如： usage: test_1.py [-h] aaa test_1.py: error: the following arguments are required: aaa 原因：定义参数aaa时，没有采用-- 的方...
python2.7中文手册 安装文件
11-29
包含python2.7版本环境安装文件、帮助文档、中文手册，相当详细
python2.7中文文档
09-19
python官方手册中文版本，介绍详细，全中文，可搜索。
E SystemExit:和error: the following arguments are required:错误
weixin_42666085的博客
06-16 2053
E SystemExit: 2和_jb_pytest_runner.py: error: the following arguments are required: -x/–xxxxx -x/–xxxxx错误 这种问题就是因为缺少参数，导致系统安全退出的问题，可以通过控制台调用命令给参数赋值来解决： python xxx.py --xxxxx 具体值 --xxxxx 具体值 ...
指定默认参数值 仍报错：error: the following arguments are required:
qq_35608277的博客
06-27 1475
无用方法正确方法 参数名前加 – 发现参数名前没有加–！！！！！！！！！！
error: the following arguments are required:
weixin_42630613的博客
03-11 7976
ap.add_argument("-i", "--image", type=str, required=True, help="path input image that we'll detect blur in") 报错的原因是：required=True，也就是说这个命令行必须有。 改法： 1、你忘记加这个命令行参数了，加上 2、改为default = “” ...
argparse - 命令行选项与参数解析（转）
weixin_33724046的博客
07-25 502
argparse - 命令行选项与参数解析（译）Mar 30, 2013 原文：argparse – Command line option and argument parsing 译者：youngsterxyf argparse模块作为optparse的一个替代被添加到Python2.7。argparse的实现支持一些不易于添加到optparse以及要求向后不兼容API变化的特性，因此以...
Python 入门指南
longfeihu的专栏
08-06 635
http://codecloud.net/books/pythontutorial27/html/index.html ython 是一门简单易学且功能强大的编程语言。它拥有高效的高级数据结构，并且能够用简单而又高效的方式进行面向对象编程。Python 优雅的语法和动态类型，再结合它的解释性，使其在大多数平台的许多领域中成为编写脚本或开发应用程序的理想语言。 你

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值