python 属性访问器 (property)

python 属性访问器 (property)

Python 中的属性访问器是 property 类型，提供了一种跟属性值相关的函数（getter、setter、deleter），它们以同样的方式访问和修改属性的值。

属性访问器可以通过以下两种方式创建：

• 使用 property() 内置函数创建；
• 在类定义中使用特殊方法创建。

下面具体介绍它们的用法：

使用 property() 内置函数创建

class MyClass:
    def __init__(self):
        self._score = 0

    def get_score(self):
        return self._score

    def set_score(self, value):
        if not isinstance(value, int):
            raise ValueError('Score must be an integer!')
        if value < 0 or value > 100:
            raise ValueError('Score must be between 0 and 100!')
        self._score = value

    def del_score(self):
        del self._score

    score = property(fget=get_score, fset=set_score, fdel=del_score, doc='This is a score property.')Copy

属性访问器通过 property() 函数创建，该函数的三个可选参数是：

• fget：获取函数，用于获取属性值；
• fset：设置函数，用于设置属性值；
• fdel：删除函数，用于删除属性。

在上面的示例代码中，score 便是一个属性访问器，其 fget、fset 和 fdel 分别为 get_score()、set_score() 和 del_score() 函数。当使用 score 访问该属性时，便会调用对应的方法。

在类定义中使用特殊方法创建

class MyClass:
    def __init__(self):
        self._score = 0

    @property
    def score(self):
        return self._score

    @score.setter
    def score(self, value):
        if not isinstance(value, int):
            raise ValueError('Score must be an integer!')
        if value < 0 or value > 100:
            raise ValueError('Score must be between 0 and 100!')
        self._score = value

    @score.deleter
    def score(self):
        del self._scoreCopy

在上面的代码中，我们使用了装饰器的方式来创建属性访问器。这种方式实际上是基于特殊方法来实现的，其中：

• @property 装饰器实际上是 getter 方法的快捷方式，在类定义中定义一个属性方法，并将其装饰为 @property，这样就可以像访问普通属性一样访问该方法，相当于使用了属性访问器，可读性更好。
• @score.setter 装饰器实际上是 setter 方法的快捷方式，用于为属性方法添加一个 setter 方法，并返回属性本身。
• @score.deleter 装饰器实际上是 deleter 方法的快捷方式，用于为属性方法添加一个 deleter 方法，并返回属性本身。

使用 property() 内置函数和特殊方法创建属性访问器的本质是相同的，都是通过绑定方法实现。使用属性访问器可以方便地控制属性的读写权限，增加类型检查和输入校验的可能性，还可以在属性读取和修改时实现一些额外的操作。

__get__ 和 __set__

一个类只要实现了__get__，__set__，__delete__中任意一个方法，我们就可以叫它描述器(descriptor)。如果只定义了__get__我们叫非资料描述器(non-data descriptor)，如果__set__，__delete__任意一个/或者同时出现，我们叫资料描述器(data descriptor)。

首先明确一点，拥有这个方法的类，必须产生一个实例，并且这个实例是另外一个类的类属性

也就是说拥有这个方法的类，那么它的实例应该属于另外一个类/对象的一个属性。 直接看代码吧：

class ActiveQuery:
    def __set__(self, instance):
        return
    def __get__(self, instance, owner):
        return owner.query.filter_by(is_deleted=False)
    
class IsDelBaseEntity(BaseEntity):
    __abstract__ = True
    is_deleted = Column(Boolean, default=False, comment="是否删除")
    active_query = ActiveQuery()

• __set__(self, instance) 是 setter 方法，如果一个属性的访问器定义了 __set__ 方法，则表示该属性只能被赋值一次，赋值后就无法再修改。在这个例子中，为了防止无法控制的重复修改，实现了一个空的 __set__ 方法，直接返回，即不允许对属性进行修改。
• __get__(self, instance, owner) 是 getter 方法，它可以带有两个参数：instance 和 owner。其中，instance 表示属性所属的实例对象，owner 表示属性所属的类。在这个例子中，返回一个经过过滤的查询集合。
• 代码以sqlalchemy 中定义模型类为列，所有继承 IsDelBaseEntity 类 的 类生成的对象都会有一个 .active_query 方法, 返回值就是 owner.query.filter_by(is_deleted=False) owner 即 对象本身(self)