商城首页欢迎来到中国正版软件门户

您的位置: 首页 > 文章列表 > 编程开发 > Python如何实现一个只读的类_通过覆盖__setattr__禁止修改属性

Python如何实现一个只读的类_通过覆盖__setattr__禁止修改属性

  发布于2026-07-19 阅读(0)

扫一扫,手机访问

在Python中,想让一个类的实例变成只读,很多人第一反应就是覆盖__setattr__方法。但直接上手就会碰壁——连实例都创建不出来。问题出在哪儿?正确的做法又是什么?来,一步步拆解。

直接覆盖__setattr__会导致实例创建失败,因为初始化时self.x=1等操作也会触发它,而此时__dict__可能未就绪;安全只读需用_frozen标记位,在__init__末尾设为True,并在__setattr__中检查该标记且允许写入_开头属性和调用super().__setattr__。

Python如何实现一个只读的类_通过覆盖__setattr__禁止修改属性

为什么直接覆盖 __setattr__ 会出错?

直接在类里写 def __setattr__(self, name, value): raise AttributeError,看起来逻辑很清晰,但实际运行时会直接翻车。原因很简单:Python在初始化阶段,比如执行 self.x = 1 时,也会触发 __setattr__。此时对象还没完成构造,__dict__ 可能尚未就绪,异常一抛,连基本属性都设不上去。

如何安全地让实例变成只读?

关键点在于:在 __init__ 完成之前先“放行”,之后再“锁死”。一个经典的做法是用标记位 _frozen 来控制开关——初始化阶段允许写入,完成后一律拒绝。

class ReadOnlyPoint:
    def __init__(self, x, y):
        self.x = x
        self.y = y
        self._frozen = True  # 初始化完成后才启用保护

    def __setattr__(self, name, value):
        if getattr(self, '_frozen', False) and not name.startswith('_'):
            raise AttributeError(f"can't modify readonly attribute '{name}'")
        super().__setattr__(name, value)

这里有几个细节值得留意:

  • _frozen 必须在 super().__setattr__ 调用之前设置好,否则第一次设置它自己就会被拦截,陷入死循环。
  • 允许写入以 _ 开头的属性(比如 _cache),方便内部扩展,同时保持对外部的只读约束。
  • 必须调用 super().__setattr__,而不是直接操作 self.__dict__,否则会绕过描述符或 __slots__ 的逻辑,导致不可预期的行为。

使用 __slots__ 配合 __setattr__ 的注意事项

如果类定义了 __slots__ = ('x', 'y'),事情就变得有点微妙了——_frozen 不在 __slots__ 列表中,所以不能动态写入。这时有两种选择:

  • _frozen 加进 __slots__:但这样会暴露该字段,而且所有实例都会多占一个 slot。
  • 改用 object.__setattr__(self, '_frozen', True) 绕过当前类的 __setattr__ 检查——这是唯一安全的“破例”方式。

后者更干净,也是推荐的做法:

class ReadOnlyPoint:
    __slots__ = ('x', 'y')
    def __init__(self, x, y):
        object.__setattr__(self, 'x', x)
        object.__setattr__(self, 'y', y)
        object.__setattr__(self, '_frozen', True)  # 直接写入,不走 __setattr__

    def __setattr__(self, name, value):
        if getattr(self, '_frozen', False) and name in self.__slots__:
            raise AttributeError(f"readonly: {name}")
        super().__setattr__(name, value)

只读 ≠ 不可变:深拷贝和继承的影响

需要清醒认识到:这种只读机制是运行时的防护,不是类型系统层面的不可变。有几个现实问题值得注意:

  • 用户仍可通过 object.__setattr__(obj, 'x', 999) 强行修改——防护的是常规赋值操作,不是恶意绕过。
  • 如果属性是可变对象(比如 self.data = [1,2,3]),虽然不能替换整个列表,但可以修改其内部内容:obj.data.append(4) 依然是合法的。
  • 子类可以重写 __setattr__,彻底取消保护。如果需要强约束,可以把类设为 final(Python 3.8+ 的 @final 装饰器),并配合文档说明。

如果真正需要强不可变语义,优先考虑 dataclasses.frozen=TrueNamedTuple,它们在构造后冻结整个实例,对嵌套可变对象也有明确的行为约定。

本文转载于:https://www.php.cn/faq/2314343.html 如有侵犯,请联系zhengruancom@outlook.com删除。
免责声明:正软商城发布此文仅为传递信息,不代表正软商城认同其观点或证实其描述。

热门关注