目前,我们只介绍了如何使用 @property 装饰器实现只读特性。本节要创建一个可读写的特性。
LineItem类第1版:表示订单中商品的类假设有个销售散装有机食物的电商应用,客户可以按重量订购坚果、干果或杂粮。在这个系统中,每个订单中都有一系列商品,而每个商品都可以使用示例 19-15 中的类表示。
示例 19-15 bulkfood_v1:最简单的
LineItem类
class LineItem:
def __init__(self, description, weight, price):
self.description = description
self.weight = weight
self.price = price
def subtotal(self):
return self.weight * self.price
这个类很精简,不过或许太简单了。示例 19-16 揭示了一个问题。
示例 19-16 重量为负值时,金额小计为负值
>>> raisins = LineItem('Golden raisins', 10, 6.95)
>>> raisins.subtotal()
69.5
>>> raisins.weight = -20 # 无效输入……
>>> raisins.subtotal() # 无效输出……
-139.0
这个示例像玩具一样,但是没有想象中的那么好玩。下面是亚马逊早期的真实故事。
我们发现顾客买书时可以把数量设为负数!然后,我们把金额打到顾客的信用卡上,苦苦等待他们把书寄出(想得美)。12
——Jeff Bezos
亚马逊创始人和 CEO
12摘自《华尔街日报》的文章,“Birth of a Salesman”(2011 年 10 月 15 日,http://www.wsj.com/articles/SB10001424052970203914304576627102996831200),这是 Jeff Bezos 的原话。
这个问题怎么解决呢?我们可以修改 LineItem 类的接口,使用读值方法和设值方法管理 weight 属性。这是 Java 采用的方式,这里也完全可行。
但是,如果能直接设定商品的 weight 属性,显得更自然。此外,系统可能在生产环境中,而其他部分已经直接访问 item.weight 了。此时,符合 Python 风格的做法是,把数据属性换成特性。
LineItem类第2版:能验证值的特性实现特性之后,我们可以使用读值方法和设值方法,但是 LineItem 类的接口保持不变(即,设置 LineItem 对象的 weight 属性依然写成 raisins.weight = 12)。
示例 19-17 列出可读写的 weight 特性的代码。
示例 19-17 bulkfood_v2.py:定义了
weight特性的LineItem类
class LineItem:
def __init__(self, description, weight, price):
self.description = description
self.weight = weight ➊
self.price = price
def subtotal(self):
return self.weight * self.price
@property ➋
def weight(self): ➌
return self.__weight ➍
@weight.setter ➎
def weight(self, value):
if value > 0:
self.__weight = value ➏
else:
raise ValueError('value must be > 0') ➐
❶ 这里已经使用特性的设值方法了,确保所创建实例的 weight 属性不能为负值。
❷ @property 装饰读值方法。
❸ 实现特性的方法,其名称都与公开属性的名称一样——weight。
❹ 真正的值存储在私有属性 __weight 中。
❺ 被装饰的读值方法有个 .setter 属性,这个属性也是装饰器;这个装饰器把读值方法和设值方法绑定在一起。
❻ 如果值大于零,设置私有属性 __weight。
❼ 否则,抛出 ValueError 异常。
注意,现在不能创建重量为无效值的 LineItem 对象:
>>> walnuts = LineItem('walnuts', 0, 10.00)
Traceback (most recent call last):
...
ValueError: value must be > 0
现在,我们禁止用户为 weight 属性提供负值或零。虽然买家通常不能设置商品的价格,但是工作人员可能犯错,应用程序也可能有缺陷,从而导致 LineItem 对象的 price 属性为负值。为了防止出现这种情况,我们也可以把 price 属性变成特性,但是这样我们的代码中就存在一些重复。
还记得第 14 章引述 Paul Graham 的那句话吗?他说:“当我在自己的程序中发现用到了模式,我觉得这就表明某个地方出错了。”去除重复的方法是抽象。抽象特性的定义有两种方式:使用特性工厂函数,或者使用描述符类。后者更灵活,第 20 章会全面讨论。其实,特性本身就是使用描述符类实现的。不过,这里我们要继续探讨特性,实现一个特性工厂函数。
但是,在实现特性工厂函数之前,我们要深入理解特性。