使用 Argparse 在子命令间灵活添加可选参数

本文旨在解决在使用 `argparse` 创建带有子命令的命令行工具时，如何允许用户在命令行中的任意位置传递可选参数（例如 `-j` 或 `--json`）的问题。我们将探讨一种通过为每个解析器实例添加带唯一ID的参数，并在解析后合并结果来实现此目的的解决方案。

在使用 argparse 构建复杂的命令行工具时，经常需要使用子命令来组织不同的功能模块。 一个常见需求是允许用户在命令行中的任意位置指定一些全局性的可选参数，例如控制输出格式的 -j 或 --json 标志。 然而，argparse 的默认行为使得实现这一点并不容易。 如果将参数添加到主解析器，它只能在子命令之前使用；如果添加到子解析器，则只能在子命令之后使用。

以下介绍一种通过变通方法实现此需求的方法。

解决方案：为每个解析器添加带唯一ID的参数

该方案的核心思想是为每个需要识别可选参数的解析器实例（包括主解析器和子解析器）都添加一个具有相同功能，但名称不同的参数。 参数名称使用唯一ID进行区分，例如 json_0, json_1, json_2。 在完成参数解析后，再将这些具有相同含义的参数合并为一个最终的参数。

以下是一个示例代码：

import argparse

def add_common_args(parser, id):
    """
    为指定的解析器添加带唯一ID的 --json 参数。

    Args:
        parser: 要添加参数的 argparse.ArgumentParser 实例。
        id: 用于区分不同解析器实例的唯一ID。
    """
    parser.add_argument(
        "-j",
        "--json",
        dest=f"json_{id}",
        action="store_true",
        help="Output as JSON",
        default=None,
    )


parser = argparse.ArgumentParser()
subparser = parser.add_subparsers(dest="command", required=True)

course_parser = subparser.add_parser("course")
course_subparser = course_parser.add_subparsers(dest="subcommand", required=True)

course_list_parser = course_subparser.add_parser("list")

# 为主解析器和所有子解析器添加 --json 参数
add_common_args(parser, 0)
add_common_args(course_parser, 1)
add_common_args(course_list_parser, 2)

args = parser.parse_args()

# 合并所有 json_<id> 参数为一个 json 参数
setattr(args, "json", any(getattr(args, f"json_{id}") for id in range(3)))
print(args)

代码解释：

可灵AI

可灵AI：新一代AI创意生产力平台

10856

查看详情

1. add_common_args(parser, id) 函数： 这个函数负责为指定的 parser 添加 -j 或 --json 参数。 关键在于 dest=f"json_{id}"，它将参数存储为 args.json_0, args.json_1 等，确保每个解析器实例的参数名都是唯一的。
2. 创建解析器： 创建主解析器 parser，并添加子解析器 course_parser 和 course_list_parser。
3. 添加参数： 调用 add_common_args 函数，为每个解析器实例添加带唯一ID的 --json 参数。
4. 参数解析： 使用 parser.parse_args() 解析命令行参数。
5. 合并参数： 通过 setattr(args, "json", any(getattr(args, f"json_{id}") for id in range(3))) 将所有 json_<id> 参数的值合并到 args.json。 如果任何一个 json_<id> 为 True，则 args.json 也为 True。

示例用法：

假设将上述代码保存为 mytool.py，则可以使用以下命令：

python mytool.py courses list -j
python mytool.py -j courses list
python mytool.py courses -j list

无论 -j 出现在命令行的哪个位置，args.json 的值都会被正确地设置为 True。

总结与注意事项

该方案通过一种变通的方式，实现了在 argparse 中允许可选参数出现在命令行任意位置的需求。 虽然它并非最理想的解决方案，但它提供了一种可行的思路。

注意事项：

• 该方案需要为每个解析器实例都添加参数，如果子命令层级很深，可能会导致代码冗余。
• 合并参数的逻辑需要根据实际情况进行调整。 例如，如果可选参数不是布尔类型，则需要采用不同的合并策略。
• 在设计命令行界面时，应尽量保持一致性和易用性。 如果用户总是需要在命令行中任意位置指定参数，可以考虑使用其他更灵活的命令行参数解析库。

以上就是使用 Argparse 在子命令间灵活添加可选参数的详细内容，更多请关注php中文网其它相关文章！