@property装饰器如何在Python中工作？

properties python decorator python-decorators python-internals

2022-09-05 01:01:55

我想了解内置功能的工作原理。让我感到困惑的是，它也可以用作装饰器，但它仅在用作内置函数时使用参数，而在用作装饰器时则不采用参数。propertyproperty

此示例摘自以下文档：

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的参数是、和 doc 字符串。getxsetxdelx

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

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.setterx.deleter

答案 1

该函数返回一个特殊的描述符对象：property()

>>> 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)

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

下面的序列还使用这些装饰器方法创建一个 full on 属性。

首先，我们创建一些函数和一个只有一个 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

最后但并非最不重要的一点是，该对象充当描述符对象，因此它具有.__get__（），.__set__（）和.__delete__（）方法，以挂接到实例属性中获取，设置和删除：property

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

描述符 Howto 包含该类型的纯 Python 示例实现：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__)

答案 2

文档说它只是创建只读属性的快捷方式。所以

@property
def x(self):
    return self._x

等效于

def getx(self):
    return self._x
x = property(getx)