描述符是實作了 __get__、__set__、__delete__ 任一方法的類別。它們讓你能自訂屬性存取行為,且可跨類別重用——這是 property 做不到的。
class Descriptor:
def __get__(self, instance, owner):
"""讀取屬性時調用: obj.attr"""
pass
def __set__(self, instance, value):
"""寫入屬性時調用: obj.attr = value"""
pass
def __delete__(self, instance):
"""刪除屬性時調用: del obj.attr"""
pass
instance:存取屬性的實例 (類別層級存取時為 None)owner:擁有該描述符的類別
class Movie:
def __init__(self, title, rating, runtime, budget, gross):
self.title = title
self._rating = rating
self._runtime = runtime
self._budget = budget
self._gross = gross
# 每個欄位都要寫一組 property... 重複代碼!
@property
def rating(self): return self._rating
@rating.setter
def rating(self, v):
if v < 0: raise ValueError("評分不可為負")
self._rating = v
# runtime, budget, gross 同理...
from weakref import WeakKeyDictionary
class NonNegative:
"""禁止負數的描述符"""
def __init__(self, default=0):
self.default = default
self.data = WeakKeyDictionary() # 關鍵:避免記憶體洩漏
def __get__(self, instance, owner):
if instance is None:
return self # 類別層級存取回傳描述符本身
return self.data.get(instance, self.default)
def __set__(self, instance, value):
if value < 0:
raise ValueError(f"負數不允許: {value}")
self.data[instance] = value
def __delete__(self, instance):
raise AttributeError("不可刪除")
# 使用:聲明式、零重複
class Movie:
rating = NonNegative(0)
runtime = NonNegative(0)
budget = NonNegative(0)
gross = NonNegative(0)
def __init__(self, title, rating, runtime, budget, gross):
self.title = title
self.rating = rating
self.runtime = runtime
self.budget = budget
self.gross = gross
def profit(self):
return self.gross - self.budget
# 測試
m = Movie('Casablanca', 97, 102, 964000, 1300000)
print(m.budget) # 964000
m.budget = -100 # ValueError: 負數不允許: -100
print(m.profit()) # 336000
普通字典會強參考實例,導致實例無法被 GC 回收。WeakKeyDictionary 只持弱引用,實例無其他引用時自動從字典移除,防止記憶體洩漏。
| 類型 | 實作方法 | 行為 | 例子 |
|---|---|---|---|
| 資料描述符 | 實作 __get__ + __set__/__delete__ | 優先級高於實例 __dict__ | property, NonNegative, ORM 欄位 |
| 非資料描述符 | 僅實作 __get__ | 優先級低於實例 __dict__ | 函式 (方法綁定), classmethod, staticmethod |
# 查找順序:
1. 類別/父類別的資料描述符 __get__
2. 實例 __dict__
3. 類別/父類別的非資料描述符 __get__ / 類別屬性
4. __getattr__ (最後手段)
class TypedAttribute:
def __init__(self, type_, default=None, validator=None):
self.type = type_
self.default = default
self.validator = validator
self.data = WeakKeyDictionary()
def __get__(self, instance, owner):
if instance is None:
return self
return self.data.get(instance, self.default)
def __set__(self, instance, value):
if not isinstance(value, self.type):
raise TypeError(f"預期 {self.type.__name__}, 得到 {type(value).__name__}")
if self.validator and not self.validator(value):
raise ValueError(f"驗證失敗: {value}")
self.data[instance] = value
class Person:
name = TypedAttribute(str, default='Anonymous')
age = TypedAttribute(int, default=0, validator=lambda x: x >= 0)
height = TypedAttribute(float, validator=lambda x: x > 0)
p = Person()
p.name = 'Alice'
p.age = 30
p.height = 165.5
# p.age = -5 # ValueError
# p.name = 123 # TypeError
property:內建資料描述符classmethod/staticmethod:非資料描述符django.db.models.Field:ORM 欄位描述符sqlalchemy.orm.attributes.InstrumentedAttribute:追蹤變更typing.ClassVar/Final:型別檢查器描述符
# 查看類別的所有描述符
def find_descriptors(cls):
for name, attr in cls.__dict__.items():
if hasattr(attr, '__get__') or hasattr(attr, '__set__'):
print(f"{name}: {type(attr).__name__}")
find_descriptors(Movie)
# rating: NonNegative
# runtime: NonNegative
# budget: NonNegative
# gross: NonNegative
描述符是 Python 物件模型的核心基石,掌握它能讓你編寫出更優雅、可重用、高效能的程式碼。