Python Glossary English

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

argparse.HelpFormatter

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

Форматтер справки по умолчанию: собирает текст usage и help, перенося строки по ширине терминала. Его наследуют все остальные форматтеры argparse.

Синтаксис

argparse.ArgumentParser(formatter_class=argparse.HelpFormatter)

Он склеивает абзацы: переводы строк и отступы в description и help схлопываются в пробелы, поэтому заранее размеченный текст справки превращается в одну строку. Публичным считается только имя класса, а его методы — деталь реализации, так что наследоваться от него ради переопределения методов рискованно. Для сохранения переносов выбирают RawDescriptionHelpFormatter или RawTextHelpFormatter.

Примеры

import argparse
parser = argparse.ArgumentParser(prog='app', description='Строка 1\n  Строка 2')
print(parser.format_help())  # → usage: app [-h] / Строка 1 Строка 2 — переносы схлопнуты

См. также

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