Python @property怎么实现Setter和Deleter完整示例
详细讲解Python中如何使用@property、@属性名.setter和@属性名.deleter实现面向对象属性的安全读取、赋值校验与删除清理,提供完整可运行的代码示例与常见陷阱排查方案。
在 Python 面向对象编程中,若想对外保留简洁的属性访问语法(如 obj.val),同时在赋值或删除时执行类型校验、边界限制及资源释放逻辑,核心解决路径就是使用内置的 @property 装饰器及其派生的 @<属性名>.setter 与 @<属性名>.deleter。本文通过一个商品库存与价格管理的实际模型,逐步展示 Getter、Setter、Deleter 的语法定义、参数拦截与状态重置流程,并剖析常见递归错误与工程注意事项。
一、@property、Setter 与 Deleter 的协作机制
在默认情况下,直接操作公开实例属性无法拦截异常赋值。如果为了控制访问而编写 get_price() 与 set_price() 传统方法,又会破坏原本平铺的属性调用风格。Python 提供的 @property 实际上是内置描述符协议(Descriptor Protocol)的高阶封装:
- Getter 阶段:在方法名上方添加
@property,将该方法转变为可读属性的获取入口。 - Setter 阶段:使用已被
@property装饰的属性对象派生出的@<属性名>.setter,定义属性被赋值(如obj.price = 100)时的处理函数。 - Deleter 阶段:使用
@<属性名>.deleter,定义执行del obj.price时的清理或状态重置行为。
底层数据通常保存在一个带有单下划线前缀的受保护变量中(如 _price),从而将对外接口与内部存储安全隔离。
二、分步实现 Setter 和 Deleter 的标准流程
实现完整的属性生命周期管理,需要遵循严格的顺序和方法命名规范。以下是标准四步操作步骤:
步骤 1:在初始化方法中预设内部属性
在类的 __init__ 中,不要直接对外暴露无约束的公开变量。推荐使用单下划线前缀(如 self._price)存放实际数据。如果希望在初始化阶段就触发校验逻辑,也可以直接调用 self.price = initial_value。
步骤 2:使用 @property 声明属性读取器(Getter)
首先编写一个与预期属性名同名的方法,并在其上方加上 @property 装饰器。该方法只能接收 self 参数,负责返回存储在内部受保护变量中的数值或计算结果。
步骤 3:使用 @<属性名>.setter 声明赋值修改器(Setter)
当 Getter 声明完成后,当前作用域内就产生了一个名为属性名的 property 对象。此时必须使用 @<属性名>.setter 装饰器修饰下一个方法。关键规则是:该方法的名字必须与 Getter 完全一致。该方法接收 self 和 value 两个参数,负责执行业务逻辑与类型断言。
步骤 4:使用 @<属性名>.deleter 声明删除清理器(Deleter)
使用 @<属性名>.deleter 装饰同名清理方法。当调用者执行 del obj.prop 时,该方法被触发。通常在其中执行 del self._prop 真正释放底层属性,或者将其重置为默认值。
三、完整可运行代码示例
下面是一个经过实际测试的 ProductItem(商品项目)类实现。代码对 price 属性实现了完整的 Getter、Setter 与 Deleter,并在 Setter 中加入类型判断与负数校验,在 Deleter 中清理底层字典数据:
class ProductItem:
def __init__(self, name: str, price: float):
self.name = name
# 初始赋值:通过 setter 执行首次校验
self.price = price
# 1. 属性读取入口 (Getter)
@property
def price(self) -> float:
"""获取商品价格。如果属性已被删除,提示异常。"""
if not hasattr(self, "_price"):
raise AttributeError(f"'{self.__class__.__name__}' 对象的属性 'price' 已被删除")
return self._price
# 2. 属性赋值与校验入口 (Setter)
@price.setter
def price(self, value: float) -> None:
"""设置商品价格,校验输入类型与数值有效性。"""
if not isinstance(value, (int, float)):
raise TypeError(f"价格必须为数值类型,当前传入类型: {type(value).__name__}")
if value < 0:
raise ValueError(f"价格不能小于零,当前传入数值: {value}")
self._price = round(float(value), 2)
# 3. 属性删除与清理入口 (Deleter)
@price.deleter
def price(self) -> None:
"""删除商品价格属性,释放底层变量。"""
if hasattr(self, "_price"):
del self._price
print(f"日志:商品 '{self.name}' 的价格已被安全清理。")
else:
raise AttributeError("属性 'price' 不存在或已被删除")
测试验证与行为输出
通过以下代码测试正常读取、合法修改、非法拦截以及删除后的访问表现:
# 实例化对象(触发初始 setter 校验)
item = ProductItem("机械键盘", 399.0)
# 1. 测试正常读取 (调用 Getter)
print(f"当前价格: {item.price}") # 示例输出:当前价格: 399.0
# 2. 测试合法修改 (调用 Setter)
item.price = 359.5
print(f"调价后价格: {item.price}") # 示例输出:调价后价格: 359.5
# 3. 测试非法输入拦截 (触发 Setter 中的类型异常)
try:
item.price = "免费"
except TypeError as e:
print(f"类型错误捕获成功: {e}")
# 示例输出:类型错误捕获成功: 价格必须为数值类型,当前传入类型: str
# 4. 测试数值边界拦截 (触发 Setter 中的数值异常)
try:
item.price = -50
except ValueError as e:
print(f"数值错误捕获成功: {e}")
# 示例输出:数值错误捕获成功: 价格不能小于零,当前传入数值: -50
# 5. 测试删除属性 (调用 Deleter)
del item.price
# 示例输出:日志:商品 '机械键盘' 的价格已被安全清理。
# 6. 测试删除后再次访问
try:
print(item.price)
except AttributeError as e:
print(f"访问已删除属性捕获成功: {e}")
# 示例输出:访问已删除属性捕获成功: 'ProductItem' 对象的属性 'price' 已被删除
四、最容易踩坑的陷阱:命名冲突与无限递归
初学者在编写 Setter 时,最常见也是最具破坏性的错误就是在 Setter 内部使用了与公开属性相同的变量名,即在 def price(self, value): 中书写了 self.price = value。
在 Python 语法中,给 self.price 赋值会再次触发 price 的 Setter 方法,该方法进而再次执行 self.price = value,导致调用栈迅速被撑爆,抛出 RecursionError: maximum recursion depth exceeded。
避坑核心法则:
被 @property 修饰的方法对外暴露的名称是公开接口(如 price),而内部承载真实数据的物理变量必须添加前缀区别开(如 _price)。在 Setter 和 Getter 内部,始终且只能读写该带下划线的内部变量。
五、其他常见注意事项与工程规范
- 只读属性的简易实现:如果某个属性只需要只读功能,只需声明
@property的 Getter,完全省略@<属性名>.setter。此时外部如果尝试给obj.attr = val赋值,Python 会自动抛出AttributeError: can't set attribute,无需手动抛错。 - 方法命名必须三者统一:Getter、Setter 和 Deleter 三个方法必须使用完全相同的名称。Setter 装饰器上的前缀必须是该名称(如
@price.setter),方法签名也必须叫def price(...)。如果写成def set_price(...),会破坏描述符绑定。 - 不能跨越属性复用 Deleter:每个 Deleter 都是基于对应属性的 property 实例绑定的,无法在一个通用的 deleter 装饰器中同时解绑多个不同名称的属性。
六、属性设计选型与总结决策
在设计 Python 类时,并不需要对每一个属性都盲目套用 @property。以下决策指引图展示了从基础公开属性到完备封装的选型路径:
综上所述,Python 的 @property 体系以极其优雅的方式解决了封装性与易用性之间的平衡问题。在实现 Setter 与 Deleter 时,只要牢记“方法名保持一致、内部存储变量加下划线隔离、按需捕获异常”这三项基本准则,就能构建出稳健、清晰的面向对象代码。
本站声明
本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。













