如何使用 Python argparse 创建 CLI 程序？

使用 argparse 为 CLI 程序创建交互式界面

什么是 argparse？

argparse 是一个功能强大的 Python 库，它允许你轻松地创建友好且直观的命令行界面（CLI）程序。它通过提供一个框架，让程序员可以轻松添加命令行选项和参数，使程序具有交互性。

如何使用 argparse

使用 argparse 创建 CLI 程序的步骤如下：

1. 创建一个 ArgumentParser 对象

import argparse

parser = argparse.ArgumentParser(description='我的第一个 argparse 程序')

2. 添加命令行选项

parser.add_argument('argument_name', help='参数帮助文本')

3. 解析命令行参数

args = parser.parse_args()

4. 处理参数

if args.argument_name == 'value':
    # 执行操作

示例：一个简单的 CLI 程序

让我们创建一个简单的 CLI 程序，它允许用户选择三个不同的操作：

import argparse

parser = argparse.ArgumentParser(description='一个简单的 CLI 程序')
parser.add_argument('action', help='要执行的操作')

args = parser.parse_args()

if args.action == 'a':
    print('执行操作 A')
elif args.action == 'b':
    print('执行操作 B')
else:
    print('无效的动作。请参见 --help 了解详情。')

运行程序：

python program.py a

输出：

执行操作 A

深入了解 argparse

argparse 提供了多种选项来定制你的 CLI 程序，包括：

• 类型转换： 将字符串参数转换为 int、float 或其他类型。
• 默认值： 为参数指定默认值，即使它们未在命令行中提供。
• 帮助文本： 为每个参数提供详细的帮助消息。
• 存储： 指定参数应该存储在哪个对象属性中。

结论

argparse 是一个功能强大的库，可让你快速轻松地创建交互式 CLI 程序。通过遵循本指南中的步骤，你可以在几分钟内创建自己的程序，从而使与用户进行交互变得更加轻松。

常见问题解答

1. 如何添加可选参数？

使用 '--' + 参数名称 语法添加可选参数，而不是 '-。

2. 如何使用 argparse 解析子命令？

使用 subparsers 属性创建子命令组。

3. 如何验证参数？

使用 type= 参数来指定参数的类型并进行验证。

4. 如何处理命令行错误？

在 try/except 块中解析参数，并使用 argparse.ArgumentError 来处理错误。

5. 如何提供自定义帮助？

通过 formatter_class 参数指定一个自定义帮助格式化程序类。