大家好，又見面了，我是你們的朋友全棧君。
學習 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
)
復制代碼這下程序稍微有點人工智能了，能夠自己明辨是非了。
程序是智能了，但在__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
)
復制代碼程序還是一樣的人工智能，非常好。
你以為你寫的代碼，已經非常優秀，無懈可擊了。
沒想到，人外有天，小明看了你的代碼後，深深地歎了口氣：類裡的三個屬性，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
)
復制代碼實現的效果和前面的一樣，可以對數據的合法性進行有效控制（字段類型、數值區間等）
以上，我舉了下具體的實例，從最原始的編碼風格到 Property ，最後引出描述符。由淺入深，一步一步帶你感受到描述符的優雅之處。
通過此文，你需要記住的只有一點，就是描述符給我們帶來的編碼上的便利，它在實現 保護屬性不受修改、屬性類型檢查 的基本功能，同時有大大提高代碼的復用率。
發布者：全棧程序員棧長，轉載請注明出處：https://javaforall.cn/106848.html原文鏈接：https://javaforall.cn
