[Python] PySnooper：替代 print 调试的 Python 利器，如何快速定位问题与跟踪日志？

PySnooper 是什么？你可以把它理解为 Python 版的 set -x，但功能更强大，信息也更直观。当你的某段代码行为诡异，既不想一步步打断点，又懒得在四处插入 print 语句时，它就是你的救星。你只需在目标函数上方加一个装饰器 @pysnooper.snoop()，或者用 with pysnooper.snoop(): 包裹一段代码。运行时，它会自动将每一行的执行情况、变量变化、甚至时间戳都打印出来。整个过程简单直接，对老旧项目尤其友好——无需任何复杂的配置。

它解决了哪些调试痛点？

在 Python 开发中，下面这些场景你是否遇到过？

• 不想在代码里乱插 print，却又迫切想知道程序的执行流程和变量变化；
• 在调试分布式服务或某些难以直接抓取 stderr 的环境时，希望能将调试日志输出到文件；
• 需要清晰地看到函数内部具体执行了哪些行，哪些局部变量被修改了；
• 在线上环境或不方便启动交互式调试器（如 pdb）的集成环境中，需要一种快速排查手段。
  PySnooper 的本质，就是将这种 “低成本、可追溯” 的调试思路，封装成了一个开箱即用的工具。

安装与快速上手

安装非常简单，使用 pip 即可：

pip install pysnooper

示例一：使用装饰器

import pysnooper

@pysnooper.snoop()
def number_to_bits(number):
    if number:
        bits = []
        while number:
            number, remainder = divmod(number, 2)
            bits.insert(0, remainder)
        return bits
    else:
        return [0]

number_to_bits(6)

运行后，控制台会详细展示函数 number_to_bits 被调用后的每一步执行过程。

示例二：使用 with 语句（局部跟踪）

如果你只想跟踪一小段代码，而不是整个函数，with 语句会更灵活。

import pysnooper, random

def foo():
    lst = [random.randrange(1, 1000) for _ in range(10)]
    with pysnooper.snoop():
        lower = min(lst)
        upper = max(lst)
        mid = (lower + upper) / 2
    print(lower, mid, upper)

foo()

这样，只有 with 块内的三行代码的执行细节会被输出，函数其他部分的执行则保持静默。

常用配置选项速查表

PySnooper 提供了多种参数来定制输出行为，以下是一些最常用的选项：

优缺点一览

为了帮你快速判断是否该引入它，这里有一个简单的对比：

一个真实的应用场景

有一次，一个线上定时任务偶尔会产生错误结果，既不能停止服务，也懒得去 Attach 调试器。这时，我在关键的转换函数上加上了 @pysnooper.snoop('/tmp/trace.log')，然后触发几次任务。接着查看 /tmp/trace.log 文件，里面清晰地记录了哪个条件分支没有被执行，或者哪个变量被意外地赋了一个奇怪的值。整个过程只花了大约十分钟就定位了问题根源，比到处写 print 然后重新运行要高效得多。

总结

PySnooper 并非要取代 pdb 这类功能强大的交互式调试器，而是提供了一种 “快速、低侵入性” 的代码可观测性补充手段。当你需要临时查看执行流程和变量变化，或者在不方便启动完整调试器的环境中进行快速排查时，它会是一个非常得力的工具。唯一需要注意的是，避免在高频调用或涉及敏感数据的生产场景中滥用，以防性能问题和日志膨胀。

如果你正在寻找一种能提升日常调试效率的轻量级方案，不妨试试 PySnooper。更多技术实践和开源工具分享，欢迎在云栈社区交流探讨。

项目开源地址：https://github.com/cool-RR/PySnooper