Python中property屬性詳解

1. 什么是property屬性

一種用起來像是使用的實例屬性一樣的特殊屬性，可以對應於某個方法

# ############### 定義 ###############
class Foo:
    def func(self):
        pass

    # 定義property屬性
    @property
    def prop(self):
        pass

# ############### 調用 ###############
foo_obj = Foo()
foo_obj.func()  # 調用實例方法
foo_obj.prop  # 調用property屬性

2.為什么使用property屬性

在綁定屬性時，如果我們直接把屬性暴露出去，雖然寫起來很簡單，但是，沒辦法檢查參數，導致可以把成績隨便改：

s = Student()
s.score = 9999

這顯然不合邏輯。為了限制score的范圍，可以通過一個set_score()方法來設置成績，再通過一個get_score()來獲取成績，這樣，在set_score()方法里，就可以檢查參數：

class Student(object):

    def get_score(self):
        return self._score

    def set_score(self, value):
        if not isinstance(value, int):
            raise ValueError('score must be an integer!')
        if value < 0 or value > 100:
            raise ValueError('score must between 0 ~ 100!')
        self._score = value

調用：
s = Student()
s.set_score(60) # ok!
s.get_score()
60
s.set_score(9999)
Traceback (most recent call last):
  ...
ValueError: score must between 0 ~ 100!

但是，上面的調用方法又略顯復雜，沒有直接用屬性這么直接簡單。

有沒有既能檢查參數，又可以用類似屬性這樣簡單的方式來訪問類的變量呢？對於追求完美的Python程序員來說，這是必須要做到的！

還記得裝飾器（decorator）可以給函數動態加上功能嗎？對於類的方法，裝飾器一樣起作用。Python內置的@property裝飾器就是負責把一個方法變成屬性調用的：

class Student(object):

    @property
    def score(self):
        return self._score

    @score.setter
    def score(self, value):
        if not isinstance(value, int):
            raise ValueError('score must be an integer!')
        if value < 0 or value > 100:
            raise ValueError('score must between 0 ~ 100!')
        self._score = value

@property的實現比較復雜，我們先考察如何使用。把一個getter方法變成屬性，只需要加上@property就可以了，此時，@property本身又創建了另一個裝飾器@score.setter，負責把一個setter方法變成屬性賦值，於是，我們就擁有一個可控的屬性操作：

調用：
s = Student()
s.score = 60 # OK，實際轉化為s.set_score(60)
s.score # OK，實際轉化為s.get_score()
60
s.score = 9999
Traceback (most recent call last):
  ...
ValueError: score must between 0 ~ 100!

3. property屬性的有兩種方式

• 裝飾器 即：在方法上應用裝飾器
• 類屬性 即：在類中定義值為property對象的類屬性

3.1 裝飾器方式

在類的實例方法上應用@property裝飾器

#coding=utf-8 # ############### 定義 ############### class Goods: """python3中默認繼承object類 以python2、3執行此程序的結果不同，因為只有在python3中才有@xxx.setter @xxx.deleter """  @property def price(self): print('@property')  @price.setter def price(self, value): print('@price.setter')  @price.deleter def price(self): print('@price.deleter') # ############### 調用 ############### obj = Goods() obj.price # 自動執行 @property 修飾的 price 方法，並獲取方法的返回值 obj.price = 123 # 自動執行 @price.setter 修飾的 price 方法，並將 123 賦值給方法的參數 del obj.price # 自動執行 @price.deleter 修飾的 price 方法

3.2 類屬性方式，創建值為property對象的類屬性

property方法中有個四個參數

• 第一個參數是方法名，調用 對象.屬性 時自動觸發執行方法
• 第二個參數是方法名，調用 對象.屬性 ＝ XXX 時自動觸發執行方法
• 第三個參數是方法名，調用 del 對象.屬性 時自動觸發執行方法
• 第四個參數是字符串，調用 對象.屬性.__doc__ ，此參數是該屬性的描述信息

  #coding=utf-8
  class Foo(object):
      def get_bar(self):
          print("getter...")
          return 'laowang'
  
      def set_bar(self, value): 
          """必須兩個參數"""
          print("setter...")
          return 'set value' + value
  
      def del_bar(self):
          print("deleter...")
          return 'laowang'
  
      BAR = property(get_bar, set_bar, del_bar, "description...")
  
  obj = Foo()
  
  obj.BAR  # 自動調用第一個參數中定義的方法：get_bar
  obj.BAR = "alex"  # 自動調用第二個參數中定義的方法：set_bar方法，並將“alex”當作參數傳入
  desc = Foo.BAR.__doc__  # 自動獲取第四個參數中設置的值：description...
  print(desc)
  del obj.BAR  # 自動調用第三個參數中定義的方法：del_bar方法