一文帶你搞懂Python中的描述符(Descriptor)

更新時間：2023年06月21日 08:53:20 作者：小小張說故事

Python是一種動態(tài)類型語言，這意味著我們可以在運行時更改對象的結構，這種靈活性有時可能會導致問題，例如我們可能無意中改變了一個屬性的值，為了解決這些問題，Python提供了一個強大的特性：描述符，文中通過代碼介紹的非常詳細,需要的朋友可以參考下

一、什么是描述符？

在Python中，描述符是一個實現了特定協(xié)議的對象。這個協(xié)議包括__get__()、__set__()和__delete__()方法。描述符使我們可以在訪問、設置或刪除屬性時定義額外的行為。

描述符主要用于管理對特定屬性的訪問。當你在類中定義了一個描述符，Python會在你訪問該屬性時使用描述符中定義的行為，而不是直接訪問對象的字典。

讓我們看一個簡單的例子，一個只讀的描述符：

class ReadOnly:
    def __init__(self, initval=None, name='var'):
        self.val = initval
        self.name = name
    def __get__(self, obj, objtype):
        return self.val
    def __set__(self, obj, val):
        raise AttributeError(f"{self.name} is read-only")
class MyClass:
    attr = ReadOnly(10, 'attr')

在這個例子中，ReadOnly是一個描述符。當我們嘗試設置MyClass的attr屬性時，它會拋出一個AttributeError，因為attr是只讀的。

二、描述符的類型

在Python中，有兩種類型的描述符：數據描述符和非數據描述符。

數據描述符是定義了__set__()或__delete__()方法的描述符。當一個數據描述符和一個實例字典中的項有相同的名字時，數據描述符將具有更高的優(yōu)先級。

非數據描述符只定義了__get__()方法。如果實例字典中有相同名字的項，那么這個項將具有更高的優(yōu)先級。

三、使用描述符

描述符通常用于實現高級功能，例如數據驗證、屬性訪問日志記錄、類型檢查等。下面我們將實現一個簡單的類型檢查描述符：

class Typed:
    def __init__(self, name, required_type):
        self.name = name
        self.required_type = required_type
    def __get__(self, instance, owner):
        return instance.__dict__[self.name]
    def __set__(self, instance, value):
        if not isinstance(value, self.required_type):
            raise TypeError(f"Expected {self.required_type}")
        instance.__dict__[self.name] = value
class MyClass:
    attr = Typed('attr', int)

在這個例子中，Typed描述符確保attr屬性總是一個整數。如果我們嘗試設置一個非整數值，就會拋出一個TypeError。

總的來說，描述符提供了一種優(yōu)雅而強大的方式來管理對象的屬性。它們?yōu)閿祿庋b、自定義數據類型、屬性驗證和計算屬性提供了無盡的可能性。理解和使用描述符可以幫助我們寫出更清晰、更靈活和更健壯的代碼。

以下是如何使用這個Typed描述符的例子：

my_obj = MyClass()
my_obj.attr = 10
print(my_obj.attr)  # Output: 10
try:
    my_obj.attr = 'hello'
except TypeError as e:
    print(e)  # Output: Expected <class 'int'>

在這個例子中，你可以看到當我們試圖給attr賦值一個非整數值時，描述符會引發(fā)一個TypeError。

描述符不僅可以用于類型檢查，還可以用于許多其他有用的功能，例如數據綁定、讀寫權限控制、自動更新屬性值等。當你需要在獲取、設置或刪除屬性時執(zhí)行特定的操作時，描述符可能會是一個很好的選擇。

四、描述符的高級用法

描述符的常見用法是實現屬性的數據綁定和數據驗證。然而，描述符還有一些高級的用法，例如延遲計算和函數重載。以下是一個使用描述符實現延遲計算的例子：

class LazyProperty:
    def __init__(self, function):
        self.function = function
        self.name = function.__name__
    def __get__(self, obj, objtype=None):
        if obj is None:
            return self
        value = self.function(obj)
        setattr(obj, self.name, value)
        return value
class MyClass:
    @LazyProperty
    def expensive_computation(self):
        print("Computing...")
        return sum(range(1000000))
my_instance = MyClass()
print(my_instance.expensive_computation)  # Output: Computing... 499999500000
print(my_instance.expensive_computation)  # Output: 499999500000

在這個例子中，expensive_computation屬性在第一次訪問時執(zhí)行一次昂貴的計算，之后的訪問會直接返回已經計算出的結果。