一、property() 函數講解

了解 @property 裝飾器之前，我們首先要了解內置函數的 property()。

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

描述：

返回 property 屬性。

參數說明：

fget —— 獲取屬性值的函數。 fset —— 設置屬性值的函數。 fdel —— 刪除屬性值函數。 doc —— property 屬性的文檔字符串，如果沒有給出 doc，則該 property 將拷貝 fget 的文檔字符串（如果存在）。

返回值：

property 屬性。

注意：

在 3.5 版更改：特征屬性對象的文檔字符串現在是可寫的。

首先我們要知道 property() 函數是用來干什么的？

property() 函數是用來創建一個托管屬性，對類中定義的屬性進行托管操作的。

托管的哪些東西呢？

獲取屬性的值的方法、設置屬性的值的方法、刪除屬性值的方法； property() 函數將類某個屬性的以上三個方法托管給了新創建的托管屬性，在類外通過對托管屬性的直接操作，從而實現類中指定屬性的訪問、設置、刪除。

在類外使用托管屬性和直接使用指定的屬性有什么區別呢？

當對屬性的訪問、設置、刪除有過濾條件的時候，可以將過濾的條件放在類中的對應方法中，而在類外通過托管屬性依舊可以以簡潔的方式實現屬性的訪問、設置、刪除。 也可以通過托管屬性對類中的多個屬性同時實現訪問、設置、刪除。 也許還有其他區別我展示沒發現。

示例：一個典型的用法是定義一個托管屬性 x。

class C: def __init__(self):self._x = None def getx(self): # 定義一個方法 getx() 用來訪問 _xreturn self._x def setx(self, value): # 定義一個方法 setx() 用來設置 _xself._x = value def delx(self): # 定義一個方法 delx() 用來刪除 _xdel self._xprint('完成 _x 或 x 的刪除！') x = property(getx, setx, delx, 'x 是一個托管屬性') # 根據 property() 函數的特點創建一個托管屬性 x c = C()# 創建一個實例對象 cc.x = '王大頭' # 實例調用托管屬性 x，對 x 賦值就是調用 setx() 方法print(c.x) # 實例調用托管屬性 x，打印 x 就是調用 getx() 方法print(C.x.__doc__) # 類調用托管屬性 x，調用 __doc__ 打印 x 的文檔字符串del c.x# 刪除托管屬性 x，就是調用 delx() 方法

運行結果：

王大頭x 是一個托管屬性完成 _x 或 x 的刪除！

二、@property 裝飾器講解

首先我們定義一個 C 類，在類中定義一個實例屬性 score。

如果我們要訪問或修改屬性 score 時，可以直接在類外通過類的實例進行。如下：

class C: def __init__(self):self.score = 85 # 默認分數為 85 c = C() # 創建一個 C 類的實例 cprint(c.score) # 通過 C 類的實例對象 c，調用 score 屬性來實現訪問c.score = 60 # 通過 C 類的實例對象 c 直接修改屬性 scoreprint(c.score)

運行結果：

8560

我們發現普通的屬性訪問、修改、刪除這樣做是可以的，但是如果我們要在訪問、修改、刪除時增加過濾條件，那么這樣操作顯然是不行的。

我們還可以通過在類中定義的方法，在方法中添加過濾條件來實現屬性的訪問、修改、刪除。在類外需要通過實例調用對應方法來實現，如下：

class C: def __init__(self):self.score = 85 def get_score(self): # 定義一個方法 get_score() 用來獲取分數if self.score < 60: return '你妹的，不及格！'else: return self.score def set_score(self, value): # 定義一個方法 set_score() 用來輸入分數if 0 <= value <= 100: self.score = valueelse: print(f'輸入的值 {value} 超出范圍 0~100 ！') def del_score(self): # 定義一個方法 del_score() 用來刪除分數del self.scoreprint('完成 score 屬性的刪除！') c = C()c.set_score(99) # 通過實例對象調用 set_score() 方法來實現 score 屬性的賦值或修改print(c.get_score()) # 通過實例對象調用 get_score() 方法來實現 score 屬性的訪問c.del_score() # 通過實例對象調用 del_score() 方法來實現 score 屬性的刪除

運行結果：

99完成 score 屬性的刪除！

通過上節對 property() 了解，我們發現 property() 函數的參數 fget、fset、fdel 分別對應著 獲取屬性函數、設置屬性函數 和 刪除屬性函數。如此以來我們就可以將 score 屬性通過 property() 函數委托給 score_x，將 get_score()、set_score()、del_score() 方法分別傳遞給 fget、fset、fdel 參數。利用托管屬性 score_x，我們可以以最簡單的方式對屬性實現有過濾條件訪問、賦值、刪除。如下：

class C: def __init__(self):self.score = 85 def get_score(self):if self.score < 60: return '你妹的，不及格！'else: return self.score def set_score(self, value):if 0 <= value <= 100: self.score = valueelse: print(f'輸入的值 {value} 超出范圍 0~100 ！') def del_score(self):del self.scoreprint('完成 score 屬性的刪除！') score_x = property(fget=get_score, fset=set_score, fdel=del_score, doc='score_x 是 score 的托管屬性。') c = C()c.score_x = 45 # 直接使用實例對象調用 score_x 進行賦值，背后還是調用了方法實現了過濾print(c.score_x)# 獲取 score_x 的值del c.score_x # 刪除 score

運行結果：

你妹的，不及格！完成 score 屬性的刪除

我們再來看看 property() 作為 裝飾器 decorator 來使用，@property 裝飾器是將被裝飾的方法轉化為一個同名的只讀的特征屬性，被裝飾方法的文檔字符串就是裝飾后同名屬性的文檔字符串：

class C: def __init__(self):self.score = 85 @property def score_x(self):'''score_x 就相當于一個 score 的托管屬性。'''return self.score c = C()print(c.score_x) # score_x() 方法被轉換為屬性后，該屬性的值就是方法的返回值print(C.score_x.__doc__) # 查看該屬性的字符串文檔c.score_x = 90 # 對 score_x 屬性的修改失敗，因為它是個只讀屬性

運行結果：

85score_x 就相當于一個 score 的托管屬性。Traceback (most recent call last): File 'C:Users13160DesktopPython Exercise011.py', line 14, in <module> c.score_x = 90AttributeError: can’t set attribute

我們發現這樣使用 @property 裝飾器裝飾的方法，只是轉變為了只讀屬性，不能修改也不能刪除。這似乎好像與 property() 函數創建托管屬性既可以訪問又可以修改、刪除有些不同。

我們要知道 @property 裝飾器的本質是 property() 函數，所以被裝飾的方法就相當于 property() 函數創建的托管屬性。托管屬性對象是具有相應的屬性 fget，fset 和 fdel（訪問、設置、刪除），而被 @property 裝飾器裝飾的對象同樣也具有對應的 getter，setter 以及 deleter 方法。所以要想被 @property 裝飾器裝飾的函數轉換為屬性后也可以實現設置、刪除操作，可以做如下設置：

class C: def __init__(self):self.score = 85 @property # @property 裝飾器本身就相當于 getter 方法 def score_x(self):if self.score < 60: return '你妹的，不及格！'else: return self.score @score_x.setter # 給 score_x 屬性裝飾 setter 方法 def score_x(self, value): # 附加方法與原始的特征屬性相同的名稱if 0 <= value <= 100: self.score = valueelse: print(f'輸入的值 {value} 超出范圍 0~100 ！') @score_x.deleter # 給 score_x 屬性裝飾 deleter 方法 def score_x(self): # 附加方法與原始的特征屬性相同的名稱del self.score c = C()print(c.score_x)c.score_x = 45print(c.score_x)

運行結果：

85你妹的，不及格！

通過上面 @property 裝飾器的應用我們可以看出，它和直接使用 property() 函數創建委托屬性其實沒啥區別。

注意：

@property 裝飾的方法對應著 getter 方法，@score_x.setter 裝飾的方法對應著 setter 方法，@score_x.deleter 裝飾的方法對應著 deleter 方法； @property、@score_x.setter、@score_x.deleter 裝飾的方法的方法名都要相同，這個方法名就相當于托管屬性的名稱

到此這篇關于詳解Python裝飾器之@property的文章就介紹到這了,更多相關Python @property內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！