`textwrap.md`

146 строк · 15.2 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.2/library/textwrap.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 6.5. [`textwrap`](https://python-all.ru/3.2/library/textwrap.html#module-textwrap) – обёртывание и заполнение текста89**Исходный код:** [Lib/textwrap.py](https://python-all.ru/src/3.2/Lib/textwrap.py)1011---1213Модуль [`textwrap`](https://python-all.ru/3.2/library/textwrap.html#module-textwrap) предоставляет две вспомогательные функции – [`wrap()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.wrap) и [`fill()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.fill), а также [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper) – класс, который выполняет всю основную работу, и служебную функцию [`dedent()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.dedent). Если требуется обернуть или заполнить одну-две строки текста, вспомогательных функций будет достаточно; в противном случае для эффективности следует использовать экземпляр [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper).1415#### `textwrap.wrap(text, width=70, **kwargs)`1617Переносит единственный абзац в *text* (строку) так, что каждая строка не длиннее *width* символов. Возвращает список выходных строк, без завершающих символов новой строки.1819Необязательные именованные аргументы соответствуют атрибутам экземпляра [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper), описанным ниже. *width* по умолчанию равен `70`.2021Дополнительные сведения о поведении [`wrap()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.wrap) см. в описании метода [`TextWrapper.wrap()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.wrap).2223#### `textwrap.fill(text, width=70, **kwargs)`2425Обёртывает единственный абзац в *text* и возвращает одну строку, содержащую обёрнутый абзац. [`fill()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.fill) – это сокращённая запись для2627```python28"\n".join(wrap(text, ...))29```3031В частности, [`fill()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.fill) принимает те же именованные аргументы, что и [`wrap()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.wrap).3233И [`wrap()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.wrap), и [`fill()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.fill) работают, создавая экземпляр [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper) и вызывая на нём один метод. Этот экземпляр не переиспользуется, поэтому для приложений, которые переносят/заполняют много текстовых строк, будет эффективнее создать собственный объект [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper).3435Текст предпочтительно переносится по пробелам и сразу после дефисов в составных словах; только в этом случае длинные слова будут разбиты при необходимости, если [`TextWrapper.break_long_words`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.break_long_words) не установлено в false.3637Дополнительная служебная функция [`dedent()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.dedent) предназначена для удаления отступов из строк, содержащих нежелательные пробелы слева от текста.3839#### `textwrap.dedent(text)`4041Удаляет общие начальные пробельные символы из каждой строки в *text*.4243Это можно использовать, чтобы выровнять строки с тройными кавычками по левому краю отображения, при этом в исходном коде они остаются с отступами.4445Обратите внимание, что табуляции и пробелы оба считаются пробельными символами, но они не равны: строки `" hello"` и `"\thello"` считаются не имеющими общего начального пробела.4647Например:4849```python50def test():51    # завершите первую строку символом \, чтобы избежать пустой строки52    s = '''\53    hello54      world55    '''56    print(repr(s))          # выводит '    hello\n      world\n    '57    print(repr(dedent(s)))  # выводит 'hello\n  world\n'58```5960#### `class textwrap.TextWrapper(**kwargs)`6162Конструктор [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper) принимает ряд необязательных именованных аргументов. Каждый именованный аргумент соответствует атрибуту экземпляра, так, например,6364```python65wrapper = TextWrapper(initial_indent="* ")66```6768это то же самое, что6970```python71wrapper = TextWrapper()72wrapper.initial_indent = "* "73```7475Можно повторно использовать один и тот же объект [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper) много раз, и между использованиями можно изменять любые его параметры прямым присваиванием атрибутам экземпляра.7677Атрибуты экземпляра [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper) (и именованные аргументы конструктора) следующие:7879#### `width`8081(по умолчанию: `70`) Максимальная длина переносимых строк. Пока во входном тексте нет отдельных слов длиннее [`width`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.width), [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper) гарантирует, что ни одна строка вывода не будет длиннее [`width`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.width) символов.8283#### `expand_tabs`8485(по умолчанию: `True`) Если истинно, то все символы табуляции в *text* будут заменены на пробелы с использованием метода `expandtabs()` строки *text*.8687#### `replace_whitespace`8889(по умолчанию: `True`) Если истинно, то после замены табуляции, но до переноса, метод [`wrap()`](https://python-all.ru/3.2/library/textwrap.html#textwrap.wrap) заменит каждый пробельный символ на один пробел. Заменяются следующие пробельные символы: табуляция, новая строка, вертикальная табуляция, прогон страницы и возврат каретки (`'\t\n\v\f\r'`).9091> **Примечание**92>93> Если [`expand_tabs`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.expand_tabs) ложно, а [`replace_whitespace`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.replace_whitespace) истинно, то каждый символ табуляции будет заменён одним пробелом, что *не* то же самое, что замена табуляции.9495> **Примечание**96>97> Если [`replace_whitespace`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.replace_whitespace) ложно, символы новой строки могут оказаться в середине строки и привести к странному выводу. По этой причине текст следует разбивать на абзацы (с помощью [`str.splitlines()`](https://python-all.ru/3.2/library/stdtypes.html#str.splitlines) или аналогично), которые переносятся отдельно.9899#### `drop_whitespace`100101(по умолчанию: `True`) Если true, то пробелы в начале и конце каждой строки (после переноса, но до отступа) удаляются. Однако пробелы в начале абзаца не удаляются, если за ними следует непробельный символ. Если удаляемые пробелы занимают целую строку, то вся строка удаляется.102103#### `initial_indent`104105(по умолчанию: `''`) Строка, которая будет добавлена к первой строке перенесённого вывода. Учитывается в длине первой строки. Пустая строка не добавляет отступ.106107#### `subsequent_indent`108109(по умолчанию: `''`) Строка, которая будет добавлена ко всем строкам перенесённого вывода, кроме первой. Учитывается в длине каждой строки, кроме первой.110111#### `fix_sentence_endings`112113(по умолчанию: `False`) Если true, [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper) пытается обнаружить концы предложений и гарантировать, что предложения всегда разделяются ровно двумя пробелами. Обычно это желательно для текста моноширинным шрифтом. Однако алгоритм обнаружения предложений несовершенен: он предполагает, что конец предложения состоит из строчной буквы, за которой следует один из `'.'`, `'!'` или `'?'`, возможно, за которым следует один из `'"'` или `"'"`, за которым следует пробел. Одна из проблем этого алгоритма заключается в том, что он не может различить «Dr.» в114115```python116[...] Dr. Frankenstein's monster [...]117```118119и «Spot.» в120121```python122[...] See Spot. See Spot run [...]123```124125[`fix_sentence_endings`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.fix_sentence_endings) по умолчанию false.126127Поскольку алгоритм обнаружения предложений полагается на `string.lowercase` для определения «строчной буквы» и соглашение об использовании двух пробелов после точки для разделения предложений на одной строке, он применим только к текстам на английском языке.128129#### `break_long_words`130131(по умолчанию: `True`) Если true, то слова длиннее [`width`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.width) будут разрываться, чтобы гарантировать, что ни одна строка не длиннее [`width`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.width). Если false, длинные слова не будут разрываться, и некоторые строки могут оказаться длиннее [`width`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.width). (Длинные слова будут помещаться на отдельную строку, чтобы минимизировать превышение [`width`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.width).)132133#### `break_on_hyphens`134135(по умолчанию: `True`) Если true, перенос будет выполняться предпочтительно по пробелам и сразу после дефисов в составных словах, как это принято в английском языке. Если false, только пробелы будут считаться потенциально хорошими местами для разрыва строк, но необходимо установить [`break_long_words`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.break_long_words) в false, если требуются действительно неразрывные слова. Поведение по умолчанию в предыдущих версиях заключалось в том, чтобы всегда разрешать разрыв слов с дефисом.136137[`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper) также предоставляет два открытых метода, аналогичных модульным удобным функциям:138139#### `wrap(text)`140141Переносит один абзац в *text* (строка) так, чтобы каждая строка имела длину не более [`width`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper.width) символов. Все параметры переноса берутся из атрибутов экземпляра [`TextWrapper`](https://python-all.ru/3.2/library/textwrap.html#textwrap.TextWrapper). Возвращает список строк вывода без завершающих символов новой строки. Если перенесённый вывод не содержит содержимого, возвращается пустой список.142143#### `fill(text)`144145Заворачивает один абзац в *текст* и возвращает одну строку, содержащую завернутый абзац.146