Документация Python неофициальный перевод

textwrap.md

228 строк · 14.1 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.1/library/textwrap.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 7.5. `textwrap` – Перенос и заполнение текста89Модуль `textwrap` предоставляет две вспомогательные функции – [`wrap()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.wrap) и [`fill()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.fill), а также [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper) – класс, который делает всю работу, и служебную функцию [`dedent()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.dedent). Если нужно перенести или заполнить одну-две текстовые строки, достаточно вспомогательных функций; в противном случае для эффективности лучше использовать экземпляр [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper).1011#### `textwrap.wrap(text, width=70, **kwargs)`1213Переносит единственный абзац в *text* (строку) так, что каждая строка не длиннее *width* символов. Возвращает список выходных строк, без завершающих символов новой строки.1415Необязательные именованные аргументы соответствуют атрибутам экземпляра [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper), описанным ниже. *width* по умолчанию равен `70`.1617#### `textwrap.fill(text, width=70, **kwargs)`1819Обёртывает единственный абзац в *text* и возвращает одну строку, содержащую обёрнутый абзац. [`fill()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.fill) – это сокращённая запись для2021```python22"\n".join(wrap(text, ...))23```2425В частности, [`fill()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.fill) принимает те же именованные аргументы, что и [`wrap()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.wrap).2627И [`wrap()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.wrap), и [`fill()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.fill) работают, создавая экземпляр [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper) и вызывая на нём один метод. Этот экземпляр не переиспользуется, поэтому для приложений, которые переносят/заполняют много текстовых строк, будет эффективнее создать собственный объект [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper).2829Текст предпочтительно переносится по пробелам и сразу после дефисов в составных словах; только в этом случае длинные слова будут разбиты при необходимости, если [`TextWrapper.break_long_words`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.break_long_words) не установлено в false.3031Дополнительная служебная функция [`dedent()`](https://python-all.ru/3.1/library/textwrap.html#textwrap.dedent) предназначена для удаления отступов из строк, содержащих нежелательные пробелы слева от текста.3233#### `textwrap.dedent(text)`3435Удаляет общие начальные пробельные символы из каждой строки в *text*.3637Это можно использовать, чтобы выровнять строки с тройными кавычками по левому краю отображения, при этом в исходном коде они остаются с отступами.3839Обратите внимание, что табуляции и пробелы оба считаются пробельными символами, но они не равны: строки `" hello"` и `"\thello"` считаются не имеющими общего начального пробела.4041Например:4243```python44def test():45    # завершите первую строку символом \, чтобы избежать пустой строки46    s = '''\47    hello48      world49    '''50    print(repr(s))          # выводит '    hello\n      world\n    '51    print(repr(dedent(s)))  # выводит 'hello\n  world\n'52```5354#### `class textwrap.TextWrapper(**kwargs)`5556Конструктор [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper) принимает ряд необязательных именованных аргументов. Каждый именованный аргумент соответствует атрибуту экземпляра, так, например,5758```python59wrapper = TextWrapper(initial_indent="* ")60```6162это то же самое, что6364```python65wrapper = TextWrapper()66wrapper.initial_indent = "* "67```6869Можно повторно использовать один и тот же объект [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper) много раз, и между использованиями можно изменять любые его параметры прямым присваиванием атрибутам экземпляра.7071Атрибуты экземпляра [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper) (и именованные аргументы конструктора) следующие:7273#### `width`7475(по умолчанию:7677`70`7879) Максимальная длина переносимых строк. Пока во входном тексте нет отдельных слов длиннее8081[`width`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.width)8283,8485[`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper)8687гарантирует, что ни одна строка вывода не будет длиннее8889[`width`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.width)9091символов.9293#### `expand_tabs`9495(по умолчанию:9697`True`9899) Если истинно, то все символы табуляции в100101*text*102103будут заменены на пробелы с использованием метода104105`expandtabs()`106107строки108109*text*110111.112113#### `replace_whitespace`114115(по умолчанию: `True`) Если истина, каждый пробельный символ (по определению `string.whitespace`), оставшийся после замены табуляции, будет заменён на один пробел.116117> **Примечание**118>119> Если [`expand_tabs`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.expand_tabs) ложно, а [`replace_whitespace`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.replace_whitespace) истинно, то каждый символ табуляции будет заменён одним пробелом, что *не* то же самое, что замена табуляции.120121> **Примечание**122>123> Если [`replace_whitespace`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.replace_whitespace) ложно, символы новой строки могут оказаться в середине строки и привести к странному выводу. По этой причине текст следует разбивать на абзацы (с помощью [`str.splitlines()`](https://python-all.ru/3.1/library/stdtypes.html#str.splitlines) или аналогично), которые переносятся отдельно.124125#### `drop_whitespace`126127(по умолчанию:128129`True`130131) Если истина, пробелы, которые после переноса оказываются в начале или конце строки, удаляются (однако начальные пробелы в первой строке всегда сохраняются).132133#### `initial_indent`134135(по умолчанию:136137`''`138139) Строка, которая будет добавлена в начало первой строки вывода после переноса. Учитывается при подсчёте длины первой строки.140141#### `subsequent_indent`142143(по умолчанию:144145`''`146147) Строка, которая будет добавлена ко всем строкам перенесённого вывода, кроме первой. Учитывается в длине каждой строки, кроме первой.148149#### `fix_sentence_endings`150151(по умолчанию: `False`) Если true, [`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper) пытается обнаружить концы предложений и гарантировать, что предложения всегда разделяются ровно двумя пробелами. Обычно это желательно для текста моноширинным шрифтом. Однако алгоритм обнаружения предложений несовершенен: он предполагает, что конец предложения состоит из строчной буквы, за которой следует один из `'.'`, `'!'` или `'?'`, возможно, за которым следует один из `'"'` или `"'"`, за которым следует пробел. Одна из проблем этого алгоритма заключается в том, что он не может различить «Dr.» в152153```python154[...] Dr. Frankenstein's monster [...]155```156157и «Spot.» в158159```python160[...] See Spot. See Spot run [...]161```162163[`fix_sentence_endings`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.fix_sentence_endings) по умолчанию false.164165Поскольку алгоритм обнаружения предложений полагается на `string.lowercase` для определения «строчной буквы» и соглашение об использовании двух пробелов после точки для разделения предложений на одной строке, он применим только к текстам на английском языке.166167#### `break_long_words`168169(по умолчанию:170171`True`172173) Если true, то слова длиннее174175[`width`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.width)176177будут разрываться, чтобы гарантировать, что ни одна строка не длиннее178179[`width`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.width)180181. Если false, длинные слова не будут разрываться, и некоторые строки могут оказаться длиннее182183[`width`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.width)184185. (Длинные слова будут помещаться на отдельную строку, чтобы минимизировать превышение186187[`width`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.width)188189.)190191#### `break_on_hyphens`192193(по умолчанию:194195`True`196197) Если true, перенос будет выполняться предпочтительно по пробелам и сразу после дефисов в составных словах, как это принято в английском языке. Если false, только пробелы будут считаться потенциально хорошими местами для разрыва строк, но необходимо установить198199[`break_long_words`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.break_long_words)200201в false, если требуются действительно неразрывные слова. Поведение по умолчанию в предыдущих версиях заключалось в том, чтобы всегда разрешать разрыв слов с дефисом.202203[`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper) также предоставляет два открытых метода, аналогичных модульным удобным функциям:204205#### `wrap(text)`206207Переносит один абзац из208209*text*210211(строки) так, чтобы каждая строка была не длиннее212213[`width`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper.width)214215символов. Все параметры переноса берутся из атрибутов экземпляра216217[`TextWrapper`](https://python-all.ru/3.1/library/textwrap.html#textwrap.TextWrapper)218219. Возвращает список строк вывода без завершающих символов новой строки.220221#### `fill(text)`222223Заворачивает один абзац в224225*текст*226227и возвращает одну строку, содержащую завернутый абзац.228