如何使用 Python 的 argparse 模块来处理命令行参数？

Python 的 argparse 模块提供了一种简化命令行参数解析的方式，使得程序在执行时可以接收用户输入的参数，并根据用户的指令执行相应的操作。本文将介绍如何使用 Python 的 argparse 模块来处理命令行参数。

一、 argparse 模块的概述

argparse 模块是 Python 自带的一个命令行参数解析器。使用 argparse 模块可以轻松地解析命令行参数，支持指定参数的类型、取值范围和默认值，还可以自动生成帮助文档和错误提示。

二、 argparse 的基本用法

argparse 模块的基本用法是先创建解析器对象 ArgumentParser，然后定义需要解析的参数。下面是一个简单的示例：

import argparse

parser = argparse.ArgumentParser(description='Calculate the sum of two numbers.')
parser.add_argument('a', type=int, help='the first number')
parser.add_argument('b', type=int, help='the second number')
args = parser.parse_args()

print(args.a + args.b)

在这个示例中，我们创建了一个 ArgumentParser 对象，并设置了一个描述信息。然后我们定义了两个位置参数 a 和 b，分别表示两个数字。在 parse_args() 方法被调用时，argparse 模块会解析用户传入的参数，并将结果保存在一个 Namespace 类型的对象中。我们可以通过该对象的属性来访问具体的参数值。

这里需要注意一个小细节：当我们使用 argparse 模块时，我们不能像以前那样直接使用 sys.argv 来获取命令行参数。我们需要通过 ArgumentParser 的 parse_args() 方法来获取参数值。

三、参数的类型、取值范围和默认值

除了可以定义参数的名称和帮助信息外，argparse 还支持定义参数的类型、取值范围和默认值。下面是一个示例：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--num', type=int, choices=[1, 2, 3], default=1,
                    help='a number between 1 and 3')
args = parser.parse_args()

print(args.num)

在这个示例中，我们定义了一个可选参数 num。它的类型为 int，取值范围为 1、2、3，而且默认值为 1。使用 --help 参数可以查看参数说明：

optional arguments:
  -h, --help         show this help message and exit
  --num {1,2,3}      a number between 1 and 3 (default: 1)

四、参数的别名和分组

在定义参数时，我们可以为其设置别名，也可以将相似的参数归为一组。下面是一个示例：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--input', '-i', help='input file path')
parser.add_argument('--output', '-o', help='output file path')
group = parser.add_argument_group('optional arguments')
group.add_argument('--version', action='version', version='1.0')
group.add_argument('--verbose', '-v', action='store_true', help='verbose mode')
args = parser.parse_args()

print(args.input)
print(args.output)
print(args.verbose)

在这个示例中，我们定义了两个参数 input 和 output，它们分别被分别为 --input 和 -i、--output 和 -o 的别名。我们还定义了一个 optional arguments 组，并在其中添加了两个参数 version 和 verbose。参数 version 使用 action='version' 设置了其为版本信息，并指定了版本号为 1.0。参数 verbose 使用了 action='store_true'，表示该参数没有传入时，默认值为 False。

使用 group.add_argument() 方法可以将参数添加到组中。

五、处理多个参数

有时候我们需要处理多个参数，例如处理一组文件的时候，我们需要为每个文件指定一个参数。在这种情况下，我们可以使用 nargs 参数来实现。下面是一个示例：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--file', nargs='+', help='input files')
args = parser.parse_args()

print(args.file)

在这个示例中，我们定义了一个可选参数 file，并使用 nargs='+'，表示 file 参数可以接收任意多个值。需要注意的是，nargs 参数最多只能接收两种取值：'?' 表示参数可以有 0 或 1 个值；'*' 表示参数可以有任意多个值。当 nargs 参数为 '+' 时，表示至少需要一个参数。

六、总结

本文介绍了如何使用 Python 的 argparse 模块来处理命令行参数。使用 argparse 模块可以轻松地解析命令行参数，支持指定参数的类型、取值范围和默认值，还可以自动生成帮助文档和错误提示。我们可以定义参数的名称、别名、帮助信息、默认值、取值范围、类型，以及分组等。最后，我们还介绍了如何处理多个参数，例如使用 nargs 参数来实现。