如何实现“只读属性”但允许在 init 中赋值的模式

13次阅读

python中模拟只读属性有三种主流方式:①重写__setattr__配合初始化标志;②__slots__+Property封装私有字段;③@dataclass(frozen=True)实现全对象不可变。

如何实现“只读属性”但允许在 init 中赋值的模式

在 Python 中,没有原生的“只读属性”语法,但可以通过 @property + 自定义 __setattr__ 或使用 __slots__ + 属性封装来模拟:核心思路是**允许在 __init__ 执行期间赋值,之后禁止修改**。

__setattr__ 控制赋值时机

在实例初始化完成前(即 __init__ 还没返回时),临时放开写权限;之后所有赋值尝试都抛出异常。

  • __init__ 开头设一个标志(如 self._initializing = True
  • 重写 __setattr__:若标志为 True,直接调用 super().__setattr__;否则检查是否为只读属性名,是则报错
  • __init__ 结尾清除标志(self._initializing = False

注意:需确保 __init__ 一定执行完毕再置为 False,否则可能漏掉校验。也可用更稳妥的方式——用 __dict__ 直接设初始值,避免触发 __setattr__

__slots__ 配合 property 实现(推荐)

定义 __slots__ 禁止动态添加属性,再用 @property 暴露只读访问,内部用私有字段(如 _x)存储值,并在 __init__ 中直接赋值给该私有字段。

  • __slots__ = ('_x', '_y') —— 限制实例字典,提升性能并防止绕过
  • @property 方法(如 def x(self): return self._x)提供只读接口
  • __init__ 中直接写 self._x = x,不走 property setter(因为没定义 @x.setter

这种方式清晰、安全、无副作用,且 ide 和类型检查器(如 mypy)能更好识别只读语义。

使用 dataclassesfield(init=True, repr=True, compare=True) + frozen=True

如果整个对象逻辑上应不可变,直接启用 @dataclass(frozen=True) 是最简洁方案。

  • 所有字段默认只读,__init__ 是唯一可赋值入口
  • 尝试修改会触发 dataclasses.FrozenInstanceError
  • 若只需部分字段只读,可结合 field(default=...)field(default_factory=...),并在 __post_init__ 中计算派生值

适合配置类、DTO、领域模型等强调不变性的场景。

进阶:带验证的只读字段(如初始化时校验范围)

__init__ 赋值前加入校验逻辑,确保只读字段从一开始就是合法的。

  • 例如:if not (0
  • 校验通过后再赋值给私有字段或 __slots__ 字段
  • 这样既保证只读性,又保证数据有效性,避免后期用 property getter 做校验(校验应在源头发生)

不复杂但容易忽略。

text=ZqhQzanResources