深入理解 Python （Descriptor）描述器的運作與應用

更新日期： 2024 年 11 月 21 日

描述器是 Python 提供的一種強大工具，用於控制屬性的讀取與寫入行為。

它的核心在於能在屬性存取時插入邏輯，比如驗證數值或記錄操作。

本篇將以一個完整的基礎範例開始，逐步說明描述器的運作機制，並結合具體範例來展示它的實用性。

描述器基礎範例

為了更直觀地理解描述器的運作，我們先從一個簡單的代碼範例開始。

描述器代碼範例

class DescriptorExample:
    def __get__(self, instance, owner):
        print("觸發 __get__ 方法")
        return instance._value

    def __set__(self, instance, value):
        print("觸發 __set__ 方法")
        if value < 0:
            raise ValueError("屬性值不能為負數")
        instance._value = value


class MyClass:
    # 將描述器掛載到屬性 'value'
    value = DescriptorExample()

# 使用範例
obj = MyClass()
obj.value = 42  # 觸發 __set__
print(obj.value)  # 觸發 __get__

# obj.value = -1  # 觸發 __set__，引發 ValueError

程式執行結果

1. obj.value = 42
   輸出：

   觸發 __set__ 方法

描述器的 __set__ 方法被觸發，檢查值是否合法並儲存到 _value。

2. print(obj.value)
   輸出：

   觸發 __get__ 方法
   42

描述器的 __get__ 方法被觸發，返回 _value 的值。

3. 如果執行 obj.value = -1，會引發以下錯誤：

   ValueError: 屬性值不能為負數

描述器的工作流程

什麼是描述器？

描述器是一個類別，通過定義特殊方法（如 __get__ 和 __set__），控制屬性的讀取、寫入或刪除行為。

它的運作方式可以分為兩個層次：

• 外部接口：使用者存取屬性（如 obj.value）。
• 內部儲存：描述器將值存放在一個私有的內部屬性（如 _value），並在存取時插入邏輯。

描述器的存取過程

描述器的運作由 Python 的屬性存取規則驅動：

• 存取屬性時（如 obj.value）：觸發 __get__ 方法，返回內部值。
• 設置屬性時（如 obj.value = value）：觸發 __set__ 方法，執行邏輯後儲存值。
• 刪除屬性時（如 del obj.value）：若定義 __delete__ 方法，則觸發該方法。

描述器的優勢與應用場景

為什麼要使用描述器？

描述器提供了靈活的屬性控制能力，適用於需要在屬性操作時執行額外邏輯的場景。

以下是描述器的幾個主要優勢：

• 靈活性：可以在屬性存取或設定時插入驗證邏輯、自動格式化或記錄操作。
• 封裝性：使用者透過公開的屬性操作，而描述器在背後處理細節邏輯。
• 重用性：同一個描述器可以掛載到多個屬性，實現邏輯共享。

常見的應用場景

• 數值驗證：限制屬性值的範圍或格式。
• 延遲計算：在屬性讀取時執行動態計算。
• 自動更新：屬性值變更時觸發其他操作。

深入理解：為什麼使用內部屬性？

描述器常常使用內部屬性（如 _value）來儲存數據，而不是直接操作公開屬性（如 value）。

這是為了避免以下問題：

避免無窮遞歸

如果在 __set__ 或 __get__ 方法中直接操作公開屬性，會再次觸發描述器的方法，導致無窮遞歸。

錯誤範例

class DescriptorExample:
    def __set__(self, instance, value):
        instance.value = value  # 錯誤：再次觸發 __set__

class MyClass:
    value = DescriptorExample()

obj = MyClass()
obj.value = 42  # 無窮遞歸

確保儲存邏輯的獨立性

將數據儲存在內部屬性（如 _value），可以避免影響描述器本身的行為，確保儲存邏輯與描述器邏輯互不干擾。

完整應用範例：銀行帳戶餘額管理

以下是一個實際應用描述器的例子，用於管理銀行帳戶的餘額。

描述器實作

class BalanceDescriptor:
    def __get__(self, instance, owner):
        return instance._balance  # 返回內部餘額

    def __set__(self, instance, value):
        if value < 0:
            raise ValueError("餘額不能為負數")  # 驗證邏輯
        instance._balance = value  # 設定內部餘額

class BankAccount:
    balance = BalanceDescriptor()  # 將描述器掛載到 balance

    def __init__(self, initial_balance):
        self.balance = initial_balance  # 觸發 __set__

使用範例

# 建立銀行帳戶
account = BankAccount(1000)
print(account.balance)  # 觸發 __get__，輸出 1000

# 更新餘額
account.balance = 500  # 觸發 __set__
print(account.balance)  # 觸發 __get__，輸出 500

# account.balance = -100  # 觸發 __set__，引發 ValueError: 餘額不能為負數

範例解析

• 內部屬性 _balance：用於儲存餘額值，與公開屬性 balance 分開。
• 驗證邏輯：__set__ 方法確保餘額不能為負數。

小結

描述器的核心概念

1. 描述器方法：

• __get__：定義屬性被讀取時的行為。
• __set__：定義屬性被設定時的行為。

2. 內部屬性：使用 _attr 來儲存數據，避免干擾描述器邏輯。

描述器的應用場景

• 數值驗證（如範圍限制）。
• 延遲計算（僅在需要時計算屬性值）。
• 自動更新（屬性變更時執行額外操作）。

描述器為 Python 提供了靈活的屬性管理能力，是面向物件設計中一個不可或缺的高級特性。

透過本文中的基礎範例與應用案例，相信你已經能夠熟練掌握描述器的使用方式並靈活運用在實際專案中！