ARTICLE DETAIL

资讯详情

深耕网站视觉设计与运营推广的一线实战洞察。

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

PySnooper高级参数调优10例:custom_repr、max_variable_length、prefix、normalize、thread_info完全指南 PySnooper高级参数调优10例custom_repr、max_variable_length、prefix、normalize、thread_info完全指南【免费下载链接】PySnooperNever use print for debugging again项目地址: https://gitcode.com/gh_mirrors/py/PySnooperPySnooper是一个 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), dtypefloat64)而不是几行数字。匹配规则按顺序进行命中一条就不再检查后面的见 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(size10000)日志清爽很多。例 3用max_variable_length放宽截断长度变量和异常默认被截断到100 字符中间用...省略实现见 pysnooper/utils.py 的truncate。想多看点细节pysnooper.snoop(max_variable_length200)例 4用max_variable_lengthNone彻底关闭截断排查字符串到底长什么样这类问题时截断本身反而碍事pysnooper.snoop(max_variable_lengthNone)⚠️ 注意变量可能是几 MB 的大对象建议只在临时排查时打开。例 5用prefix给日志加前缀方便 grep日志混在一堆其他输出里时加个醒目前缀pysnooper.snoop(prefixZZZ )之后grep ZZZ app.log就能一次性抽出所有 snoop 行。前缀是在每条日志写入时统一拼接的tracer.py 的write方法。例 6用normalize抹掉机器信息便于对比时间戳、绝对路径、内存地址都是机器相关数据导致两次运行的日志无法直接 diff。normalizeTrue会把时间戳清空、路径只保留文件名、repr 中的0x...地址移除pysnooper.snoop(normalizeTrue)这在回归对比改代码前后行为是否一致时非常实用归一化逻辑见 pysnooper/utils.py。例 7用thread_info定位多线程问题多线程程序里多条线程的日志交织在一起thread_infoTrue会在每行前面加上线程ID-线程名并对齐补白pysnooper.snoop(thread_infoTrue)这样一眼就能分清哪条日志来自哪个线程。注意normalize与thread_info不能同时使用tracer.py。例 8用relative_time显示相对耗时默认时间戳是墙上时钟绝对时间对比两行代码间隔不直观。relative_timeTrue改为相对函数开始的耗时pysnooper.snoop(relative_timeTrue)配合上面的例子你能直接看出第 3 行之后卡了 500ms这类性能线索。例 9用colorFalse关闭彩色输出Linux/macOS 上日志默认带颜色Windows 默认关闭。写入日志文件或管道处理时建议关掉避免 ANSI 转义码污染文件pysnooper.snoop(/my/log/file.log, colorFalse)例 10生产级组合拳真实排查时通常多个参数一起用。一个推荐的排查大对象 多行日志组合pysnooper.snoop( /tmp/snoop.log, # 输出到文件 prefixZZZ , # 方便 grep max_variable_length300, # 多看点细节 relative_timeTrue, # 看耗时 )另外提醒设置环境变量PYSNOOPER_DISABLED1可以让 PySnooper 整体静默方便代码里常驻装饰器、临时关调试。三、参数速查表参数默认值作用custom_repr()按类型/条件自定义变量显示max_variable_length100变量截断长度None表示不截断prefix每行日志前缀便于 grepnormalizeFalse去掉时间戳/路径/地址便于 diffthread_infoFalse显示线程 ID 与名称relative_timeFalse时间戳改为相对耗时color平台相关关闭 ANSI 彩色输出完整签名定义在 pysnooper/tracer.py 的Tracer.__init__想深挖某个参数行为时直接对照源码即可。四、小结 日志太长刷屏 →custom_repr、max_variable_length日志混杂难找 →prefix想对比两次运行 →normalize多线程排查 →thread_info关注性能耗时 →relative_timePySnooper 的哲学始终是零配置也能用而这 10 个参数则让你在企业级项目里同样用得顺手。建议从例 5prefix和例 6normalize开始这两个参数在日常排障中受益最快。【免费下载链接】PySnooperNever use print for debugging again项目地址: https://gitcode.com/gh_mirrors/py/PySnooper创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表