开始免费使用
当前位置：首页 > Python > Python pprint模块使用指南：美观打印与格式化技巧

Python pprint模块使用指南：美观打印与格式化技巧

山间有风
山间有风
发布时间：2026-10-16| 5人浏览过
原创

本文详细介绍Python标准库中的pprint模块，涵盖美观打印数据结构、日志记录中的格式化输出、自定义类的处理以及递归数据的表示。重点解析depth和width参数的使用，帮助开发者优化复杂数据的输出可读性，提升调试效率。

一. pprint美观打印数据结构

pprint模块提供了一个美观打印机，用于生成数据结构的可视化视图。该格式化工具生成的表示不仅可由解释器正确解析，还便于人类阅读。输出会尽可能保持在单行，若需换行则会自动缩进。

1.打印


from pprint import pprint

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']),

]

print('PRINT:')

print(data)

print()

print('PPRINT:')

pprint(data)

使用pprint()函数可对对象进行格式化，并将其作为参数传入数据流（默认为sys.stdout）。


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'])]

2 .格式化

若需将数据结构格式化为字符串而非直接写入流（例如用于日志记录），可使用pformat()来构建字符串表示。


import logging

from pprint import pformat



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']),

]

logging.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())

随后可单独打印该格式化字符串或将其记录到日志中。


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'])]

3. 任意类

若自定义类定义了__repr__()方法，pprint()使用的PrettyPrinter类亦可处理此类自定义对象。


from pprint import pprint

class 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)

通过PrettyPrinter组合嵌套对象的表示，可返回完整的字符串表示。


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

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

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

4. 递归

递归数据结构由指向原数据源的引用表示，格式为<Recursion on typename with id=number>。


from pprint import pprint

local_data = ['a', 'b', 1, 2]

local_data.append(local_data)

print('id(local_data) =>', id(local_data))

pprint(local_data)

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


id(local_data) => 2763816527488

['a', 'b', 1, 2, <Recursion on list with id=2763816527488>]

5. 限制嵌套输出

对于深层数据结构，可能无需在输出中包含所有细节。数据可能未正确格式化，或格式化文本过大难以管理，甚至部分数据可能冗余。


from pprint import pprint

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(data, depth=1)

pprint(data, depth=2)

通过depth参数可控制美观打印机递归处理嵌套数据结构的深度。输出中未包含的层次以省略号表示。


[(...), (...), (...), (...), (...)]

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

6.控制输出宽度

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


from pprint import pprint

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']),

]

for width in [80, 5]:

    print('WIDTH =', width)

    pprint(data, width=width)

    print()

当宽度不足以容纳格式化数据结构时，若截断或转行会导致非法语法，则不会进行截断或转行。


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()尝试在每行放置更多数据，而非将复杂数据结构分解为多行。


from pprint import pprint

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']),

]

for width in [80, 5]:

    print('WIDTH =', width)

    pprint(data, width=width)

    print()

此示例展示了一个数据结构在一行无法放下时会被分解（数据列表中的第二项亦如此）。若多个元素可放置在一行（如第三个和第四个成员），则会将它们放在同一行。


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'])]

到此这篇关于 Python中的pprint模块的文章就介绍到这了,更多相关 Python pprint模块内容请搜索本站以前的文章或继续浏览下面的相关文章希望大家以后多多支持本站！

相关文章

相关标签: Python

免责声明：本文内容仅供参考，不代表本站观点。转载或引用请注明出处。

作者最新文章

全部文章

Python 相关产品和应用

全部下载
PythonSelenium
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

Python机器学习
scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Python代码质量
Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Python代码质量
Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

Pythonpytest
pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

PythonFastAPI
FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架，支持类型提示和自动接口文档。

PythonFlask
Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

PythonDjango
Django

Django

6.1.2 · Windows

成熟的 Python Web 框架，适合构建内容站点和业务系统。

PythonSpyder
Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

PythonSciPy
SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。