如何在Python中防止类属性被意外修改(实现只读属性)?

老浩小哥_8299

老浩小哥_8299

2026-07-17

1012人浏览

原创

最稳妥的只读属性方案是用 @property 配合 __init__ 中赋值,不定义 setter;它拦截常规赋值、兼容类型检查,但不禁止直接操作 _x;真正封死需结合 __slots__ 与自定义 __setattr__ 或 dataclass(frozen=true)。

如何在python中防止类属性被意外修改(实现只读属性)?

用 @property 定义只读属性最稳妥

直接在类中给 self._x = value 赋值,再配一个不带 setter 的 @property,是 Python 里最常用也最符合预期的只读方案。它不阻止你改底层变量(比如 obj._x),但能拦住 obj.x = ... 这种常规赋值,且 IDE 和类型检查器(如 mypy)都能识别。

常见错误是只写 @property 却没加 @xxx.setter,结果误以为完全不可修改——其实绕过 property 直接操作下划线字段仍可行。真正想封死,得配合 __setattr__ 或 __slots__。

  • @property 方法里别做重计算或 I/O,否则每次访问都触发,性能易翻车
  • 如果属性依赖初始化参数,确保在 __init__ 中完成赋值,不要在 @property 里懒加载并缓存(除非明确需要)
  • 类型注解建议加上:例如 x: int 放在 @property 方法签名后,mypy 才能校验调用方是否当它是只读

用 __slots__ + __setattr__ 拦截所有赋值

当必须禁止任何字段被动态新增或修改(包括私有字段),__slots__ 配合自定义 __setattr__ 是更硬核的做法。它能在运行时抛出 AttributeError,比纯 @property 更彻底。

容易踩的坑是忘了在 __setattr__ 里放行 __init__ 阶段的赋值——否则对象根本构造不出来。典型做法是用标志位或检查 self.__dict__ 是否为空来区分初始化和后续修改。

  • 启用 __slots__ 后,实例不再有 __dict__,所以不能靠 getattr(obj, 'x', default) 动态查不存在的属性,得提前定义好 slot 名
  • __setattr__ 里用 super().__setattr__(name, value) 绕过拦截,仅限内部可信代码使用;对外一律 raise
  • 这种方案对继承敏感:子类若没声明 __slots__,父类的限制就失效了

用 dataclass(frozen=True) 快速获得不可变实例

如果你的类本质是数据容器(字段少、无复杂逻辑),@dataclass(frozen=True) 是最快捷的只读方案。它自动生成 __hash__、禁止所有字段修改,并在尝试赋值时立刻报 FrozenInstanceError。

python 查询技能
python 查询技能

查询客流数据,输出JSON格式,可直接导入Bitable等可视化工具

下载

注意它冻结的是整个实例,不是单个字段。哪怕你只想让 id 只读、name 可变,它也不支持——此时得退回 @property 或手动控制。

  • frozen=True 会禁用 __dict__,所以无法在运行时动态加属性(连 obj._cache = ... 都不行)
  • 如果字段默认值是可变对象(如 list),必须用 default_factory,否则所有实例共享同一份引用
  • 继承 frozen dataclass 时,子类也必须声明 frozen=True,否则父类字段可被绕过修改

为什么不用 __setitem__ 或描述符强行“锁死”?

有人试过用描述符(Descriptor)在 __set__ 里无条件 raise,或重写 __setitem__ 拦字典式访问——这些方法在特定场景(如模拟常量类)可能有用,但绝大多数时候是过度设计。

它们的问题在于:破坏 Python 的惯性认知。用户调用 obj.x = 1 时,期望得到明确的属性行为,而不是被描述符静默吞掉或抛出不相关的异常。而且这类方案往往漏掉 setattr(obj, 'x', 1) 这种反射调用,还得额外补 __setattr__,反而更难维护。

  • 描述符的 __set__ 对 obj.__dict__['x'] = 1 无效,而这是很多框架(如 ORM、序列化库)实际用的底层操作
  • __setitem__ 只管 obj['x'],对点号访问完全没影响,混淆语义
  • 真正需要“绝对不可变”的场景极少,多数时候只需约定+工具链约束(如 mypy + pre-commit hook)就够了

真正难的不是实现只读,而是判断哪些字段该只读、哪些该开放、以及要不要为这点安全性增加维护成本。Python 的哲学是“我们都是 consenting adults”,所以多数项目用 @property 加文档说明,已经足够清晰。硬上 frozen=True 或 __setattr__ 前,先确认你的使用者真的会、且有必要去绕过那些防护。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

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

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

下载

相关标签:

python python dataclass

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

相关专题

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

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

2023.07.20

1711

4

python能做什么
python能做什么

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

2023.07.25

4304

7

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

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

2023.07.31

1689

3

python教程
python教程

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

2023.08.03

25137

23

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

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

2023.08.04

3067

5

python eval
python eval

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

2023.08.04

3087

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2403

5

热门下载

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

精品课程

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