Python 描述器特殊方法

说明

《Python 教程》持续更新中，提供建议、纠错、催更等加作者微信: gairuo123（备注：pandas教程）和关注公众号「盖若」ID: gairuo。跟作者学习，请进入 Python学习课程。欢迎关注作者出版的书籍：《深入浅出Pandas》和《Python之光》。

在Python中，描述器是一种对象，它实现了一组特殊方法，用于控制属性的访问。

特殊方法

主要的描述器特殊方法包括：

__get__(self, instance, owner)：当从实例或类中访问属性时调用，用于获取属性的值。instance是访问属性的实例，owner是拥有属性的类。
__set__(self, instance, value)：当给属性赋值时调用，用于设置属性的值。instance是访问属性的实例，value是要设置的值。
__delete__(self, instance)：当删除属性时调用，用于删除属性的值。instance是访问属性的实例。

这些特殊方法使得描述器能够控制属性的访问、赋值和删除过程，从而实现属性的定制化行为。

示例

以下是一个简单的示例：

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

    def __get__(self, instance, owner):
        if instance is None:
            return self  # 当从类中访问属性时返回描述器本身
        print(f'Getting attribute {self.name}')
        return instance.__dict__.get(self.name)

    def __set__(self, instance, value):
        print(f'Setting attribute {self.name}')
        instance.__dict__[self.name] = value

    def __delete__(self, instance):
        print(f'Deleting attribute {self.name}')
        del instance.__dict__[self.name]

class MyClass:
    attr = Descriptor('attr')

# 示例用法
obj = MyClass()
obj.attr = 42  # 调用 __set__ 方法
print(obj.attr)  # 调用 __get__ 方法
del obj.attr  # 调用 __delete__ 方法

示例中，Descriptor 类实现了描述器的功能。它的实例被赋值给 MyClass 类的属性 attr，从而控制了该属性的访问、赋值和删除行为。

用途

在Python中，描述器（descriptor）是一种功能强大的工具，它允许你在访问类的属性时自定义属性的获取、设置和删除行为。描述器通常用于实现属性的管理、验证和计算。具体来说，描述器的作用包括：

属性访问控制：描述器允许你控制属性的访问行为，可以根据需要进行验证、转换或计算。例如，你可以使用描述器来限制属性的访问权限，只允许特定的用户或条件访问属性。
属性值验证：你可以使用描述器来验证属性的值是否符合规定的格式或范围。如果属性的值不符合要求，你可以引发异常或执行其他处理逻辑。
属性值计算：描述器允许你在获取属性值时执行计算操作。这对于需要根据其他属性的值来动态计算属性值的情况非常有用。
延迟加载：你可以使用描述器来实现惰性加载，延迟获取属性值直到第一次访问。这对于需要大量计算或资源开销较大的属性特别有用。
实现属性代理：描述器可以用来实现属性代理，允许你在访问属性时将其委托给其他对象。

总之，描述器提供了一种灵活而强大的方式来管理属性的访问行为，使得你可以定制属性的行为以满足特定的需求。描述器是Python中重要的概念之一，广泛应用于各种场景，如ORM框架、数据验证、属性计算等。

区别

自定义属性访问和描述器都可以用于控制属性的访问行为，但它们之间有一些区别：

实现方式：

自定义属性访问通常是通过定义特殊方法（如__getattr__()、__setattr__()、__delattr__()、__getattribute__()）来实现的，这些方法允许你在属性被访问、设置或删除时执行定制化的行为。
描述器是一种特殊的类，它定义了__get__()、__set__()和__delete__()等方法，允许你控制属性的获取、设置和删除行为。描述器通常是作为类的属性来使用，从而影响类的所有实例。

应用范围：

自定义属性访问通常用于对整个类的属性访问行为进行定制，它影响所有实例的属性访问。
描述器通常用于针对特定的属性进行定制，你可以将描述器作为类的属性，并将其应用于需要特殊处理的属性上。

灵活性：

自定义属性访问提供了更大的灵活性，你可以根据需要定义任意的属性访问行为，并且可以在运行时动态修改。
描述器虽然功能强大，但它们在定义时就已经决定了属性的访问行为，而且通常是针对特定的属性进行操作。

用途：

自定义属性访问通常用于实现属性的惰性加载、动态计算、验证等功能。
描述器通常用于实现对属性的验证、计算、延迟加载等功能，并且通常用于库和框架中，用于提供高度定制化的属性行为。

虽然自定义属性访问和描述器都可以用于控制属性的访问行为，但它们在实现方式、应用范围、灵活性和用途上略有不同，因此在选择使用时需要根据具体的需求和场景来决定。

案例

我们将创建一个描述器，用于在 Pandas DataFrame 中计算列的平方值。

import pandas as pd

class SquareDescriptor:
    def __get__(self, instance, owner):
        return instance.map(lambda x: x ** 2)

class DataFrameWithSquare(pd.DataFrame):
    square = SquareDescriptor()

# 创建一个包含数字的 DataFrame
data = {'A': [1, 2, 3, 4, 5]}
df = DataFrameWithSquare(data)

# 添加一个名为 'A_squared' 的列，该列值为 'A' 列的平方
df['A_squared'] = df.square['A']
print(df)
'''
   A  A_squared
0  1          1
1  2          4
2  3          9
3  4         16
4  5         25
'''

我们定义了一个名为 SquareDescriptor 的描述器类，它只有一个 __get__() 方法，用于计算属性的平方值。然后，我们创建了一个自定义的 DataFrame 类 DataFrameWithSquare，它继承自 Pandas 的 DataFrame 类，并将 square 描述器作为其属性。最后，我们创建一个包含数字的 DataFrame，并使用 square 描述器计算了 A 列的平方值，并将结果存储在一个名为 A_squared 的新列中。

参考

https://docs.python.org/zh-cn/3/reference/datamodel.html#implementing-descriptors
https://docs.python.org/zh-cn/3/howto/descriptor.html

< `__dir__()` 对象的属性和方法列表 Python 的特殊方法 `__call__()` 模拟可调用对象 >

更新时间：2024-03-04 12:36:47 标签：python 特殊方法描述器