7.7. textwrap —Literals 换行和填充

2.3 版的新Function。

源代码: Lib/textwrap.py


textwrap模块提供了两个便捷Function,wrap()fill()以及TextWrapper(完成所有工作的类)和 Util Functiondedent()。如果只是包装或填充一两个文本字符串,那么便利Function应该足够好;否则,您应使用TextWrapper的实例以提高效率。

  • textwrap. wrap(* text * [,* width * [,* ... *]])
    • 将单个段落包装在* text (字符串)中,因此每一行最多为 width *个字符长。返回输出行列表,不带finally换行符。

可选的关键字参数对应于TextWrapper的实例属性,在下面记录。 * width *默认为70

有关wrap()行为的其他详细信息,请参见TextWrapper.wrap()方法。

  • textwrap. fill(* text * [,* width * [,* ... *]])
    • 将单个段落包装在* text *中,并返回包含已包装段落的单个字符串。 fill()是的简写
"\n".join(wrap(text, ...))

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

wrap()fill()都pass创建TextWrapper实例并在其上调用单个方法来工作。该实例不会被重用,因此对于包装/填充许多文本字符串的应用程序,创建自己的TextWrapper对象将更加有效。

最好将文本包装在空白处,并在连字符后的连字符后紧跟;只有这样,除非有必要,除非TextWrapper.break_long_words设置为 false,否则长单词将被打断。

提供了一个附加的 Util Functiondedent(),以从文本左侧带有多余空格的字符串中删除缩进。

  • textwrap. dedent(* text *)
    • 从* text *中的每一行中删除所有常见的前导空格。

这可以使三引号字符串与显示的左边缘对齐,同时仍将它们以缩进形式显示在源代码中。

请注意,制表符和空格都被视为空格,但它们并不相等:第" hello""\thello"行被认为没有公共的前导空格。 (此行为是 Python 2.5 中的新增Function;该模块的旧版本在搜索常见的前导空白之前会错误地扩展选项卡.)

仅包含空格的行在 Importing 中被忽略,并在输出中标准化为单个换行符。

For example:

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. TextWrapper(* ... *)
    • TextWrapper构造函数接受许多可选的关键字参数。每个参数对应一个实例属性,例如
wrapper = TextWrapper(initial_indent="* ")

是相同的

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

您可以多次重复使用相同的TextWrapper对象,并且可以pass在使用之间直接分配给实例属性来更改其任何选项。

TextWrapper实例属性(以及构造函数的关键字参数)如下:

  • width

    • (默认值:70)换行的最大长度。只要 Importing 文本中没有单个单词的长度超过widthTextWrapper保证没有输出行的长度超过width个字符。
  • expand_tabs

    • (默认值:True)如果为 true,则将使用* text expandtabs()方法将 text *中的所有制表符扩展为空格。
  • replace_whitespace

    • (默认值:True)如果为 true,则在制表符扩展之后但在包装之前,wrap()方法将用单个空格替换每个空白字符。替换的空白字符如下:选项卡,换行符,垂直选项卡,换页和回车('\t\n\v\f\r')。

Note

如果expand_tabs为 false 且replace_whitespace为 true,则每个制表符都将替换为一个空格,这与制表符 extensions*并非相同。

Note

如果replace_whitespace为假,则换行符可能会出现在一行的中间,并导致奇怪的输出。因此,应将文本拆分为段落(使用str.splitlines()或类似名称),并分别包装。

  • drop_whitespace
    • (默认值:True)如果为 true,则会删除每行开头和结尾(在换行后但在缩进之前)的空格。但是,如果非空格后面紧跟段落开头,则不会删除空格。如果要删除的空格占用了整行,则将删除整行。

2.6 版的新Function:在早期版本中始终删除空格。

  • initial_indent

    • (默认值:'')将在包装输出的第一行之前添加的字符串。计入第一行的长度。空字符串不缩进。
  • subsequent_indent

    • (默认值:'')将在包装输出的所有行(除第一行)之前添加的字符串。除第一行外,均计入每行的长度。
  • fix_sentence_endings

    • (默认值:False)如果为 true,则TextWrappertry检测句子的结尾并确保句子始终完全由两个空格分隔。对于等宽字体的文本,通常需要这样做。但是,句子检测算法是不完善的:它假定句子结尾由小写字母组成,后跟'.''!''?'之一,然后可能跟着'"'"'"之一,后跟一个空格。这种算法的一个问题是算法无法检测“ Dr.”之间的差异。在
[...] Dr. Frankenstein's monster [...]

和“现货”。在

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

fix_sentence_endings默认为假。

由于句子检测算法依赖于string.lowercase来定义“小写字母”,并且约定在句点后使用两个空格来分隔同一行中的句子,因此它专用于英语文本。

  • break_long_words

    • (默认值:True)如果为 true,则长于width的单词将被打断,以确保没有行长于width。如果为假,则长字不会被打断,某些行可能长于width。 (为了避免超出width的数量,长行单词将自己放在一行上。)
  • break_on_hyphens

    • (默认值:True)如果为 true,则按照英语习惯,换行最好在复合词和连字符后的连字符后出现。如果为 false,则仅将空格视为换行符的潜在好地方,但如果要使用 true 不安全的单词,则需要将break_long_words设置为 false。以前版本中的默认行为是始终允许断开连字符。

2.6 版的新Function。

TextWrapper还提供了两种公共方法,类似于模块级便捷Function:

  • wrap(文本)

    • 将单个段落包装为* text *(字符串),因此每一行最多为width个字符。所有包装选项均取自TextWrapper实例的实例属性。返回输出行列表,不带finally换行符。如果包装的输出没有内容,则返回的列表为空。
  • fill(文本)

    • 将单个段落包装在* text *中,并返回包含已包装段落的单个字符串。