企业官网建设流程全解析

PySnooper高级参数调优10例：custom_repr、max_variable_length、prefix、normalize、thread_info完全指南

【免费下载链接】PySnooperNever use print for debugging again项目地址: https://gitcode.com/gh_mirrors/py/PySnooper

PySnooper是一个 Python 调试工具，号称"再也不需要用 print 调试"。你只需要给函数加一行装饰器@pysnooper.snoop()，它就能逐行打印出执行的代码行和每个局部变量的变化。入门很容易，但真正提升排查效率的，是它的一批高级参数。本文用 10 个实际例子，把custom_repr、max_variable_length、prefix、normalize、thread_info这些常用高级参数讲透。

一、准备工作：1 分钟上手

先确认安装：

$ 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]

运行后，标准错误输出里会出现类似上图的逐行日志：每一行代码何时执行、变量何时新建（New var）、何时被修改（Modified var）、最终返回值，一目了然。

下面 10 个例子都基于这个函数演示，参数细节可参考官方 ADVANCED_USAGE.md 与 pysnooper/tracer.py 的源码。

二、10 个参数调优实例

例 1：用custom_repr自定义类型显示（numpy 场景）

默认 repr 打印一个大矩阵会刷屏。custom_repr接受(类型, 显示函数)的元组组合：

def print_ndarray(a): return 'ndarray(shape={}, dtype={})'.format(a.shape, a.dtype) @pysnooper.snoop(custom_repr=((numpy.ndarray, print_ndarray),)) def sum_to_x(x): a = numpy.zeros((10, 10)) return a.sum()

日志里就会显示a = ndarray(shape=(10, 10), dtype=float64)而不是几行数字。匹配规则按顺序进行，命中一条就不再检查后面的（见 pysnooper/utils.py 中的get_repr_function）。

例 2：用条件函数代替类型判断

第一个元素不一定要是类型，也可以是"返回 True/False 的函数"。比如只关心超长列表的长度：

def is_large_list(l): return isinstance(l, list) and len(l) > 5 def print_list_size(l): return 'list(size={})'.format(len(l)) @pysnooper.snoop(custom_repr=((is_large_list, print_list_size),)) def sum_to_x(x): l = list(range(10000)) return sum(l)

输出变成l = list(size=10000)，日志清爽很多。

例 3：用max_variable_length放宽截断长度

变量和异常默认被截断到100 字符，中间用...省略（实现见 pysnooper/utils.py 的truncate）。想多看点细节：

@pysnooper.snoop(max_variable_length=200)

例 4：用max_variable_length=None彻底关闭截断

排查"字符串到底长什么样"这类问题时，截断本身反而碍事：

@pysnooper.snoop(max_variable_length=None)

⚠️ 注意：变量可能是几 MB 的大对象，建议只在临时排查时打开。

例 5：用prefix给日志加前缀，方便 grep

日志混在一堆其他输出里时，加个醒目前缀：

@pysnooper.snoop(prefix='ZZZ ')

之后grep 'ZZZ' app.log就能一次性抽出所有 snoop 行。前缀是在每条日志写入时统一拼接的（tracer.py 的write方法）。

例 6：用normalize抹掉机器信息，便于对比

时间戳、绝对路径、内存地址都是"机器相关"数据，导致两次运行的日志无法直接 diff。normalize=True会把时间戳清空、路径只保留文件名、repr 中的0x...地址移除：

@pysnooper.snoop(normalize=True)

这在回归对比（"改代码前后行为是否一致"）时非常实用，归一化逻辑见 pysnooper/utils.py。

例 7：用thread_info定位多线程问题

多线程程序里，多条线程的日志交织在一起，thread_info=True会在每行前面加上线程ID-线程名，并对齐补白：

@pysnooper.snoop(thread_info=True)

这样一眼就能分清哪条日志来自哪个线程。注意：normalize与thread_info不能同时使用（tracer.py）。

例 8：用relative_time显示相对耗时

默认时间戳是"墙上时钟"（绝对时间），对比两行代码间隔不直观。relative_time=True改为相对函数开始的耗时：

@pysnooper.snoop(relative_time=True)

配合上面的例子，你能直接看出"第 3 行之后卡了 500ms"这类性能线索。

例 9：用color=False关闭彩色输出

Linux/macOS 上日志默认带颜色（Windows 默认关闭）。写入日志文件或管道处理时建议关掉，避免 ANSI 转义码污染文件：

@pysnooper.snoop('/my/log/file.log', color=False)

例 10：生产级组合拳

真实排查时通常多个参数一起用。一个推荐的"排查大对象 + 多行日志"组合：

@pysnooper.snoop( '/tmp/snoop.log', # 输出到文件 prefix='ZZZ ', # 方便 grep max_variable_length=300, # 多看点细节 relative_time=True, # 看耗时 )

另外提醒：设置环境变量PYSNOOPER_DISABLED=1可以让 PySnooper 整体静默，方便"代码里常驻装饰器、临时关调试"。

三、参数速查表

完整签名定义在 pysnooper/tracer.py 的Tracer.__init__，想深挖某个参数行为时直接对照源码即可。

四、小结 🎯

• 日志太长刷屏 →custom_repr、max_variable_length
• 日志混杂难找 →prefix
• 想对比两次运行 →normalize
• 多线程排查 →thread_info
• 关注性能耗时 →relative_time

PySnooper 的哲学始终是"零配置也能用"，而这 10 个参数则让你在企业级项目里同样用得顺手。建议从例 5（prefix）和例 6（normalize）开始，这两个参数在日常排障中受益最快。

【免费下载链接】PySnooperNever use print for debugging again项目地址: https://gitcode.com/gh_mirrors/py/PySnooper