python 面向对象专题（八）：特殊方法 （一）__get__、__set__、__delete__ 描述符（一）

class Quantity:  #描述符基于协议实现，无需创建子类。

    def __init__(self, storage_name):

        self.storage_name = storage_name  #Quantity 实例有个 storage_name 属性，

                                          #这是托管实例中存储值的属性的名称。

    def __set__(self, instance, value):  #尝试为托管属性赋值时，

                                         # 会调用 __set__ 方法。这里，self 是描述符实例
                                         #（即 LineItem.weight 或 LineItem.price），
                                         #instance 是托管实例（LineItem 实例），value 是要设定的值。

        if value > 0:

            instance.__dict__[self.storage_name] = value  #这里，必须直接处理托管实例的 __dict__ 属性；
                                                          #如果使用内置的setattr 函数，
                                                          #会再次触发 __set__ 方法，导致无限递归

        else:

            raise ValueError('value must be > 0')

class LineItem:

    weight = Quantity('weight')  #第一个描述符实例绑定给 weight 属性

    price = Quantity('price')  #第二个描述符实例绑定给 price 属性

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

        self.description = description

        self.weight = weight

        self.price = price

    def subtotal(self):

        return self.weight * self.price

instance.__dict__[self.storage_name] = value

self.__dict__[self.storage_name] = value

class Quantity:

    __counter = 0  #__counter 是 Quantity 类的类属性，统计Quantity 实例的数量。

    def __init__(self):

        cls = self.__class__  #cls 是 Quantity 类的引用。

        prefix = cls.__name__

        index = cls.__counter

        self.storage_name = '_{}#{}'.format(prefix, index)  #每个描述符实例的 storage_name 属性都是独一无二的，
                                                            #因为其值由描述符类的名称和 __counter 属性的当前值构成（例

                                                            #如，_Quantity#0）。

        cls.__counter += 1  #递增 __counter 属性的值。

    def __get__(self, instance, owner):  #我们要实现 __get__ 方法，因为托管属性的名称与 storage_name

                                          #不同。稍后会说明 owner 参数。

        return getattr(instance, self.storage_name)  #使用内置的 getattr 函数从
                                                     # instance 中获取储存属性的值。

    def __set__(self, instance, value):

       if value > 0:

           setattr(instance, self.storage_name, value)  #使用内置的 setattr 函数把值存储在 instance 中。

       else:

           raise ValueError('value must be > 0')

class LineItem:

    weight = Quantity()  #现在，不用把托管属性的名称传给 Quantity 构造方法。这是这一版的目标。

price = Quantity()

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

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

>>> from bulkfood_v4 import LineItem

>>> LineItem.weight

Traceback (most recent call last):

  ...

  File ".../descriptors/bulkfood_v4.py", line 54, in __get__

    return getattr(instance, self.storage_name)

AttributeError: 'NoneType' object has no attribute '_Quantity#0'

class Quantity:

    __counter = 0

    def __init__(self):

        cls = self.__class__

        prefix = cls.__name__

        index = cls.__counter

        self.storage_name = '_{}#{}'.format(prefix, index)

        cls.__counter += 1

    def __get__(self, instance, owner):

        if instance is None:

            return self  #如果不是通过实例调用，返回描述符自身。

        else:

            return getattr(instance, self.storage_name)

            #否则，像之前一样，返回托管属性的值。

    def __set__(self, instance, value):

        if value > 0:

            setattr(instance, self.storage_name, value)

        else:

            raise ValueError('value must be > 0')

import model_v4c as model  ➊

class LineItem:

    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

import abc

class AutoStorage:  #AutoStorage 类提供了之前 Quantity 描述符的大部分功能……

    __counter = 0

    def __init__(self):

        cls = self.__class__

        prefix = cls.__name__

        index = cls.__counter

        self.storage_name = '_{}#{}'.format(prefix, index)

        cls.__counter += 1

    def __get__(self, instance, owner):

        if instance is None:

            return self

        else:

            return getattr(instance, self.storage_name)

    def __set__(self, instance, value):

        setattr(instance, self.storage_name, value)  #……验证除外

class Validated(abc.ABC, AutoStorage):  #Validated 是抽象类，不过也继承自 AutoStorage 类。

    def __set__(self, instance, value):

        value = self.validate(instance, value)  #__set__ 方法把验证操作委托给 validate 方法……

        super().__set__(instance, value)  #……然后把返回的 value 传给超类的 __set__ 方法，存储值。

    @abc.abstractmethod

    def validate(self, instance, value):  #在这个类中，validate 是抽象方法

        """return validated value or raise ValueError"""

class Quantity(Validated):  #Quantity 和 NonBlank 都继承自

                                       # Validated 类。

    """a number greater than zero"""

    def validate(self, instance, value):

        if value <= 0:

            raise ValueError('value must be > 0')

        return value

class NonBlank(Validated):

    """a string with at least one non-space character"""

    def validate(self, instance, value):

        value = value.strip()

        if len(value) == 0:

            raise ValueError('value cannot be empty or blank')

        return value  #要求具体的 validate 方法返回验证后的值，

                           #借机可以清理、转换或

                            #规范化接收的数据。

                            #这里，我们把 value 首尾的空白去掉，然后将其返回。

import model_v5 as model  #导入 model_v5 模块，

                                         #指定一个更友好的名称。

class LineItem:

    description = model.NonBlank()  #使用 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