`textwrap.md`

209 строк · 18.6 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/textwrap.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 6.4. [`textwrap`](https://python-all.ru/3.6/library/textwrap.html#module-textwrap) – Обёртывание и заполнение текста89**Исходный код:** [Lib/textwrap.py](https://python-all.ru/src/3.6/Lib/textwrap.py)1011---1213Модуль [`textwrap`](https://python-all.ru/3.6/library/textwrap.html#module-textwrap) предоставляет несколько удобных функций, а также класс [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper), который выполняет всю основную работу. Если нужно всего лишь перенести или дополнить одну-две текстовые строки, удобных функций должно быть достаточно; в противном случае для эффективности следует использовать экземпляр [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper).1415#### `textwrap.wrap(text, width=70, **kwargs)`1617Переносит единственный абзац в *text* (строку) так, что каждая строка не длиннее *width* символов. Возвращает список выходных строк, без завершающих символов новой строки.1819Необязательные именованные аргументы соответствуют атрибутам экземпляра [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper), описанным ниже. *width* по умолчанию равен `70`.2021См. метод [`TextWrapper.wrap()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.wrap) для дополнительных сведений о поведении [`wrap()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.wrap).2223#### `textwrap.fill(text, width=70, **kwargs)`2425Переносит единственный абзац в *text* и возвращает одну строку, содержащую перенесённый абзац. [`fill()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.fill) – это сокращённая форма записи для2627```python28"\n".join(wrap(text, ...))29```3031В частности, [`fill()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.fill) принимает те же именованные аргументы, что и [`wrap()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.wrap).3233#### `textwrap.shorten(text, width, **kwargs)`3435Сжимает и обрезает заданный *text*, чтобы он поместился в заданную *width*.3637Сначала все пробелы в *text* схлопываются (все пробелы заменяются на одиночные пробелы). Если результат помещается в *width*, он возвращается. В противном случае из конца удаляется достаточное количество слов, чтобы оставшиеся слова вместе с `placeholder` поместились в пределах `width`:3839```python40>>> textwrap.shorten("Hello  world!", width=12)41'Hello world!'42>>> textwrap.shorten("Hello  world!", width=11)43'Hello [...]'44>>> textwrap.shorten("Hello world", width=10, placeholder="...")45'Hello...'46```4748Необязательные именованные аргументы соответствуют атрибутам экземпляра [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper), описанным ниже. Обратите внимание: пробельные символы сжимаются до передачи текста в функцию [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper) [`fill()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.fill), поэтому изменение значений [`tabsize`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.tabsize), [`expand_tabs`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.expand_tabs), [`drop_whitespace`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.drop_whitespace) и [`replace_whitespace`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.replace_whitespace) не даст эффекта.4950Новое в версии 3.4.5152#### `textwrap.dedent(text)`5354Удаляет общие начальные пробельные символы из каждой строки в *text*.5556Это можно использовать, чтобы выровнять строки с тройными кавычками по левому краю отображения, при этом в исходном коде они остаются с отступами.5758Обратите внимание: табуляции и пробелы считаются пробельными символами, но они не равны: строки `" hello"` и `"\thello"` считаются не имеющими общих начальных пробельных символов.5960Например:6162```python63def test():64    # завершите первую строку символом \, чтобы избежать пустой строки65    s = '''\66    hello67      world68    '''69    print(repr(s))          # выводит '    hello\n      world\n    '70    print(repr(dedent(s)))  # выводит 'hello\n  world\n'71```7273#### `textwrap.indent(text, prefix, predicate=None)`7475Добавляет *prefix* в начало выбранных строк в *text*.7677Строки разделяются вызовом `text.splitlines(True)`.7879По умолчанию *prefix* добавляется ко всем строкам, не состоящим только из пробельных символов (включая концы строк).8081Например:8283```python84>>> s = 'hello\n\n \nworld'85>>> indent(s, '  ')86'  hello\n\n \n  world'87```8889Необязательный аргумент *predicate* можно использовать для управления тем, какие строки получают отступ. Например, легко добавить *prefix* даже к пустым строкам и строкам, состоящим только из пробелов:9091```python92>>> print(indent(s, '+ ', lambda line: True))93+ hello94+95+96+ world97```9899Новое в версии 3.3.100101[`wrap()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.wrap), [`fill()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.fill) и [`shorten()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.shorten) работают путём создания экземпляра [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper) и вызова единственного метода на нём. Этот экземпляр не используется повторно, поэтому для приложений, обрабатывающих много текстовых строк с помощью [`wrap()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.wrap) и/или [`fill()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.fill), может быть эффективнее создать собственный объект [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper).102103Текст предпочтительно переносится по пробелам и сразу после дефисов в словах с дефисом; только после этого при необходимости разбиваются длинные слова, если только [`TextWrapper.break_long_words`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.break_long_words) не установлен в значение false.104105#### `class textwrap.TextWrapper(**kwargs)`106107Конструктор [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper) принимает ряд необязательных именованных аргументов. Каждый именованный аргумент соответствует атрибуту экземпляра, так, например108109```python110wrapper = TextWrapper(initial_indent="* ")111```112113это то же самое, что114115```python116wrapper = TextWrapper()117wrapper.initial_indent = "* "118```119120Один и тот же объект [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper) можно многократно использовать, а любые его параметры можно изменять прямым присваиванием атрибутам экземпляра между использованиями.121122Атрибуты экземпляра [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper) (и ключевые аргументы конструктора) следующие:123124#### `width`125126(по умолчанию: `70`) Максимальная длина перенесённых строк. Если во входном тексте нет отдельных слов длиннее [`width`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.width), [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper) гарантирует, что ни одна строка вывода не будет длиннее [`width`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.width) символов.127128#### `expand_tabs`129130(по умолчанию: `True`) Если true, все символы табуляции в *text* будут заменены на пробелы с помощью метода `expandtabs()` *text*.131132#### `tabsize`133134(по умолчанию: `8`) Если [`expand_tabs`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.expand_tabs) равно true, все символы табуляции в *text* будут заменены на ноль или больше пробелов в зависимости от текущей позиции столбца и заданного размера табуляции.135136Новое в версии 3.3.137138#### `replace_whitespace`139140(по умолчанию: `True`) Если true, после замены табуляции, но до переноса строк, метод [`wrap()`](https://python-all.ru/3.6/library/textwrap.html#textwrap.wrap) заменит каждый пробельный символ на один пробел. Заменяемыми пробельными символами являются: табуляция, новая строка, вертикальная табуляция, перевод страницы и возврат каретки (`'\t\n\v\f\r'`).141142> **Примечание**143>144> Если [`expand_tabs`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.expand_tabs) равно false, а [`replace_whitespace`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.replace_whitespace) – true, каждый символ табуляции будет заменён одним пробелом, что *не* то же самое, что и замена табуляции.145146> **Примечание**147>148> Если [`replace_whitespace`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.replace_whitespace) равно false, символы новой строки могут появляться в середине строки и приводить к странному выводу. По этой причине текст следует разбивать на абзацы (с помощью [`str.splitlines()`](https://python-all.ru/3.6/library/stdtypes.html#str.splitlines) или аналогичных средств), которые переносятся отдельно.149150#### `drop_whitespace`151152(по умолчанию: `True`) Если true, пробелы в начале и конце каждой строки (после переноса, но до добавления отступа) удаляются. Однако пробелы в начале абзаца не удаляются, если за ними следует непробельный символ. Если удаляемый пробел занимает всю строку, она удаляется целиком.153154#### `initial_indent`155156(по умолчанию: `''`) Строка, которая будет добавлена к первой строке перенесённого вывода. Учитывается в длине первой строки. Пустая строка не добавляет отступ.157158#### `subsequent_indent`159160(по умолчанию: `''`) Строка, которая будет добавлена ко всем строкам перенесённого вывода, кроме первой. Учитывается в длине каждой строки, кроме первой.161162#### `fix_sentence_endings`163164(по умолчанию: `False`) Если true, [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper) пытается определять концы предложений и гарантирует, что предложения всегда разделяются ровно двумя пробелами. Обычно это желательно для текста в моноширинном шрифте. Однако алгоритм определения концов предложений несовершенен: он предполагает, что конец предложения состоит из строчной буквы, за которой следует один из `'.'`, `'!'` или `'?'`, возможно, за которым следует один из `'"'` или `"'"`, а затем пробел. Одна из проблем этого алгоритма в том, что он не может обнаружить разницу между «Dr.» в165166```python167[...] Dr. Frankenstein's monster [...]168```169170и «Spot.» в171172```python173[...] See Spot. See Spot run [...]174```175176[`fix_sentence_endings`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.fix_sentence_endings) по умолчанию равно false.177178Поскольку алгоритм определения предложений опирается на `string.lowercase` для определения «строчной буквы» и соглашение об использовании двух пробелов после точки для разделения предложений в одной строке, он специфичен для текстов на английском языке.179180#### `break_long_words`181182(по умолчанию: `True`) Если true, слова длиннее [`width`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.width) будут разбиты, чтобы ни одна строка не была длиннее [`width`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.width). Если false, длинные слова не разбиваются, и некоторые строки могут быть длиннее [`width`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.width). (Длинные слова будут размещены на отдельной строке, чтобы минимизировать превышение [`width`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.width).)183184#### `break_on_hyphens`185186(по умолчанию: `True`) Если true, перенос будет выполняться предпочтительно по пробелам и сразу после дефисов в составных словах, как принято в английском. Если false, только пробелы будут считаться потенциально хорошими местами для разрыва строк, но для полного запрета разрыва слов нужно установить [`break_long_words`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.break_long_words) в false. В предыдущих версиях поведение по умолчанию всегда разрешало разрыв слов с дефисом.187188#### `max_lines`189190(по умолчанию: `None`) Если не `None`, то вывод будет содержать не более *max\_lines* строк, причём в конце вывода будет отображаться *placeholder*.191192Новое в версии 3.4.193194#### `placeholder`195196(по умолчанию: `' [...]'`) Строка, которая появится в конце вывода, если текст был сокращён.197198Новое в версии 3.4.199200[`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper) также предоставляет несколько открытых методов, аналогичных вспомогательным функциям уровня модуля:201202#### `wrap(text)`203204Заворачивает один абзац в *текст* (строку), так чтобы каждая строка была длиной не более [`width`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper.width) символов. Параметры обтекания берутся из атрибутов экземпляра [`TextWrapper`](https://python-all.ru/3.6/library/textwrap.html#textwrap.TextWrapper). Возвращает список строк вывода, без конечных символов новой строки. Если завернутый вывод не содержит содержимого, возвращается пустой список.205206#### `fill(text)`207208Заворачивает один абзац в *текст* и возвращает одну строку, содержащую завернутый абзац.209