Python argparse帮助信息，禁用短选项的metavar

Question

我想构造一个argparser帮助消息，看起来像:

-i, --input=INPUT    help for input
-o, --output=output  help for output

我的当前代码:

arg_parser = argparse.ArgumentParser
arg_parser.add_argument('-i', '--input', dest='input', metavar='=INPUT', help='help for input')
arg_parser.add_argument('-o', '--output', dest='output', metavar='=OUTPUT', help='help for output')
arg_parser.print_help()

给了我

-i =INPUT, --input =INPUT    help for input
-o =INPUT, --output =output  help for output

我只是想知道如何去掉短选项和长选项之间的东西

Answer 1

不要在print_help() from argparse中显示两次长选项

本质上也是同样的问题。如果您不打算编写自己的HelpFormatter子类(可能需要更改一个方法)，则需要使用现有的格式化工具—帮助、元数据和描述。

也在这里

和我如何避免大写占位符在python's argparse模块?

对于88275023问题，我制定了(但没有发布)这个Formatter类。更改在末尾

class CustomFormatter(argparse.HelpFormatter):
    def _format_action_invocation(self, action):
        if not action.option_strings:
            metavar, = self._metavar_formatter(action, action.dest)(1)
            return metavar
        else:
            parts = []
            # if the Optional doesn't take a value, format is:
            #    -s, --long
            if action.nargs == 0:
                parts.extend(action.option_strings)
            # if the Optional takes a value, format is:
            #    -s ARGS, --long ARGS
            # change to 
            #    -s, --long ARGS
            else:
                default = action.dest.upper()
                args_string = self._format_args(action, default)
                for option_string in action.option_strings:
                    #parts.append('%s %s' % (option_string, args_string))
                    parts.append('%s' % option_string)
                parts[-1] += ' %s'%args_string
            return ', '.join(parts)

Answer 2

正如在被接受的答案的注释中提到的，以下参数对我来说已经足够了。

metavar='b'

Answer 3

更短的自定义格式化器版本:

import argparse

class HelpFormatter(argparse.HelpFormatter):
    def _format_action_invocation(self, action: argparse.Action) -> str:
        formatted = super()._format_action_invocation(action)
        if action.option_strings and action.nargs != 0:
            formatted = formatted.replace(
                f" {self._format_args(action, self._get_default_metavar_for_optional(action))}",
                "",
                len(action.option_strings) - 1,
            )
        return formatted

示例输出:

app@01d3adfb794b:/usr/local/src/app$ app database --help
Usage: app database [-h] [-s] [-d] [-b [NAME]]
Options:
  -h, --help           Show this help message and exit
  -s, --sync           Manually sync the database with the services
  -d, --dump           Dump the database as JSON to the STDOUT
  -b, --backup [NAME]  Generate and store a database backup (default: %timestamp%.bak)