【案例講解】Python為什麼要使用描述符?

Python程式設計時光發表於2019-04-28

學習 Python 這麼久了,說起 Python 的優雅之處,能讓我脫口而出的, Descriptor(描述符)特性可以排得上號。

描述符 是Python 語言獨有的特性,它不僅在應用層使用,在語言的基礎設施中也有涉及。

我可以大膽地猜測,你對於描述符的瞭解是始於諸如 Django ORM 和 SQLAlchemy 中的欄位物件,是的,它們都是描述符。你的它的認識,可能也止步於此,如果你沒有去深究,它為何要如此設計?也就加體會不到 Python 給我們帶來的便利與優雅。

由於 描述符的內容較多,長篇大論,容易讓你倦怠,所以我打算分幾篇來講。

今天的話題是:為何要使用描述符?

假想你正在給學校寫一個成績管理系統,並沒有太多編碼經驗的你,可能會這樣子寫。

class Student:
    def __init__(self, name, math, chinese, english):
        self.name = name
        self.math = math
        self.chinese = chinese
        self.english = english

    def __repr__(self):
        return "<Student: {}, math:{}, chinese: {}, english:{}>".format(
                self.name, self.math, self.chinese, self.english
            )
複製程式碼

看起來一切都很合理

>>> std1 = Student('小明', 76, 87, 68)
>>> std1
<Student: 小明, math:76, chinese: 87, english:68>
複製程式碼

但是程式並不像人那麼智慧,不會自動根據使用場景判斷資料的合法性,如果老師在錄入成績的時候,不小心錄入了將成績錄成了負數,或者超過100,程式是無法感知的。

聰明的你,馬上在程式碼中加入了判斷邏輯。

class Student:
    def __init__(self, name, math, chinese, english):
        self.name = name
        if 0 <= math <= 100:
            self.math = math
        else:
            raise ValueError("Valid value must be in [0, 100]")
        
        if 0 <= chinese <= 100:
            self.chinese = chinese
        else:
            raise ValueError("Valid value must be in [0, 100]")
      
        if 0 <= chinese <= 100:
            self.english = english
        else:
            raise ValueError("Valid value must be in [0, 100]")
        

    def __repr__(self):
        return "<Student: {}, math:{}, chinese: {}, english:{}>".format(
                self.name, self.math, self.chinese, self.english
            )
複製程式碼

這下程式稍微有點人工智慧了,能夠自己明辨是非了。

【案例講解】Python為什麼要使用描述符?

程式是智慧了,但在__init__裡有太多的判斷邏輯,很影響程式碼的可讀性。巧的是,你剛好學過 Property 特性,可以很好的應用在這裡。於是你將程式碼修改成如下,程式碼的可讀性瞬間提升了不少

class Student:
    def __init__(self, name, math, chinese, english):
        self.name = name
        self.math = math
        self.chinese = chinese
        self.english = english

    @property
    def math(self):
        return self._math

    @math.setter
    def math(self, value):
        if 0 <= value <= 100:
            self._math = value
        else:
            raise ValueError("Valid value must be in [0, 100]")

    @property
    def chinese(self):
        return self._chinese

    @chinese.setter
    def chinese(self, value):
        if 0 <= value <= 100:
            self._chinese = value
        else:
            raise ValueError("Valid value must be in [0, 100]")

    @property
    def english(self):
        return self._english

    @english.setter
    def english(self, value):
        if 0 <= value <= 100:
            self._english = value
        else:
            raise ValueError("Valid value must be in [0, 100]")

    def __repr__(self):
        return "<Student: {}, math:{}, chinese: {}, english:{}>".format(
                self.name, self.math, self.chinese, self.english
            )
複製程式碼

程式還是一樣的人工智慧,非常好。

【案例講解】Python為什麼要使用描述符?

你以為你寫的程式碼,已經非常優秀,無懈可擊了。

沒想到,人外有天,小明看了你的程式碼後,深深地嘆了口氣:類裡的三個屬性,math、chinese、english,都使用了 Property 對屬性的合法性進行了有效控制。功能上,沒有問題,但就是太囉嗦了,三個變數的合法性邏輯都是一樣的,只要大於0,小於100 就可以,程式碼重複率太高了,這裡三個成績還好,但假設還有地理、生物、歷史、化學等十幾門的成績呢,這程式碼簡直沒法忍。去了解一下 Python 的描述符吧。

經過小明的指點,你知道了「描述符」這個東西。懷著一顆敬畏之心,你去搜尋了下關於 描述符的用法。

其實也很簡單,一個實現了 描述符協議 的類就是一個描述符。

什麼描述符協議:實現了 __get__()__set__()__delete__() 其中至少一個方法的類,就是一個描述符。

  • __get__: 用於訪問屬性。它返回屬性的值,若屬性不存在、不合法等都可以丟擲對應的異常。
  • __set__:將在屬性分配操作中呼叫。不會返回任何內容。
  • __delete__:控制刪除操作。不會返回內容。

對描述符有了大概的瞭解後,你開始重寫上面的方法。

如前所述,Score 類是一個描述器,當從 Student 的例項訪問 math、chinese、english這三個屬性的時候,都會經過 Score 類裡的三個特殊的方法。這裡的 Score 避免了 使用Property 出現大量的程式碼無法複用的尷尬。

class Score:
    def __init__(self, default=0):
        self._score = default

    def __set__(self, instance, value):
        if not isinstance(value, int):
            raise TypeError('Score must be integer')
        if not 0 <= value <= 100:
            raise ValueError('Valid value must be in [0, 100]')

        self._score = value

    def __get__(self, instance, owner):
        return self._score

    def __delete__(self):
        del self._score
        
class Student:
    math = Score(0)
    chinese = Score(0)
    english = Score(0)

    def __init__(self, name, math, chinese, english):
        self.name = name
        self.math = math
        self.chinese = chinese
        self.english = english


    def __repr__(self):
        return "<Student: {}, math:{}, chinese: {}, english:{}>".format(
                self.name, self.math, self.chinese, self.english
            )
複製程式碼

實現的效果和前面的一樣,可以對資料的合法性進行有效控制(欄位型別、數值區間等)

【案例講解】Python為什麼要使用描述符?

以上,我舉了下具體的例項,從最原始的編碼風格到 Property ,最後引出描述符。由淺入深,一步一步帶你感受到描述符的優雅之處。

通過此文,你需要記住的只有一點,就是描述符給我們帶來的編碼上的便利,它在實現 保護屬性不受修改屬性型別檢查 的基本功能,同時有大大提高程式碼的複用率。

關注公眾號,獲取最新干貨!

相關文章