Argparse： '--help'にデフォルト値を含める方法？

次の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フォーマッタをサブクラス化するだけですか？

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)

'%(default)s'表示内容を制御するには、ヘルプパラメータに追加します。

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

ラッパークラス

これは、デフォルトを表示argparse.RawTextHelpFormatterし、同時に次のような別のフォーマッターを使用するためにこれまでに見つけた中で最も信頼性が高く、DRYのアプローチです。

#!/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を使用する方法はないと思います。argparsedocstringさんのコメント：

このモジュールの他のすべてのクラスは、実装の詳細と見なされます。（また、HelpFormatterとRawDescriptionHelpFormatterはオブジェクト名としてのみパブリックと見なされることに注意してください。フォーマッタオブジェクトのAPIは実装の詳細と見なされます。）

参照：argparseヘルプメッセージのカスタマイズ

Python 3.6.5でテスト済み。