允许子命令间任意位置使用可选参数

本文探讨了如何在使用 argparse 创建带有子命令的命令行工具时，允许用户在命令行的任意位置传递可选参数（例如，一个全局的 JSON 输出标志 -j）。通过一种变通方法，将参数添加到每个相关的解析器，并最终合并它们的结果，从而实现了在不同位置使用相同参数的目的。

在使用 argparse 构建复杂的命令行工具时，经常会遇到需要定义全局可选参数的需求。例如，一个用于控制输出格式的 -j 或 --json 参数，希望用户可以在主命令、子命令以及子子命令之间任意位置指定。然而，argparse 默认的行为会将参数与其定义的解析器绑定，导致无法灵活地在命令行中任意位置使用。

以下介绍一种变通方法，可以在一定程度上解决这个问题。

解决方案：多处定义，统一合并

该方案的核心思想是：在所有可能需要该参数的解析器（主解析器、子解析器等）中都定义该参数，但使用不同的目标名称，最后再将这些目标的值合并到一个统一的参数中。

具体步骤如下：

1. 定义一个添加公共参数的函数： 该函数接收一个解析器对象和一个唯一的 ID 作为参数，用于在该解析器中添加指定的公共参数，并使用 dest 参数为该参数指定一个带有 ID 的目标名称。

   import argparse
   
   def add_common_args(parser, id):
       parser.add_argument(
           "-j",
           "--json",
           dest=f"json_{id}",
           action="store_true",
           help="Output as JSON",
           default=None,
       )

2. 创建主解析器和子解析器： 使用 argparse.ArgumentParser 创建主解析器，并使用 add_subparsers 添加子解析器。

   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")

3. 在所有相关解析器中添加公共参数： 调用 add_common_args 函数，将公共参数添加到主解析器和所有相关的子解析器中。注意，为每个解析器传递一个唯一的 ID。

   add_common_args(parser, 0)
   add_common_args(course_parser, 1)
   add_common_args(course_list_parser, 2)

4. 解析命令行参数： 使用 parser.parse_args() 解析命令行参数。

   args = parser.parse_args()

5. 合并参数值： 在解析完参数后，创建一个新的属性 json，其值为所有 json_ 属性的逻辑或。这样，只要在命令行中任何位置指定了 -j 或 --json，最终的 args.json 就会为 True。

   setattr(args, "json", any(getattr(args, f"json_{id}") for id in range(3)))
   print(args)

完整示例代码：

import argparse

def add_common_args(parser, 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")

add_common_args(parser, 0)
add_common_args(course_parser, 1)
add_common_args(course_list_parser, 2)

args = parser.parse_args()
setattr(args, "json", any(getattr(args, f"json_{id}") for id in range(3)))
print(args)

使用示例：

python your_script.py -j course list
python your_script.py course -j list
python your_script.py course list -j

在以上任何一种情况下，args.json 的值都会为 True。

注意事项

• ID 的唯一性： 确保传递给 add_common_args 函数的 ID 在所有解析器中都是唯一的，以避免命名冲突。
• 参数数量： 如果需要添加多个公共参数，可以修改 add_common_args 函数，使其能够处理多个参数。
• 适用性： 这种方法适用于参数数量不多，且需要在多个子命令中共享的情况。如果需要处理大量参数，或者参数之间的依赖关系非常复杂，可能需要考虑其他更高级的解决方案。
• 代码可读性： 这种方法略显繁琐，可能会降低代码的可读性。建议添加适当的注释，以提高代码的可维护性。

总结

虽然 argparse 并没有直接提供在任意位置使用可选参数的功能，但通过这种变通方法，可以在一定程度上模拟实现该需求。该方案通过在所有相关解析器中定义参数，并最终合并它们的结果，从而实现了在不同位置使用相同参数的目的。虽然该方法略显复杂，但在某些情况下，它可以提供更大的灵活性。在实际应用中，需要根据具体情况权衡利弊，选择最合适的解决方案。