基于Python argparse实现分级帮助（普通/高级参数）

需求说明 #

需要对extended_help.py进行修改，基于Python的argparse模块实现分级帮助：

1. 执行python extended_help.py -h时，仅输出普通参数的帮助信息；
2. 执行python extended_help.py -H时，输出包含所有参数的完整帮助信息（即原python extended_help.py -h的输出内容）；
3. 核心要求：禁止手动重复编写参数的帮助信息。

已尝试的方案 #

• 禁用默认帮助，将-h绑定version action、-H绑定help action：-H可正常显示完整帮助，但-h只能输出占位文本，无法满足需求；
• 提前捕获添加高级参数前的帮助信息，覆盖-h的version属性：功能实现，但-h输出的帮助丢失了原有的换行和空格格式，显示混乱；
• 最终通过自定义action解决了格式问题，现寻求对该方案的反馈或其他替代实现思路。

优化后的解决方案（自定义Action实现） #

通过自定义一个HelpAction类，分别处理普通帮助和完整帮助的输出逻辑，无需重复编写任何帮助文本：

import argparse
import sys

class HelpAction(argparse.Action):
    def __init__(self, option_strings, dest=argparse.SUPPRESS, default=argparse.SUPPRESS,
                 help=None):
        super().__init__(option_strings=option_strings, dest=dest, default=default, help=help)

    def __call__(self, parser, namespace, values, option_string=None):
        # 区分普通帮助和完整帮助
        if option_string in ('-h', '--help'):
            # 创建仅包含普通参数的临时解析器
            temp_parser = argparse.ArgumentParser(description=parser.description)
            # 复制普通参数组
            for group in parser._action_groups:
                if group.title == 'common parameters':
                    temp_group = temp_parser.add_argument_group(group.title, group.description)
                    for action in group._actions:
                        temp_group._add_action(action)
            temp_parser.print_help()
        elif option_string in ('-H', '--help-all'):
            # 输出完整帮助
            parser.print_help()
        sys.exit(0)

def main():
    ap = argparse.ArgumentParser(description="演示分级帮助功能的工具")
    
    # 替换默认帮助，添加自定义HelpAction
    ap.add_argument('-h', '--help', action=HelpAction, help='显示普通参数帮助并退出')
    ap.add_argument('-H', '--help-all', action=HelpAction, help='显示完整帮助（含高级参数）并退出')

    common_args = ap.add_argument_group("common parameters",
                                        """这些参数通常足以运行工具。`%(prog)s -h|--help`会列出这些参数。""")
    advanced_args = ap.add_argument_group("advanced parameters",
                                          """这些参数仅面向有特殊需求的高级用户。为了让帮助更易用，`%(prog)s -h|--help`不会显示这些参数，而`%(prog)s -H|--help-all`会包含所有参数。""")

    common_args.add_argument("-f", "--foo", metavar="<foo>", help="常用的Foo参数")
    common_args.add_argument("--flag", action="store_true", help="启用常规选项的标志")
    advanced_args.add_argument("-b", "--bar", metavar="<bar>", help="很少用到的Bar参数")
    advanced_args.add_argument("-B", "--baz", metavar="<baz>", help="更冷门的Baz参数")
    advanced_args.add_argument("--FLAG", action="store_true", help="仅面向高级用户的标志")

    ap.parse_args()

if __name__ == "__main__":
    main()

方案说明 #

1. 自定义HelpAction：通过继承argparse.Action，重写__call__方法，根据传入的选项字符串（-h或-H）执行不同逻辑；
2. 普通帮助实现：创建临时解析器，仅复制原解析器中的common parameters参数组，然后调用print_help()输出，保证格式与原argparse输出一致；
3. 完整帮助实现：直接调用原解析器的print_help()，输出所有参数信息；
4. 无重复帮助文本：所有参数的帮助信息仅编写一次，通过复制参数组的方式复用，完全符合需求。

替代方案思路 #

如果不想自定义Action，也可以通过提前创建两个解析器的方式实现：

• 第一个解析器仅添加普通参数，处理-h的输出；
• 第二个解析器添加所有参数，处理-H的输出；
• 但这种方式需要注意参数的同步维护，不如自定义Action灵活。

内容的提问来源于stack exchange，提问作者mschilli