formatter.md

1> **Источник:** https://python-all.ru/3.3/library/formatter.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 32.1. [`formatter`](https://python-all.ru/3.3/library/formatter.html#module-formatter) – Generic output formatting89Этот модуль поддерживает два определения интерфейса, каждое с несколькими реализациями: интерфейс *форматера* и интерфейс *объекта записи*, который требуется интерфейсу форматера.1011Объекты форматера преобразуют абстрактный поток событий форматирования в конкретные выходные события на объектах записи. Форматеры управляют несколькими стековыми структурами, чтобы различные свойства объекта записи можно было изменять и восстанавливать; объекты записи не обязаны обрабатывать относительные изменения или какие-либо операции «отката». Определенные свойства объекта записи, которыми можно управлять через объекты форматера: горизонтальное выравнивание, шрифт и отступ левого поля. Предусмотрен механизм, который также позволяет передавать объекту записи произвольные, неисключительные настройки стиля. Дополнительные интерфейсы облегчают обработку необратимых событий форматирования, таких как разделение абзацев.1213Объекты записи инкапсулируют интерфейсы устройств. Поддерживаются как абстрактные устройства (например, форматы файлов), так и физические устройства. Все предоставленные реализации работают с абстрактными устройствами. Интерфейс предоставляет механизмы для установки свойств, которыми управляют объекты форматера, и вставки данных в вывод.1415## 32.1.1. The Formatter Interface1617Интерфейсы для создания форматеров зависят от конкретного класса форматера, который создается. Описанные ниже интерфейсы являются обязательными, которые все форматеры должны поддерживать после инициализации.1819На уровне модуля определен один элемент данных:2021#### `formatter.AS_IS`2223Значение, которое может использоваться в спецификации шрифта, передаваемой методу `push_font()`, описанному ниже, или в качестве нового значения для любого другого метода `push_property()`. Передача значения `AS_IS` позволяет вызвать соответствующий метод `pop_property()` без необходимости отслеживать, было ли изменено свойство.2425Для объектов-экземпляров форматера определены следующие атрибуты:2627#### `formatter.writer`2829Экземпляр объекта записи, с которым взаимодействует форматер.3031#### `formatter.end_paragraph(blanklines)`3233Закрывает все открытые абзацы и вставляет не менее *пустых строк* перед следующим абзацем.3435#### `formatter.add_line_break()`3637Добавляет жесткий разрыв строки, если его еще нет. Это не нарушает логический абзац.3839#### `formatter.add_hor_rule(*args, **kw)`4041Вставляет горизонтальную линию в вывод. Если в текущем абзаце есть данные, вставляется жесткий разрыв, но логический абзац не разрывается. Аргументы и ключевые слова передаются методу `send_line_break()` writer'а.4243#### `formatter.add_flowing_data(data)`4445Предоставляет данные, которые должны быть отформатированы со схлопыванием пробелов. Пробелы из предыдущих и последующих вызовов [`add_flowing_data()`](https://python-all.ru/3.3/library/formatter.html#formatter.formatter.add_flowing_data) также учитываются при схлопывании. Ожидается, что данные, переданные этому методу, будут переноситься по словам устройством вывода. Обратите внимание, что любой перенос по словам всё равно должен выполняться объектом writer из-за необходимости полагаться на информацию об устройстве и шрифте.4647#### `formatter.add_literal_data(data)`4849Предоставляет данные, которые должны быть переданы объекту записи без изменений. Пробелы, включая символы новой строки и табуляции, считаются допустимыми в значении *data*.5051#### `formatter.add_label_data(format, counter)`5253Вставляет метку, которая должна быть размещена слева от текущего левого поля. Это следует использовать для построения маркированных или нумерованных списков. Если значение *format* является строкой, оно интерпретируется как спецификация формата для *counter*, который должен быть целым числом. Результат этого форматирования становится значением метки; если *format* не является строкой, оно используется как значение метки напрямую. Значение метки передаётся как единственный аргумент методу `send_label_data()` writer'а. Интерпретация нестроковых значений метки зависит от соответствующего writer'а.5455Спецификации формата – это строки, которые в сочетании со значением счётчика используются для вычисления значений меток. Каждый символ в строке формата копируется в значение метки, при этом некоторые символы распознаются как указание на преобразование значения счётчика. В частности, символ `'1'` представляет значение счётчика в виде арабского числа, символы `'A'` и `'a'` представляют алфавитные представления значения счётчика в верхнем и нижнем регистре соответственно, а `'I'` и `'i'` представляют значение счётчика римскими цифрами в верхнем и нижнем регистре. Обратите внимание, что алфавитные и римские преобразования требуют, чтобы значение счётчика было больше нуля.5657#### `formatter.flush_softspace()`5859Отправляет любые ожидающие пробелы, буферизированные от предыдущего вызова [`add_flowing_data()`](https://python-all.ru/3.3/library/formatter.html#formatter.formatter.add_flowing_data), соответствующему объекту writer. Это следует вызывать перед любыми прямыми манипуляциями с объектом writer.6061#### `formatter.push_alignment(align)`6263Помещает новую настройку выравнивания в стек выравнивания. Это может быть [`AS_IS`](https://python-all.ru/3.3/library/formatter.html#formatter.AS_IS), если изменение не требуется. Если значение выравнивания изменено относительно предыдущей настройки, вызывается метод `new_alignment()` writer'а со значением *align*.6465#### `formatter.pop_alignment()`6667Восстанавливает предыдущее выравнивание.6869#### `formatter.push_font((size, italic, bold, teletype))`7071Изменяет некоторые или все свойства шрифта объекта writer. Свойства, которые не установлены в [`AS_IS`](https://python-all.ru/3.3/library/formatter.html#formatter.AS_IS), устанавливаются в переданные значения, в то время как остальные сохраняют текущие настройки. Метод `new_font()` writer'а вызывается с полностью разрешённой спецификацией шрифта.7273#### `formatter.pop_font()`7475Восстанавливает предыдущий шрифт.7677#### `formatter.push_margin(margin)`7879Увеличивает количество отступов левого поля на единицу, связывая логический тег *margin* с новым отступом. Начальный уровень поля – `0`. Изменённые значения логического тега должны быть истинными; ложные значения, отличные от [`AS_IS`](https://python-all.ru/3.3/library/formatter.html#formatter.AS_IS), недостаточны для изменения поля.8081#### `formatter.pop_margin()`8283Восстановить предыдущее поле.8485#### `formatter.push_style(*styles)`8687Помещает произвольное количество спецификаций стиля. Все стили помещаются в стек стилей по порядку. Кортеж, представляющий весь стек, включая значения [`AS_IS`](https://python-all.ru/3.3/library/formatter.html#formatter.AS_IS), передаётся методу `new_styles()` writer'а.8889#### `formatter.pop_style(n=1)`9091Извлекает последние *n* спецификаций стиля, переданных [`push_style()`](https://python-all.ru/3.3/library/formatter.html#formatter.formatter.push_style). Кортеж, представляющий изменённый стек, включая значения [`AS_IS`](https://python-all.ru/3.3/library/formatter.html#formatter.AS_IS), передаётся методу `new_styles()` writer'а.9293#### `formatter.set_spacing(spacing)`9495Устанавливает стиль межстрочных интервалов для writer.9697#### `formatter.assert_line_data(flag=1)`9899Сообщает форматировщику, что в текущий абзац были добавлены данные вне основного потока. Это следует использовать, когда writer изменялся напрямую. Необязательный аргумент *flag* можно установить в false, если в результате манипуляций с writer в конце вывода возник жёсткий разрыв строки.100101## 32.1.2. Formatter Implementations102103В этом модуле предоставлены две реализации объектов форматировщика. Большинство приложений могут использовать один из этих классов без изменений или создания подклассов.104105#### `class formatter.NullFormatter(writer=None)`106107Форматтер, который ничего не делает. Если параметр *writer* опущен, создаётся экземпляр [`NullWriter`](https://python-all.ru/3.3/library/formatter.html#formatter.NullWriter). Никакие методы писателя не вызываются экземплярами [`NullFormatter`](https://python-all.ru/3.3/library/formatter.html#formatter.NullFormatter). Реализации должны наследоваться от этого класса, если они реализуют интерфейс писателя, но не нуждаются в наследовании какой-либо реализации.108109#### `class formatter.AbstractFormatter(writer)`110111Стандартный форматировщик. Эта реализация показала широкую применимость для многих писателей и может использоваться напрямую в большинстве случаев. Она использовалась для реализации полнофункционального веб-браузера.112113## 32.1.3. The Writer Interface114115Интерфейсы для создания писателей зависят от конкретного класса писателя, который создаётся. Описанные ниже интерфейсы являются обязательными интерфейсами, которые все писатели должны поддерживать после инициализации. Обратите внимание, что хотя большинство приложений может использовать класс [`AbstractFormatter`](https://python-all.ru/3.3/library/formatter.html#formatter.AbstractFormatter) в качестве форматтера, писатель должен обычно предоставляться приложением.116117#### `writer.flush()`118119Сбрасывает все буферизованные выходные данные или события управления устройством.120121#### `writer.new_alignment(align)`122123Устанавливает стиль выравнивания. Значение *align* может быть любым объектом, но по соглашению является строкой или `None`, где `None` указывает, что должно использоваться «предпочтительное» выравнивание писателя. Обычные значения *align*: `'left'`, `'center'`, `'right'` и `'justify'`.124125#### `writer.new_font(font)`126127Устанавливает стиль шрифта. Значение *font* будет `None`, что указывает на необходимость использования шрифта устройства по умолчанию, или кортежем вида `(size, italic, bold, teletype)`. Параметр size будет строкой, указывающей размер шрифта; конкретные строки и их интерпретация должны быть определены приложением. Значения *italic*, *bold* и *teletype* являются логическими значениями, определяющими, какие из этих атрибутов шрифта следует использовать.128129#### `writer.new_margin(margin, level)`130131Устанавливает уровень поля в целое число *level*, а логический тег – в *margin*. Интерпретация логического тега остаётся на усмотрение writer; единственное ограничение на значение логического тега – оно не должно быть ложным для ненулевых значений *level*.132133#### `writer.new_spacing(spacing)`134135Устанавливает стиль интервалов в *spacing*.136137#### `writer.new_styles(styles)`138139Устанавливает дополнительные стили. Значение *styles* представляет собой кортеж произвольных значений; значение [`AS_IS`](https://python-all.ru/3.3/library/formatter.html#formatter.AS_IS) следует игнорировать. Кортеж *styles* может интерпретироваться либо как набор, либо как стек в зависимости от требований приложения и реализации писателя.140141#### `writer.send_line_break()`142143Разрывает текущую строку.144145#### `writer.send_paragraph(blankline)`146147Создаёт разделение абзацев как минимум из *blankline* пустых строк или эквивалентное. Значение *blankline* будет целым числом. Обратите внимание, что реализация получит вызов [`send_line_break()`](https://python-all.ru/3.3/library/formatter.html#formatter.writer.send_line_break) перед этим вызовом, если требуется разрыв строки; этот метод не должен включать завершение последней строки абзаца. Он отвечает только за вертикальные промежутки между абзацами.148149#### `writer.send_hor_rule(*args, **kw)`150151Отображает горизонтальную линию на устройстве вывода. Аргументы этого метода полностью зависят от приложения и писателя, и должны интерпретироваться с осторожностью. Реализация метода может предполагать, что разрыв строки уже был сделан через [`send_line_break()`](https://python-all.ru/3.3/library/formatter.html#formatter.writer.send_line_break).152153#### `writer.send_flowing_data(data)`154155Выводит символьные данные, которые при необходимости могут быть перенесены по словам и переформатированы. В любой последовательности вызовов этого метода writer может считать, что последовательности из нескольких пробелов были сжаты до одного пробела.156157#### `writer.send_literal_data(data)`158159Выводит символьные данные, которые уже отформатированы для отображения. Как правило, это следует понимать так, что разрывы строк, обозначенные символами новой строки, должны сохраняться, и новые разрывы строк не должны добавляться. Данные могут содержать встроенные символы новой строки и табуляции, в отличие от данных, передаваемых интерфейсу `send_formatted_data()`.160161#### `writer.send_label_data(data)`162163Устанавливает *данные* слева от текущего левого поля, если это возможно. Значение *данных* не ограничено; обработка нестроковых значений полностью зависит от приложения и writer'а. Этот метод будет вызываться только в начале строки.164165## 32.1.4. Реализации Writer166167Три реализации интерфейса объекта писателя предоставляются в качестве примеров этим модулем. Большинству приложений потребуется создавать новые классы писателя на основе класса [`NullWriter`](https://python-all.ru/3.3/library/formatter.html#formatter.NullWriter).168169#### `class formatter.NullWriter`170171Writer, который предоставляет только определение интерфейса; никаких действий над методами не выполняется. Это должен быть базовый класс для всех writer'ов, которым не нужно наследовать методы реализации.172173#### `class formatter.AbstractWriter`174175Writer, который можно использовать в отладочных форматтерах, но не более того. Каждый метод просто сообщает о себе, печатая своё имя и аргументы в стандартный вывод.176177#### `class formatter.DumbWriter(file=None, maxcol=72)`178179Простой класс writer'а, который записывает вывод в [*файловый объект*](https://python-all.ru/3.3/glossary.html#term-file-object), переданный как *file*, или, если *file* опущен, в стандартный вывод. Вывод просто переносится по словам на количество столбцов, заданное *maxcol*. Этот класс подходит для переформатирования последовательности абзацев.180