返回介绍

21.2 定制描述符的类装饰器

发布于 2024-02-05 21:59:46 字数 2648 浏览 0 评论 0 收藏 0

20.1.3 节中的 LineItem 示例还有个问题没有解决:储存属性的名称不具有描述性,即属性(如 weight)的值存储在名为 _Quantity#0 的实例属性中,这样的名称有点不便于调试。我们可以使用下述代码从示例 20-7 定义的描述符中获取储存属性的名称:

>>> LineItem.weight.storage_name
'_Quantity#0'

可是,如果储存属性的名称中包含托管属性的名称更好,如下所示:

>>> LineItem.weight.storage_name
'_Quantity#weight'

20.1.2 节说过,我们不能使用描述性的储存属性名称,因为实例化描述符时无法得知托管属性(即绑定到描述符上的类属性,例如前述示例中的 weight)的名称。可是,一旦组建好整个类,而且把描述符绑定到类属性上之后,我们就可以审查类,并为描述符设置合理的储存属性名称。LineItem 类的 __new__ 方法可以做到这一点,因此,在 __init__ 方法中使用描述符时,储存属性已经设置了正确的名称。为了解决这个问题而使用 __new__ 方法纯属白费力气:每次新建 LineItem 实例时都会运行 __new__ 方法中的逻辑,可是,一旦 LineItem 类构建好了,描述符与托管属性之间的绑定就不会变了。因此,我们要在创建类时设置储存属性的名称。使用类装饰器或元类可以做到这一点。我们首先使用较简单的方式。

类装饰器与函数装饰器非常类似,是参数为类对象的函数,返回原来的类或修改后的类。

在示例 21-3 中,解释器会计算 LineItem 类,把返回的类对象传给 model.entity 函数。Python 会把 LineItem 这个全局名称绑定给 model.entity 函数返回的对象。在这个示例中,model.entity 函数会返回原先的 LineItem 类,但是会修改各个描述符实例的 storage_name 属性。

示例 21-3 bulkfood_v6.py:使用 Quantity 和 NonBlank 描述符的 LineItem 类

import model_v6 as model

@model.entity  ➊
class LineItem:
  description = model.NonBlank()
  weight = model.Quantity()
  price = model.Quantity()

  def __init__(self, description, weight, price):
    self.description = description
    self.weight = weight
    self.price = price

  def subtotal(self):
    return self.weight * self.price

➊ 这个类唯一的变化是添加了装饰器。

示例 21-4 是那个装饰器的实现。这里只列出了 model_v6.py 脚本底部添加的新代码,其余的代码与 model_v5.py 脚本(见示例 20-6)一样。

示例 21-4 model_v6.py:一个类装饰器

def entity(cls):  ➊
  for key, attr in cls.__dict__.items():  ➋
    if isinstance(attr, Validated):  ➌
      type_name = type(attr).__name__
      attr.storage_name = '_{}#{}'.format(type_name, key)  ➍
  return cls  ➎

❶ 装饰器的参数是一个类。

❷ 迭代存储类属性的字典。

❸ 如果属性是 Validated 描述符的实例……

❹ ……使用描述符类的名称和托管属性的名称命名 storage_name(例如 _NonBlank#description)。

❺ 返回修改后的类。

bulkfood_v6.py 脚本中的 doctest 证明,改动是成功的。例如,示例 21-5 展示了一个 LineItem 实例中的储存属性名称。

示例 21-5 bulkfood_v6.py:描述符中新 storage_name 属性的 doctest

>>> raisins = LineItem('Golden raisins', 10, 6.95)
>>> dir(raisins)[:3]
['_NonBlank#description', '_Quantity#price', '_Quantity#weight']
>>> LineItem.description.storage_name
'_NonBlank#description'
>>> raisins.description
'Golden raisins'
>>> getattr(raisins, '_NonBlank#description')
'Golden raisins'

可以看出,这并不复杂。类装饰器能以较简单的方式做到以前需要使用元类去做的事情——创建类时定制类。

类装饰器有个重大缺点:只对直接依附的类有效。这意味着,被装饰的类的子类可能继承也可能不继承装饰器所做的改动,具体情况视改动的方式而定。接下来的几节会探讨这个问题,并给出解决方案。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文