Python怎么在序列化时排除特定属性_自定义__getstate__与__setstate__

陌辰小哥_1400

陌辰小哥_1400

2026-04-12

997人浏览

原创

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

python怎么在序列化时排除特定属性_自定义__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-script-generator
python-script-generator

快速生成专业的 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 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1671

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4144

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

23977

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2927

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2967

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1143

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2303

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程