Argparse: sposób na dołączenie wartości domyślnych do '--help'?

Załóżmy, że mam następujący fragment kodu:

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

Obecnie --helpzwraca:

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.

Wolałbym coś takiego:

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

Zerknięcie na kod formatera pomocy ujawnił ograniczone opcje. Czy istnieje sprytny sposób na argparsewydrukowanie domyślnej wartości --scan-timew podobny sposób, czy też powinienem po prostu podklasować helpformatyzator?

Użyj argparse.ArgumentDefaultsHelpFormatterformatyzatora :

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

Aby zacytować dokumentację:

Druga dostępna klasa formatera ArgumentDefaultsHelpFormatterdoda informacje o domyślnej wartości każdego z argumentów.

Zauważ, że dotyczy to tylko argumentów ze zdefiniowanym tekstem pomocy ; bez helpwartości dla argumentu, nie ma komunikatu o pomoc, aby dodać informacje o wartości domyślnej do .

Dokładne wyjście dla opcji czasu skanowania staje się wtedy:

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

Dodaj '%(default)s'do parametru pomocy, aby kontrolować wyświetlane informacje.

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

Klasa opakowania

Jest to najbardziej niezawodne i SUCHE podejście, jakie do tej pory znalazłem, aby zarówno wyświetlać wartości domyślne, jak i używać innego formatyzatora, takiego jak 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())

Wynik:

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+ RawTextHelpFormatterwielokrotne dziedziczenie

Wielokrotne dziedziczenie po prostu działa, ale nie wydaje się publicznym 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()

Wynik:

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)

To po prostu działa, ponieważ, jak możemy łatwo zobaczyć ze źródeł https://github.com/python/cpython/blob/v3.6.5/Lib/argparse.py#L648, że:

• RawTextHelpFormatter narzędzia _split_lines
• ArgumentDefaultsHelpFormatter narzędzia _get_help_string

więc możemy zgadywać, że będą ze sobą dobrze współpracować.

Nie wydaje się to jednak publicznym interfejsem API, formatter_classpodobnie jak metody , więc nie sądzę, że istnieje obecnie publiczny sposób interfejsu API. argparsedocstring mówi:

Wszystkie pozostałe klasy w tym module są uważane za szczegóły implementacji. (Należy również pamiętać, że HelpFormatter i RawDescriptionHelpFormatter są uważane za publiczne tylko jako nazwy obiektów - API obiektów formaterów jest nadal uważane za szczegół implementacji).

Zobacz także: Dostosuj komunikat pomocy argparse

Testowane na Pythonie 3.6.5.