为什么 Python 中的 @foo.setter 对我不起作用？

Question

所以，我在 Python 2.6 中使用装饰器，但在让它们工作时遇到了一些麻烦。这是我的类文件：

class testDec:

    @property
    def x(self): 
        print 'called getter'
        return self._x

    @x.setter
    def x(self, value): 
        print 'called setter'
        self._x = value

我认为这意味着将 x 视为一个属性，但在 get 和 set 上调用这些函数。所以，我启动了 IDLE 并检查了它：

>>> from testDec import testDec
from testDec import testDec
>>> t = testDec()
t = testDec()
>>> t.x
t.x
called getter
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "testDec.py", line 18, in x
    return self._x
AttributeError: testDec instance has no attribute '_x'
>>> t.x = 5
t.x = 5
>>> t.x
t.x
5

显然，第一次调用按预期工作，因为我调用了 getter，并且没有默认值，它失败了。好的，好的，我明白了。但是，调用assign t.x = 5 似乎创建了一个新属性x，现在getter 不起作用！

我错过了什么？

Answer 1

您需要使用通过从对象派生类来实现的新型类：

class testDec(object):
   ....

那么它应该可以工作了。

Answer 2

您似乎在 python 2 中使用了classic old-style classes。为了使properties 正常工作，您需要改用new-style classes（在python 2 中您必须使用inherit from object）。只需将您的班级声明为MyClass(object)：

class testDec(object):

    @property
    def x(self): 
        print 'called getter'
        return self._x

    @x.setter
    def x(self, value): 
        print 'called setter'
        self._x = value

有效：

>>> k = testDec()
>>> k.x
called getter
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/devel/class_test.py", line 6, in x
    return self._x
AttributeError: 'testDec' object has no attribute '_x'
>>> k.x = 5
called setter
>>> k.x
called getter
5
>>> 

另一个可能导致问题的细节是两个方法需要相同的名称才能使属性起作用。 如果你用这样的不同名称定义 setter，它将不起作用：

@x.setter
def x_setter(self, value):
    ...

另外一件一开始并不完全容易发现的事情是顺序：getter 必须首先定义。如果你先定义 setter，你会得到name 'x' is not defined 错误。

Answer 3

对于偶然发现此异常的其他人，请注意：两个函数必须具有相同的名称。如下命名方法会导致异常：

@property
def x(self): pass

@x.setter
def x_setter(self, value): pass

取而代之的是给这两个方法同名

@property
def x(self): pass

@x.setter
def x(self, value): pass

同样重要的是要注意声明的顺序。 getter 必须在文件中的 setter 之前定义，否则你会得到一个NameError: name 'x' is not defined

Answer 4

如果有人从谷歌来到这里，除了上面的答案，我想补充一点，在基于this answer 从你的类的__init__ 方法调用setter 时需要特别注意 具体来说：

class testDec(object):                                                                                                                                            

    def __init__(self, value):
        print 'We are in __init__'
        self.x = value # Will call the setter. Note just x here
        #self._x = value # Will not call the setter

    @property
    def x(self):
        print 'called getter'
        return self._x # Note the _x here

    @x.setter
    def x(self, value): 
        print 'called setter'
        self._x = value # Note the _x here

t = testDec(17)
print t.x 

Output:
We are in __init__
called setter
called getter
17