python textwrap -格式化文本段落

textwrap模块可用于格式化文本,以便在需要漂亮打印的情况下输出。它提供的编程功能类似于许多文本编辑器和文字处理器中的段落换行或填充功能。

示例数据

本节中的示例使用textwrap_example.py包含字符串的模块sample_text

textwrap_example.py

sample_text = '''
 The textwrap module can be used to format text for output in
 situations where pretty-printing is desired.  It offers
 programmatic functionality similar to the paragraph wrapping
 or filling features found in many text editors.
 '''

灌装段落

fill()函数将文本作为输入,并生成格式化的文本作为输出。

textwrap_fill.py

import textwrap
from textwrap_example import sample_text

print(textwrap.fill(sample_text, width=50))

结果差强人意。现在,文本左对齐,但是第一行保留缩进,并且每行后面的空格都嵌入到段落中。

$ python3 textwrap_fill.py

     The textwrap module can be used to format
text for output in     situations where pretty-
printing is desired.  It offers     programmatic
functionality similar to the paragraph wrapping
or filling features found in many text editors.

删除现有的缩进

前面的示例在输出的中间有嵌入的制表符和多余的空格,因此其格式不是很干净。从示例文本的所有行中删除公共空格前缀dedent()会产生更好的结果,并允许直接从Python代码使用docstrings或嵌入的多行字符串,同时删除代码本身的格式。示例字符串具有人工缩进级别,用于说明此功能。

textwrap_dedent.py

import textwrap
from textwrap_example import sample_text

dedented_text = textwrap.dedent(sample_text)
print('Dedented:')
print(dedented_text)

结果开始看起来更好。

$ python3 textwrap_dedent.py

Dedented:

The textwrap module can be used to format text for output in
situations where pretty-printing is desired.  It offers
programmatic functionality similar to the paragraph wrapping
or filling features found in many text editors.

由于“缩进”与“缩进”相反,因此结果是一块文本,其中每行都删除了公共的初始空白。如果一行的缩进量已超过另一行,则某些空白将不会被删除。

输入像

␣Line one.
␣␣␣Line two.
␣Line three.
</pre>

变成

Line one.
␣␣Line two.
Line three.

结合迪登并填写

接下来,可以fill()使用几个不同的width值传递下划线的文本。

textwrap_fill_width.py

import textwrap
from textwrap_example import sample_text

dedented_text = textwrap.dedent(sample_text).strip()
for width in [45, 60]:
    print('{} Columns:\n'.format(width))
    print(textwrap.fill(dedented_text, width=width))
    print()

这将产生指定宽度的输出。

$ python3 textwrap_fill_width.py

45 Columns:

The textwrap module can be used to format
text for output in situations where pretty-
printing is desired. It offers programmatic
functionality similar to the paragraph
wrapping or filling features found in many
text editors.

60 Columns:

The textwrap module can be used to format text for output in
situations where pretty-printing is desired. It offers
programmatic functionality similar to the paragraph wrapping
or filling features found in many text editors.
</pre>

缩进块

使用此indent()功能可将一致的前缀文本添加到字符串中的所有行。此示例的格式与示例文本相同,就好像它是答复中引用的电子邮件的一部分>一样,用作每行的前缀。

textwrap_indent.py

<pre style="margin: 0px 2em 1em; font-family: monospace, serif; font-size: 1em; white-space: pre; overflow-wrap: normal; padding: 0.5em; overflow: auto; border-left: 5px solid rgba(41, 42, 136, 0.2);">import textwrap
from textwrap_example import sample_text

dedented_text = textwrap.dedent(sample_text)
wrapped = textwrap.fill(dedented_text, width=50)
wrapped += '\n\nSecond paragraph after a blank line.'
final = textwrap.indent(wrapped, '> ')

print('Quoted block:\n')
print(final)
</pre>

文本块在换行符上分割,将前缀添加到包含文本的每行中,然后将这些行组合回一个新字符串并返回。

<pre style="margin: 0px 2em 1em; font-family: monospace, serif; font-size: 1em; white-space: pre; overflow-wrap: normal; padding: 0.5em; overflow: auto; border-left: 5px solid rgba(41, 42, 136, 0.2);">$ python3 textwrap_indent.py

Quoted block:

The textwrap module can be used to format text
for output in situations where pretty-printing is
desired. It offers programmatic functionality
similar to the paragraph wrapping or filling
features found in many text editors.

Second paragraph after a blank line.
</pre>

要控制哪些行接收新的前缀,请将callable作为predicate参数传递 给indent()。将依次为每一行文本调用callable,并为返回值为true的行添加前缀。

textwrap_indent_predicate.py

<pre style="margin: 0px 2em 1em; font-family: monospace, serif; font-size: 1em; white-space: pre; overflow-wrap: normal; padding: 0.5em; overflow: auto; border-left: 5px solid rgba(41, 42, 136, 0.2);">import textwrap
from textwrap_example import sample_text

def should_indent(line):
print('Indent {!r}?'.format(line))
return len(line.strip()) % 2 == 0

dedented_text = textwrap.dedent(sample_text)
wrapped = textwrap.fill(dedented_text, width=50)
final = textwrap.indent(wrapped, 'EVEN ',
predicate=should_indent)

print('\nQuoted block:\n')
print(final)
</pre>

本示例将前缀添加EVEN到包含偶数个字符的行。

<pre style="margin: 0px 2em 1em; font-family: monospace, serif; font-size: 1em; white-space: pre; overflow-wrap: normal; padding: 0.5em; overflow: auto; border-left: 5px solid rgba(41, 42, 136, 0.2);">$ python3 textwrap_indent_predicate.py

Indent ' The textwrap module can be used to format text\n'?
Indent 'for output in situations where pretty-printing is\n'?
Indent 'desired. It offers programmatic functionality\n'?
Indent 'similar to the paragraph wrapping or filling\n'?
Indent 'features found in many text editors.'?

Quoted block:

EVEN The textwrap module can be used to format text
for output in situations where pretty-printing is
EVEN desired. It offers programmatic functionality
EVEN similar to the paragraph wrapping or filling
EVEN features found in many text editors.
</pre>

悬挂缩进

以可能设置输出宽度的相同方式,可以独立于后续行来控制第一行的缩进。

textwrap_hanging_indent.py

<pre style="margin: 0px 2em 1em; font-family: monospace, serif; font-size: 1em; white-space: pre; overflow-wrap: normal; padding: 0.5em; overflow: auto; border-left: 5px solid rgba(41, 42, 136, 0.2);">import textwrap
from textwrap_example import sample_text

dedented_text = textwrap.dedent(sample_text).strip()
print(textwrap.fill(dedented_text,
initial_indent='',
subsequent_indent=' ' * 4,
width=50,
))
</pre>

这使得可以产生悬挂的凹痕,其中第一行的凹痕小于其他行。

<pre style="margin: 0px 2em 1em; font-family: monospace, serif; font-size: 1em; white-space: pre; overflow-wrap: normal; padding: 0.5em; overflow: auto; border-left: 5px solid rgba(41, 42, 136, 0.2);">$ python3 textwrap_hanging_indent.py

The textwrap module can be used to format text for
output in situations where pretty-printing is
desired. It offers programmatic functionality
similar to the paragraph wrapping or filling
features found in many text editors.
</pre>

缩进值也可以包含非空格字符。例如,悬挂的缩进可以带有前缀*以产生项目符号点。

截断长文本

要截断文本以创建摘要或预览,请使用 shorten()。所有现有的空白,例如制表符,换行符和一系列的多个空格,都将被标准化为一个空格。然后,在单词边界之间,文本将被截断为小于或等于所请求长度的长度,以便不包括部分单词。

textwrap_shorten.py

<pre style="margin: 0px 2em 1em; font-family: monospace, serif; font-size: 1em; white-space: pre; overflow-wrap: normal; padding: 0.5em; overflow: auto; border-left: 5px solid rgba(41, 42, 136, 0.2);">import textwrap
from textwrap_example import sample_text

dedented_text = textwrap.dedent(sample_text)
original = textwrap.fill(dedented_text, width=50)

print('Original:\n')
print(original)

shortened = textwrap.shorten(original, 100)
shortened_wrapped = textwrap.fill(shortened, width=50)

print('\nShortened:\n')
print(shortened_wrapped)
</pre>

如果作为截断的一部分将非空白文本从原始文本中删除,则将其替换为占位符值。[...]可以通过提供placeholder 参数来替换默认值shorten()

<pre style="margin: 0px 2em 1em; font-family: monospace, serif; font-size: 1em; white-space: pre; overflow-wrap: normal; padding: 0.5em; overflow: auto; border-left: 5px solid rgba(41, 42, 136, 0.2);">$ python3 textwrap_shorten.py

Original:

The textwrap module can be used to format text
for output in situations where pretty-printing is
desired. It offers programmatic functionality
similar to the paragraph wrapping or filling
features found in many text editors.

Shortened:

The textwrap module can be used to format text for
output in situations where pretty-printing [...]</pre>

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353

推荐阅读更多精彩内容