textwrap — 文本换行和填充

源代码: Lib/textwrap.py

textwrap 模块提供了一些便捷函数，以及完成所有工作的类 TextWrapper。如果你只是换行或填充一两个文本字符串，便捷函数就足够了；否则，为了效率，你应该使用 TextWrapper 的实例。

textwrap.wrap(text, width=70, *, initial_indent='', subsequent_indent='', expand_tabs=True, replace_whitespace=True, fix_sentence_endings=False, break_long_words=True, drop_whitespace=True, break_on_hyphens=True, tabsize=8, max_lines=None, placeholder=' [...]')

将 text（字符串）中的单个段落换行，使得每行最多 width 个字符。返回一个输出行列表，不带最终的换行符。

可选的关键字参数对应于 TextWrapper 的实例属性，如下所述。

有关 wrap() 行为的更多详细信息，请参见 TextWrapper.wrap() 方法。

textwrap.fill(text, width=70, *, initial_indent='', subsequent_indent='', expand_tabs=True, replace_whitespace=True, fix_sentence_endings=False, break_long_words=True, drop_whitespace=True, break_on_hyphens=True, tabsize=8, max_lines=None, placeholder=' [...]')

将 text 中的单个段落换行，并返回包含已换行段落的单个字符串。fill() 是以下内容的简写：

"\n".join(wrap(text, ...))

特别是，fill() 接受与 wrap() 完全相同的关键字参数。

textwrap.shorten(text, width, *, fix_sentence_endings=False, break_long_words=True, break_on_hyphens=True, placeholder=' [...]')

折叠并截断给定的 text 以适应给定的 width。

首先，text 中的空白被折叠（所有空白都被替换为单个空格）。如果结果符合 width，则返回。否则，从末尾删除足够的单词，使剩余的单词加上 placeholder 适合 width。

>>> textwrap.shorten("Hello  world!", width=12)
'Hello world!'
>>> textwrap.shorten("Hello  world!", width=11)
'Hello [...]'
>>> textwrap.shorten("Hello world", width=10, placeholder="...")
'Hello...'

可选的关键字参数对应于 TextWrapper 的实例属性，如下所述。请注意，在文本传递给 TextWrapper 的 fill() 函数之前，空白会被折叠，因此更改 tabsize、expand_tabs、drop_whitespace 和 replace_whitespace 的值将无效。

在 3.4 版本加入。

textwrap.dedent(text)

从 text 中的每一行移除任何常见的行首空白。

这可用于使三引号字符串与显示屏的左边缘对齐，同时在源代码中以缩进形式呈现它们。

请注意，制表符和空格都被视为空白，但它们不相等：行 "  hello" 和 "\thello" 被认为没有共同的行首空白。

输入中仅包含空白的行将被忽略，并在输出中标准化为单个换行符。

例如:

def test():
    # end first line with \ to avoid the empty line!
    s = '''\
    hello
      world
    '''
    print(repr(s))          # prints '    hello\n      world\n    '
    print(repr(dedent(s)))  # prints 'hello\n  world\n'
textwrap.indent(text, prefix, predicate=None)

将 prefix 添加到 text 中选定行的开头。

通过调用 text.splitlines(True) 来分隔行。

默认情况下，prefix 会添加到所有不完全由空白（包括任何行尾字符）组成的行。

例如:

>>> s = 'hello\n\n \nworld'
>>> indent(s, '  ')
'  hello\n\n \n  world'

可选的 predicate 参数可用于控制哪些行被缩进。例如，很容易将 prefix 添加到空行和仅包含空白的行中。

>>> print(indent(s, '+ ', lambda line: True))
+ hello
+
+
+ world

在 3.3 版本加入。

wrap()、fill() 和 shorten() 通过创建一个 TextWrapper 实例并调用其上的单个方法来工作。该实例不会被重用，因此对于使用 wrap() 和/或 fill() 处理许多文本字符串的应用程序，创建自己的 TextWrapper 对象可能更高效。

文本优先在空格处和带连字符的单词中的连字符后进行换行；只有在必要时才会拆分长单词，除非 TextWrapper.break_long_words 设置为 False。

class textwrap.TextWrapper(**kwargs)

TextWrapper 构造函数接受许多可选的关键字参数。每个关键字参数都对应一个实例属性，例如

wrapper = TextWrapper(initial_indent="* ")

与以下相同

wrapper = TextWrapper()
wrapper.initial_indent = "* "

您可以多次重用同一个 TextWrapper 对象，并且您可以在每次使用之间通过直接赋值给实例属性来更改其任何选项。

TextWrapper 实例属性（和构造函数的可选关键字参数）如下：

width

（默认值：70）换行行的最大长度。只要输入文本中没有单个单词的长度超过 width，TextWrapper 就保证没有输出行会比 width 字符长。

expand_tabs

（默认值：True）如果为 True，则 text 中的所有制表符都将使用 text 的 expandtabs() 方法展开为空格。

tabsize

（默认值：8）如果 expand_tabs 为 True，则 text 中的所有制表符都将根据当前列和给定的制表符大小扩展为零个或多个空格。

在 3.3 版本加入。

replace_whitespace

（默认值：True）如果为 True，则在制表符展开后但在换行之前，wrap() 方法会将每个空白字符替换为单个空格。替换的空白字符如下：制表符、换行符、垂直制表符、换页符和回车符（'\t\n\v\f\r'）。

备注

如果 expand_tabs 为 False 且 replace_whitespace 为 True，则每个制表符都将替换为单个空格，这与制表符展开 不同。

备注

如果 replace_whitespace 为 False，则换行符可能会出现在行的中间并导致奇怪的输出。因此，文本应拆分为段落（使用 str.splitlines() 或类似方法），并分别进行换行。

drop_whitespace

（默认值：True）如果为 True，则（换行后但在缩进前）每行开头和结尾的空白将被删除。但是，如果后面有非空白字符，则段落开头的空白不会被删除。如果被删除的空白占据整行，则整行将被删除。

initial_indent

（默认值：''）将添加到换行输出的第一行开头的字符串。计入第一行的长度。空字符串不缩进。

subsequent_indent

（默认值：''）将添加到除第一行之外的所有换行输出行开头的字符串。计入除第一行之外的每行的长度。

fix_sentence_endings

（默认值：False）如果为 True，TextWrapper 将尝试检测句子结尾，并确保句子始终用两个空格分隔。这对于等宽字体的文本通常是期望的。但是，句子检测算法并不完善：它假定句子结尾由一个小写字母后跟 '.'、'!' 或 '?' 之一组成，可能后跟 '"' 或 "'" 之一，再后跟一个空格。此算法的一个问题是它无法区分以下情况中的“Dr.”

[...] Dr. Frankenstein's monster [...]

和以下情况中的“Spot.”

[...] See Spot. See Spot run [...]

fix_sentence_endings 默认为 False。

由于句子检测算法依赖于 string.lowercase 来定义“小写字母”，以及在句号后使用两个空格来分隔同一行上的句子的约定，因此它仅适用于英语文本。

break_long_words

（默认值：True）如果为 True，则长度超过 width 的单词将被拆分，以确保没有一行长于 width。如果为 False，则长单词不会被拆分，有些行可能长于 width。（长单词将单独占一行，以尽量减少超出 width 的量。）

break_on_hyphens

（默认值：True）如果为 True，换行将优先在空格和复合词的连字符后发生，这在英语中是惯例。如果为 False，则只有空格会被视为潜在的良好断行位置，但如果您想要真正不可分割的单词，则需要将 break_long_words 设置为 False。先前版本中的默认行为是始终允许拆分带连字符的单词。

max_lines

（默认值：None）如果不是 None，则输出最多包含 max_lines 行，其中 placeholder 出现在输出的末尾。

在 3.4 版本加入。

placeholder

（默认值：' [...]'）如果输出文本被截断，将出现在输出文本末尾的字符串。

在 3.4 版本加入。

TextWrapper 还提供了一些公共方法，类似于模块级的便捷函数

wrap(text)

将 text（字符串）中的单个段落换行，使得每行最多 width 个字符长。所有换行选项都取自 TextWrapper 实例的实例属性。返回一个输出行列表，不带最终的换行符。如果换行输出没有内容，则返回的列表为空。

fill(text)

将 text 中的单个段落换行，并返回一个包含已换行段落的单个字符串。