Python Glossary English

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

argparse.RawDescriptionHelpFormatter

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

Форматтер справки, сохраняющий переносы строк и отступы в description и epilog. Текст help у отдельных аргументов по-прежнему переформатируется.

Синтаксис

argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter)

Подходит для описания с примерами вызова или списком — они сохранят вид. Частая ошибка: ждать, что и help у аргументов сохранит переносы, — нет, его форматтер по-прежнему склеивает; для этого нужен RawTextHelpFormatter. Форматтеры передаются классом в formatter_class=, без скобок, и их нельзя совмещать в одном парсере, кроме как общим подклассом.

Примеры

import argparse
parser = argparse.ArgumentParser(
    prog='app', description='Строка 1\n  Строка 2',
    formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('--n', help='сколько\nраз')
print(parser.format_help())  # → Строка 1 / Строка 2 / сколько раз — help склеен

См. также

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