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

5次阅读

结论:@Property 的 setter 为空时,__init__ 中无法赋值,因属性访问走 descriptor 协议;需自定义描述符(如 InitOnlyDescriptor),利用 set_name 动态生成私有名,并在 set 中用哨兵值或 hasattr 检查首次赋值,确保 init 可写、之后只读。

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

python@property 无法在 __init__ 中赋值?用 __set_name__ + 实例字典绕过

直接说结论:标准 @property 的 setter 被设为空时,__init__ 里也不能赋值——因为属性访问走的是 descriptor 协议,不是普通实例属性。真要“只读但 init 可写”,得自定义描述符,且在初始化阶段绕过只读逻辑。

常见错误是这么写:

class Person:     def __init__(self, name):         self._name = name  # ✅ 看似 OK,但 _name 是普通属性,不触发 property     @property     def name(self):         return self._name     @name.setter     def name(self, _):         raise AttributeError("name is read-only")

问题在于:self._name 完全脱离了描述符控制,外部仍可直接改 obj._name,且没做任何初始化校验。

  • 必须把值存在实例字典里(如 obj.__dict__['name']),而非用下划线字段模拟
  • 描述符需实现 __set_name__ 获取属性名,并在 __set__ 中区分是否为首次赋值(即 __init__ 阶段)
  • 不能依赖 hasattr(obj, 'name') 判定是否已初始化——因为 __get__ 可能返回默认值,造成误判
  • 推荐在 __set__ 中检查 value is NOT_SET(用哨兵对象),而不是检查 key 是否在 __dict__ 里——避免和 __slots__ 冲突

__set_name__ 和哨兵值实现真正的 init-only 写入

核心是让描述符知道“这是第一次设置”,且只允许在 __init__ 期间发生。关键不在于时间点,而在于是否已存在该键。

class InitOnlyDescriptor:     NOT_SET = object()     def __set_name__(self, owner, name):         self.name = name         self.private_name = f'_{name}'     def __get__(self, obj, objtype=None):         if obj is None:             return self         if not hasattr(obj, self.private_name):             raise AttributeError(f"'{type(obj).__name__}' object has no attribute '{self.name}'")         return getattr(obj, self.private_name)     def __set__(self, obj, value):         if hasattr(obj, self.private_name):             raise AttributeError(f"{self.name} is read-only")         setattr(obj, self.private_name, value) 

class Person: name = InitOnlyDescriptor() def init(self, name): self.name = name # ✅ 触发 set,且此时 private_name 不存在

  • self.name = name__init__ 中合法,因为 __set__ 检查的是 hasattr(obj, private_name),初始为 False
  • 之后再写 person.name = "new" 就会抛 AttributeError
  • 外部无法通过 person._name 绕过——因为真实值存的是 _name(由 __set_name__ 动态生成),不是硬编码字符串
  • 如果类用了 __slots__,需确保 private_name 在 slots 列表中,否则 setattr 会失败

为什么不用 __post_init__dataclassinit=False

那是另一条路,但不符合“init 中赋值”这个前提。比如 dataclass(init=False) 要求你手动写 __init__,且字段本身不参与构造参数,等于放弃语言级的参数绑定。

  • dataclass(frozen=True) 是只读,但所有字段都不可变,连 init 都不允许改
  • field(default_factory=...) 无法接收 __init__ 参数,只能固定值或闭包
  • __post_init__ 里赋值仍是普通属性写入,不经过 descriptor,失去类型/范围校验能力
  • 如果你需要在 init 时做转换(比如把字符串转为 datetime),必须走描述符的 __set__ 才能统一拦截

容易被忽略的边界:继承多继承__slots__

自定义描述符在复杂继承链里可能被覆盖或跳过,尤其当父类也定义同名属性时。__set_name__ 虽然在类创建时调用,但若子类重定义该属性,会重新触发一次,导致 private_name 被覆盖。

  • 若父类有 name = InitOnlyDescriptor(),子类又写一遍,那父类的 descriptor 就失效了
  • 使用 __slots__ 时,必须显式包含 private_name 字符串,例如:__slots__ = ('_name',),否则 setattrAttributeError
  • 不要在 __get__ 中用 getattr(obj, self.name, ...)——这会无限递归,因为 self.name 是公开属性名,访问它又触发 __get__

真正难的不是写一个只读属性,而是让“只读”和“init 可写”在 descriptor 协议层面严格共存。大部分坑都出在对 set 触发时机和实例状态判断的理解偏差上。

text=ZqhQzanResources