formatter – Общее форматирование вывода¶formatter – Generic output formatting

Интерфейс форматера¶The Formatter Interface

Интерфейсы для создания форматеров зависят от конкретного класса форматера, который создается. Описанные ниже интерфейсы являются обязательными, которые все форматеры должны поддерживать после инициализации.

На уровне модуля определен один элемент данных:

formatter.AS_IS¶

Значение, которое можно использовать в спецификации шрифта, передаваемой методу push_font(), описанному ниже, или как новое значение для любого другого метода push_property(). Помещение значения AS_IS позволяет вызвать соответствующий метод pop_property(), не отслеживая, было ли изменено свойство.

Для объектов-экземпляров форматера определены следующие атрибуты:

formatter.writer¶

Экземпляр объекта записи, с которым взаимодействует форматер.

formatter.end_paragraph(blanklines)¶

Закрывает все открытые абзацы и вставляет не менее пустых строк перед следующим абзацем.

formatter.add_line_break()¶

Добавляет жесткий разрыв строки, если его еще нет. Это не нарушает логический абзац.

formatter.add_hor_rule(*args, **kw)¶

Вставляет горизонтальную линию в вывод. Жесткий разрыв вставляется, если в текущем абзаце есть данные, но логический абзац не нарушается. Аргументы и ключевые слова передаются методу send_line_break() объекта записи.

formatter.add_flowing_data(data)¶

Предоставляет данные, которые должны быть отформатированы со схлопыванием пробельных символов. Пробелы из предыдущих и последующих вызовов add_flowing_data() также учитываются при выполнении схлопывания. Ожидается, что данные, передаваемые этому методу, будут перенесены по словам выходным устройством. Обратите внимание, что любой перенос по словам все равно должен выполняться объектом записи, поскольку необходимо полагаться на информацию об устройстве и шрифте.

formatter.add_literal_data(data)¶

Предоставляет данные, которые должны быть переданы объекту записи без изменений. Пробелы, включая символы новой строки и табуляции, считаются допустимыми в значении data.

formatter.add_label_data(format, counter)¶

Вставляет метку, которая должна быть размещена слева от текущего левого поля. Используется для создания маркированных или нумерованных списков. Если значение format – строка, оно интерпретируется как спецификация формата для counter, который должен быть целым числом. Результат этого форматирования становится значением метки; если format не строка, оно используется как значение метки напрямую. Значение метки передается как единственный аргумент методу send_label_data() объекта записи. Интерпретация нестроковых значений метки зависит от соответствующего объекта записи.

Спецификации формата – это строки, которые в сочетании со значением счетчика используются для вычисления значений меток. Каждый символ в строке формата копируется в значение метки, при этом некоторые символы распознаются как указание на преобразование значения счетчика. В частности, символ '1' представляет значение счетчика, отформатированное арабскими цифрами; символы 'A' и 'a' представляют буквенное представление значения счетчика в верхнем и нижнем регистре соответственно; а 'I' и 'i' представляют значение счетчика римскими цифрами в верхнем и нижнем регистре. Обратите внимание, что для буквенного и римского преобразований требуется, чтобы значение счетчика было больше нуля.

formatter.flush_softspace()¶

Отправляет все ожидающие обработки пробелы, буферизованные из предыдущего вызова add_flowing_data(), соответствующему объекту записи. Этот метод следует вызывать перед любым прямым изменением объекта записи.

formatter.push_alignment(align)¶

Помещает новую настройку выравнивания в стек выравнивания. Это может быть AS_IS, если изменение не требуется. Если значение выравнивания изменяется по сравнению с предыдущей настройкой, вызывается метод new_alignment() объекта записи со значением align.

formatter.pop_alignment()¶

Восстанавливает предыдущее выравнивание.

formatter.push_font((size, italic, bold, teletype))¶

Изменяет некоторые или все свойства шрифта объекта записи. Свойства, которые не установлены в AS_IS, устанавливаются в переданные значения, а остальные сохраняют текущие настройки. Метод new_font() объекта записи вызывается с полностью разрешенной спецификацией шрифта.

formatter.pop_font()¶

Восстанавливает предыдущий шрифт.

formatter.push_margin(margin)¶

Увеличивает количество отступов левого поля на единицу, связывая логический тег margin с новым отступом. Начальный уровень поля – 0. Измененные значения логического тега должны быть истинными; ложные значения, отличные от AS_IS, недостаточны для изменения поля.

formatter.pop_margin()¶

Восстановить предыдущее поле.

formatter.push_style(*styles)¶

Добавляет произвольное количество спецификаций стилей. Все стили последовательно помещаются в стек стилей. Кортеж, представляющий весь стек, включая значения AS_IS, передаётся методу new_styles() объекта writer.

formatter.pop_style(n=1)¶

Извлекает последние n спецификаций стилей, переданных в push_style(). Кортеж, представляющий изменённый стек, включая значения AS_IS, передаётся методу new_styles() объекта writer.

formatter.set_spacing(spacing)¶

Устанавливает стиль межстрочных интервалов для writer.

formatter.assert_line_data(flag=1)¶

Сообщает форматировщику, что в текущий абзац были добавлены данные вне основного потока. Это следует использовать, когда writer изменялся напрямую. Необязательный аргумент flag можно установить в false, если в результате манипуляций с writer в конце вывода возник жёсткий разрыв строки.

Реализации форматировщиков¶Formatter Implementations

В этом модуле предоставлены две реализации объектов форматировщика. Большинство приложений могут использовать один из этих классов без изменений или создания подклассов.

class formatter.NullFormatter(writer=None)¶

Форматировщик, который ничего не делает. Если writer опущен, создаётся экземпляр NullWriter. Экземпляры NullFormatter не вызывают никаких методов writer. Реализации должны наследовать этот класс, если реализуют интерфейс writer, но не нуждаются в наследовании какой-либо реализации.

class formatter.AbstractFormatter(writer)¶

Стандартный форматировщик. Эта реализация показала широкую применимость для многих писателей и может использоваться напрямую в большинстве случаев. Она использовалась для реализации полнофункционального веб-браузера.

Интерфейс Writer¶The Writer Interface

Интерфейсы для создания writer зависят от конкретного класса writer, который инстанцируется. Описанные ниже интерфейсы являются обязательными, которые все writer должны поддерживать после инициализации. Обратите внимание, что хотя большинство приложений могут использовать класс AbstractFormatter в качестве форматировщика, writer обычно должен предоставляться приложением.

writer.flush()¶

Сбрасывает все буферизованные выходные данные или события управления устройством.

writer.new_alignment(align)¶

Устанавливает стиль выравнивания. Значение align может быть любым объектом, но по соглашению это строка или None, где None указывает на использование «предпочтительного» выравнивания writer. Традиционные значения align: 'left', 'center', 'right' и 'justify'.

writer.new_font(font)¶

Устанавливает стиль шрифта. Значение font будет None, что означает использование шрифта устройства по умолчанию, или кортежем вида (size, italic, bold, teletype). Размер (Size) будет строкой, указывающей размер шрифта; конкретные строки и их интерпретация должны быть определены приложением. Значения italic, bold и teletype – логические значения, определяющие, какие из атрибутов шрифта следует использовать.

writer.new_margin(margin, level)¶

Устанавливает уровень поля в целое число level, а логический тег – в margin. Интерпретация логического тега остаётся на усмотрение writer; единственное ограничение на значение логического тега – оно не должно быть ложным для ненулевых значений level.

writer.new_spacing(spacing)¶

Устанавливает стиль интервалов в spacing.

writer.new_styles(styles)¶

Устанавливает дополнительные стили. Значение styles – кортеж произвольных значений; значение AS_IS следует игнорировать. Кортеж styles может интерпретироваться либо как набор, либо как стек в зависимости от требований приложения и реализации writer.

writer.send_line_break()¶

Разрывает текущую строку.

writer.send_paragraph(blankline)¶

Создаёт разделение абзацев как минимум на blankline пустых строк или эквивалент. Значение blankline будет целым числом. Обратите внимание, что реализация получит вызов send_line_break() перед этим вызовом, если требуется разрыв строки; этот метод не должен включать завершение последней строки абзаца. Он отвечает только за вертикальные интервалы между абзацами.

writer.send_hor_rule(*args, **kw)¶

Отображает горизонтальную линию на устройстве вывода. Аргументы этого метода полностью зависят от приложения и конкретного writer'а, и их следует интерпретировать с осторожностью. Реализация метода может предполагать, что перенос строки уже был сделан с помощью send_line_break().

writer.send_flowing_data(data)¶

Выводит символьные данные, которые при необходимости могут быть перенесены по словам и переформатированы. В любой последовательности вызовов этого метода writer может считать, что последовательности из нескольких пробелов были сжаты до одного пробела.

writer.send_literal_data(data)¶

Выводит символьные данные, уже отформатированные для отображения. Как правило, это означает, что разрывы строк, обозначенные символами новой строки, должны сохраняться, и новые разрывы строк добавляться не должны. Данные могут содержать символы новой строки и табуляции, в отличие от данных, передаваемых через интерфейс send_formatted_data().

writer.send_label_data(data)¶

Устанавливает данные слева от текущего левого поля, если это возможно. Значение данных не ограничено; обработка нестроковых значений полностью зависит от приложения и writer'а. Этот метод будет вызываться только в начале строки.

Реализации writer'а¶Writer Implementations

Этот модуль предоставляет три реализации интерфейса объекта writer в качестве примеров. Большинству приложений потребуется создать собственные классы writer'а на основе класса NullWriter.

class formatter.NullWriter¶

Writer, который предоставляет только определение интерфейса; никаких действий над методами не выполняется. Это должен быть базовый класс для всех writer'ов, которым не нужно наследовать методы реализации.

class formatter.AbstractWriter¶

Writer, который можно использовать в отладочных форматтерах, но не более того. Каждый метод просто сообщает о себе, печатая своё имя и аргументы в стандартный вывод.

class formatter.DumbWriter(file=None, maxcol=72)¶

Простой класс writer'а, который записывает вывод в файловый объект, переданный как file, или, если file опущен, в стандартный вывод. Вывод просто переносится по словам на количество столбцов, заданное maxcol. Этот класс подходит для переформатирования последовательности абзацев.