python - Property

Python 中的 property 属性

在详细解释和深入了解Python中的property之前，让我们首先建立这样一个直觉：为什么我们需要用到property？

从一个实例开始

假设有天你决定创建一个类，用来存储摄氏温度。当然这个类也需要实现一个将摄氏温度转换为华氏温度的方法。一种实现的方式如下:

class Celsius:
    def __init__(self, temperature = 0):
        self.temperature = temperature
    def to_fahrenheit(self):
        return (self.temperature * 1.8) + 32

我们可以用这个类产生一个对象，然后按照我们期望的方式改变该对象的温度属性：

>>> # create new object
>>> man = Celsius()

>>> # set temperature
>>> man.temperature = 37

>>> # get temperature
>>> man.temperature
37

>>> # get degrees Fahrenheit
>>> man.to_fahrenheit()
98.60000000000001

每当我们赋值或获取任何对象的属性时，例如上面展示的温度，Python都会从对象的__dict__字典中搜索它

>>> man.__dict__
{'temperature': 37}

因此，man.temperature在其内部就变成了man.__dict__['temperature']

现在，让我们进一步假设我们的类在客户中很受欢迎，他们开始在其程序中使用这个类。他们对该类生成的对象做了各种操作。

有一天，一个受信任的客户来找我们，建议温度不能低于-273摄氏度（热力学的同学可能会提出异议，它实际上是-273.15），也被称为绝对零。

客户进一步要求我们实现这个值约束。作为一个以争取客户满意度为己任的公司，我们很高兴地听从了建议，发布了1.01版本，升级了我们现有的类。

使用Getters和Setters

对于上边的约束，一个很容易想到的解决方案是隐藏其温度属性（使其私有化），并且定义新的用于操作温度属性的getter和setter接口。可以这么实现：

class Celsius:
    def __init__(self, temperature = 0):
        self.set_temperature(temperature)
 
    def to_fahrenheit(self):
        return (self.get_temperature() * 1.8) + 32
 
    # new update
    def get_temperature(self):
        return self._temperature
 
    def set_temperature(self, value):
        if value < -273:
            raise ValueError("Temperature below -273 is not possible")
        self._temperature = value

从上边可以看出，我们定义了两个新方法get_temperature()和set_temperature()，此外属性temperature也被替换为了_temperature。最前边的下划线（_）用于指示Python中的私有变量。

>>> c = Celsius(-277)
Traceback (most recent call last):
...
ValueError: Temperature below -273 is not possible
 
>>> c = Celsius(37)
>>> c.get_temperature()
37
>>> c.set_temperature(10)
 
>>> c.set_temperature(-300)
Traceback (most recent call last):
...
ValueError: Temperature below -273 is not possible

  >>> c._temperature = -300

  >>> c.get_temperature()

  -300

这个更新成功地实现了新约束，我们不再允许设置温度低于-273度。

请注意，Python中实际上是没有私有变量的。有一些简单的被遵循的规范。Python本身不会应用任何限制

 

 

但这样并不会让人很放心。上述更新的最大问题是，所有在他们的程序中使用了我们先前类的客户都必须更改他们的代码：obj.temperature改为obj.get_temperature()，

 

所有的赋值语句也必须更改，比如obj.temperature = val改为obj.set_temperature(val)。这样的重构会给那些拥有成千上万行代码的客户带来很大的麻烦。

总而言之，我们的更新是不向后兼容地。这就是需要property闪亮登场的地方。

Property的作用

对于上边的问题，Python式的解决方式是使用property。这里是我们已经实现了的一个版本：

class Celsius:
    def __init__(self, temperature = 0):
        self.temperature = temperature
 
    def to_fahrenheit(self):
        return (self.temperature * 1.8) + 32
 
    def get_temperature(self):
        print("Getting value")
        return self._temperature
 
    def set_temperature(self, value):
        if value < -273:
            raise ValueError("Temperature below -273 is not possible")
        print("Setting value")
        self._temperature = value
 
    temperature = property(get_temperature,set_temperature)

我们在get_temperature()和set_temperature()的内部增加了一个print()函数，用来清楚地观察它们是否正在执行。

代码的最后一行，创建了一个property对象temperature。简单地说，property将一些代码（get_temperature和set_temperature）附加到成员属性（temperature）的访问入口。

任何获取temperature值的代码都会自动调用get_temperature()，而不是去字典表（__dict__）中进行查找。

同样的，任何赋给temperature值的代码也会自动调用set_temperature()。这是Python中一个很酷的功能。我们实际演示一下。

>>> c = Celsius()
Setting value

从上边的代码中我们可以看到，即使当我们创建一个对象时，set_temperature()也会被调用。你能猜到为什么吗？

原因是，当一个对象被创建时，__init__()方法被调用。该方法有一行代码self.temperature = temperature。这个任务会自动调用set_temperature()方法。

>>> c.temperature
Getting value
0

同样的，对于属性的任何访问，例如c.temperature，也会自动调用get_temperature()方法。这就是property所作的事情。这里有一些额外的实例。

>>> c.temperature = 37
Setting value
 
>>> c.to_fahrenheit()
Getting value
98.60000000000001

我们可以看到，通过使用property，我们在不需要客户代码做任何修改的情况下，修改了我们的类，并实现了值约束。因此我们的实现是向后兼容的，这样的结果，大家都很高兴。

最后需要注意的是，实际温度值存储在私有变量_temperature中。属性temperature是一个property对象，是用来为这个私有变量提供接口的。

深入挖掘property

在Python中，property()是一个内置函数，用于创建和返回一个property对象。该函数的签名为：

property(fget=None, fset=None, fdel=None, doc=None)

这里，fget是一个获取属性值的函数，fset是一个设置属性值的函数，fdel是一个删除属性的函数，doc是一个字符串（类似于注释）。

从函数实现上看，这些函数参数都是可选的。所以，可以按照如下的方式简单的创建一个property对象。

>>> property()
<property object at 0x0000000003239B38>

Property对象有三个方法，getter(), setter()和delete()，用来在对象创建后设置fget，fset和fdel。

这就意味着，这行代码：temperature = property(get_temperature,set_temperature)可以被分解为：

# make empty property
temperature = property()
# assign fget
temperature = temperature.getter(get_temperature)
# assign fset
temperature = temperature.setter(set_temperature)

 它们之间是相互等价的。

熟悉Python中装饰器decorator的程序员能够认识到上述结构可以作为decorator实现。我们可以更进一步，不去定义名字get_temperature和set_temperature，

因为他们不是必须的，并且污染类的命名空间。为此，我们在定义getter函数和setter函数时重用名字temperature。下边的代码展示如何实现它:

class Celsius:
    def __init__(self, temperature = 0):
        self._temperature = temperature
 
    def to_fahrenheit(self):
        return (self.temperature * 1.8) + 32
 
    @property
    def temperature(self):
        print("Getting value")
        return self._temperature
 
    @temperature.setter
    def temperature(self, value):
        if value < -273:
            raise ValueError("Temperature below -273 is not possible")
        print("Setting value")
        self._temperature = value

上边的两种生成property的实现方式，都很简单，推荐使用

 

深入挖掘property - 使用需要注意的地方

python学习笔记 - @property

请注意以下代码场景 (Python2.6环境)： 

代码片段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.6下，分别运行测试 
片段1：将会提示一个预期的错误信息 AttributeError: can't set attribute 
片段2：正确运行 （python2.7会报片段1同样的错误）

参考python2.6文档，@property将提供一个ready-only property，以上代码没有提供对应的@voltage.setter，按理说片段2代码将提示运行错误，在python2.6文档中，我们可以找到以下信息： 
property([fget[, fset[, fdel[, doc]]]]) 
Return a property attribute for new-style classes (classes that derive from object). 
原来在python2.6下，内置类型 object 并不是默认的基类；如果在定义类时，没有明确说明的话我们定义的Parrot（代码片段2）将不会继承object 

而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'>是我们需要的object类型（python 3.0 将object类作为默认基类） 
为了考虑代码的python 版本过渡期的兼容性问题，我觉得应该定义class文件的时候，都应该显式定义object，做为一个好习惯

请注意以下代码场景 (Python2.7环境)： 

class Student1():
    def __init__(self, name, score):
        self.name = name
        self.__score = score

    @property
    def score(self):
        print 'get score...'
        return self.__score

    @score.setter
    def score(self, score):
        print 'set score...'
        if score < 0 or score > 100:
            raise ValueError('invalid score')
        self.__score = score

class Student2(object):
    def __init__(self, name, score):
        self.name = name
        self.__score = score

    @property
    def score(self):
        print 'get score...'
        return self.__score

    @score.setter
    def score(self, score):
        print 'set score...'
        if score < 0 or score > 100:
            raise ValueError('invalid score')
        self.__score = score

print 'test student1...'
st1 = Student1('test', 60)
print st1.score
st1.score = 80
print st1.score

print 'test student2...'
st2 = Student2('test', 60)
print st2.score
st2.score = 80
print st2.score

结果：
test student1...
get score...
60
80 #不会调用property fget,fset属性
test student2...
get score...
60
set score...
get score...
80