python - @property 装饰器在 Python 中是如何工作的？

Question

我想了解内置函数 property 的工作原理。让我困惑的是 property 也可以用作装饰器，但它只在用作内置函数时才带参数，而不是在用作装饰器时。

这个例子来自 documentation :

class C:
    def __init__(self):
        self._x = None

    def getx(self):
        return self._x
    def setx(self, value):
        self._x = value
    def delx(self):
        del self._x
    x = property(getx, setx, delx, "I'm the 'x' property.")

property 的参数是 getx、setx、delx 和一个文档字符串。

在下面的代码中，property 被用作装饰器。它的对象是 x 函数，但在上面的代码中，参数中没有对象函数的位置。

class C:
    def __init__(self):
        self._x = None

    @property
    def x(self):
        """I'm the 'x' property."""
        return self._x

    @x.setter
    def x(self, value):
        self._x = value

    @x.deleter
    def x(self):
        del self._x

在这种情况下，x.setter 和 x.deleter 装饰器是如何创建的？

Answer 1

property() 函数返回一个特殊的 descriptor object :

>>> property()
<property object at 0x10ff07940>

正是这个对象有额外的方法:

>>> property().getter
<built-in method getter of property object at 0x10ff07998>
>>> property().setter
<built-in method setter of property object at 0x10ff07940>
>>> property().deleter
<built-in method deleter of property object at 0x10ff07998>

这些也充当装饰器。它们返回一个新的属性对象:

>>> property().getter(None)
<property object at 0x10ff079f0>

这是旧对象的副本，但其中一个功能已被替换。

请记住，@decorator 语法只是语法糖；语法:

@property
def foo(self): return self._foo

其实和

的意思是一样的

def foo(self): return self._foo
foo = property(foo)

所以 foo 函数被替换为 property(foo)，我们在上面看到是一个特殊的对象。然后，当您使用 @foo.setter() 时，您所做的是调用我在上面向您展示的 property().setter 方法，该方法返回属性，但这次将 setter 函数替换为修饰方法。

以下序列还通过使用这些装饰器方法创建了一个完整的属性。

首先我们用一个 getter 创建一些函数和一个 property 对象:

>>> def getter(self): print('Get!')
... 
>>> def setter(self, value): print('Set to {!r}!'.format(value))
... 
>>> def deleter(self): print('Delete!')
... 
>>> prop = property(getter)
>>> prop.fget is getter
True
>>> prop.fset is None
True
>>> prop.fdel is None
True

接下来我们使用.setter()方法添加一个setter:

>>> prop = prop.setter(setter)
>>> prop.fget is getter
True
>>> prop.fset is setter
True
>>> prop.fdel is None
True

最后我们用 .deleter() 方法添加一个删除器:

>>> prop = prop.deleter(deleter)
>>> prop.fget is getter
True
>>> prop.fset is setter
True
>>> prop.fdel is deleter
True

最后但同样重要的是，property 对象充当 descriptor object , 所以它有 .__get__() , .__set__()和 .__delete__() Hook 实例属性获取、设置和删除的方法:

>>> class Foo: pass
... 
>>> prop.__get__(Foo(), Foo)
Get!
>>> prop.__set__(Foo(), 'bar')
Set to 'bar'!
>>> prop.__delete__(Foo())
Delete!

描述符方法包括 pure Python sample implementation property() 类型的:

class Property:
    "Emulate PyProperty_Type() in Objects/descrobject.c"

    def __init__(self, fget=None, fset=None, fdel=None, doc=None):
        self.fget = fget
        self.fset = fset
        self.fdel = fdel
        if doc is None and fget is not None:
            doc = fget.__doc__
        self.__doc__ = doc

    def __get__(self, obj, objtype=None):
        if obj is None:
            return self
        if self.fget is None:
            raise AttributeError("unreadable attribute")
        return self.fget(obj)

    def __set__(self, obj, value):
        if self.fset is None:
            raise AttributeError("can't set attribute")
        self.fset(obj, value)

    def __delete__(self, obj):
        if self.fdel is None:
            raise AttributeError("can't delete attribute")
        self.fdel(obj)

    def getter(self, fget):
        return type(self)(fget, self.fset, self.fdel, self.__doc__)

    def setter(self, fset):
        return type(self)(self.fget, fset, self.fdel, self.__doc__)

    def deleter(self, fdel):
        return type(self)(self.fget, self.fset, fdel, self.__doc__)