อาร์กิวเมนต์: วิธีรวมค่าเริ่มต้นใน '--help' หรือไม่

สมมติว่าฉันมีตัวอย่างอาร์กิวเมนต์ต่อไปนี้:

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ในลักษณะที่คล้ายกันหรือฉันควร subclass helpformatter?

ใช้ตัว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)")

คลาส Wrapper

นี่เป็นวิธีที่เชื่อถือได้และแห้งที่สุดที่ฉันเคยพบมาเพื่อแสดงค่าเริ่มต้นและใช้ตัวจัดรูปแบบอื่นเช่น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())

เอาท์พุท:

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