python系列（pprint - 数据结构之漂亮的打印数据结构

该pprint模块包含一个“漂亮的打印机”，用于生成美观的数据结构视图。格式化程序生成数据结构的表示，可以由解释器正确解析，并且人们也可以轻松阅读。如果可能，输出将保留在一行中，并在分割为多行时缩进。

本节中的示例均取决于pprint_data.py此处所示。

pprint_data.py

data = [
    (1, {'a': 'A', 'b': 'B', 'c': 'C', 'd': 'D'}),
    (2, {'e': 'E', 'f': 'F', 'g': 'G', 'h': 'H',
         'i': 'I', 'j': 'J', 'k': 'K', 'l': 'L'}),
    (3, ['m', 'n']),
    (4, ['o', 'p', 'q']),
    (5, ['r', 's', 't''u', 'v', 'x', 'y', 'z']),]

打印

使用该模块的最简单方法是通过该pprint() 功能。

pprint_pprint.py

from pprint import pprintfrom pprint_data import dataprint('PRINT:')print(data)print()print('PPRINT:')pprint(data)

pprint()格式化对象并将其写入作为参数传入的数据流（或sys.stdout默认情况下）。

$ python3 pprint_pprint.py

PRINT:
[(1, {'a': 'A', 'b': 'B', 'c': 'C', 'd': 'D'}), (2, {'e': 'E', 'f':
'F', 'g': 'G', 'h': 'H', 'i': 'I', 'j': 'J', 'k': 'K', 'l': 'L'}), (
3, ['m', 'n']), (4, ['o', 'p', 'q']), (5, ['r', 's', 'tu', 'v', 'x',
 'y', 'z'])]

PPRINT:
[(1, {'a': 'A', 'b': 'B', 'c': 'C', 'd': 'D'}),
 (2,
  {'e': 'E',
   'f': 'F',
   'g': 'G',
   'h': 'H',
   'i': 'I',
   'j': 'J',
   'k': 'K',
   'l': 'L'}),
 (3, ['m', 'n']),
 (4, ['o', 'p', 'q']),
 (5, ['r', 's', 'tu', 'v', 'x', 'y', 'z'])]

格式化

要格式化数据结构而不将其直接写入流（例如，用于记录），请使用pformat()构建字符串表示形式。

pprint_pformat.py

import loggingfrom pprint import pformatfrom pprint_data import datalogging.basicConfig(
    level=logging.DEBUG,
    format='%(levelname)-8s%(message)s',)logging.debug('Logging pformatted data')formatted = pformat(data)for line in formatted.splitlines():
    logging.debug(line.rstrip())

然后可以单独打印或记录格式化的字符串。

$ python3 pprint_pformat.py

DEBUG    Logging pformatted data
DEBUG    [(1, {'a': 'A', 'b': 'B', 'c': 'C', 'd': 'D'}),
DEBUG     (2,
DEBUG      {'e': 'E',
DEBUG       'f': 'F',
DEBUG       'g': 'G',
DEBUG       'h': 'H',
DEBUG       'i': 'I',
DEBUG       'j': 'J',
DEBUG       'k': 'K',
DEBUG       'l': 'L'}),
DEBUG     (3, ['m', 'n']),
DEBUG     (4, ['o', 'p', 'q']),
DEBUG     (5, ['r', 's', 'tu', 'v', 'x', 'y', 'z'])]

任意类

如果定义方法，则PrettyPrinter使用的类pprint()也可以使用自定义类__repr__()。

pprint_arbitrary_object.py

from pprint import pprintclass node:

    def __init__(self, name, contents=[]):
        self.name = name
        self.contents = contents[:]

    def __repr__(self):
        return (
            'node(' + repr(self.name) + ', ' +
            repr(self.contents) + ')'
        )trees = [
    node('node-1'),
    node('node-2', [node('node-2-1')]),
    node('node-3', [node('node-3-1')]),]pprint(trees)

嵌套对象的表示由PrettyPrinterto 组合 以返回完整的字符串表示。

$ python3 pprint_arbitrary_object.py

[node('node-1', []),
 node('node-2', [node('node-2-1', [])]),
 node('node-3', [node('node-3-1', [])])]

递归

递归数据结构用对格式中给出的原始数据源的引用来表示。<Recursion on typename with id=number>

pprint_recursion.py

from pprint import pprintlocal_data = ['a', 'b', 1, 2]local_data.append(local_data)print('id(local_data) =>', id(local_data))pprint(local_data)

在此示例中，列表local_data将添加到自身，从而创建递归引用。

$ python3 pprint_recursion.py

id(local_data) => 4358913288
['a', 'b', 1, 2, <Recursion on list with id=4358913288>]

限制嵌套输出

对于非常深的数据结构，可能不希望输出包括所有细节。数据可能格式不正确，格式化文本可能太大而无法管理，或者某些数据可能无关紧要。

pprint_depth.py

from pprint import pprintfrom pprint_data import datapprint(data, depth=1)pprint(data, depth=2)

使用该depth参数来控制漂亮的打印机递归到嵌套数据结构的距离。未包含在输出中的级别由省略号表示。

$ python3 pprint_depth.py

[(...), (...), (...), (...), (...)]
[(1, {...}), (2, {...}), (3, [...]), (4, [...]), (5, [...])]

控制输出宽度

格式化文本的默认输出宽度为80列。要调整该宽度，请使用width参数to pprint()。

pprint_width.py

from pprint import pprintfrom pprint_data import datafor width in [80, 5]:
    print('WIDTH =', width)
    pprint(data, width=width)
    print()

当宽度太小而无法容纳格式化的数据结构时，如果这样做会引入无效语法，则不会截断或包装这些行。

$ python3 pprint_width.py

WIDTH = 80
[(1, {'a': 'A', 'b': 'B', 'c': 'C', 'd': 'D'}),
 (2,
  {'e': 'E',
   'f': 'F',
   'g': 'G',
   'h': 'H',
   'i': 'I',
   'j': 'J',
   'k': 'K',
   'l': 'L'}),
 (3, ['m', 'n']),
 (4, ['o', 'p', 'q']),
 (5, ['r', 's', 'tu', 'v', 'x', 'y', 'z'])]

WIDTH = 5
[(1,
  {'a': 'A',
   'b': 'B',
   'c': 'C',
   'd': 'D'}),
 (2,
  {'e': 'E',
   'f': 'F',
   'g': 'G',
   'h': 'H',
   'i': 'I',
   'j': 'J',
   'k': 'K',
   'l': 'L'}),
 (3,
  ['m',
   'n']),
 (4,
  ['o',
   'p',
   'q']),
 (5,
  ['r',
   's',
   'tu',
   'v',
   'x',
   'y',
   'z'])]

该compact标志告诉pprint()我尝试在每条线上装入更多数据，而不是跨线传播复杂的数据结构。

pprint_compact.py

from pprint import pprintfrom pprint_data import dataprint('DEFAULT:')pprint(data, compact=False)print('\nCOMPACT:')pprint(data, compact=True)

此示例显示当数据结构不适合某一行时，它将被拆分（与数据列表中的第二项一样）。当多个元素可以放在一条线上时，就像第三个和第四个成员一样，它们就是这样放置的。

$ python3 pprint_compact.py

DEFAULT:
[(1, {'a': 'A', 'b': 'B', 'c': 'C', 'd': 'D'}),
 (2,
  {'e': 'E',
   'f': 'F',
   'g': 'G',
   'h': 'H',
   'i': 'I',
   'j': 'J',
   'k': 'K',
   'l': 'L'}),
 (3, ['m', 'n']),
 (4, ['o', 'p', 'q']),
 (5, ['r', 's', 'tu', 'v', 'x', 'y', 'z'])]

COMPACT:
[(1, {'a': 'A', 'b': 'B', 'c': 'C', 'd': 'D'}),
 (2,
  {'e': 'E',
   'f': 'F',
   'g': 'G',
   'h': 'H',
   'i': 'I',
   'j': 'J',
   'k': 'K',
   'l': 'L'}),
 (3, ['m', 'n']), (4, ['o', 'p', 'q']),
 (5, ['r', 's', 'tu', 'v', 'x', 'y', 'z'])]