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-time的默认值，或者我应该只是help格式化器的子类？

Answer 1

使用argparse.ArgumentDefaultsHelpFormatter formatter：

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

引用文档：

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

请注意，仅适用于已定义帮助文本的参数;如果参数没有help值，则无法将添加到。

扫描时间选项的确切输出将变为：

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

Answer 2

将'%(default)'添加到help参数以控制显示的内容。

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

Answer 3

包装器类

这是迄今为止我发现的最可靠，最干燥的方法，既可以显示默认值，也可以同时使用另一种格式化程序，例如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是仍被视为实现细节。）

另请参阅：Customize argparse help message

在Python 3.6.5上测试。

Answer 4

能够自动在帮助输出中包含default值通常很有用，但仅限于明确指定的值（使用{{ 1}})。已经提到的方法在这方面存在一些不足：

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

这两种方法最终都需要人工干预才能打印出“正确”的默认值。自动执行此操作的一种方法是增加 '%(default)s' 以忽略 help 和 ArgumentDefaultsHelpFormatter 的默认值：

None

用它代替 False：

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，则不会在该类的帮助中显示；如果您希望在帮助输出中使用该参数，请将 None 字符串添加到 False。

Answer 5

python中default没有Optparser 但是，您可以使用以下内容 -

# show help as default
if len(sys.argv) == 1:
  os.system("python " + sys.argv[0] + " -h")
  exit()

这将使用-h选项和exit运行相同的脚本请注意 - 您需要import os, sys个模块才能使用此选项。

Argparse：在'--help'中包含默认值的方法？

5 个答案: