Argparse: Maneira de incluir valores padrão em '--help'?

Suponha que eu tenha o seguinte trecho de argumento:

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

Atualmente, --helpretorna:

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.

Eu preferiria algo como:

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

Espreitar o código do formatador de ajuda revelou opções limitadas. Existe uma maneira inteligente argparsede imprimir o valor padrão de --scan-timemaneira semelhante ou devo apenas subclassificar o helpformatador?

Use o argparse.ArgumentDefaultsHelpFormatterformatador :

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

Para citar a documentação:

A outra classe de formatador disponível ArgumentDefaultsHelpFormatter,, adicionará informações sobre o valor padrão de cada um dos argumentos.

Observe que isso se aplica apenas a argumentos que possuem texto de ajuda definido ; sem helpvalor para um argumento, não há nenhuma mensagem de ajuda para adicionar informações sobre o valor padrão para .

A saída exata para a sua opção de tempo de varredura se torna:

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

Adicione '%(default)s'ao parâmetro de ajuda para controlar o que é exibido.

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

Classe Wrapper

Essa é a abordagem mais confiável e DRY que eu encontrei até agora para mostrar padrões e usar outro formatador, como argparse.RawTextHelpFormatterao mesmo tempo:

#!/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())

Resultado:

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+ RawTextHelpFormatterherança múltipla

A herança múltipla simplesmente funciona, mas não parece ser uma API pública:

#!/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()

Resultado:

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)

Ele simplesmente funciona funciona porque, como podemos ver trivialmente das fontes https://github.com/python/cpython/blob/v3.6.5/Lib/argparse.py#L648, que:

• RawTextHelpFormatter implementa _split_lines
• ArgumentDefaultsHelpFormatter implementa _get_help_string

para que possamos adivinhar que eles funcionarão juntos muito bem.

No entanto, isso não parece ser uma API pública, nem os métodos formatter_class, então não acho que exista uma maneira pública de fazer isso atualmente. argparsedocstring diz:

Todas as outras classes neste módulo são consideradas detalhes de implementação. (Observe também que HelpFormatter e RawDescriptionHelpFormatter são considerados públicos apenas como nomes de objetos - a API dos objetos do formatador ainda é considerada um detalhe de implementação.)

Consulte também: Personalizar a mensagem de ajuda do argparse

Testado em Python 3.6.5.