第45讲：魔方方法——属性访问

一 属性访问相关的知识

1 几个常用的方法：

• __getattr__(self,name)：定义当用户试图获取一个不存在的属性时的行为
• __getattribute__(self,name)：定义当该类的属性被访问时的行为
• __setattr__(self,name,value)：定义当一个属性被设置时的行为
• __delattr__(self,name)：定义当一个属性被删除时的行为

2 举例：

>>> class C(object):
...     def __getattribute__(self,name):
...             print("getattribute")
...             return super().__getattribute__(name)
...     def __getattr__(self,name):
...             print("getattr")
...     def __setattr__(self,name,value):
...             print("setattr")
...             super().__setattr__(name,value)
...     def __delattr__(self,name):
...             print("delattr")
...             super().__delattr__(name)
...
>>> c = C()
>>> c.x
getattribute
getattr
>>> c.x = object
setattr
>>> c.x
getattribute
<class 'object'>
>>> c.x = 5
setattr
>>> c.x
getattribute
5

3 死循环陷阱——课堂练习

练习要求：

• 写一个矩形类，默认有宽和高两个属性；
• 如果为一个叫square的属性赋值，那么说明这是一个正方形，值就是正方形的边长，此时宽和高都应该等于边长。

会引起死循环的代码：

class Rectangle(object):
    def __init__(self,width=0,height=0):
        self.width = width            # 该句是赋值语句，执行过程中已经调用了类本身的__setattr__(self,name,value)方法
        self.height = height
        
    def __setattr__(self,name,value):
        if name == 'square':
            self.width = value
            self.height = value
        else:
            self.name = value          # 此时再次进行赋值，同样会调用类本身的__setattr__(self,name,value)方法，从而陷入死循环
    
    def getArea(self):
        return self.width * self.height
    
    def getCirc(self):
        return 2 * (self.width + self.height)

改正后的代码：

class Rectangle(object):
    def __init__(self,width=0,height=0):
        self.width = width            # 该句是赋值语句，执行过程中已经调用了类本身的__setattr__(self,name,value)方法
        self.height = height
        
    def __setattr__(self,name,value):
        if name == 'square':
            self.width = value
            self.height = value
        else:
            super().__setattr__(name,value)  # 通过调用父类的__setattr__(self,name,value)方法完成重新赋值的操作，不会造成死循环
            # self.__dict__[name] = value    # 通过__dict__属性以字典的方式进行赋值，此过程不会调用__setattr__(self,name,value)方法
    
    def getArea(self):
        return self.width * self.height
    
    def getCirc(self):
        return 2 * (self.width + self.height)

 

二 课后作业

测试题部分：

0. 请问以下代码的作用是什么？这样写正确吗？（如果不正确，请改正）

def __setattr__(self, name, value):
        self.name = value + 1

答：这段代码试图在对象的属性发生赋值操作的时候，将实际的值 +1赋值给相应的属性。但这么写法是错误的，因为每当属性被赋值的时候， __setattr__() 会被调用，而里边的 self.name = value + 1 语句又会再次触发 __setattr__() 调用，导致无限递归。

代码应该这样写：

def __setattr__(self, name, value):
        self.__dict__[name] = value + 1

或者：

def __setattr__(self, name, value):
        super().__setattr__(name, value+1)

 

1. 自定义该类的属性被访问的行为，你应该重写哪个魔法方法？
答：__getattribute__(self, name)

2. 在不上机验证的情况下，你能推断以下代码分别会显示什么吗？

>>> class C:
        def __getattr__(self, name):
                print(1)
        def __getattribute__(self, name):
                print(2)
        def __setattr__(self, name, value):
                print(3)
        def __delattr__(self, name):
                print(4)

                
>>> c = C()
>>> c.x = 1
# 位置一，请问这里会显示什么？
>>> print(c.x)
# 位置二，请问这里会显示什么？

答：位置一会显示 3，因为 c.x = 1 是赋值操作，所以会访问 __setattr__() 魔法方法；

       位置二会显示 2 和 None，因为 x 是属于实例对象 c 的属性，所以 c.x 是访问一个存在的属性，因此会访问 __getattribute__() 魔法方法，但我们重写了这个方法，使得它不能按照正常的逻辑返回属性值，而是打印一个 2 代替，由于我们没有写返回值，所以紧接着返回 None 并被 print() 打印出来。

3. 在不上机验证的情况下，你能推断以下代码分别会显示什么吗？

>>> class C:
        def __getattr__(self, name):
                print(1)
                return super().__getattr__(name)
        def __getattribute__(self, name):
                print(2)
                return super().__getattribute__(name)
        def __setattr__(self, name, value):
                print(3)
                super().__setattr__(name, value)
        def __delattr__(self, name):
                print(4)
                super().__delattr__(name)
                
>>> c = C()
>>> c.x

答：在不上机的情况下，我相信80%以上的鱼油很难猜到正确的答案T_T

>>> c = C()
>>> c.x
2
1
Traceback (most recent call last):
  File "<pyshell#31>", line 1, in <module>
    c.x
  File "<pyshell#29>", line 4, in __getattr__
    return super().__getattr__(name)
AttributeError: 'super' object has no attribute '__getattr__'

为什么会如此显示呢？我们来分析下：首先 c.x 会先调用 __getattribute__() 魔法方法，打印 2；然后调用 super().__getattribute__()，找不到属性名 x，因此会紧接着调用 __getattr__() ，于是打印 1；但是你猜到了开头没猜到结局……当你希望最后以 super().__getattr__() 终了的时候，Python 竟然告诉你 AttributeError，super 对象木有 __getattr__ ！！

求证：

>>> dir(super)
['__class__', '__delattr__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__get__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__self__', '__self_class__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__thisclass__']

 

4. 请指出以下代码的问题所在：

class Counter:
        def __init__(self):
                self.counter = 0
        def __setattr__(self, name, value):
                self.counter += 1
                super().__setattr__(name, value)
        def __delattr__(self, name):
                self.counter -= 1
                super().__delattr__(name)

答：初学者重写属性魔法方法很容易陷入的一个误区就是木有“观前顾后”。
以下注释：

class Counter:
        def __init__(self):
                self.counter = 0 # 这里会触发 __setattr__ 调用
        def __setattr__(self, name, value):
                self.counter += 1
“““既然需要 __setattr__ 调用后才能真正设置 self.counter 的值，所以这时候 self.counter 还没有定义，所以没法 += 1，错误的根源。”””
                super().__setattr__(name, value)
        def __delattr__(self, name):
                self.counter -= 1
                super().__delattr__(name)

 

动动手部分：

0. 按要求重写魔法方法：当访问一个不存在的属性时，不报错且提示“该属性不存在！”
代码清单：

class Demo(object):
    def __getattr__(self,name):
        return "该属性不存在！"

demo = Demo()
print(demo.x)

 

1. 编写 Demo 类，使得下边代码可以正常执行：

>>> demo = Demo()
>>> demo.x
'FishC'
>>> demo.x = "X-man"
>>> demo.x
'X-man'

代码清单：

class Demo(object):
    def __getattr__(self,name):
        self.name = 'FishC'
        return self.name

demo = Demo()
print(demo.x)

demo.x = "X-man"
print(demo.x)

 

2. 修改上边【测试题】第 4 题，使之可以正常运行：编写一个 Counter 类，用于实时检测对象有多少个属性。
程序实现如下：

>>> c = Counter()
>>> c.x = 1
>>> c.counter
1
>>> c.y = 1
>>> c.z = 1
>>> c.counter
3
>>> del c.x
>>> c.counter
2

代码清单：WP"OqI3%

class Counter(object):
    k = []
    def __init__(self):
        self.counter = 0
    def __setattr__(self,name,value):
        if name != 'counter':
            if name not in self.k:
                self.counter += 1
                print(f"set: {self.counter}")
                self.k.append(name)
        super().__setattr__(name,value)
    def __delattr__(self,name):
        if name in self.k:
            self.counter -= 1
            print(f"del:{self.counter}")
            self.k.remove(name)
        super().__delattr__(name)


c = Counter()
c.x = 1
print(c.counter)

c.y = 2
c.z = 3
print(c.counter)

del c.x 
print(c.counter)