快捷導(dǎo)航

詳解Python裝飾器之@property

更新時(shí)間：2021年05月25日 11:55:30 作者：小皇魚

今天帶大家學(xué)習(xí)python裝飾器的相關(guān)知識(shí),文中對(duì)Python @property做了非常詳細(xì)的介紹,對(duì)正在學(xué)習(xí)python的小伙伴們很有幫助,需要的朋友可以參考下

一、property() 函數(shù)講解

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

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

描述：

返回 property 屬性。

參數(shù)說(shuō)明：

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

返回值：

property 屬性。

注意：

在 3.5 版更改：特征屬性對(duì)象的文檔字符串現(xiàn)在是可寫的。

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

property() 函數(shù)是用來(lái)創(chuàng)建一個(gè)托管屬性，對(duì)類中定義的屬性進(jìn)行托管操作的。

托管的哪些東西呢？

獲取屬性的值的方法、設(shè)置屬性的值的方法、刪除屬性值的方法；
property() 函數(shù)將類某個(gè)屬性的以上三個(gè)方法托管給了新創(chuàng)建的托管屬性，在類外通過(guò)對(duì)托管屬性的直接操作，從而實(shí)現(xiàn)類中指定屬性的訪問(wèn)、設(shè)置、刪除。

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

當(dāng)對(duì)屬性的訪問(wèn)、設(shè)置、刪除有過(guò)濾條件的時(shí)候，可以將過(guò)濾的條件放在類中的對(duì)應(yīng)方法中，而在類外通過(guò)托管屬性依舊可以以簡(jiǎn)潔的方式實(shí)現(xiàn)屬性的訪問(wèn)、設(shè)置、刪除。
也可以通過(guò)托管屬性對(duì)類中的多個(gè)屬性同時(shí)實(shí)現(xiàn)訪問(wèn)、設(shè)置、刪除。
也許還有其他區(qū)別我展示沒(méi)發(fā)現(xiàn)。

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

class C:
    def __init__(self):
        self._x = None
 
    def getx(self):          # 定義一個(gè)方法 getx() 用來(lái)訪問(wèn) _x
        return self._x
 
    def setx(self, value):   # 定義一個(gè)方法 setx() 用來(lái)設(shè)置 _x
        self._x = value
 
    def delx(self):          # 定義一個(gè)方法 delx() 用來(lái)刪除 _x
        del self._x
        print("完成 _x 或 x 的刪除！")
 
    x = property(getx, setx, delx, "x 是一個(gè)托管屬性")     # 根據(jù) property() 函數(shù)的特點(diǎn)創(chuàng)建一個(gè)托管屬性 x
 
 
c = C()                # 創(chuàng)建一個(gè)實(shí)例對(duì)象 c
c.x = "王大頭"         # 實(shí)例調(diào)用托管屬性 x，對(duì) x 賦值就是調(diào)用 setx() 方法
print(c.x)             # 實(shí)例調(diào)用托管屬性 x，打印 x 就是調(diào)用 getx() 方法
print(C.x.__doc__)     # 類調(diào)用托管屬性 x，調(diào)用 __doc__ 打印 x 的文檔字符串
del c.x                # 刪除托管屬性 x，就是調(diào)用 delx() 方法

運(yùn)行結(jié)果：

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

二、@property 裝飾器講解

首先我們定義一個(gè) C 類，在類中定義一個(gè)實(shí)例屬性 score。

如果我們要訪問(wèn)或修改屬性 score 時(shí)，可以直接在類外通過(guò)類的實(shí)例進(jìn)行。如下：

class C:
    def __init__(self):
        self.score = 85          # 默認(rèn)分?jǐn)?shù)為 85
 
 
c = C()                          # 創(chuàng)建一個(gè) C 類的實(shí)例 c
print(c.score)                   # 通過(guò) C 類的實(shí)例對(duì)象 c，調(diào)用 score 屬性來(lái)實(shí)現(xiàn)訪問(wèn)
c.score = 60                     # 通過(guò) C 類的實(shí)例對(duì)象 c 直接修改屬性 score
print(c.score)

運(yùn)行結(jié)果：

85
60

我們發(fā)現(xiàn)普通的屬性訪問(wèn)、修改、刪除這樣做是可以的，但是如果我們要在訪問(wèn)、修改、刪除時(shí)增加過(guò)濾條件，那么這樣操作顯然是不行的。

我們還可以通過(guò)在類中定義的方法，在方法中添加過(guò)濾條件來(lái)實(shí)現(xiàn)屬性的訪問(wèn)、修改、刪除。在類外需要通過(guò)實(shí)例調(diào)用對(duì)應(yīng)方法來(lái)實(shí)現(xiàn)，如下：

class C:
    def __init__(self):
        self.score = 85
 
    def get_score(self):                 # 定義一個(gè)方法 get_score() 用來(lái)獲取分?jǐn)?shù)
        if self.score < 60:
            return "不及格！"
        else:
            return self.score
 
    def set_score(self, value):          # 定義一個(gè)方法 set_score() 用來(lái)輸入分?jǐn)?shù)
        if 0 <= value <= 100:
            self.score = value
        else:
            print(f"輸入的值 {value} 超出范圍 0~100 ！")
 
    def del_score(self):                 # 定義一個(gè)方法 del_score() 用來(lái)刪除分?jǐn)?shù)
        del self.score
        print("完成 score 屬性的刪除！")
 
 
c = C()
c.set_score(99)               # 通過(guò)實(shí)例對(duì)象調(diào)用 set_score() 方法來(lái)實(shí)現(xiàn) score 屬性的賦值或修改
print(c.get_score())          # 通過(guò)實(shí)例對(duì)象調(diào)用 get_score() 方法來(lái)實(shí)現(xiàn) score 屬性的訪問(wèn)
c.del_score()                 # 通過(guò)實(shí)例對(duì)象調(diào)用 del_score() 方法來(lái)實(shí)現(xiàn) score 屬性的刪除

運(yùn)行結(jié)果：

99
完成 score 屬性的刪除！

通過(guò)上節(jié)對(duì) property() 了解，我們發(fā)現(xiàn) property() 函數(shù)的參數(shù) fget、fset、fdel 分別對(duì)應(yīng)著獲取屬性函數(shù)、設(shè)置屬性函數(shù) 和刪除屬性函數(shù)。如此以來(lái)我們就可以將 score 屬性通過(guò) property() 函數(shù)委托給 score_x，將 get_score()、set_score()、del_score() 方法分別傳遞給 fget、fset、fdel 參數(shù)。利用托管屬性 score_x，我們可以以最簡(jiǎn)單的方式對(duì)屬性實(shí)現(xiàn)有過(guò)濾條件訪問(wèn)、賦值、刪除。如下：

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 = value
        else:
            print(f"輸入的值 {value} 超出范圍 0~100 ！")
 
    def del_score(self):
        del self.score
        print("完成 score 屬性的刪除！")
 
    score_x = property(fget=get_score, fset=set_score, fdel=del_score, doc="score_x 是 score 的托管屬性。")
 
 
c = C()
c.score_x = 45          # 直接使用實(shí)例對(duì)象調(diào)用 score_x 進(jìn)行賦值，背后還是調(diào)用了方法實(shí)現(xiàn)了過(guò)濾
print(c.score_x)        # 獲取 score_x 的值
del c.score_x           # 刪除 score

運(yùn)行結(jié)果：

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

我們?cè)賮?lái)看看 property() 作為裝飾器 decorator 來(lái)使用，@property 裝飾器是將被裝飾的方法轉(zhuǎn)化為一個(gè)同名的只讀的特征屬性，被裝飾方法的文檔字符串就是裝飾后同名屬性的文檔字符串：

class C:
    def __init__(self):
        self.score = 85
 
    @property
    def score_x(self):
        """score_x 就相當(dāng)于一個(gè) score 的托管屬性。"""
        return self.score
 
 
c = C()
print(c.score_x)                  # score_x() 方法被轉(zhuǎn)換為屬性后，該屬性的值就是方法的返回值
print(C.score_x.__doc__)          # 查看該屬性的字符串文檔
c.score_x = 90                    # 對(duì) score_x 屬性的修改失敗，因?yàn)樗莻€(gè)只讀屬性

運(yùn)行結(jié)果：

85
score_x 就相當(dāng)于一個(gè) score 的托管屬性。
Traceback (most recent call last):
File "C:\Users\13160\Desktop\Python Exercise\011.py", line 14, in <module>
c.score_x = 90
AttributeError: can't set attribute

我們發(fā)現(xiàn)這樣使用 @property 裝飾器裝飾的方法，只是轉(zhuǎn)變?yōu)榱酥蛔x屬性，不能修改也不能刪除。這似乎好像與 property() 函數(shù)創(chuàng)建托管屬性既可以訪問(wèn)又可以修改、刪除有些不同。

我們要知道 @property 裝飾器的本質(zhì)是 property() 函數(shù)，所以被裝飾的方法就相當(dāng)于 property() 函數(shù)創(chuàng)建的托管屬性。托管屬性對(duì)象是具有相應(yīng)的屬性 fget，fset 和 fdel（訪問(wèn)、設(shè)置、刪除），而被 @property 裝飾器裝飾的對(duì)象同樣也具有對(duì)應(yīng)的 getter，setter 以及 deleter 方法。所以要想被 @property 裝飾器裝飾的函數(shù)轉(zhuǎn)換為屬性后也可以實(shí)現(xiàn)設(shè)置、刪除操作，可以做如下設(shè)置：

class C:
    def __init__(self):
        self.score = 85
 
    @property                           # @property 裝飾器本身就相當(dāng)于 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 = value
        else:
            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 = 45
print(c.score_x)

運(yùn)行結(jié)果：

85
不及格！

通過(guò)上面 @property 裝飾器的應(yīng)用我們可以看出，它和直接使用 property() 函數(shù)創(chuàng)建委托屬性其實(shí)沒(méi)啥區(qū)別。

注意：

@property 裝飾的方法對(duì)應(yīng)著 getter 方法，@score_x.setter 裝飾的方法對(duì)應(yīng)著 setter 方法，@score_x.deleter 裝飾的方法對(duì)應(yīng)著 deleter 方法；
@property、@score_x.setter、@score_x.deleter 裝飾的方法的方法名都要相同，這個(gè)方法名就相當(dāng)于托管屬性的名稱

到此這篇關(guān)于詳解Python裝飾器之@property的文章就介紹到這了,更多相關(guān)Python @property內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: