允许子命令之间任意位置的可选参数

本文介绍了如何在使用 `argparse` 创建带有子命令的工具时，允许用户在命令行中的任何位置传递可选参数（例如 `-j` 或 `--json`）。核心思路是将该可选参数添加到主解析器和所有子解析器，并使用不同的目标名称存储其值。最后，通过检查所有目标名称的值，确定最终的参数值。

在使用 argparse 构建复杂的命令行工具时，经常需要使用子命令来组织不同的功能。一个常见的需求是允许用户在命令行的任何位置指定一些全局可选参数，例如用于指定输出格式（如 JSON）的 -j 或 --json 标志。然而，argparse 的默认行为可能会限制这些参数的使用位置，要么只能在主命令之后，要么只能在子命令之后。本文将提供一种解决此问题的方案。

解决方案

该解决方案的核心思想是：将可选参数添加到主解析器以及所有的子解析器中，但为每个解析器中的参数使用不同的目标名称。这样，无论参数出现在命令行的哪个位置，都能被正确解析。最后，程序会检查所有目标名称的值，如果其中任何一个为 True，则将最终的参数值设置为 True。

以下是一个示例代码：

import argparse

def add_common_args(parser, id):
    """
    向解析器添加通用参数（例如 --json）。

    Args:
        parser: 要添加参数的 argparse 解析器。
        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 参数值
setattr(args, "json", any(getattr(args, f"json_{id}") for id in range(3)))
print(args)

代码解释：

美间AI

美间AI：让设计更简单

45

查看详情

1. add_common_args(parser, id) 函数： 这个函数负责将 -j 或 --json 参数添加到指定的 parser 中。关键在于 dest=f"json_{id}"，它为每个解析器中的 -j 参数指定了不同的目标名称（例如 json_0、json_1、json_2）。
2. 创建解析器和子解析器： 这部分代码创建了主解析器、子解析器 course 和 course list。
3. 调用 add_common_args： 将 -j 参数添加到主解析器和所有子解析器。
4. 解析命令行参数： 使用 parser.parse_args() 解析命令行参数。
5. 确定最终的 json 值： 这部分代码检查 json_0、json_1 和 json_2 的值，如果其中任何一个为 True，则将 args.json 设置为 True。any() 函数用于简化这个过程。

示例用法：

python your_script.py courses list -j
python your_script.py -j courses list
python your_script.py courses -j list

在以上任何一种情况下，args.json 都会被设置为 True。

注意事项

• ID 的唯一性： 确保传递给 add_common_args 函数的 ID 在所有解析器中都是唯一的。
• 参数名称冲突： 如果你的子命令之间存在参数名称冲突，也需要使用类似的方法来避免冲突。
• 代码可维护性： 对于更复杂的命令行工具，可以考虑使用更高级的 argparse 特性，例如自定义 Action 类，来进一步提高代码的可维护性。

总结

虽然 argparse 并没有直接提供一种简单的方法来允许可选参数出现在命令行中的任何位置，但通过将参数添加到主解析器和所有子解析器，并使用不同的目标名称，可以有效地解决这个问题。这种方法虽然略显繁琐，但能够满足灵活的命令行参数解析需求。

以上就是允许子命令之间任意位置的可选参数的详细内容，更多请关注php中文网其它相关文章！