深入解析argparse.argumentparser()

发布时间：2023-05-21

一、入门级介绍

argparse.argumentparser()是Python语言中常用的命令行参数解析库，可以帮助我们轻松地从命令行读取参数，并对其进行解析。在第一次使用该库时，我们可以先简单了解其基础结构和使用方法。 argparse.argumentparser()的使用非常简单，我们只需要按照以下步骤来使用即可:

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

在上述例子中，“echo”是我们需要从命令行读取的参数名称。通过add_argument()方法，我们扩展了一个命令行参数，parser.parse_args()用来解析这个参数，并将结果存储到args中。最后，我们通过print()打印出了这个参数的值。 下面我们将对argparse.argumentparser()做进一步的介绍，涵盖更广阔的范围。

二、常用参数类型

为了让程序更加灵活，我们需要定义一些支持的参数类型。下面我们将介绍一些常用的参数类型，方便编写更加完整的参数解析脚本。

1. 位置参数

位置参数是指在命令行中不带任何选项或标志（没有方向的单词）的参数。这类参数可以用add_argument()方法来添加。在下面的示例中，我们定义了两个位置参数：

parser.add_argument("arg1")
parser.add_argument("arg2")
args = parser.parse_args()

当我们在命令行中输入下面的命令时，程序将解析出arg1和arg2：

$ python myprogram.py foo bar

2. 可选选项参数

可选选项参数只在命令行中有一个简短的标记或名字，既可以带参数传入，也可以不带参数传入。在argparse中，我们可以通过add_argument()方法来定义可选选项参数。

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

当我们在命令行中这样输入时：

$ python myprogram.py -v

程序将解析verbose的值是True，我们也可以通过下面的方式指定参数值为2：

$ python myprogram.py -v 2

3. 互斥选项参数

在有些情况下，只有一种选项可以被选择。例如，在下面的示例中，如果指定了--foo，就不能再指定--bar，同时反之亦然。在argparse中，我们使用add_mutually_exclusive_group()来实现这种互斥关系。

group = parser.add_mutually_exclusive_group()
group.add_argument("-f", "--foo", action="store_true")
group.add_argument("-b", "--bar", action="store_true")
args = parser.parse_args()

在上面的示例中，我们用add_mutually_exclusive_group()创建了一个新的参数组，并向其添加两个互斥的参数。当我们在命令行中同时指定--foo和--bar时，将会引发错误。

三、常用参数介绍

在深入了解argparse后，我们将介绍一些常用的参数，以增加代码的灵活性和可读性。

1. action参数

action 参数用来描述当参数存在时，将被执行的动作。例如，当 argparse在命令行中找到指定的标志参数时必须采取的操作，一个常用的参数就是store_true，它会将指定的标志参数变成True。

parser.add_argument('--foo', action='store_true')
parser.add_argument('--bar', action='store_false')
parser.add_argument('--baz', action='store_false')

在上面的示例中，--foo有没有指定都行，如果指定了就将其设置为True。而--bar和--baz则相反。

2. dest参数

dest 参数指定将一个值存储到该属性的名称。有时我们希望命令行参数的名称与脚本变量名称不同，使用 dest 可以解决这个问题。

parser.add_argument('--long-name', dest='short_name')
args = parser.parse_args()

在上面的示例中，--long-name将被解析到short_name变量中，这样我们可以使用args.short_name来访问这个变量。

3. default参数

default 参数用于指定在未指定命令行参数时要使用的值。例如，我们可以指定一个默认值为42:

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

在上面的示例中，如果我们在命令行没有指定--foo这个参数，那么 args.foo 的值就会是"42"。这里的默认值可以是任何有效的类型，包括列表、字典和其他可迭代对象。

4. type参数

type 参数用于指定命令行参数值的类型。默认情况下，argparse 将字符串解析为字符串。如果指定了类型，它将尝试将 args 参数转换为指定的类型，并在失败时引发错误。

parser.add_argument("--count", type=int, default=1)

在上面的示例中，我们将--count参数的类型指定为整数，如果用户没有在命令行中指定--count的值，args.count 的默认值为 1。如果指定了值，则在转换为int类型时进行验证。

5. choices参数

choices 参数可以为指定的选项限制值集合。如果用户尝试为参数提供不属于集合中的值，则 argparse 将引发错误。

parser.add_argument('--size', choices=['S', 'M', 'L'], default='M')
args = parser.parse_args()

在上面的示例中，用户只能指定 S、M 或 L 中的一个值，否则 argparse 将引发错误。

总结

本文对argparse.argumentparser()做了详细介绍，涉及了基础使用方法、常用参数类型和常用参数介绍等多方面。argparse.argumentparser()是一个非常强大的Python命令行参数解析库，可以大大简化从命令行读取参数并对其进行解析的过程。我们希望这篇文章能够帮助您更好地使用argparse.argumentparser()，编写出更加完善的Python脚本程序。

推荐文章