Argparse: Cara memasukkan nilai default di '--help'?

Misalkan saya memiliki potongan argparse berikut:

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

Saat ini, --helppengembalian:

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.

Saya lebih suka sesuatu seperti:

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

Mengintip kode bantuan formatter mengungkapkan opsi terbatas. Apakah ada cara pintar argparseuntuk mencetak nilai default --scan-timedengan cara yang sama, atau haruskah saya hanya subkelas helppemformat?

Gunakan argparse.ArgumentDefaultsHelpFormatterformatter :

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

Mengutip dokumentasi:

Kelas formatter lain yang tersedia,, ArgumentDefaultsHelpFormatterakan menambahkan informasi tentang nilai default setiap argumen.

Perhatikan bahwa ini hanya berlaku untuk argumen yang memiliki teks bantuan yang ditentukan ; tanpa helpnilai untuk sebuah argumen, tidak ada bantuan pesan untuk menambah informasi tentang nilai default untuk .

Output yang tepat untuk opsi waktu pindai Anda kemudian menjadi:

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

Tambahkan '%(default)s'ke parameter bantuan untuk mengontrol apa yang ditampilkan.

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

Kelas pembungkus

Ini adalah pendekatan yang paling andal dan KERING yang saya temukan sejauh ini untuk menunjukkan default dan menggunakan formatter lain seperti argparse.RawTextHelpFormatterpada saat yang sama:

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

Keluaran:

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+ RawTextHelpFormattermultiple inheritance

Beberapa warisan hanya berfungsi, tetapi sepertinya itu bukan API publik:

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

Keluaran:

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)

Ini hanya berfungsi karena seperti yang dapat kita lihat secara sepele dari sumber https://github.com/python/cpython/blob/v3.6.5/Lib/argparse.py#L648 bahwa:

• RawTextHelpFormatter mengimplementasikan _split_lines
• ArgumentDefaultsHelpFormatter mengimplementasikan _get_help_string

jadi kita bisa menebak bahwa mereka akan bekerja sama dengan baik.

Namun, ini sepertinya bukan API publik, dan juga tidak ada metode formatter_class, jadi saya tidak berpikir ada cara API publik untuk melakukannya saat ini. argparsedocstring mengatakan:

Semua kelas lain dalam modul ini dianggap sebagai detail implementasi. (Perhatikan juga bahwa HelpFormatter dan RawDescriptionHelpFormatter hanya dianggap publik sebagai nama objek - API objek formatter masih dianggap sebagai detail implementasi.)

Lihat juga: Kustomisasi pesan bantuan argparse

Diuji pada Python 3.6.5.