如何让类属性成为只读描述符但允许 init 赋值

7次阅读

@Property在__init__中赋值报错是因为只读属性缺少__set__方法,触发AttributeError;解决方案是用自定义描述符配合初始化标记(如_initializing)实现构造期写入,或直接使用attrs/dataclasses的frozen=True。

如何让类属性成为只读描述符但允许 init 赋值

为什么 @property__init__ 里赋值会报错

因为标准 @property 没有 __set__ 方法,一旦定义为只读,连 self._x = value 这种直接赋值(绕过 property)都可能被后续的 @x.setter 缺失干扰——但更常见的是你在 __init__ 里写 self.x = value,结果触发了只读 property 的 __set__(如果你手动实现了它并抛异常),或者压根没实现 __set__ 导致 AttributeError: can't set attribute

用自定义描述符 + 实例字典标记实现 init 期写入

核心思路:让描述符在实例刚创建、尚未完成初始化时允许一次写入。常用做法是在 __init__ 开头设一个临时标记(如 self._initializing = True),描述符的 __set__ 检查该标记;初始化结束后立刻删掉它。

  • __set__ 中判断 hasattr(instance, '_initializing'),存在则接受赋值并存入 instance.__dict__
  • __get__ 正常返回 instance.__dict__.get(self.name)(或抛 AttributeError 如果未初始化)
  • __init__ 结尾加 delattr(self, '_initializing'),确保后续无法再写
  • 注意:不要用 setattr(instance, self.name, value),会递归触发 __set__
class ReadOnlyDescriptor:     def __init__(self, name):         self.name = name 
def __get__(self, instance, owner):     if instance is None:         return self     if self.name not in instance.__dict__:         raise AttributeError(f"'{type(instance).__name__}' Object has no attribute '{self.name}'")     return instance.__dict__[self.name]  def __set__(self, instance, value):     if hasattr(instance, '_initializing'):         instance.__dict__[self.name] = value     else:         raise AttributeError(f"'{self.name}' is read-only")

class Person: name = ReadOnlyDescriptor('name')

def __init__(self, name):     self._initializing = True     self.name = name  # ✅ 允许     delattr(self, '_initializing')  # ? 锁死

__slots__ + 描述符需额外处理

如果类用了 __slots__,就不能依赖 instance.__dict__ 存值,得改用 weakref.WeakKeyDictionary 或在描述符内部维护映射。否则 instance.__dict__[self.name] = value 会失败。

  • WeakKeyDictionary 存值时,__set__ 需先检查是否在初始化中,再调用 self._values[instance] = value
  • __get__ 要处理 key 不存在的情况(比如还没 init 完就 get)
  • __delete__ 一般不需要,但若支持删除需同步清理映射
  • 注意:弱引用字典在实例被 gc 后自动清理,比手动管理更安全

第三方方案:attrsdataclasses 的只读字段

如果你不强求手写描述符,attrsfield(init=True, repr=True, hash=True, kw_only=False) 配合 frozen=True 是更稳的选择;dataclasses 同理,用 field(default=..., init=True, repr=True) 再设 frozen=True

  • frozen=True 会让 __init__ 赋值合法,但实例创建后所有字段不可变(包括通过 __dict__
  • 它们底层不是靠描述符,而是生成带 object.__setattr____init__,绕过常规属性拦截
  • 缺点:无法对单个字段做差异化控制(比如只读 A、可写 B);且 frozen 会影响整个实例的可变性

真正难的不是“怎么写”,而是想清楚:你是否真的需要运行时动态控制可写性?还是只是想表达“构造后不变”——后者用 frozen 更少出错。

text=ZqhQzanResources