Python class@property: 使用 setter 但逃避 getter？

在 python 类中,@属性是一个很好的修饰符，它避免使用显式的 setter 和 getter 函数。然而，它的开销是“经典”类函数的2-5倍。在我的例子中，在设置属性的情况下，这样做是可以的，因为与设置时需要执行的处理相比，开销是微不足道的。

但是，当获得属性时，我不需要处理。它永远只是“归还自己的财产”。是否有一种优雅的方式使用 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。

38948 次浏览
小开
最佳答案

在这种情况下不要使用 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'
小开

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
小开

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

Setter 描述符(alt。)

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

演示:

>>> 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
小开

@ WezhongTu 的回答

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)

提交答案