python 内置装饰器@property

牧码人

最近对python的内置装饰器@property我纠结了好久，一直没有弄懂它的原理。

先照例水一波个人对property的浅显的认知，疑问在末尾。

1. 
   
2. class Student:
   
3.     '定义学生知我介绍的类'
   
4.     def __init__(self, name):
   
5.         self.name = name
   
6.         self.intro = "my name is " + self.name
   
7. 
   
8. 
   
9. st = Student("Jaki")
   
10. 
    
11. print(st.name)
    
12. print(st.intro)
    
13. 
    
14. st.name = '小甲鱼'
    
15. print(st.intro)
    
16. 
    
17. 
    
18. 
    
19. >>>Jaki
    
20. >>>my name is Jaki
    
21. >>>'小甲鱼'
    
22. >>>my name is Jaki     
    
23. 
    

复制代码

为什么实例st的属性name改成了小甲鱼，但是访问st.intro的时候输出没有改变呢？

1. 
   
2. >>> st.__dict__
   
3. {'name': 'Jaki', 'intro': 'my name is Jaki'}
   
4. >>> Student.__dict__
   
5. mappingproxy({'__module__': '__main__', '__doc__': '定义学生知我介绍的类', '__init__': <function Student.__init__ at 0x000002AE7BDD7268>, '__dict__': <attribute '__dict__' of 'Student' objects>, '__weakref__': <attribute '__weakref__' of 'Student' objects>})
   
6. >>> st.name = '小甲鱼'
   
7. >>> st.__dict__
   
8. {'name': '小甲鱼', 'intro': 'my name is Jaki'}   #可以看到， 改变了实例属性name后，并没有影响到实例属性intro的指向。
   
9. 
   

复制代码

代码改进

1. 
   
2. class Student:
   
3.     def __init__(self, name):
   
4.         self.name = name
   
5.         #self.intro = "my name is "  + self.name
   
6. 
   
7. 
   
8.     def intro(self):
   
9.         return "my name is " + self.name
   
10. 
    
11. st = Student("Jaki")
    
12. 
    
13. print(st.name)
    
14. print(st.intro())
    
15. 
    
16. st.name = '小甲鱼'
    
17. print(st.name)
    
18. print(st.intro())
    
19. 
    
20. 
    
21. >>>Jaki
    
22. >>>my name is Jaki
    
23. >>>'小甲鱼'
    
24. >>>my name is 小甲鱼
    

复制代码

假设实际中有上万行代码在最开始都是用的st.intro来获取实例属性，我们不可能一行一行的去将st.intro改为st.intro(), 所以这里python的内置装饰器property可以派上用场了。

代码继续改进

1. 
   
2. class Student:
   
3.     def __init__(self, name):
   
4.         self.name = name
   
5.         #self.intro = "my name is "  + self.name
   
6. 
   
7.     @property
   
8.     def intro(self):
   
9.         return "my name is " + self.name
   
10. 
    
11. st = Student("Jaki")
    
12. 
    
13. print(st.name)
    
14. print(st.intro)
    
15. 
    
16. st.name = '小甲鱼'
    
17. print(st.name)
    
18. print(st.intro)
    
19. 
    
20. 
    
21. >>>Jaki
    
22. >>>my name is Jaki
    
23. >>>'小甲鱼'
    
24. >>>my name is 小甲鱼
    
25. 
    
26. 好吧，以上就是我对property的粗浅认识.
    
27. 
    
28. 下面直接贴上代码，请大佬帮我分析一下
    
29. 
    
30. class Celsius:
    
31.     def __init__(self, temperature = 0):
    
32.         self.temperature = temperature
    
33. 
    
34.     def to_fahrenheit(self):
    
35.         return (self.temperature * 1.8) + 32
    
36. 
    
37.     def get_temperature(self):
    
38.         print("Getting value")
    
39.         return self._temperature
    
40. 
    
41.     def set_temperature(self, value):
    
42.         if value < -273:
    
43.             raise ValueError("Temperature below -273 is not possible")
    
44.         print("Setting value")
    
45.         self._temperature = value
    
46. 
    
47.      temperature = property(get_temperature,set_temperature)
    
48. 
    
49. >>>c = Celsius()   
    
50. Setting value
    

复制代码

【原文】当一个对象被创建时，__init__()方法被调用。该方法有一行代码self.temperature = temperature。这个任务会自动调用set_temperature()方法。
那应该也会调用get_temperature()方法，因为代码最后一行函数property里将set_temperature和get_temperature都作为参数传入了。

为什么上述代码执行 c = Celsius后会打印出"Setting value" ，而不是"Getting value"，或者两者都打印？

1. 
   
2. temperature = property(get_temperature,set_temperature)
   
3. 
   
4. 与下式等价，所以"Setting value"和"Getting value"都会打印才对
   
5. 
   
6. """
   
7. temperature = property()
   
8. temperature = temperature.getter(get_temperature)
   
9. temperature = temperature.setter(set_temperature)
   
10. """
    

复制代码

原文出处http://python.jobbole.com/81967/#article-comment


有一段对上面property的解释是这样的

property将一些代码（get_temperature和set_temperature）附加到成员属性（temperature）的访问入口。任何获取temperature值的代码都会自动调用get_temperature()，而不是去字典表（__dict__）中进行查找。

这一段总共两句话，这两句话我都没有能理解，汗！！！

牧码人

好吧，我这里把stack overflow里找到的property源码贴上，大佬可以在 visualize里可视化调试这个程序，代码运行到第三步往后我就看不懂了。下面是链接。

http://www.pythontutor.com/visualize.html#code=class%20Property%28object%29%3A%0A%20%20%20%20%22Emulate%20PyProperty_Type%28%29%20in%20Objects/descrobject.c%22%0A%0A%20%20%20%20def%20__init__%28self,%20fget%3DNone,%20fset%3DNone,%20fdel%3DNone,%20doc%3DNone%29%3A%0A%20%20%20%20%20%20%20%20self.fget%20%3D%20fget%0A%20%20%20%20%20%20%20%20self.fset%20%3D%20fset%0A%20%20%20%20%20%20%20%20self.fdel%20%3D%20fdel%0A%20%20%20%20%20%20%20%20if%20doc%20is%20None%20and%20fget%20is%20not%20None%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20doc%20%3D%20fget.__doc__%0A%20%20%20%20%20%20%20%20self.__doc__%20%3D%20doc%0A%0A%20%20%20%20def%20__get__%28self,%20obj,%20objtype%3DNone%29%3A%0A%20%20%20%20%20%20%20%20if%20obj%20is%20None%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20self%0A%20%20%20%20%20%20%20%20if%20self.fget%20is%20None%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20raise%20AttributeError%28%22unreadable%20attribute%22%29%0A%20%20%20%20%20%20%20%20return%20self.fget%28obj%29%0A%0A%20%20%20%20def%20__set__%28self,%20obj,%20value%29%3A%0A%20%20%20%20%20%20%20%20if%20self.fset%20is%20None%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20raise%20AttributeError%28%22can't%20set%20attribute%22%29%0A%20%20%20%20%20%20%20%20self.fset%28obj,%20value%29%0A%0A%20%20%20%20def%20__delete__%28self,%20obj%29%3A%0A%20%20%20%20%20%20%20%20if%20self.fdel%20is%20None%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20raise%20AttributeError%28%22can't%20delete%20attribute%22%29%0A%20%20%20%20%20%20%20%20self.fdel%28obj%29%0A%0A%20%20%20%20def%20getter%28self,%20fget%29%3A%0A%20%20%20%20%20%20%20%20return%20type%28self%29%28fget,%20self.fset,%20self.fdel,%20self.__doc__%29%0A%0A%20%20%20%20def%20setter%28self,%20fset%29%3A%0A%20%20%20%20%20%20%20%20return%20type%28self%29%28self.fget,%20fset,%20self.fdel,%20self.__doc__%29%0A%0A%20%20%20%20def%20deleter%28self,%20fdel%29%3A%0A%20%20%20%20%20%20%20%20return%20type%28self%29%28self.fget,%20self.fset,%20fdel,%20self.__doc__%29%0A%20%20%20%20%20%20%20%20%0Aclass%20Student%3A%0A%0A%20%20%20%20def%20__init__%28self,score%3D0%29%3A%0A%20%20%20%20%20%20%20%20self.score%20%3D%20score%0A%0A%20%20%20%20%23%40property%0A%20%20%20%20def%20get_score%28self%29%3A%0A%20%20%20%20%20%20%20%20print%28'Getting%20value'%29%0A%20%20%20%20%20%20%20%20return%20self._score%0A%0A%20%20%20%20%23%40get_score.setter%0A%20%20%20%20def%20set_score%28self,value%29%3A%0A%20%20%20%20%20%20%20%20print%28'Setting%20value'%29%0A%20%20%20%20%20%20%20%20if%20not%20isinstance%28value,int%29%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20raise%20ValueError%28'score%20must%20be%20a%20integer!'%29%0A%20%20%20%20%20%20%20%20if%20value%20%3C%200%20or%20value%20%3E%20100%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20raise%20ValueError%28'score%20must%20between%200~100!'%29%0A%20%20%20%20%20%20%20%20self._score%20%3D%20value%0A%0A%20%20%20%20score%20%3D%20Property%28get_score,set_score%29%0A%0As%20%3D%20Student%28%29&cumulative=false&curInstr=2&heapPrimitives=nevernest&mode=display&origin=opt-frontend.js&py=3&rawInputLstJSON=%5B%5D&textReferences=false

1. class Property(object):
   
2.     "Emulate PyProperty_Type() in Objects/descrobject"
   
3. 
   
4.     def __init__(self, fget=None, fset=None, fdel=None, doc=None):
   
5.         self.fget = fget
   
6.         self.fset = fset
   
7.         self.fdel = fdel
   
8.         if doc is None and fget is not None:
   
9.             doc = fget.__doc__
   
10.         self.__doc__ = doc
    
11. 
    
12.     def __get__(self, obj, objtype=None):
    
13.         if obj is None:
    
14.             return self
    
15.         if self.fget is None:
    
16.             raise AttributeError("unreadable attribute")
    
17.         return self.fget(obj)
    
18. 
    
19.     def __set__(self, obj, value):
    
20.         if self.fset is None:
    
21.             raise AttributeError("can't set attribute")
    
22.         self.fset(obj, value)
    
23. 
    
24.     def __delete__(self, obj):
    
25.         if self.fdel is None:
    
26.             raise AttributeError("can't delete attribute")
    
27.         self.fdel(obj)
    
28. 
    
29.     def getter(self, fget):
    
30.         return type(self)(fget, self.fset, self.fdel, self.__doc__)
    
31. 
    
32.     def setter(self, fset):
    
33.         return type(self)(self.fget, fset, self.fdel, self.__doc__)
    
34. 
    
35.     def deleter(self, fdel):
    
36.         return type(self)(self.fget, self.fset, fdel, self.__doc__)
    
37.         
    
38. class Student:
    
39. 
    
40.     def __init__(self,score=0):
    
41.         self.score = score
    
42. 
    
43.     #@property
    
44.     def get_score(self):
    
45.         print('Getting value')
    
46.         return self._score
    
47. 
    
48.     #@get_score.setter
    
49.     def set_score(self,value):
    
50.         print('Setting value')
    
51.         if not isinstance(value,int):
    
52.             raise ValueError('score must be a integer!')
    
53.         if value < 0 or value > 100:
    
54.             raise ValueError('score must between 0~100!')
    
55.         self._score = value
    
56. 
    
57.     score = Property(get_score,set_score)  #这里调用Property
    
58. 
    
59. s = Student()

复制代码

zjhahaha

我的理解是，
因为当你用c = Celsius()实例化一个对象的时候，构造函数__init__（）已经默认给temperature赋值是0，那么同时会把temperature=0传给set_temperature()这个函数，这是一个属性修饰函数，当你调用这个函数的时候，就会按照函数语句一句一句执行，这就是为什么会打印Setting value而不会打印Getting value（根本没有调用get_temperature这个函数）。