Python 类@property：使用setter 但避开getter？

Posted 2023-02-22

技术标签:

【中文标题】Python 类@property：使用setter 但避开getter？【英文标题】：Python class @property: use setter but evade getter? 【发布时间】：2013-07-08 16:47:34 【问题描述】：

在 python 类中，@property 是一个很好的装饰器，它避免使用显式的 setter 和 getter 函数。但是，它的开销是“经典”类函数的 2-5 倍。在我的情况下，这在设置属性的情况下是相当好的，与设置时需要完成的处理相比，开销是微不足道的。

但是，我在获得房产时不需要处理。它始终只是“返回 self.property”。有没有一种优雅的方式来使用 setter 而不是使用 getter，而不需要使用不同的内部变量？

为了说明，下面的类有属性“var”，它引用内部变量“_var”。调用“var”比调用“_var”需要更长的时间，但如果开发人员和用户都可以只使用“var”而不必跟踪“_var”，那就太好了。

class MyClass(object):
  def __init__(self):
    self._var = None

  # the property "var". First the getter, then the setter
  @property
  def var(self):
    return self._var
  @var.setter
  def var(self, newValue):
    self._var = newValue
    #... and a lot of other stuff here

  # Use "var" a lot! How to avoid the overhead of the getter and not to call self._var!
  def useAttribute(self):
    for i in xrange(100000):
      self.var == 'something'

对于那些感兴趣的人，在我的电脑上调用“var”平均需要 204 ns，而调用“_var”平均需要 44 ns。

【问题讨论】：

不，没有这样的方法。一旦使用数据描述符，同名的实例属性就不得到尊重。 【参考方案1】：

在这种情况下不要使用property。 property 对象是一个数据描述符，这意味着对 instance.var 的任何访问都将调用该描述符，Python 永远不会在实例本身上查找属性。

您有两个选择：使用 .__setattr__() 挂钩或构建仅实现 .__set__ 的描述符。

使用`.setattr()` 钩子

class MyClass(object):
    var = 'foo'

    def __setattr__(self, name, value):
        if name == 'var':
            print "Setting var!"
            # do something with `value` here, like you would in a
            # setter.
            value = 'Set to ' + value
        super(MyClass, self).__setattr__(name, value)

现在在读取 .var 时使用普通属性查找，但在分配给 .var 时会调用 __setattr__ 方法，让您拦截 value 并根据需要进行调整。

演示：

>>> mc = MyClass()
>>> mc.var
'foo'
>>> mc.var = 'bar'
Setting var!
>>> mc.var
'Set to bar'

setter 描述符

setter 描述符只会拦截变量赋值：

class SetterProperty(object):
    def __init__(self, func, doc=None):
        self.func = func
        self.__doc__ = doc if doc is not None else func.__doc__
    def __set__(self, obj, value):
        return self.func(obj, value)

class Foo(object):
    @SetterProperty
    def var(self, value):
        print 'Setting var!'
        self.__dict__['var'] = value

注意我们需要如何分配给实例.__dict__ 属性以防止再次调用setter。

演示：

>>> f = Foo()
>>> f.var = 'spam'
Setting var!
>>> f.var = 'ham'
Setting var!
>>> f.var
'ham'
>>> f.var = 'biggles'
Setting var!
>>> f.var
'biggles'

【讨论】：

非常感谢您的好评！我最终使用了 setattr 钩子，因为只有它允许对“myInstance.attrib += 5”之类的值进行操作。我可以补充一点，如果 setattr 设置在扩展另一个类的类中，则它不会被覆盖。就性能而言，与@property setter 相比，它增加了大约 x3 的开销，但当然，获取属性值要快得多，这一点更为重要。快速提问。如果您将self.__dict__['var'] = value 移动到描述符的__set__ 方法中作为obj.__dict__['var'] = value，它会起作用吗？ @MadPhysicist：当然！ self 和 obj 在那里引用同一个对象。更一般地说，你能做到obj.__dict__[self.func.__name__] = value吗？每当通过 def 定义带注释的方法时，我是否期望它能够正常工作？也相关：docs.python.org/3.6/whatsnew/…【参考方案2】：

propertypython 文档：https://docs.python.org/2/howto/descriptor.html#properties

class MyClass(object):
    def __init__(self):
        self._var = None

    # only setter
    def var(self, newValue):
        self._var = newValue

    var = property(None, var)


c = MyClass()
c.var = 3
print ('ok')
print (c.var)

输出：

ok
Traceback (most recent call last):
  File "Untitled.py", line 15, in <module>
    print c.var
AttributeError: unreadable attribute

【讨论】：

这并不能解决问题，因为我仍然希望属性是“可获取的”。只是我不想在获取它时产生任何处理开销。但用于其他目的的有趣解决方案！ @JonasLindeløv 是的，这可能对某人有用，所以我在这里发布了我的答案。有什么办法可以将它用作装饰器。我的意思不是使用 var = property(None, var) ，而是使用装饰器 @WeizhongTu 您可以通过将var = property(None, var) 替换为var = property(lambda x: x._var, var) 来使属性可读。【参考方案3】：

@WeizhongTu 的回答

class MyClass(object):
    def __init__(self):
        self._var = None

    # only setter
    def var(self, newValue):
        self._var = newValue

    var = property(None, var)


c = MyClass()
c.var = 3
print ('ok')
print (c.var)

很好，除了使变量无法获取的事实......

一个类似的解决方案，但保留 getter 是 with

var = property(lambda self: self._var, var)

而不是

var = property(None, var)

【讨论】：

var = property(lambda self: getattr(self, '_var', None), var) 使您不必定义self._var。但通常，最好的选择可能是使用你的 setter 而不是定义self._var。这样，如果没有设置任何值，对象将引发AttributeError，这通常是意料之中的。【参考方案4】：

如果它自己设置属性，接受的答案的设置器描述符可能会更方便：

setter 描述符（替代）

class setter:
    def __init__(self, func, doc=None):
        self.func = func
        self.__doc__ = doc or func.__doc__

    def __set__(self, obj, value):
        obj.__dict__[self.func.__name__] = self.func(obj, value)

class Foo:
    @setter
    def var(self, value):
        print('Setting var!')

        # validations and/or operations on received value
        if not isinstance(value, str):
            raise ValueError('`var` must be a string')
        value = value.capitalize()

        # returns property value
        return value

演示：