argparse模块

这篇教程旨在作为 argparse 的入门介绍，此模块是 Python 标准库中推荐的命令行解析模块。

注解还有另外两个模块可以完成同样的任务，称为 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 cpythond

rwxr-xr-x 4 wena wena 4096 Feb 8 12:04 devguide

-rwxr-xr-x 1 wena wena 535 Feb 19 00:05 prog.pyd

rwxr-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 是一个即使在运行的时候没有提供任何选项，也非常有用的命令。在默认情况下他会输出当前文件夹包含的文件和文件夹。
如果我们想要使用比它默认提供的更多功能，我们需要告诉该命令更多信息。在这个例子里，我们想要查看一个不同的目录，pypy。我们所做的是指定所谓的位置参数。之所以这样命名，是因为程序应该如何处理该参数值，完全取决于它在命令行出现的位置。更能体现这个概念的命令如 cp，它最基本的用法是 cp SRC DEST。第一个位置参数指的是*你想要复制的*，第二个位置参数指的是*你想要复制到的位置*。
现在假设我们想要改变这个程序的行为。在我们的例子中，我们不仅仅只是输出每个文件的文件名，还输出了更多信息。在这个例子中，-l 被称为可选参数。
这是一段帮助文档的文字。它是非常有用的，因为当你遇到一个你从未使用过的程序时，你可以通过阅读它的帮助文档来弄清楚它是如何运行的。

基础¶

让我们从一个简单到（几乎）什么也做不了的例子开始：

import argparse

parser = argparse.ArgumentParser() #parser（译：解析）

parser.parse_args()

以下是该代码的运行结果：

$ 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

程序运行情况如下：

在没有任何选项的情况下运行脚本不会在标准输出显示任何内容。这没有什么用处。
第二行代码开始展现出 argparse 模块的作用。我们几乎什么也没有做，但已经得到一条很好的帮助信息。
--help 选项，也可缩写为 -h，是唯一一个可以直接使用的选项（即不需要指定该选项的内容）。指定任何内容都会导致错误。即便如此，我们也能直接得到一条有用的用法信息。

位置参数介绍¶

举个例子：

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("echo")

args = parser.parse_args() #args 是argument的缩写（译：参数）

print(args.echo)

运行此程序：

$ 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

optional arguments: #可选参数

-h, --help show this help message and exit

$ python3 prog.py foo

foo

程序运行情况如下：

我们增加了 add_argument() 方法，该方法用于指定程序能够接受哪些命令行选项。在这个例子中，我将选项命名为 echo，与其功能一致。
现在调用我们的程序必须要指定一个选项。
The parse_args() method actually returns some data from the options specified, in this case, echo. （parse_args方法实际上从指定的选项返回一些数据。现在是echo）
这一变量是 argparse 免费施放的某种 “魔法”（即是说，不需要指定哪个变量是存储哪个值的）。你也可以注意到，这一名称与传递给方法的字符串参数一致，都是 echo。

然而请注意，尽管显示的帮助看起来清楚完整，但它可以比现在更有帮助。比如我们可以知道 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

现在，来做一些更有用的事情：

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 5, in <module>

print(args.square**2)

TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

进展不太顺利。那是因为 argparse 会把我们传递给它的选项视作为字符串，除非我们告诉它别这样。所以，让我们来告诉 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

$ python3 prog.py four

usage: prog.py [-h] square

prog.py: error: argument square: invalid int value: 'four'

做得不错。当这个程序在收到错误的无效的输入时，它甚至能在执行计算之前先退出，还能显示很有帮助的错误信息。

可选参数介绍

到目前为止，我们一直在研究位置参数。让我们看看如何添加可选的：

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("--verbosity", help="increase output verbosity")

args = parser.parse_args()

if args.verbosity:

print("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

increase output verbosity

$ python3 prog.py --verbosity

usage: prog.py [-h] [--verbosity VERBOSITY]

prog.py: error: argument --verbosity: expected one argument

程序运行情况如下:

这一程序被设计为当指定 --verbosity 选项时显示某些东西，否则不显示。
不添加这一选项时程序没有提示任何错误而退出，表明这一选项确实是可选的。注意，如果一个可选参数没有被使用时，相关变量被赋值为 None，在此例中是 args.verbosity，这也就是为什么它在 if 语句中被当作逻辑假。
帮助信息有点不同。
使用 --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")

和输出：

$ 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

程序运行情况如下：

现在，这一选项更多地是一个标志，而非需要接受一个值的什么东西。我们甚至改变了选项的名字来符合这一思路。注意我们现在指定了一个新的关键词 action，并赋值为 "store_true"。这意味着，当这一选项存在时，为 args.verbose 赋值为 True。没有指定时则隐含地赋值为 False。
当你为其指定一个值时，它会报错，符合作为标志的真正的精神。
留意不同的帮助文字。

短选项

如果你熟悉命令行的用法，你会发现我还没讲到这一选项的短版本。这也很简单：

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

效果就像这样：

$ 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

可以注意到，这一新的能力也反映在帮助文本里。

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

我们的程序变得越来越复杂了：

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)

接着是输出：

$ python3 prog.py

usage: prog.py [-h] [-v] square

prog.py: error: the following arguments are required: square

$ python3 prog.py 416

$ python3 prog.py 4 --verbose

the square of 4 equals 16

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

和输出：

$ python3 prog.py 4

$ python3 prog.py 4 -v

usage: prog.py [-h] [-v VERBOSITY] square

prog.py: error: argument -v/--verbosity:

$ python3 prog.py 4 -v 1

4^2 == 16

$ python3 prog.py 4 -v 2

the square of 4 equals 16

$ python3 prog.py 4 -v 3

除了最后一个，看上去都不错。最后一个暴露了我们的程序中有一个 bug。我们可以通过限制 --verbosity 选项可以接受的值来修复它：

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)

和输出：

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

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

注意这一改变同时反应在错误信息和帮助信息里。

现在，让我们使用另一种的方式来改变冗长度。这种方式更常见，也和 CPython 的可执行文件处理它自己的冗长度参数的方式一致（参考 python --help 的输出）：

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)

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

$ python3 prog.py 4

$ 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

是的，它现在比前一版本更像是一个标志（和 action="store_true" 相似）。这能解释它为什么报错。
它也表现得与 “store_true” 的行为相似。
这给出了一个关于 count 动作的效果的演示。你之前很可能应该已经看过这种用法。
如果你不添加 -v 标志，这一标志的值会是 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)

这是它给我们的输出：

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

第一组输出很好，修复了之前的 bug。也就是说，我们希望任何 >= 2 的值尽可能详尽。
第三组输出并不理想。

让我们修复那个 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", 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 异常）。

然后：

$ python3 prog.py 4

凭借我们目前已学的东西你就可以做到许多事情，而我们还仅仅学了一些皮毛而已。 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)

输出：

$ python3 prog.py

usage: prog.py [-h] [-v] x y

prog.py: error: the following arguments are required: x, y

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

$ python3 prog.py 4 2 -v

4^2 == 16

请注意到目前为止我们一直在使用详细级别来更改所显示的文本。以下示例则使用详细级别来显示更多的文本:

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), end="")

print(answer)

输出：

$ python3 prog.py 4 2

$ python3 prog.py 4 2 -v

4^2 == 16

$ python3 prog.py 4 2 -vv

Running 'prog.py'

4^2 == 16

矛盾的选项

到目前为止，我们一直在使用 argparse.ArgumentParser 实例的两个方法。让我们再介绍第三个方法 add_mutually_exclusive_group() （mutually：译-相互的）（exclusive：译-唯一的）。它允许我们指定彼此相互冲突的选项。让我们再更改程序的其余部分以便使用新功能更有意义：我们将引入 --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 4 2

4^2 == 16

$ python3 prog.py 4 2 -q

$ 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

这应该很容易理解。我添加了末尾的输出这样你就可以看到其所达到的灵活性，即混合使用长和短两种形式的选项。

在我们收尾之前，你也许希望告诉你的用户这个程序的主要目标，以免他们还不清楚:

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

请注意用法文本中有细微的差异。注意 [-v | -q]，它的意思是说我们可以使用 -v 或 -q，但不能同时使用两者：

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

add_argument() 方法

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

定义单个的命令行参数应当如何解析。每个形参都在下面有它自己更多的描述，长话短说有：

name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。
action - 当参数在命令行中出现时使用的动作基本类型。
nargs - 命令行参数应当消耗的数目。
const - 被一些 action 和 nargs 选择所需求的常数。
default - 当参数未在命令行中出现时使用的值。
type - 命令行参数应当被转换成的类型。
choices - 可用的参数的容器。
required - 此命令行选项是否可省略（仅选项可用）。
help - 一个此选项作用的简单描述。
metavar - 在使用方法消息中使用的参数值示例。
dest - 被添加到 parse_args() 所返回对象上的属性名。

以下部分描述这些参数如何使用。

required¶

通常，argparse 模块会认为 -f 和 --bar 等旗标是指明可选的参数，它们总是可以在命令行中被忽略。要让一个选项成为必需的，则可以将 True 作为 required= 关键字参数传给 add_argument():

>>> parser = argparse.ArgumentParser()

>>> parser.add_argument('--foo', required=True)

>>> parser.parse_args(['--foo', 'BAR'])

Namespace(foo='BAR')

>>> parser.parse_args([])

usage: argparse.py [-h] [--foo FOO]

argparse.py: error: option --foo is required

如这个例子所示，如果一个选项被标记为 required，则当该选项未在命令行中出现时，parse_args() 将会报告一个错误。

注解：必需的选项通常被认为是不适宜的，因为用户会预期 options 都是可选的，因此在可能的情况下应当避免使用它们。

default默认值¶

所有选项和一些位置参数可能在命令行中被忽略。add_argument() 的命名参数 default，默认值为 None，指定了在命令行参数未出现时应当使用的值。对于选项， default 值在选项未在命令行中出现时使用:

>>> parser = argparse.ArgumentParser()

>>> parser.add_argument('--foo', default=42)

>>> parser.parse_args(['--foo', '2'])

Namespace(foo='2')

>>> parser.parse_args([])

Namespace(foo=42)

如果 default 值是一个字符串，解析器解析此值就像一个命令行参数。特别是，在将属性设置在 Namespace 的返回值之前，解析器应用任何提供的 type 转换参数。否则解析器使用原值:

>>> parser = argparse.ArgumentParser()

>>>parser.add_argument('--length', default='10', type=int)

>>> parser.add_argument('--width', default=10.5, type=int)

>>> parser.parse_args()

Namespace(length=10, width=10.5)

对于 nargs 等于 ? 或 * 的位置参数， default 值在没有命令行参数出现时使用。

>>> parser = argparse.ArgumentParser()

>>> parser.add_argument('foo', nargs='?', default=42)

>>> parser.parse_args(['a'])

Namespace(foo='a')

>>> parser.parse_args([])

Namespace(foo=42)

提供 default=argparse.SUPPRESS 导致命令行参数未出现时没有属性被添加:

>>> parser = argparse.ArgumentParser()

>>> parser.add_argument('--foo', default=argparse.SUPPRESS)

>>> parser.parse_args([])

Namespace()

>>> parser.parse_args(['--foo', '1'])

Namespace(foo='1')

choices¶

某些命令行参数应当从一组受限值中选择。这可通过将一个容器对象作为 choices 关键字参数传给 add_argument() 来处理。当执行命令行解析时，参数值将被检查，如果参数不是可接受的值之一就将显示错误消息:

>>> parser = argparse.ArgumentParser(prog='game.py')

>>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])

>>> parser.parse_args(['rock'])

Namespace(move='rock')

>>> parser.parse_args(['fire'])

usage: game.py [-h] {rock,paper,scissors}

game.py: error: argument move: invalid choice: 'fire' (choose from 'rock','paper', 'scissors')

请注意 choices 容器包含的内容会在执行任意 type 转换之后被检查，因此 choices 容器中对象的类型应当与指定的 type 相匹配:

>>> parser = argparse.ArgumentParser(prog='doors.py')

>>> parser.add_argument('door', type=int, choices=range(1, 4))

>>> print(parser.parse_args(['3']))

Namespace(door=3)

>>> parser.parse_args(['4'])

usage: doors.py [-h] {1,2,3}

doors.py: error: argument door: invalid choice: 4 (choose from 1, 2, 3)

任何容器都可作为 choices 值传入，因此 list 对象，set 对象以及自定义容器都是受支持的。

action

ArgumentParser 对象将命令行参数与动作相关联。这些动作可以做与它们相关联的命令行参数的任何事，尽管大多数动作只是简单的向 parse_args() 返回的对象上添加属性。action 命名参数指定了这个命令行参数应当如何处理。供应的动作有：

'store' - 存储参数的值。这是默认的动作。例如:

 parser = argparse.ArgumentParser()
 parser.add_argument('--foo')
 parser.parse_args('--foo 1'.split())

结果：

Namespace(foo='1')

'store_const' - 存储被 const 命名参数指定的值。 'store_const' 动作通常用在选项中来指定一些标志。例如:

 parser = argparse.ArgumentParser()
 parser.add_argument('--foo', action='store_const', const=42)
 parser.parse_args(['--foo'])

结果：

Namespace(foo=42)

'store_true' and 'store_false' - 这些是 'store_const' 分别用作存储 True 和 False 值的特殊用例。另外，它们的默认值分别为 False 和 True。例如:

 parser = argparse.ArgumentParser()
 parser.add_argument('--foo', action='store_true')
 parser.add_argument('--bar', action='store_false')
 parser.add_argument('--baz', action='store_false')
 parser.parse_args('--foo --bar'.split())

结果：

Namespace(foo=True, bar=False, baz=True)

'append' - 存储一个列表，并且将每个参数值追加到列表中。在允许多次使用选项时很有用。例如:

parser = argparse.ArgumentParser()
parser.add_argument('--foo', action='append')
parser.parse_args('--foo 1 --foo 2'.split())

结果：

Namespace(foo=['1', '2'])

'append_const' - 这存储一个列表，并将 const 命名参数指定的值追加到列表中。（注意 const 命名参数默认为 None。）``'append_const'`` 动作一般在多个参数需要在同一列表中存储常数时会有用。例如:

 parser = argparse.ArgumentParser()
 parser.add_argument('--str', dest='types', action='append_const', const=str)
 parser.add_argument('--int', dest='types', action='append_const', const=int)
 parser.parse_args('--str --int'.split())

结果：

Namespace(types=[<class 'str'>, <class 'int'>])

'count' - 计算一个关键字参数出现的数目或次数。例如，对于一个增长的详情等级来说有用:

 parser = argparse.ArgumentParser()
 parser.add_argument('--verbose', '-v', action='count', default=0)
 parser.parse_args(['-vvv'])

结果：

Namespace(verbose=3)

'help' - 打印所有当前解析器中的选项和参数的完整帮助信息，然后退出。默认情况下，一个 help 动作会被自动加入解析器。关于输出是如何创建的，参与 ArgumentParser。

'version' - 期望有一个 version= 命名参数在 add_argument() 调用中，并打印版本信息并在调用后退出:

 import argparse
 parser = argparse.ArgumentParser(prog='PROG')
 parser.add_argument('--version', action='version', version='%(prog)s 2.0')
 parser.parse_args(['--version'])

结果：

PROG 2.0

'extend' - 这会存储一个列表，并将每个参数值加入到列表中。示例用法:

 parser = argparse.ArgumentParser()
 parser.add_argument("--foo", action="extend", nargs="+", type=str)
 parser.parse_args(["--foo", "f1", "--foo", "f2", "f3", "f4"])

结果：

Namespace(foo=['f1', 'f2', 'f3', 'f4'])

dest

大多数 ArgumentParser 动作会添加一些值作为 parse_args() 所返回对象的一个属性。该属性的名称由 add_argument() 的 dest 关键字参数确定。对于位置参数动作，dest 通常会作为 add_argument() 的第一个参数提供:
```
 parser = argparse.ArgumentParser()
 parser.add_argument('bar')
 parser.parse_args(['XXX'])
```
结果：
```
Namespace(bar='XXX')
```

对于可选参数动作，dest 的值通常取自选项字符串。 ArgumentParser 会通过接受第一个长选项字符串并去掉开头的 -- 字符串来生成 dest 的值。如果没有提供长选项字符串，则 dest 将通过接受第一个短选项字符串并去掉开头的 - 字符来获得。任何内部的 - 字符都将被转换为 _ 字符以确保字符串是有效的属性名称。下面的例子显示了这种行为:
```
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-f', '--foo-bar', '--foo')
>>> parser.add_argument('-x', '-y')
>>> parser.parse_args('-f 1 -x 2'.split())
Namespace(foo_bar='1', x='2')
>>> parser.parse_args('--foo 1 -y 2'.split())
Namespace(foo_bar='1', x='2')
```

dest 允许提供自定义属性名称:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', dest='bar')
>>> parser.parse_args('--foo XXX'.split())
Namespace(bar='XXX')

posted @ 2020-09-29 12:55 小白也会飞阅读(378) 评论(0) 编辑收藏举报

刷新页面返回顶部

会飞的小白白

argparse模块

概念¶

基础¶

位置参数介绍¶

可选参数介绍

短选项

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

进行一些小小的改进¶

矛盾的选项

add_argument() 方法

required¶

default默认值¶

choices¶

action

dest