封裝是面向對象核心原則。Python 無 private 關鍵字,慣例用 _name(受保護)或 __name(名稱修飾)表示內部屬性。property 讓我們在「屬性訪問」語法(obj.attr)下,執行自定義的獲取、設置、刪除邏輯——實現驗證、計算屬性、只讀、側效應等,且不破壞調用者介面。
property(fget, fset, fdel, doc) 工廠函數
class ClassicProp:
def __init__(self):
self.__x = None # 名稱修飾 -> _ClassicProp__x
# 三個存取器
def get_x(self):
print("get_x called")
return self.__x
def set_x(self, value):
print(f"set_x called with {value}")
self.__x = value
def del_x(self):
print("del_x called")
del self.__x
# 綁定為屬性
x = property(get_x, set_x, del_x, "這是 x 的文檔字串")
# 使用
c = ClassicProp()
c.x = 100 # 呼叫 set_x
print(c.x) # 呼叫 get_x
del c.x # 呼叫 del_x
print(ClassicProp.x.__doc__) # 文檔可訪問
優點:集中定義、可動態構建(如根據配置生成屬性)。
缺點:方法分散、命名需約定(get_x/set_x/del_x)、視覺上不直觀。
class ModernProp:
def __init__(self):
self.__x = None
@property
def x(self):
"""獲取 x"""
print("getter")
return self.__x
@x.setter
def x(self, value):
print(f"setter: {value}")
if not isinstance(value, int):
raise TypeError("x must be int")
self.__x = value
@x.deleter
def x(self):
print("deleter")
del self.__x
# 使用體驗完全一致
m = ModernProp()
m.x = 42
print(m.x)
del m.x
關鍵規則:
@property(getter),返回 property 對象並綁定到名稱 x。@x.setter、@x.deleter **必須同名**,否則會創建新屬性而非擴展現有屬性。
class Circle:
def __init__(self, r): self.r = r
@property
def area(self): return 3.14159 * self.r ** 2
@property
def perimeter(self): return 2 * 3.14159 * self.r
c = Circle(5)
print(c.area) # 78.53975
# c.area = 10 # AttributeError: 沒有 setter
class User:
def __init__(self): self._email = None
@property
def email(self): return self._email
@email.setter
def email(self, val):
if "@" not in val: raise ValueError("Invalid email")
self._email = val.lower() # 歸一化
self._notify_email_changed()
def _notify_email_changed(self): print("Email updated")
class DataLoader:
def __init__(self, path): self.path = path; self._data = None
@property
def data(self):
if self._data is None:
print("Loading...")
self._data = open(self.path).read()
return self._data
dl = DataLoader("big.txt")
print(len(dl.data)) # 首次載入
print(len(dl.data)) # 直接返回緩存
class Base:
@property
def value(self): return self._value
class Derived(Base):
@Base.value.setter
def value(self, v):
if v < 0: raise ValueError("non-negative")
self._value = v
子類可單獨擴展 setter/getter,父類 property 對象被復用。
| 維度 | property() 函數 | @property 裝飾器 |
|---|---|---|
| 可讀性 | 分散 | 集中、聲明式 |
| 動態構建 | 易(循環/元編程) | 需 setattr + property |
| 文檔字串 | 第 4 參數 | getter 的 __doc__ |
| 繼承擴展 | 麻煩 | 自然(@Parent.prop.setter) |
| 適用版本 | 所有 | Python 2.6+ / 3.0+ |
@x.setter def x(self, v): self.x = v → 無限遞歸。正確:self._x = v。__x 在子類中變為 _Child__x,導致父類 property 訪問不到。建議單下劃線 _x 或統一用 _x。property 必須定義在類體中,不可在 __init__ 動態添加(需用 setattr(cls, 'prop', property(...)))。現代 Python 專案**強烈推薦裝飾器語法**——可讀性高、工具鏈支援好(IDE 跳轉、類型檢查、文檔生成)。經典 property() 保留給元編程、動態屬性生成等進階場景。掌握兩者轉換,能靈活應對從簡單封裝到複雜框架開發的各種需求。