Python argparse模块详解|极客教程

Python argparse模块详解

介绍

命令行工具是软件开发过程中常用的工具之一，它可以让用户通过命令行输入参数来控制程序的行为。Python标准库中提供了argparse模块，它可以帮助我们通过定义命令行参数，并解析用户传入的参数，从而简化开发过程。

本文将详细介绍argparse模块的使用方法和常见应用场景，包括定义位置参数、可选参数、子命令等内容。

安装

argparse模块是Python标准库的一部分，无需额外安装。

导入模块

使用argparse模块前，需要先导入它：

import argparse

创建解析器

在开始解析命令行参数之前，我们需要创建一个解析器对象：

parser = argparse.ArgumentParser()

定义位置参数

位置参数是指那些不以”-“或”–“开头的参数，它们出现在命令行参数中的顺序决定了它们的值。

我们可以通过调用add_argument方法来定义位置参数，add_argument方法的第一个参数是位置参数的名称，第二个参数是位置参数的帮助信息。

下面的示例代码演示了如何定义一个名为name的位置参数：

parser.add_argument('name', help='enter your name')

定义可选参数

可选参数是指那些以”-“或”–“开头的参数，它们的出现顺序可以是任意的。

我们可以通过调用add_argument方法来定义可选参数，add_argument方法的第一个参数是可选参数的名称，通常使用”–“开头，第二个参数是可选参数的帮助信息。

下面的示例代码演示了如何定义一个名为--age的可选参数：

parser.add_argument('--age', help='enter your age')

可选参数还可以定义一些配置项，比如是否接受一个值、这个值的类型等。这些配置项可以通过type、default等关键字参数来指定。

parser.add_argument('--age', help='enter your age', type=int, default=18)

在上面的示例中，type指定了参数的类型为整数，default指定了参数的默认值为18。

解析命令行参数

定义好位置参数和可选参数之后，我们可以通过调用parse_args方法来解析命令行参数。

args = parser.parse_args()

解析结果将会保存在一个对象中，我们可以通过使用.来访问这些参数的值。

print(args.name)
print(args.age)

下面的示例代码演示了如何解析命令行参数并获取它们的值：

import argparse

# 创建解析器
parser = argparse.ArgumentParser()

# 定义位置参数
parser.add_argument('name', help='enter your name')

# 定义可选参数
parser.add_argument('--age', help='enter your age', type=int, default=18)

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

# 输出参数值
print(args.name)
print(args.age)

运行结果如下：

$ python example.py Lily --age 20
Lily
20

添加子命令

有时候，我们可能需要给命令行工具添加一些子命令，这些子命令可以对应不同的功能。

我们可以通过定义多个解析器对象来实现子命令。首先，我们需要为主命令创建一个解析器对象，然后为每个子命令创建一个解析器对象，并将它们传给主命令的解析器对象。

下面的示例代码演示了如何定义一个主命令和两个子命令：

import argparse

# 创建主命令解析器
parser = argparse.ArgumentParser()

# 创建子命令解析器
subparsers = parser.add_subparsers(title='subparsers', description='valid subcommands')

# 创建子命令1解析器
parser1 = subparsers.add_parser('command1', help='subcommand1 help')

# 创建子命令2解析器
parser2 = subparsers.add_parser('command2', help='subcommand2 help')

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