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

Question

@property是Python类中一个方便的装饰器，它可以避免使用显式的setter和getter函数。然而，与“传统”的类函数相比，它会带来2-5倍的开销。在我的情况下，当设置属性时，这并不重要，因为与要进行的处理相比，开销微不足道。

然而，当获取属性时，我不需要进行任何处理。它总是返回“return 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。

- Jonas Lindeløv

---

没有这样的方法。一旦使用数据描述符，具有相同名称的实例属性将不会被应用。 - Martijn Pieters

Answer 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'

一个设置器描述符

一个设置器描述符只拦截变量赋值：

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'

- Martijn Pieters

---

非常感谢您的积极回应！最终我使用了__setattr__钩子，因为只有它允许对值进行操作，例如"myInstance.attrib += 5"。我可以补充说明，如果在扩展另一个类的类中设置了__setattr__，它不会被覆盖。就性能而言，与@property setter相比，它增加了约3倍的开销，但获取属性值要快得多，这更为重要。 - Jonas Lindeløv

快速问题。如果您将 self.__dict__['var'] = value 移动到描述符的 __set__ 方法中作为 obj.__dict__['var'] = value，是否有效？ - Mad Physicist

@MadPhysicist：当然！self和obj在那里引用同一个对象。 - Martijn Pieters

更一般地说，您能够执行 obj.__dict__[self.func.__name__] = value 吗？当通过 def 定义注释方法时，我的预期是正确的吗？ - Mad Physicist

同样相关: https://docs.python.org/3.6/whatsnew/3.6.html#pep-487-descriptor-protocol-enhancements - Mad Physicist

Answer 2

property Python 文档：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

- WeizhongTu

---

这并没有解决问题，因为我仍然希望属性是“可获取的”。只是我不想在获取属性时增加任何处理开销。但对于其他目的来说，这是一个有趣的解决方案！ - Jonas Lindeløv

@JonasLindeløv 是的，这可能对某些人有用，所以我在这里发布了我的答案。 - WeizhongTu

有没有办法将其作为装饰器使用？我的意思是，可以使用装饰器而不是使用 var = property(None, var) 吗？ - Gaurang Shah

您可以通过将 var = property(None, var) 替换为 var = property(lambda x: x._var, var) 来使属性可读。 - Nuno André

Answer 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 是使用

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

替代

var = property(None, var)

- Lore

---

var = property(lambda self: getattr(self, '_var', None), var) 可以避免定义 self._var。但通常最好的选择是使用 setter 而不是定义 self._var。这样，如果没有设置值，对象将引发 AttributeError，这是经常期望的行为。 - Nuno André

Answer 4

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

Setter描述符（备选项）

最初的回答的setter描述符可能更方便，如果它自己设置属性：

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

Demo:

>>> f = Foo()
>>> f.var = 'spam'
Setting var!
>>> f.var = 'ham'
Setting var!
>>> f.var
'Ham'
>>> f.var = 'biggles'
Setting var!
>>> f.var
'Biggles'
>>> f.var = 3
ValueError: `var` must be a string

- Nuno André