第四十六课：魔法方法：描述符（property的原理）

内容来源于网络，本人只是在此稍作整理，如有涉及版权问题，归小甲鱼官方所有。

练习题（来自小甲鱼官方论坛）

0.请尽量用作自己的语言来解释什么是描述符？（不要搜索来的答案，用自己的话解释）

答：有时候，某个应用程序可能会有一个相当微妙的需求，需要你设计一些更加复杂的操作来相应（例如每当属性被访问时，你也许想创建一个日志记录）。最好的解决方案就是编写一个用于执行这些“更复杂的操作”的特殊函数，然后指定它在属性被访问时运行。那么一个具有这种函数的对象被称为描述符。

---

1.描述类中，分别通过哪些魔法方法来实现对属性的get、set和delete操作的？

答：描述类相关的魔法方法，见下表：

魔法方法	含义
__ get__(self, instance, owner)	用于访问属性，它返回属性的值
__ set__(self, instance, value)	将在属性分配操作中调用，不返回任何内容
__ delete__(self, instance)	控制删除操作，不返回任何内容

---

2.请问以下代码，分别调用test.a和test.x，哪个会打印“getting…”

>>> class MyDes:
    def __get__(self, instance, owner):
        print("getting...")
        
>>> class Test:
    a = MyDes()
    x = a
    
>>> test = Test()

答：都会打印的

>>> test.a
getting...
>>> test.x
getting...

---

3.请问以下代码会打印什么内容？

class MyDes:
    def __init__(self, value = None):
        self.val = value

    def __get__(self, instance, owner):
        return self.val - 20

    def __set__(self, instance, value):
        self.val = value + 10
        print(self.val)


class C:
    x = MyDes()

if __name__ == '__main__':
    c = C()
    c.x = 10
    print(c.x)

答：需要注意的是print(c.x)访问了c的x属性，因此值减20

20
0

---

4.请问以下代码会打印什么内容？

>>> class MyDes:
    def __init__(self, value = None):
        self.val = value
    def __get__(self, instance, owner):
        return self.val ** 2

    
>>> class Test:
    def __init__(self):
        self.x = MyDes(3)

        
>>> test = Test()
>>> test.x

答：打印如下：

>>> test.x
<__main__.MyDes object at 0x000001A2EA668278>

如你所见，访问实例层次上的描述符x，只会返回描述符本身。为了让描述符能够正常工作，它们必须定义在类的层次上。如果你不这样做，那么Python无法自动为你调用__ get__和__ set__方法。
正确如下：

>>> class MyDes:
    def __init__(self, value = None):
        self.val = value
    def __get__(self, instance, owner):
        return self.val ** 2

    
>>> class Test:
    x = MyDes(3)

    
>>> test = Test()
>>> test.x
9

---

编程题

0.按要求编写描述符MyDes：当类的属性被访问、修改或设置的时候，分别作出提醒。

答：其实如果大家自己认真思考了代码，会发现我们这里的描述符起到的作用是间接地保存指定变量的数据。

class MyDes:
    def __init__(self, initval=None, name=None):
        self.val = initval
        self.name = name

    def __get__(self, instance, owner):
        print("正在获取变量：", self.name)
        return self.name

    def __set__(self, instance, value):
        print("正在修改变量：", self.name)
        self.name = value

    def __delattr__(self, instance):
        print("正在删除变量：", self.name)
        print("┗|｀O′|┛ 嗷~~这个变量没法删除~")

---

1.按要求编写描述符MyDes：记录指定变量的读取和写入操作，并将记录以及触发时间保存到文件。

import time

class Record:
    def __init__(self, initval=None, name='x'):
        self.val = initval
        self.name = name
        self.filename = "record.txt"

    def __get__(self, instance, owner):
        with open(self.filename, 'a', encoding='utf-8') as f:
            f.write("%s 变量于北京时间 %s 被读取，%s = %s\n" % \
                    (self.name, time.ctime(), self.name, str(self.val)))
        return self.val

    def __set__(self, instance, value):
        filename = "%s_record.txt" % self.name
        with open(self.filename, 'a', encoding='utf-8') as f:
            f.write("%s 变量于北京时间 %s 被修改，%s = %s\n" % \
                    (self.name, time.ctime(), self.name, str(value)))
        self.val = value

---

2.编写描述符MyDes，使用文件来存储属性，属性的值会直接存储到对应的pickle的文件中。如果属性被删除了，文件也会同时被删除，属性的名字也会被注销。

import os
import pickle

class MyDes:
    saved = []

    def __init__(self, name='11'):
        self.name = name
        self.filename = self.name + '.pkl'

    def __get__(self, instance, owner):
        if self.name not in MyDes.saved:
            raise AttributeError("%s 属性还没有赋值！" % self.name)

        with open(self.filename, 'rb') as f:
            value = pickle.load(f)

        return value

    def __set__(self, instance, value):
        with open(self.filename, 'wb') as f:
            pickle.dump(value, f)
            MyDes.saved.append(self.name)

    def __delete__(self, instance):
        os.remove(self.filename)
        MyDes.saved.remove(self.name)

class Test:
    x = MyDes()

test = Test()
test.x = 10

---

3.请写下这一节课你学习到的内容：格式不限，回忆并复述是加强记忆的好方式！

• 描述符property()函数
  一句话解释：描述符就是将某种特殊类型的类的实例指派给另一个类的属性。

>>> class MyDescriptor:
    # self是描述符自身的实例；instance是这个描述符的拥有着所在类的实例，在这里也就是Test类的实例；owner是这个描述符的拥有者所在的类本身
    def __get__(self, instance, owner):
        print("getting...", self, instance, owner)
    # 参数value是等号右边的值，就是下面的'X-man'
    def __set__(self, instance, value):
        print("setting...", self, instance, value)
    def __delete__(self, instance):
        print("delete...", self, instance)

        
>>> class Test:
    x = MyDescriptor()

    
>>> test = Test()
>>> test.x
getting... <__main__.MyDescriptor object at 0x000001A2EA6D86D8> <__main__.Test object at 0x000001A2EA668278> 
>>> test
<__main__.Test object at 0x000001A2EA668278>
>>> Test

>>> test.x = 'X-man'
setting... <__main__.MyDescriptor object at 0x000001A2EA6D86D8> <__main__.Test object at 0x000001A2EA668278> X-man
>>> del test.x
delete... <__main__.MyDescriptor object at 0x000001A2EA6D86D8> <__main__.Test object at 0x000001A2EA668278>
>>> 

• 自定义property

>>> class MyProperty:
    def __init__(self, fget=None, fset=None, fdel=None):
        self.fget = fget
        self.fset = fset
        self.fdel = fdel
    def __get__(self, instance, owner):
        return self.fget(instance)
    def __set__(self, instance, value):
        self.fset(instance, value)
    def __delete__(self, instance):
        self.fdel(instance)

>>> class C:
    def __init__(self):
        self._x = None  # 你想声明为私有的方法和属性前加上单下划线,以提示该属性和方法不应在外部调用
    def getX(self):
        return self._x
    def setX(self, value):
        self._x = value
    def delX(self):
        del self._x
    x = MyProperty(getX, setX, delX)

>>> c = C()
>>> c.x = 'X-man'
>>> c.x
'X-man'
>>> c._x
'X-man'
>>> del c.x
>>> c._x
Traceback (most recent call last):
  File "", line 1, in 
    c._x
AttributeError: 'C' object has no attribute '_x'
>>> 

下面举一个摄氏与华氏相互转换的例子：

>>> class Celsius:
    def __init__(self, value=26.0):
        self.value  = float(value)
    def __get__(self, instance, owner):
        return self.value
    def __set__(self, instance, value):
        self.value = float(value)

        
>>> class Fahrenheit:
    def __get__(self, instance, owner):
        return instance.cel * 1.8 + 32
    def __set__(self, instance, value):
        instance.cel = (float(value) - 32) / 1.8

        
>>> class Temperature:
    cel = Celsius()
    fah = Fahrenheit()

    
>>> temp = Temperature()
>>> temp.cel
26.0
>>> temp.fah
78.80000000000001
>>> temp.fah = 100
>>> temp.cel
37.77777777777778

---