Python中调试弱引用、解决pickle序列化报错的实用策略

核心报错信息 #

ReferenceError                            Traceback (most recent call last)
/Users/rhys/phd-work/tmp-design-test.py in <cell line: 125>()
    212 # # %%
    214 with open("test-pipe.pt", "wb") as f:
--> 215     pickle.dump(form_pipe, f)
    216     # torch.save(form_pipe, f)
    218 with open("test-pipe.pt", "rb") as f:

ReferenceError: weakly-referenced object no longer exists

调试策略与工具 #

1. 开启pickle最高等级调试日志，定位炸点对象 #

不要直接调用pickle.dump，手动实例化Pickler对象开启debug模式，序列化过程会逐对象打印处理流程，报错前最后输出的对象就是携带失效弱引用的元凶：

import pickle
import traceback

with open("test-pipe.pt", "wb") as f:
    pickler = pickle.Pickler(f)
    pickler.debug = 3  # 开启最高等级调试日志
    try:
        pickler.dump(form_pipe)
    except ReferenceError:
        traceback.print_exc()

2. 用gc模块遍历扫描所有失效弱引用 #

Python的gc模块可以枚举所有内存中的对象，通过遍历弱引用、反向追踪引用链，可以直接定位到持有失效弱引用的业务对象，在dump逻辑前插入以下代码即可：

import gc
import weakref

gc.collect()  # 先执行全量垃圾回收，清理所有无引用对象
invalid_refs = []
# 扫描所有内存对象，找出已经指向回收对象的失效弱引用
for obj in gc.get_objects():
    try:
        if isinstance(obj, weakref.ReferenceType) and obj() is None:
            invalid_refs.append(obj)
    except Exception:
        continue

print(f"扫描到{len(invalid_refs)}个失效弱引用")
# 反向追踪每个失效弱引用的持有者，过滤掉栈帧、模块本身的系统引用
for ref in invalid_refs:
    for holder in gc.get_referrers(ref):
        if type(holder).__module__ not in ("builtins", "gc", "weakref", "pickle"):
            print(f"持有失效弱引用的对象类型：{type(holder)}，对象内容：{holder}")

3. 结合已知线索缩小排查范围 #

根据已知的「去除NaN后序列化正常、序列化对象为搭载自定义转换器的sklearn.Pipeline」特征，优先排查以下高频坑点：

• 自定义转换器的fit方法中，是否直接存储了带NaN的输入数据的视图、掩码数组、pandas/numpy临时生成的类型校验对象。这类临时对象很多在C扩展层实现，依赖弱引用自动回收，出了fit的作用域就会被销毁，如果没有做深拷贝直接挂在实例属性上，序列化时就会触发报错。
• 检查自定义转换器是否正确实现sklearn接口规范：比如fit方法是否返回self、是否在拟合流程结束后没有清理临时缓存属性。sklearn在拟合时会生成若干带弱引用的校验缓存，正常流程下会在fit返回前自动清理，如果接口实现不符合规范会导致缓存残留。
• 如果转换器中混用了PyTorch相关逻辑，检查是否存储了计算图中间生成的无强引用Tensor、设备对象。NaN触发计算异常分支时，计算图会提前释放，挂在实例上的中间tensor引用就会变成失效弱引用。

4. 二分法快速定位问题组件 #

如果上述方法定位效率低，可以直接拆分Pipeline逐段验证：

• 逐个单独序列化Pipeline的每一步转换器，找到触发报错的具体步骤
• 对出问题的转换器，逐个删除实例属性后重试序列化，定位到具体携带问题的属性
• 定位后对需要持久化的属性做深拷贝（比如numpy数组调用.copy()、pandas对象用.copy(deep=True)），不需要持久化的临时属性直接在fit方法结尾删除即可。

内容的提问来源于stack exchange，提问作者Goods