pprint,一个漂亮打印的 Python 库!

pprint,一个漂亮打印的 Python 库! 在日常编程中我们经常需要打印复杂的数据结构——嵌套的字典、列表、JSON 响应、配置对象等。使用普通的print()会将整个结构挤在一行或简单换行导致可读性极差尤其是在调试多层嵌套的 API 返回数据时简直是一场灾难。pprint模块Pretty Printer正是为了解决这一问题而诞生的。它能够将 Python 对象以一种美观、缩进对齐、可读性强的格式输出并且自动处理递归结构、限制深层展示、支持宽度控制。在实际生活中这就像把杂乱无章的衣柜整理得井井有条——当你需要理解复杂的配置文件、分析爬虫抓取的嵌套数据、向同事展示数据结构样例甚至只是调试自己的代码时pprint都能让你的控制台输出变得清晰如一封排版优美的信件。一、安装库pprint是 Python 标准库无需额外安装。直接导入即可pythonfrom pprint import pprint, pformat通常使用pprint()直接打印或pformat()返回格式化后的字符串以供日志记录。二、基本用法下面通过 4 个小步骤掌握pprint的核心使用。1. 简单打印嵌套结构对比普通print与pprint的输出差异pythonfrom pprint import pprint data { name: Alice, age: 30, address: { street: 123 Main St, city: Springfield, coordinates: {lat: 40.123, lng: -74.456} }, hobbies: [reading, coding, hiking], metadata: {created: 2024-01-01, version: 1.2} } print(普通 print:) print(data) print(\npprint 输出:) pprint(data)pprint会智能换行、缩进使得结构一目了然。2. 控制输出宽度通过width参数调整每行最大字符数默认 80pythonpprint(data, width40) # 更窄的宽度强制更多换行3. 设置缩进深度indent参数控制每一层的缩进空格数默认 1pythonpprint(data, indent4) # 每层缩进4个空格4. 限制嵌套层级depth参数可以截断过深的嵌套pythondeep [1, [2, [3, [4, [5]]]]] pprint(deep, depth3) # 最深只显示三层更深用 ... 表示三、高级用法使用pformat()获取字符串当需要将格式化后的内容写入日志文件或发送到网络时使用pformat()pythonimport logging from pprint import pformat logging.basicConfig(levellogging.INFO) data {key: [1, 2, 3], nested: {a: 10, b: 20}} logging.info(Data structure:\n%s, pformat(data))自定义PrettyPrinter对象可以创建pprint.PrettyPrinter实例并配置自己的输出流例如写入文件pythonfrom pprint import PrettyPrinter with open(output.txt, w) as f: printer PrettyPrinter(streamf, indent2, width60) printer.pprint(data)处理递归数据结构pprint能检测并优雅处理递归引用避免无限打印pythonrecursive_list [] recursive_list.append(recursive_list) pprint(recursive_list) # 输出: [Recursion on list with id...]紧凑输出compact参数Python 3.4让序列在一行内尽可能紧凑pythonlong_list [1, 2, 3, 4, 5, 6, 7, 8] pprint(long_list, compactTrue) # 输出: [1, 2, 3, 4, 5, 6, 7, 8]不换行 # 如果超出宽度则适当换行四、实际应用场景场景1调试 API 响应电商价格爬虫当你调用一个电商的开放 API 获取商品详情时返回的 JSON 可能嵌套很深。用pprint快速查看结构找出价格字段路径pythonimport requests from pprint import pprint response requests.get(https://dummyjson.com/products/1) data response.json() pprint(data, depth2) # 只看前两层避免刷屏 # 输出会清晰展示 product 的 id、title、price 等字段的位置场景2分析配置文件差异运维人员常使用 YAML/JSON 配置文件。用pprint格式化后对比两个配置的差异配合difflibpythonfrom pprint import pformat import difflib config_old {db: {host: localhost, port: 5432}, cache: {ttl: 60}} config_new {db: {host: 192.168.1.1, port: 5432}, cache: {ttl: 120}} old_str pformat(config_old, width50) new_str pformat(config_new, width50) diff difflib.unified_diff(old_str.splitlines(), new_str.splitlines(), lineterm) print(\n.join(diff))场景3教学演示或代码文档生成在编写技术教程时需要展示复杂数据结构的样例输出。pprint可以生成整洁的示例pythonfrom pprint import pprint example { name: Person, fields: [ {name: id, type: int}, {name: name, type: str}, ], meta: {created: 2025-01-01} } print(预期的数据结构) pprint(example, indent2)场景4日志记录中的结构化数据深度案例在分布式系统中经常需要记录每个请求的上下文。利用pformat将其写入日志方便后续排查pythonimport logging from pprint import pformat from datetime import datetime import random logging.basicConfig(levellogging.INFO, format%(asctime)s - %(message)s) def process_request(user_id, payload): context { user_id: user_id, timestamp: datetime.now().isoformat(), payload: payload, internal_state: { cache_hit: random.choice([True, False]), retry_count: random.randint(0, 3), errors: [] } } # 使用 pformat 将复杂对象转为可读字符串 logging.info(Request context:\n%s, pformat(context, indent2, width100)) # 实际业务逻辑... return context process_request(12345, {action: buy, item: laptop, quantity: 1})此案例中pformat保证了即使payload和internal_state嵌套较深日志依然整洁易读便于事后分析。五、结尾互动总而言之pprint是一个小巧但极其实用的标准库。它用优雅的排版拯救了开发者面对杂乱数据时的双眼——无论是调试、教学、日志记录还是数据探索pprint都能瞬间提升你的信息获取效率。记住当你下一次为print(data)输出的混乱而头痛时只需将print改成pprint世界立刻变得清晰。如果你有自己独特的使用技巧比如结合json.dumps与pprint或自定义PrettyPrinter子类过滤敏感信息欢迎在评论区分享。你曾因为数据输出不直观而浪费了多少调试时间试试pprint也许会有意想不到的收获。