Python argparse模块实现解析命令行参数方法详解

下面是“Python argparse模块实现解析命令行参数方法详解”的完整攻略。

简介

在Python中，argparse是一个非常方便的解析命令行参数的模块，可以帮助我们方便地实现命令行参数的解析、验证和提示等功能，极大地降低了开发过程中的难度。

用法

argparse模块的基本用法可以分为以下几个步骤：

导入argparse模块
创建一个解析器
添加需要解析的参数
解析参数

下面是一个简单的示例代码：

import argparse

# 创建一个解析器
parser = argparse.ArgumentParser(description='这是一个简单的示例程序')

# 添加需要解析的参数
parser.add_argument('-n', '--name', required=True, help='你的名字')

# 解析参数
args = parser.parse_args()

# 输出解析结果
print('Hello, {}!'.format(args.name))

上面的代码通过argparse模块，实现了一个简单的命令行程序。接下来我们对每一步进行一一讲解。

导入argparse模块

首先，我们需要在代码的最开始导入argparse模块，如下所示：

import argparse

创建一个解析器

接着，我们需要创建一个解析器：

parser = argparse.ArgumentParser(description='这是一个简单的示例程序')

在创建解析器的时候，我们可以使用description参数来给解析器添加一个简短的描述，以帮助用户理解这个命令行程序的作用。

添加需要解析的参数

一旦创建好了解析器，我们就可以通过添加需要解析的参数，告诉解析器我们期望从命令行中接收哪些参数，以及这些参数的具体设定。

在argparse中，常见的参数类型有以下几种：

positional argument 位置参数，也就是在命令行中不需要加前缀的参数，一般会按照位置顺序进行解析，如：python myprogram.py arg1 arg2
optional argument 可选参数，也就是在命令行中需要加前缀的参数，可以通过--或-进行指定，如：python myprogram.py --name Alex
mutually exclusive group 互斥参数组，指的是一组参数中只能有一个参数被指定，通常使用add_mutually_exclusive_group()方法创建。

下面是一个示例代码，展示了一种常见的参数类型，也就是可选参数：

parser.add_argument('-n', '--name', required=True, help='你的名字')

上面的代码中，我们使用add_argument()方法添加了一个可选参数，它有两个别名-n和--name，required参数指定了这个参数是必须的（也就是说用户必须在命令行中指定--name参数），同时，我们还通过help参数添加了一个对这个参数的描述。

另外，我们通过type参数可以指定这个参数的类型，默认值为字符串类型。我们可以指定为整数类型、浮点数类型等。不同数据类型的指定方式会有所不同。

解析参数

完成参数的添加之后，我们就可以调用parse_args()方法，将用户传入的命令行参数解析成Python对象，并赋值给相应的变量。例如：

args = parser.parse_args()

示例

下面是两个具体的完整例子，分别演示了如何解析可选参数和位置参数：

解析可选参数

import argparse

# 创建一个解析器
parser = argparse.ArgumentParser(description='这是一个解析可选参数示例程序')

# 添加需要解析的参数
parser.add_argument('-n', '--name', required=True, help='你的名字')
parser.add_argument('-a', '--age', required=False, help='你的年龄')

# 解析参数
args = parser.parse_args()

# 输出解析结果
print('你的名字是：{}'.format(args.name))
if args.age:
    print('你的年龄是：{}'.format(args.age))

上述代码中，我们添加了两个参数，分别是名字和年龄，其中名字是必须的，年龄是可选的。在解析参数之后，我们会首先输出名字，然后再判断年龄是否有值，如果有，则输出年龄。

在命令行中可以这样使用：

python myprogram.py -n Alex -a 20

解析位置参数

import argparse

# 创建一个解析器
parser = argparse.ArgumentParser(description='这是一个解析位置参数示例程序')

# 添加需要解析的参数
parser.add_argument('name', help='你的名字')
parser.add_argument('age', help='你的年龄')

# 解析参数
args = parser.parse_args()

# 输出解析结果
print('你的名字是：{}'.format(args.name))
print('你的年龄是：{}'.format(args.age))

上述代码中，我们添加了两个位置参数，分别是名字和年龄，它们不需要加前缀 - 或 --，在命令行中直接用空格分隔即可。