Python黑魔法之属性装饰器详解

@property 装饰器可以将一个方法变成一个属性并调用它。一起来看看Python黑魔法@property装饰器的使用技巧吧。

@property 有什么用？从表面上看，就是把一个方法作为一个属性来访问。

上代码,代码最清晰了.

class Circle(object): 
  def __init__(self, radius): 
    self.radius = radius 
  
  @property 
  def area(self): 
    return 3.14 * self.radius ** 2 
  
c = Circle(4) 
print c.radius 
print c.area

可以看出虽然area定义为方法，但是加上@property后，可以直接将c.area作为属性访问。

现在问题来了，每次调用c.area都会计算一次，很浪费cpu，怎么可能只计算一次呢？这是懒惰的财产。

class lazy(object): 
  def __init__(self, func): 
    self.func = func 
  
  def __get__(self, instance, cls): 
    val = self.func(instance) 
    setattr(instance, self.func.__name__, val) 
    return val 
  
class Circle(object): 
  def __init__(self, radius): 
    self.radius = radius 
  
  @lazy 
  def area(self): 
    print 'evalute' 
    return 3.14 * self.radius ** 2 
  
c = Circle(4) 
print c.radius 
print c.area 
print c.area 
print c.area

可以看出'evalute'只输出一次，@lazy的机制应该很好理解。

在这里，惰性类有一个 __get__ 方法，表明它是一个描述符。第一次执行c.area时，因为顺序问题，先到c.__dict__中查找。如果没找到，就去班级空间找。 Circle中有area()方法，所以被__get__拦截。

在__get__中，调用实例的area()方法计算结果，并为实例动态添加一个同名属性，将结果赋值给它，即添加到c.__dict__中。

再次执行c.area时，先到c.__dict__中查找，因为此时已经存在，所以不会经过area()方法和__get__。

注意点

请注意以下代码场景：

代码片段1：

class Parrot(object): 
  def __init__(self): 
    self._voltage = 100000 
  
  @property 
  def voltage(self): 
    """Get the current voltage.""" 
    return self._voltage 
  
if __name__ == "__main__": 
  # instance 
  p = Parrot() 
  # similarly invoke "getter" via @property 
  print p.voltage 
  # update, similarly invoke "setter" 
  p.voltage = 12

代码片段2

class Parrot: 
  def __init__(self): 
    self._voltage = 100000 
  
  @property 
  def voltage(self): 
    """Get the current voltage.""" 
    return self._voltage 
  
if __name__ == "__main__": 
  # instance 
  p = Parrot() 
  # similarly invoke "getter" via @property 
  print p.voltage 
  # update, similarly invoke "setter" 
  p.voltage = 12

代码1、2的区别在于

class Parrot(object):

在python2下，分别运行测试

片段1：将会提示一个预期的错误信息 AttributeError: can't set attribute

片段2：正确运行

参考 python2 文档，@property 将提供一个只读属性。上述代码没有提供对应的@voltage.setter。按理说snippet 2中的代码会提示错误。在python2的文档中，我们可以找到如下信息：

BIF:

property([fget[, fset[, fdel[, doc]]]])

Return a property attribute for new-style classes (classes that derive from object).

原来在python2下，内置类型对象并不是默认的基类。如果在定义类的时候没有明确声明（代码片段2），我们定义的Parrot（代码片段2）就不会继承object

对象类只是提供了我们需要的@property 功能。在文档中，我们可以找到以下信息：

new-style class

Any class which inherits from object. This includes all built-in types like list and dict. Only new-style classes can use Python's newer, versatile features like __slots__, descriptors, properties, and __getattribute__().

同时我们也可以通过以下方法来验证

class A: 
  pass 
>>type(A) 
<type 'classobj'>

class A(object): 
  pass 
>>type(A) 
<type 'type'>

从返回的<type 'classobj'>, <type 'type'>可以看出，<type 'type'>是我们需要的对象类型（python 3.0使用对象类作为默认基类，所以会返回<类型'类型''>)

为了考虑python版本代码过渡期间的兼容性问题，我认为在定义class文件的时候，明确定义对象是个好习惯

最后的代码将如下

class Parrot(object): 
  def __init__(self): 
    self._voltage = 100000 
  @property 
  def voltage(self): 
    """Get the current voltage.""" 
    return self._voltage 
  @voltage.setter 
  def voltage(self, new_value): 
    self._voltage = new_value 
  
if __name__ == "__main__": 
  # instance 
  p = Parrot() 
  # similarly invoke "getter" via @property 
  print p.voltage 
  # update, similarly invoke "setter" 
  p.voltage = 12

另外，@property是在2.6、3.0新增的，2.5没有该功能。