在编写Python脚本时，我们经常需要让用户通过命令行传递参数来调整程序的运行方式。今天，钢铁老豆要给大家介绍的是argparse模块，这是Python标准库中一个强大的工具，它可以帮助你轻松处理命令行参数，使你的脚本更加友好和灵活。如果你正在寻找一个强大而灵活的命令行参数解析工具，Python的argparse模块无疑是首选。

0.argparse模块

什么是argparse模块？

argparse模块是Python用来解析命令行参数和选项的标准库之一。它允许程序员定义所需的参数，处理输入，并自动生成帮助和使用消息。这样，用户就可以了解如何正确使用你的程序。

为什么选择argparse？

• 易于编码：只需几行代码，你就可以实现复杂的命令行参数处理。
• 自动生成帮助：argparse自动根据你的定义生成帮助信息，无需手动编写。
• 支持多种参数类型：支持字符串、整数、浮点数等多种类型，并提供类型检查功能。
• 灵活的命令行选项：支持短选项（如-h）和长选项（如--help），以及可选和必需参数的混合使用。

1.快速入门指南

下面，钢铁老豆马上给大家介绍 argparse 的一些常见用法，这些用法能够覆盖大多数常规需求。

创建解析器

首先，需要导入 argparse 模块，并创建一个 ArgumentParser 对象。这个对象将用于添加参数，并解析命令行输入的参数。

import argparse

parser = argparse.ArgumentParser(description='示例程序')

使用 add_argument 方法来定义你希望从命令行接收的参数。

位置参数

位置参数是命令行中必须出现的参数，它们的位置固定。

parser.add_argument('echo', help='回显输入的字符串')

可选参数

可选参数通常以 - 或 -- 开头，不是必须输入的，可以赋予默认值。

parser.add_argument('-v', '--verbose', action='store_true', help='增加输出的详细性')

参数类型与转换

可以指定参数的类型，argparse 将自动将输入的字符串转换为指定类型。

parser.add_argument('square', type=int, help='显示输入的数字的平方')

默认值

为参数设置默认值，如果命令行中未指定该参数，则使用默认值。

parser.add_argument('--length', type=int, default=10, help='输入的长度，默认为10')

选择列表

限定参数的值必须从预定义的选项中选择。

parser.add_argument('--unit', choices=['kg', 'lb'], help='重量单位')

处理布尔值

使用 store_true 或 store_false 来处理布尔类型的开关。

parser.add_argument('--debug', action='store_true', help='开启调试模式')

解析参数

调用 parse_args() 方法来解析命令行输入的参数。

args = parser.parse_args()

完整示例

将前面的概念整合到一个示例中，方便大家更好地理解如何使用 argparse。

import argparse

# 创建解析器
parser = argparse.ArgumentParser(description="处理命令行参数的示例程序")

# 添加参数
parser.add_argument('echo', help='回显输入的字符串')
parser.add_argument('-v', '--verbose', action='store_true', help='增加输出的详细性')
parser.add_argument('square', type=int, help='显示输入的数字的平方')
parser.add_argument('--length', type=int, default=10, help='输入的长度，默认为10')
parser.add_argument('--unit', choices=['kg', 'lb'], help='重量单位')
parser.add_argument('--debug', action='store_true', help='开启调试模式')

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

# 使用参数
if args.verbose:
    print("输入的字符串:", args.echo)
print(args.square ** 2)
if args.debug:
    print("调试模式已开启")

以上是 argparse 常见的一些功能和用法。通过使用这些功能，你可以构建功能强大、易于使用的命令行应用程序。

2.高级应用

以上用法已经能够覆盖大多数常规需求，但argparse的强大远不止于此，你可以根据需要添加更多复杂的命令行参数选项，如选择性参数、互斥组、子命令等，非常适合构建复杂的命令行应用程序。由于篇幅问题，这个留待以后钢铁老豆再给大家介绍，关注我，不要错过最新的推荐消息~

欢迎点赞+收藏+评论+关注，每天学习一点Python小知识，无论基础、模块、数据分析、深度学习和Ai，总有你感兴趣的。我是钢铁老豆，一个30岁转行IT、自学成为算法工程师、想用Ai点亮孩子小小世界的Pythoner。