22 Python的argparse模块

概述

        在上一节，我们介绍了Python的datetime模块，包括：datetime模块中一些常用的属性和函数。在这一节，我们将介绍Python的argparse模块。argparse模块是Python的一个标准库，用于编写命令行界面。它可以处理命令行参数和选项，并生成帮助和使用信息。

        该模块主要包含的功能如下：

        帮助和使用信息生成：自动生成帮助和使用信息，包括参数和选项的说明、用法示例等。

        命令行参数解析：解析命令行参数和选项，包括位置参数、可选参数和标志。

        参数类型检查：支持对参数类型进行检查，包括整数、浮点数、字符串等。

        子命令支持：支持定义子命令，每个子命令可以有自己的参数和选项。

        参数组：支持将参数分组，以方便管理和使用。

        下面，我们将逐一介绍argparse模块中一些常用的类和函数。

argparse.ArgumentParser类

        argparse.ArgumentParser是argparse模块中的一个类，用于创建解析器对象，帮助处理命令行参数和选项，并生成帮助和使用信息。使用argparse.ArgumentParser类可以简化命令行参数和选项的解析过程，以下是具体的使用步骤：

        1、导入argparse模块：import argparse。

        2、实例化一个对象：parser = argparse.ArgumentParser()。

        3、加入参数或选项：parser.add_argument()，每一个add_argument方法对应一个要关注的参数或选项。

        4、获取参数：args = parser.parse_args()，解析成功之后即可使用。

        在创建argparse.ArgumentParser对象时，可以指定一些可选参数，比如：description，用于描述程序的用途和参数的说明。

add_argument基本选项

        通过调用add_argument函数，可以指定命令行参数的名称、类型、默认值等属性，为参数提供帮助文本和元数据。

# test.py
import argparse# 创建解析器对象
parser = argparse.ArgumentParser(description = '这是一个示例程序')# 添加参数
parser.add_argument('param_name', type = int, help = '这是一个整数参数')# 解析参数
args = parser.parse_args()# 使用参数
print(args.param_name)

        在上面的示例代码中，我们使用add_argument函数添加了一个名为param_name的参数，指定了它的类型为整数，并提供了帮助文本。然后，通过调用parse_args函数解析命令行参数，并将解析后的参数值存储在args对象中。最后，我们可以使用args.param_name访问该参数的值。如果我们在命令行输入python test.py 66命令，则会输出：66。

add_argument更多选项

        add_argument函数还有许多其他选项，如下。

        metavar：指定参数的元变量名称，用于帮助文本中。

        nargs：指定参数接收的值的数量，可以是固定的数量，也可以是可变数量。其中，'+'表示至少需要一个参数，'*'表示可以接受任意数量的参数，数字表示只接受固定数量的参数。

        default：指定参数的默认值。

        choices：限制参数的取值范围。

        required：指定参数是否必需。

        help：提供参数的帮助文本。

        下面是一个稍微复杂一点的示例代码，用到了更多的选项。

# test.py
import argparse# 创建解析器对象
parser = argparse.ArgumentParser(description = '这是一个示例程序')# 添加参数
parser.add_argument('integers', metavar='N', type=int, nargs='+', help = '用于运算的整数的个数')
parser.add_argument('--sum', dest='compute_sum', action='store_true', help = '计算输入的整数的和')
parser.add_argument('--max', dest='find_max', action='store_true', help = '找到输入的最大整数')
parser.add_argument('--average', dest='compute_average', action='store_true', help = '计算输入的平均值')# 解析参数
args = parser.parse_args()# 使用参数
if args.compute_sum:print(sum(args.integers))
elif args.find_max:print(max(args.integers))
elif args.compute_average:print(sum(args.integers) / len(args.integers))
else:print('未选择任何操作')

        在上面的示例代码中，我们添加了如下几个参数和选项。

        integers：一个位置参数，接受一个或多个整数作为输入。

        --sum：一个可选的选项，用于计算输入整数的总和。

        --max：一个可选的选项，用于找出输入整数的最大值。

        --average：一个可选的选项，用于计算输入整数的平均值。

        通过解析命令行参数，我们可以根据用户选择的选项执行相应的操作，并打印输出相应的结果。上述代码的执行结果如下。

python test.py -h
usage: test.py [-h] [--sum] [--max] [--average] N [N ...]这是一个示例程序positional arguments:N           用于运算的整数的个数options:-h, --help  show this help message and exit--sum       计算输入的整数的和--max       找到输入的最大整数--average   计算输入的平均值python test.py --sum 5 6 7
18python test.py --max 5 6 7
7python test.py --average 5 6 7
6.0python test.py 5 6 7
未选择任何操作

add_argument的action选项

        action选项用来定义当命令行选项被触发时的行为。有多种可用的行为，如下。

        'store'：默认值。当命令行选项被触发时，将选项后面的参数值存储下来。

        'store_const'：当命令行选项被触发时，将一个常量值存储下来。比如：add_argument('--foo', action='store_const', const=42)会将42存储为args.foo。

        'store_true' 和 'store_false'：当命令行选项被触发时，将一个布尔值存储下来。比如：add_argument('--foo', action='store_true')会在args.foo为真（即选项被触发）时存储一个True值。

        'append'：当命令行选项被触发时，将一个值添加到列表中。比如：add_argument('--foo', action='append', default=[])会将任何遇到的--foo选项的值添加到args.foo列表中。

        'append_const'：当命令行选项被触发时，将一个常量值添加到列表中。比如：add_argument('--foo', action='append_const', const=42)会将42添加到args.foo列表中。

# test.py
import argparseparser = argparse.ArgumentParser()
parser.add_argument('--param1', action = 'store_true')
parser.add_argument('--param2', action = 'append', default = [])
parser.add_argument('numbers', nargs = '+')
args = parser.parse_args()print(args.param1)
print(args.param2)
print(args.numbers)

        在上面的示例代码中，--param1选项被触发时，将存储一个True值。--param2选项可以接受任意数量的参数，并将它们添加到一个列表中。numbers选项接受一个或多个参数，并将它们添加到一个列表中。上述代码的执行结果如下。

python test.py 99 100 --param1 --param2 6 --param2 9
True
['6', '9']
['99', '100']