如何理解 Python 的 Descriptor

Python的Descriptor（描述符）是一种实现了特定协议的类，该协议包括__get__()、__set__()和__delete__()方法。 通过这些方法，描述符允许开发者自定义对象的属性访问机制。在描述符的帮助下，可以更精细地控制属性的访问、设置和删除。其中__get__()方法是描述符协议中的读取器，它定义了当访问某个属性时要执行的操作。

描述符的核心在于它们提供了一种方法，让你可以重新定义属性的取值(get)、赋值(set)和删除(delete)操作。这三个操作对应于对象的三个特殊方法，分别是：__get__、__set__和__delete__。当一个描述符被绑定到了对象的类上时，Python 会自动管理调用这些方法的过程。

一、描述符的种类

描述符通常基于它们实现的方法被分为两大类：数据描述符和非数据描述符。

数据描述符

数据描述符定义了__set__()或__delete__()方法。 相对而言，它们有更高的优先级。当对象的属性和描述符同名时，如果该描述符是数据描述符，它将覆盖对象的属性。

非数据描述符

非数据描述符仅定义了__get__()方法。当访问该属性时，若实例中存在同名的实例变量，则会优先访问实例变量而不是调用描述符的__get__()方法。

二、描述符的使用

实现一个描述符

为了实现一个描述符，你需要定义一个类，并至少实现上述三个魔术方法中的一个。

class Descriptor:

    def __init__(self, initial_value=None, name='var'):
        self.value = initial_value
        self.name = name
    def __get__(self, obj, objtype):
        print('Getting:', self.name)
        return self.value
    def __set__(self, obj, value):
        print('Setting:', self.name, 'to', value)
        self.value = value
    def __delete__(self, obj):
        print('Deleting:', self.name)
        del self.value

使用一个描述符管理属性访问可以帮助实现一些复杂的功能，比如类型检查、值验证等。

在类中使用描述符

描述符必须作为类属性来使用。这意味着它们必须绑定到类的属性名上，而不是实例的属性名。

class MyClass:

    descriptor = Descriptor(initial_value='my descriptor', name='descriptor')

三、描述符的底层机制

描述符的属性访问规则

Python在属性的访问上实现了一个称为“描述符协议”的底层机制。这个协议定义了如何通过__get__、__set__和__delete__方法来实现属性的访问控制。

类属性访问过程

当通过实例访问属性时，如果该属性是一个描述符，Python会优先调用描述符的__get__方法。如果属性访问涉及写入或删除操作，且相应的__set__或__delete__方法被定义，则会调用这些方法。

四、描述符的实际应用

属性验证

描述符可以用来确保给属性赋值时的类型检查或值验证，强制确保数据的准确性。

class TypedAttribute:

    def __init__(self, name, expected_type):
        self.name = name
        self.expected_type = expected_type
    def __get__(self, obj, objtype):
        return obj.__dict__.get(self.name)
    def __set__(self, obj, value):
        if not isinstance(value, self.expected_type):
            rAIse TypeError("Expected " + str(self.expected_type))
        obj.__dict__[self.name] = value

通过使用TypedAttribute，我们现在可以创建带有类型验证的类属性。

用于Lazy属性的描述符

描述符可以用来创建仅在首次访问时计算其值的属性，这称为延迟属性或懒加载属性。这可以优化性能，避免不必要的计算。

class LazyProperty:

    def __init__(self, method):
        self.method = method
        self.method_name = method.__name__
    def __get__(self, obj, cls):
        if not obj:
            return None
        value = self.method(obj)
        setattr(obj, self.method_name, value)
        return value

LazyProperty描述符允许将属性的创建推迟到它实际被访问的时候。

五、描述符的优缺点

描述符的优点在于它们提供了一种强大的方式来重用属性访问逻辑，并且可以在不同的属性和不同的类之间共享这些逻辑。然而，它们也可能导致代码变得更加复杂，需要更多的计划和设计来正确实现。

描述符是实现Python魔术方法的高级应用，适用于构建框架或者库等要求高度自定义属性行为的场合。了解描述符，不仅能帮助你更好地理解Python的一些内部工作机制，还能让你在面对复杂的编程问题时，拥有更多的解决方案。

相关问答FAQs：

Q1: Python 的 Descriptor 是什么？怎样理解它？

A1: Python 的 Descriptor 是一种特殊的对象，它用于控制属性的访问和赋值行为。通过使用 Descriptor，我们可以定义属性的读取和修改行为，以及更细粒度地控制属性的访问权限。可以将 Descriptor 看作是 Python 对象的一种装饰器，它在属性访问、赋值时提供了自定义的行为。

Q2: Descriptor 在 Python 中有什么作用？有什么优点？

A2: Descriptor 在 Python 中的作用非常重要。首先，它使得我们能够在属性访问的过程中添加额外的逻辑，例如类型检查、数据验证等。其次，Descriptor 提供了细粒度的属性控制，让我们可以更加灵活地管理属性的访问权限。此外，Descriptor 还可以用于实现属性的延迟加载、属性的缓存和计算等功能。

Q3: 如何编写自定义的 Descriptor？能举个例子吗？

A3: 要编写自定义的 Descriptor，首先需要定义一个类，并实现 __get__()、__set__() 和 __delete__() 这三个特殊的方法。__get__() 方法用于获取属性值，__set__() 方法用于设置属性值，__delete__() 方法用于删除属性。可以根据需要在这些方法中添加额外的逻辑。

以下是一个简单的例子，演示了一个计算属性的实现：

class Square:
    def __get__(self, instance, owner):
        return instance.__dict__[self.name] ** 2
    
    def __set__(self, instance, value):
        instance.__dict__[self.name] = value

class Rectangle:
    length = Square()
    width = Square()
    
    def __init__(self, length, width):
        self.length = length
        self.width = width

rect = Rectangle(5, 3)
print(rect.length)  # 输出25
print(rect.width)   # 输出9

在上述例子中，Square 类是一个自定义的 Descriptor，它将属性的值平方后返回。Rectangle 类中的 length 和 width 属性都使用了 Square 描述器。当我们访问这些属性时，会触发 Square 描述器的 __get__() 方法，从而返回计算后的属性值。

最后建议，企业在引入信息化系统初期，切记要合理有效地运用好工具，这样一来不仅可以让公司业务高效地运行，还能最大程度保证团队目标的达成。同时还能大幅缩短系统开发和部署的时间成本。特别是有特定需求功能需要定制化的企业，可以采用我们公司自研的企业级低代码平台：织信Informat。 织信平台基于数据模型优先的设计理念，提供大量标准化的组件，内置AI助手、组件设计器、自动化（图形化编程）、脚本、工作流引擎（BPMN2.0）、自定义API、表单设计器、权限、仪表盘等功能，能帮助企业构建高度复杂核心的数字化系统。如ERP、MES、CRM、PLM、SCM、WMS、项目管理、流程管理等多个应用场景，全面助力企业落地国产化/信息化/数字化转型战略目标。 版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们微信：Informat_5 处理，核实后本网站将在24小时内删除。