在Python中构建命令行：命令行接口（CLI）——argparse模块

Python标准库中的argparse模块用于从命令行解析参数。argparse模块使得编写用户友好的命令行接口变得简单直接。

1. 基本用法

使用Python的argparse库来创建命令行接口的简单例子：展示如何定义一个Python脚本，该脚本接受两个命令行参数：一个是文件路径（--file），另一个是可选的详细模式（--verbose）。

首先，创建一个名为example_script.py的文件，并在其中编写以下代码：

import argparse  
  
# 创建ArgumentParser对象  
parser = argparse.ArgumentParser(description="这是一个示例脚本，用于展示argparse的用法。")  
  
# 添加必需的--file参数  
parser.add_argument("--file", type=str, required=True, help="要处理的文件路径。")  
  
# 添加可选的--verbose参数  
parser.add_argument("--verbose", action="store_true", help="启用详细模式以打印更多信息。")  
  
# 解析命令行参数  
args = parser.parse_args()  
  
# 使用解析后的参数  
if args.verbose:  
    print(f"详细模式已启用。正在处理文件：{args.file}")  
else:  
    print(f"正在处理文件，但详细模式未启用。文件路径：{args.file}")  
  
# 注意：这里只是一个示例，实际上并没有进行文件处理。  
# 在实际脚本中，你应该在这里添加打开文件、读取内容等逻辑。

现在，你可以在命令行中运行这个脚本，并传递必要的参数。例如：

python example_script.py --file /path/to/your/file.txt

这将输出：

正在处理文件，但详细模式未启用。文件路径：/path/to/your/file.txt

如果你想要启用详细模式，可以这样做：

python example_script.py --file /path/to/your/file.txt --verbose

这将输出：

详细模式已启用。正在处理文件：/path/to/your/file.txt

在这个例子中：

• --file是一个必需的参数，没有提供它将导致脚本显示错误消息并退出。
• --verbose是一个可选的布尔参数。当提供时，args.verbose将为True，否则为False。action="store_true"是处理布尔开关的常用方式。

argparse库非常强大，可以处理更复杂的命令行接口需求，包括子命令、默认值和类型检查等。上面的例子只是展示了最基本的功能。

2. 高级用法

argparse库除了基本的功能外，它还支持一些高级用法，以满足更复杂的命令行接口需求。下面举一个例子来说明argparse的高级用法：子命令（sub-commands）。

子命令允许你创建具有多个不同操作或模式的命令行工具。每个子命令可以有自己的参数和说明。下面是一个简单的例子，展示了如何使用argparse来创建带有子命令的命令行接口。

首先，创建一个名为advanced_example.py的文件，并在其中编写以下代码：

import argparse  
  
# 创建ArgumentParser对象  
parser = argparse.ArgumentParser(description="这是一个带有子命令的示例脚本。")  
  
# 创建子命令解析器  
subparsers = parser.add_subparsers(dest="command", help="可用的子命令")  
  
# 添加'create'子命令  
create_parser = subparsers.add_parser('create', help='创建一个新项目。')  
create_parser.add_argument('project_name', type=str, help='项目的名称。')  
create_parser.add_argument('--template', type=str, default='default', help='使用的模板（默认为default）。')  
  
# 添加'build'子命令  
build_parser = subparsers.add_parser('build', help='构建项目。')  
build_parser.add_argument('--config', type=str, required=True, help='构建配置文件的路径。')  
  
# 解析命令行参数  
args = parser.parse_args()  
  
# 根据子命令执行不同的操作  
if args.command == 'create':  
    print(f"正在创建项目：{args.project_name}，使用的模板为：{args.template}")  
elif args.command == 'build':  
    print(f"正在构建项目，配置文件路径为：{args.config}")  
else:  
    parser.print_help()

现在，你可以在命令行中运行这个脚本，并传递子命令及其参数。例如：

python advanced_example.py create my_project --template custom

这将输出：

正在创建项目：my_project，使用的模板为：custom

另一个例子是构建项目：

python advanced_example.py build --config /path/to/config.json

这将输出：

正在构建项目，配置文件路径为：/path/to/config.json

在这个高级用法的例子中：

• 我们使用add_subparsers()方法创建了一个子命令解析器。
• 使用add_parser()方法为每个子命令添加了单独的解析器，并定义了它们自己的参数。
• dest参数用于指定存储子命令名称的属性名。
• 在解析参数后，我们根据args.command的值来判断用户执行了哪个子命令，并相应地执行不同的操作。

这种高级用法使得你可以创建功能丰富且用户友好的命令行工具，每个子命令都可以有自己的参数和说明，从而提高了工具的可用性和可扩展性。

类似的库：命令行接口（CLI）——Click库