python - Argparse：在“--help”中包含默认值的方法？

Question

假设我有以下 argparse 片段：

diags.cmdln_parser.add_argument( '--scan-time',
                     action  = 'store',
                     nargs   = '?',
                     type    = int,
                     default = 5,
                     help    = "Wait SCAN-TIME seconds between status checks.")

目前，--help返回：

usage: connection_check.py [-h]
                             [--version] [--scan-time [SCAN_TIME]]

          Test the reliability/uptime of a connection.



optional arguments:
-h, --help            show this help message and exit
--version             show program's version number and exit
--scan-time [SCAN_TIME]
                    Wait SCAN-TIME seconds between status checks.

我更喜欢这样的东西：

--scan-time [SCAN_TIME]
                    Wait SCAN-TIME seconds between status checks.
                    (Default = 5)

查看帮助格式化程序代码会发现有限的选项。有没有一种聪明的方法可以以类似argparse的方式打印默认值，或者我应该只对格式化程序进行子类化？--scan-timehelp

score 562 · Accepted Answer

使用argparse.ArgumentDefaultsHelpFormatter格式化程序：

parser = argparse.ArgumentParser(
    # ... other options ...
    formatter_class=argparse.ArgumentDefaultsHelpFormatter)

引用文档：

另一个可用的格式化程序类ArgumentDefaultsHelpFormatter，将添加有关每个参数的默认值的信息。

请注意，这只适用于定义了帮助文本的参数；如果参数没有help值，则没有帮助消息将有关默认值的信息添加到.

然后，您的扫描时间选项的确切输出变为：

  --scan-time [SCAN_TIME]
                        Wait SCAN-TIME seconds between status checks.
                        (default: 5)

score 247 · Accepted Answer

添加'%(default)s'到帮助参数以控制显示的内容。

parser.add_argument("--type", default="toto", choices=["toto","titi"],
                              help = "type (default: %(default)s)")

备注：

它是+ 括号中的默认值 + 格式字符（不要与我们在或 f-string中找到的%大括号混淆）{default}format
不要忘记在末尾添加类型表示的“说明符字符”（即s字符串、d整数、f浮点数等）
您还可以添加通常的“printf”格式说明符（如浮点数、前导零等）

您可以参考printf 文档了解更多详细信息。

score 14 · Accepted Answer

包装类

这是迄今为止我发现的最可靠和最干燥的方法，既可以显示默认值，又可以同时使用另一种格式化程序argparse.RawTextHelpFormatter：

#!/usr/bin/env python3

import argparse

class ArgumentParserWithDefaults(argparse.ArgumentParser):
    def add_argument(self, *args, help=None, default=None, **kwargs):
        if help is not None:
            kwargs['help'] = help
        if default is not None and args[0] != '-h':
            kwargs['default'] = default
            if help is not None:
                kwargs['help'] += ' Default: {}'.format(default)
        super().add_argument(*args, **kwargs)

parser = ArgumentParserWithDefaults(
    formatter_class=argparse.RawTextHelpFormatter
)
parser.add_argument('-a', default=13, help='''my help
for a''')
parser.add_argument('-b', default=42, help='''my help
for b''')
parser.add_argument('--no-default', help='''my help
for no-default''')
parser.add_argument('--no-help', default=101)

parser.print_help()
print()
print(parser.parse_args())

输出：

usage: main.py [-h] [-a A] [-b B] [--no-default NO_DEFAULT]
               [--no-help NO_HELP]

optional arguments:
  -h, --help            show this help message and exit
  -a A                  my help
                        for a Default: 13
  -b B                  my help
                        for b Default: 42
  --no-default NO_DEFAULT
                        my help
                        for no-default
  --no-help NO_HELP

Namespace(a=13, b=42, no_default=None, no_help=101)

ArgumentDefaultsHelpFormatter+RawTextHelpFormatter多重继承

多重继承只是工作，但它似乎不是公共API：

#!/usr/bin/env python3

import argparse

class RawTextArgumentDefaultsHelpFormatter(
        argparse.ArgumentDefaultsHelpFormatter,
        argparse.RawTextHelpFormatter
    ):
        pass

parser = argparse.ArgumentParser(
    formatter_class=RawTextArgumentDefaultsHelpFormatter
)
parser.add_argument('-a', default=13, help='''my help
for a''')
parser.add_argument('-b', default=42, help='''my help
for b''')
parser.print_help()

输出：

usage: a.py [-h] [-a A] [-b B]

optional arguments:
  -h, --help  show this help message and exit
  -a A        my help
              for a (default: 13)
  -b B        my help
              for b (default: 42)

它之所以有效，是因为我们可以从源代码https://github.com/python/cpython/blob/v3.6.5/Lib/argparse.py#L648中看到：

RawTextHelpFormatter工具_split_lines
ArgumentDefaultsHelpFormatter工具_get_help_string

所以我们可以猜测它们会很好地协同工作。

但是，这似乎不是公共 API，的方法也不是formatter_class，所以我认为目前没有公共 API 方法可以做到这一点。argparse文档字符串说：

此模块中的所有其他类都被视为实现细节。（另请注意，HelpFormatter 和 RawDescriptionHelpFormatter 仅被视为作为对象名称公开——格式化程序对象的 API 仍被视为实现细节。）

另请参阅：自定义 argparse 帮助消息

在 Python 3.6.5 上测试。

score 4 · Accepted Answer

能够在帮助输出中自动包含default值通常很有用，但仅限于那些明确指定的值（使用default=..）。已经提到的方法在这方面存在一些缺点：

该ArgumentDefaultsHelpFormatter 方法(default: None)会为每个未明确指定默认值的参数以及(default: False)“标志”( action='store_true')打印输出。这会使帮助输出变得混乱。为避免这种情况，default=argparse.SUPPRESS需要为每个此类参数手动添加。
该'%(default)s' 方法需要手动将其添加到我们确实希望在帮助中打印的所有参数help字符串中。

这两种方法最终都需要手动干预才能仅打印出“正确”的默认值。自动执行此操作的一种方法是增加ArgumentDefaultsHelpFormatter忽略Nones 和Falses 默认值：

class ExplicitDefaultsHelpFormatter(argparse.ArgumentDefaultsHelpFormatter):
    def _get_help_string(self, action):
        if action.default in (None, False):
            return action.help
        return super()._get_help_string(action)

用它代替ArgumentDefaultsHelpFormatter：

parser = argparse.ArgumentParser(
        formatter_class=ExplicitDefaultsHelpFormatter
                )

这将仅打印default帮助输出中明确设置的值。

注意：如果参数的默认值显式设置为Noneor False，则不会在此类的帮助中显示；如果您希望在帮助输出中添加该参数的%(default)s字符串。help

python - Argparse：在“--help”中包含默认值的方法？

4 回答 4

Related

Reference