9.12 使用装饰器扩充类的功能

问题

你想通过反省或者重写类定义的某部分来修改它的行为,但是你又不希望使用继承或元类的方式。

解决方案

这种情况可能是类装饰器最好的使用场景了。例如,下面是一个重写了特殊方法 getattribute 的类装饰器,可以打印日志:

  1. def log_getattribute(cls):
  2. # Get the original implementation
  3. orig_getattribute = cls.__getattribute__
  4.  
  5. # Make a new definition
  6. def new_getattribute(self, name):
  7. print('getting:', name)
  8. return orig_getattribute(self, name)
  9.  
  10. # Attach to the class and return
  11. cls.__getattribute__ = new_getattribute
  12. return cls
  13.  
  14. # Example use
  15. @log_getattribute
  16. class A:
  17. def __init__(self,x):
  18. self.x = x
  19. def spam(self):
  20. pass

下面是使用效果:

  1. >>> a = A(42)
  2. >>> a.x
  3. getting: x
  4. 42
  5. >>> a.spam()
  6. getting: spam
  7. >>>

讨论

类装饰器通常可以作为其他高级技术比如混入或元类的一种非常简洁的替代方案。比如,上面示例中的另外一种实现使用到继承:

  1. class LoggedGetattribute:
  2. def __getattribute__(self, name):
  3. print('getting:', name)
  4. return super().__getattribute__(name)
  5.  
  6. # Example:
  7. class A(LoggedGetattribute):
  8. def __init__(self,x):
  9. self.x = x
  10. def spam(self):
  11. pass

这种方案也行得通,但是为了去理解它,你就必须知道方法调用顺序、super() 以及其它8.7小节介绍的继承知识。某种程度上来讲,类装饰器方案就显得更加直观,并且它不会引入新的继承体系。它的运行速度也更快一些,因为他并不依赖 super() 函数。

如果你系想在一个类上面使用多个类装饰器,那么就需要注意下顺序问题。例如,一个装饰器A会将其装饰的方法完整替换成另一种实现,而另一个装饰器B只是简单的在其装饰的方法中添加点额外逻辑。那么这时候装饰器A就需要放在装饰器B的前面。

你还可以回顾一下8.13小节另外一个关于类装饰器的有用的例子。

原文:

http://python3-cookbook.readthedocs.io/zh_CN/latest/c09/p12_using_decorators_to_patch_class_definitions.html