python 中 property类的使用用法

首先需要声明的是property 只适用于新式类。 

property是python有别于其它语言所特有的类，该类实现把函数名变为属性名使用。

property类有3个方法getter、setter、deleter， 分别把对应的操作绑定到指定的函数实现。

因此:

1) 对property类对象的读操作就是执行绑定到getter的函数

2) 对对象赋值操作就是执行绑定到setter的函数

3) 对删除对像操作则执行绑定到deleter的函数，

这是property类所特别的功能，也是python区别于其它语言所特有的功能。  用例子来说明：

 

Class C(object):

    def __init__(self,p1):

        self.p=p1

    def get_function(self):

        ....

        pass

 

     def set_function(self):

         ....

         pass

 

    def del_function(self):

        ....

        pass

 

 

    p = property(get_function,set_function,del_function)

 

==>

c = C()

c.p                 ==>  调用get_function

c.p = "aa"      ==>  调用set_function

del c.p           ==>  调用del_function

 

下面提供2个例子，分别用引用和decorator两种方法说明property的使用过程。

 

假设有一个类，实现对温度的读、写和计算。 对于JAVA等其它语言，都是在类里面实现setter和getter方法，从而实现对属性的封装和隐藏。当然python也可以按照这样的思路来实现。代码：

class Celsius(object):

    def __init__(self, value= 0):

        self.set_temperature(value)

 

    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):

        self.__temperature = value

 

这样的实现简单、易懂，又同时支持新式类和经典类。

 

如果很不幸，如果你不是用这种方法实现，而是直接把温度属性暴露给了外部，代码：

class Celsius(object):

    def __init__(self, value= 0):

        self.temperature = value

 

    def to_fahrenheit(self):

        return (self.temperature * 1.8) + 32

 

现在要求对外部传入的值做下判断（输入小于-273（绝对0度）的要提示报错），同时要求对self.temperature实现封装和隐藏。 如果这个类还没有被其它类引用或者继承，那么就按照getter和setter重写类方法。 

如果这个类已经被别的类引用了或者被继承了，一但修改了类的接口，还需要修改大量的引用和子类， 这个工作量太大了，这个时候property就出场了。

 

第一步，给上面代码片断增加getter和setter方法，对属性接口进行封闭和隐藏。 代码：

==> 用最引用的方法实现操作getter 和 setter

class Celsius(object):

    def __init__(self, value= 0):

        print "init"

        self.temperature = value        ##  对self.temperature的赋值会触发property绑定的set_temperature方法

 

    def to_fahrenheit(self):

        return (self.temperature * 1.8) + 32    ##  对self.temperature的访问会触发property绑定的get_temperature方法

 

    def get_temperature(self):         ##  绑定到property的getter方法

        print("Getting value")

        return self.__temperature

 

    def set_temperature(self, value):            ##  绑定到property的setter方法

        if value < -273:

            raise ValueError("Temperature below -273 is not possible")

        print("Setting value")

        self.__temperature= value         ##  对属性进行封装和隐藏

 

    def del_temperature(self):

        print "del temperature"

        del self.__temperature

 

    temperature = property(get_temperature,set_temperature,del_temperature)

 

其中

（1）在末尾增加了property类初始化，temperature 则是property()对像的引用。 对temperature 的读写就变成了对property()所绑定的get_temperature和set_temperature方法的操作。

（2）__init__方法里的属性接口使用方法不变，虽然写法上一样，但是实际意义已经发生变化，其用法实际上是使用了末尾定义的temperature引用，对temperature的写操作就变成了对绑定到setter函数的操作（property类就是这么定义的）。

 

c = Celsius(9)

print c.temperature

c.temperature=230

print c.temperature

del c.temperature

==> 输出：

init

Setting value

Getting value

9

Setting value

Getting value

230

del temperature

 

 

以上是没有decorator的实现， python 2.4以上版本已经实现decorator的功能，现在可以用decorator简化以上的定义。代码：

 

==> decorator实现：

class Celsius(object):

    def __init__(self,value= 0):

        self.temperature = value        ##  对self.temperature 的赋值会直接调用property绑定的setter方法

 

    def to_fahrenheit(self):

        return (self.temperature * 1.8) + 32   ##  对self.temperature 的访问会直接调度property绑定的getter方法

 

    @property   ##  默认第1个绑定的是getter方法，所以要这个函数定义要放第1个绑定

    def temperature(self):

        print "Getting value"

        return self.__temperature    ##  读取私有变量值

 

    @temperature.setter       ##  因为 temperature = property(temperature)

    def temperature(self,value):

        if value < -273:

            raise ValueError("Temperature below -273 is not passible")

        print "Setting value"

        self.__temperature = value     ##  把value存储到私有变量，实现了对 temperature 的隐藏。 当然了，这里可以用其它私有变量名称，只要getter/setter/deleter三个方法中使用的变量名称保持一致即可。

 

    @temperature.deleter

    def temperature(self):

        print "del temperature"

        del self.__temperature

 

c = Celsius(9)

print c.temperature

c.temperature =230

print c.temperature

del c.temperature

==>输出：

Setting value

Getting value

9

Setting value

Getting value

230

del temperature