Argparse: '--help' içine varsayılan değerler dahil etmenin yolu?

Aşağıdaki argparse snippet'ine sahip olduğumu varsayalım:

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

Şu anda şunu --helpdöndürüyor:

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.

Gibi bir şey tercih ederim:

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

Yardım biçimlendirici koduna bakmak sınırlı seçenekler ortaya koydu. Benzer bir argparsedeğer için varsayılan değeri yazdırmanın akıllıca bir yolu var mı --scan-time, yoksa yalnızca helpbiçimlendiriciyi alt sınıfta mı kullanmalıyım?

argparse.ArgumentDefaultsHelpFormatterFormatlayıcıyı kullanın :

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

Belgeleri alıntılamak için:

Kullanılabilir diğer biçimlendirici sınıfı ArgumentDefaultsHelpFormatter, bağımsız değişkenlerin her birinin varsayılan değeri hakkında bilgi ekler.

Bunun yalnızca yardım metni tanımlanmış argümanlar için geçerli olduğunu unutmayın ; Hiçbir birlikte helpbir argüman değeri, varsayılan değeri hakkında bilgi eklemek için hiçbir yardım mesajı yoktur için .

Tarama zamanı seçeneğiniz için kesin çıktı şu şekilde olur:

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

'%(default)s'Görüntülenenleri kontrol etmek için help parametresine ekleyin .

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

Sarıcı sınıfı

Bu, hem varsayılanları göstermek hem argparse.RawTextHelpFormatterde aynı anda başka bir formatlayıcı kullanmak için şimdiye kadar bulduğum en güvenilir ve KURU yaklaşımdır :

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

Çıktı:

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çoklu kalıtım

Birden fazla miras sadece işe yarar, ancak herkese açık API gibi görünmüyor:

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

Çıktı:

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)

Sadece çalışır, çünkü https://github.com/python/cpython/blob/v3.6.5/Lib/argparse.py#L648 kaynaklarından önemsiz olarak gördüğümüz için :

• RawTextHelpFormatter uygular _split_lines
• ArgumentDefaultsHelpFormatter uygular _get_help_string

böylece birlikte iyi çalışacaklarını tahmin edebiliriz.

Ancak, bu genel API gibi görünmüyor ve ne yöntemleri formatter_class, bu yüzden şu anda bunu yapmak için genel bir API yolu olduğunu sanmıyorum. argparsedocstring diyor ki:

Bu modüldeki diğer tüm sınıflar uygulama ayrıntıları olarak kabul edilir. (Ayrıca, HelpFormatter ve RawDescriptionHelpFormatter öğelerinin yalnızca nesne adları olarak herkese açık olarak kabul edildiğini unutmayın - biçimlendirici nesnelerinin API'sı yine de bir uygulama ayrıntısı olarak kabul edilir.)

Ayrıca bkz: Argparse yardım mesajını özelleştirme

Python 3.6.5 üzerinde test edilmiştir.