python中描述符的作用-CFANZ编程社区

理解 Python 中描述符的作用

在 Python 中，描述符是一种允许你控制对象属性访问的一种机制。描述符可以通过为对象提供一种自动化和复用的方式来实现属性的获取、设置、删除等操作。本文将帮助新手理解描述符的基本概念、流程和实现方法。

描述符的流程

在实现描述符时，我们可以将其大致划分为以下几个步骤：

步骤	描述
1	创建一个描述符类，定义 `__get__`、`__set__`、`__delete__` 方法。
2	在目标类中定义一个属性并将其设置为描述符的实例。
3	通过实例化目标类来测试描述符的功能。

步骤详解

第一步：创建描述符类

首先，你需要创建一个描述符类。这个类需要实现至少一个特殊的方法，通常是 __get__ 和 __set__。

class Descriptor:
    def __init__(self, name=None):
        self.name = name

    def __get__(self, instance, owner):
        """从实例中获取属性值"""
        print(f"Getting value of {self.name}")
        return instance.__dict__.get(self.name)

    def __set__(self, instance, value):
        """设置属性值"""
        print(f"Setting value of {self.name} to {value}")
        instance.__dict__[self.name] = value

    def __delete__(self, instance):
        """删除属性"""
        print(f"Deleting value of {self.name}")
        del instance.__dict__[self.name]

代码解释：

__init__: 初始化描述符实例的名称。
__get__: 当属性被访问时自动调用，返回属性的当前值。
__set__: 当属性值被设置时自动调用。
__delete__: 当属性被删除时自动调用。

第二步：在目标类中使用描述符

接下来，我们在目标类中定义属性并将其设置为描述符实例。

class MyClass:
    attr = Descriptor("attr")

    def __init__(self, value):
        self.attr = value  # 触发 Descriptor 的 __set__ 方法

代码解释：

attr 是我们在 MyClass 中定义的一个属性，被赋值为 Descriptor 的实例。
在 __init__ 方法中，我们给 attr 赋值，这将触发 Descriptor 的 __set__ 方法。

第三步：测试描述符功能

最后，我们可以实例化 MyClass 来查看描述符的行为。

if __name__ == "__main__":
    obj = MyClass(10)  # 输出: Setting value of attr to 10
    print(obj.attr)    # 输出: Getting value of attr   => 10
    obj.attr = 20      # 输出: Setting value of attr to 20
    print(obj.attr)    # 输出: Getting value of attr   => 20
    del obj.attr       # 输出: Deleting value of attr

代码解释：

MyClass(10) 会调用 __init__ 方法并触发 __set__。
访问 obj.attr 调用 __get__ 来获取属性值。
修改 obj.attr 或删除 obj.attr 分别触发 __set__ 和 __delete__ 方法。

使用 Mermaid 绘制序列图

以下是描述符调用过程的序列图：

sequenceDiagram
    participant User
    participant Descriptor as Desc
    participant MyClass as MC

    User->>MC: Create instance (MyClass(10))
    MC->>Desc: __set__(10)
    Desc-->>MC: Attribute set
    User->>MC: Access obj.attr
    MC->>Desc: __get__()
    Desc-->>User: Return attribute value
    User->>MC: Modify obj.attr (20)
    MC->>Desc: __set__(20)
    Desc-->>MC: Value updated
    User->>MC: Delete obj.attr
    MC->>Desc: __delete__()
    Desc-->>MC: Attribute deleted