直接用 pickle.dump 会因不可序列化属性(如 lock、socket)报错,或误存不该持久化的临时属性;可通过 __getstate__ 返回过滤后的状态字典排除指定属性,并建议配对实现 __setstate__ 补回必要对象。

为什么直接用 pickle.dump 会报错或序列化出不该有的属性
当你用 pickle 序列化一个对象时,它默认调用对象的 __dict__(即所有实例属性)。如果对象里有不可序列化的值(比如 threading.Lock、socket.socket、lambda、文件句柄等),就会直接抛 TypeError: can't pickle ...。更隐蔽的问题是:有些属性本就不该持久化(如缓存、临时计算结果、数据库连接),但它们仍被一并塞进 __dict__ 被保存下来。
怎么用 __getstate__ 排除特定属性
__getstate__ 是 pickle 在序列化前调用的钩子函数,返回一个字典,决定哪些属性真正写入序列化流。你只需在类中定义它,返回过滤后的状态字典即可。
常见做法:
- 复制原始
__dict__,再用del或字典推导删掉不想保存的键 - 避免硬编码字段名,可用集合定义要排除的属性列表(便于维护)
- 注意:如果类继承自父类且父类也有状态,别忘了调用
super().__getstate__()(不过多数情况下父类没重写,直接操作self.__dict__就够)
示例:
class CacheManager:
def __init__(self):
self.data = {"a": 1}
self._cache = {}
self._lock = threading.Lock() # 不可序列化
self._temp_result = None
<pre class="brush:python;toolbar:false;">def __getstate__(self):
state = self.__dict__.copy()
# 明确排除这些属性
for attr in ["_lock", "_temp_result"]:
state.pop(attr, None)
return state
__setstate__ 必须配对实现吗
不是必须,但强烈建议配对。如果你在 __getstate__ 中删了某些属性,反序列化时 __dict__ 就不包含它们——而有些属性(如 _lock)是运行必需的,否则后续调用会 AttributeError。
快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。
__setstate__ 在 unpickle 后立即执行,接收的就是 __getstate__ 返回的字典。你可以在这里补回缺失的属性:
- 重新初始化不可序列化的对象(如新建
threading.Lock()) - 设置默认值(如
self._temp_result = None) - 不要直接赋值整个
state到self.__dict__,否则会绕过你的初始化逻辑
示例续写:
def __setstate__(self, state):
# 先恢复基础状态
self.__dict__.update(state)
# 补回不可序列化的依赖
self._lock = threading.Lock()
self._temp_result = None
比 __getstate__ 更轻量的替代方案:__reduce__
如果你只是想跳过几个字段,又不想写两套方法,__reduce__ 是更底层、更灵活的选择。它返回一个元组:(callable, args, state),其中 state 就是给 __setstate__ 的字典。你可以只传部分属性过去,甚至完全绕过 __dict__。
但它容易出错:一旦 callable 和 args 构造不出正确实例,反序列化就失败;而且调试起来比 __getstate__ 更难追踪。
所以除非你有特殊构造逻辑(比如必须调用工厂函数),否则优先用 __getstate__ + __setstate__。它们语义清晰、调试友好、也符合大多数人的直觉。
真正容易被忽略的是:如果你的类用了 __slots__,__dict__ 可能根本不存在,这时 __getstate__ 必须手动拼出状态字典,不能无脑 self.__dict__.copy() —— 这种情况得先检查 hasattr(self, '__dict__') 或改用 getattr(self, '__slots__', []) 来遍历。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!










