Python Glossary English

все Python 3argparseпонятие

argparse.ArgumentDefaultsHelpFormatter

форматтеры справки

Форматтер справки, дописывающий значение по умолчанию к help аргументов: «(default: 3)». Избавляет от ручного дублирования default в тексте.

Синтаксис

argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)

Значение дописывается только аргументам, у которых есть help: аргумент без help останется без пометки, даже если default задан. Для аргументов без default в справке появится «(default: None)», что пугает пользователей; заглушить можно, вписав в help явный %(default)s там, где нужно, — тогда форматтер не добавит его второй раз.

Примеры

import argparse
parser = argparse.ArgumentParser(
    prog='app', formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('--n', type=int, default=3, help='сколько раз')
parser.add_argument('--name', default='x')
print(parser.format_help())  # → --n N        сколько раз (default: 3) / --name NAME

См. также

Открыть в полном глоссарииdocs.python.orgСообщить о неточности