继承 Python 的`property`

Posted 2023-02-22

【中文标题】继承 Python 的`property`

【英文标题】：Subclassing Python's `property`

【发布时间】：2012-09-06 11:19:12

【问题描述】：

在我的一门课程中，我有许多属性在获取和设置方面执行非常相似的操作。所以我把property的参数抽象成一个工厂函数：

def property_args(name):
    def getter(self):
        # do something
        return getattr(self, '_' + name)
    def setter(self, value)
        # do something
        setattr(self, '_' + name, value)
    return getter, setter

class MyClass(object):
    def __init__(self):
        self._x = None
    x = property(*property_args('x'))  # obviously there's more than one of these IRL

然而，我后来发现property 实际上是一个类，并且对它进行子类化将是完美的。我在文档中找不到任何解释我需要重写的内容（以及__init__ 等的参数签名），而且我真的不想在 C 源代码中寻找它。有谁知道我在哪里可以找到这些信息？

【问题讨论】：

作为参考，C实现可以在这里找到：hg.python.org/cpython/file/tip/Objects/descrobject.c

@nneonneo：谢谢！第 1228 行的大注释块就是答案。如果你想写一个完整的答案，那么我会接受。

很遗憾你可以回答你自己的问题:)

@BurhanKhalid 但 nneonneo 值得称赞！

【参考方案1】：

这是 property() 中代码的纯 Python 等价物：

class Property(object):
    "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__)

【讨论】：

现在在 Python 3 online documentation 中 Descriptor HowTo Guide（由 Raymond 编写）。 （它也在Python 2 documentation。）

【参考方案2】：

property 是 descriptor，因此您必须覆盖（或在新对象上重新实现）__get__(), __set__(), and __delete__() methods。