Python 装饰器作为静态方法

Question

我正在尝试编写一个 python 类，它使用需要实例状态信息的装饰器函数。这是按预期工作的，但是如果我明确地将装饰器设为静态方法，则会收到以下错误：

Traceback (most recent call last):
  File "tford.py", line 1, in <module>
    class TFord(object):
  File "tford.py", line 14, in TFord
    @ensure_black
TypeError: 'staticmethod' object is not callable

为什么？

这是代码：

class TFord(object):
    def __init__(self, color):
        self.color = color

    @staticmethod
    def ensure_black(func):
        def _aux(self, *args, **kwargs):
            if self.color == 'black':
                return func(*args, **kwargs)
            else:
                return None
        return _aux

    @ensure_black
    def get():
        return 'Here is your shiny new T-Ford'

if __name__ == '__main__':
    ford_red = TFord('red')
    ford_black = TFord('black')

    print ford_red.get()
    print ford_black.get()

如果我只是删除行 @staticmethod ，一切正常，但我不明白为什么。它不应该需要 self 作为第一个参数吗？

Answer 1

这不是 staticmethod 应该如何使用的。 staticmethod 对象是返回包装对象的描述符，因此它们仅当作为 classname.staticmethodname 访问时才有效。 示例

class A(object):
    @staticmethod
    def f():
        pass
print A.f
print A.__dict__["f"]

打印

<function f at 0x8af45dc>
<staticmethod object at 0x8aa6a94>

在 A 范围内，您始终会得到后一个对象，该对象不可调用。

我强烈建议将装饰器移至模块范围——它似乎不属于类内部。如果您想将其保留在类中，请不要将其设为staticmethod，而是简单地将其del放在类主体的末尾——这并不是为了在这种情况下可以从类外部使用。

Answer 2

Python 类是在运行时评估类声明的内容后创建的。通过将所有声明的变量和函数分配给一个特殊的字典并使用该字典调用 type.__new__ 来评估该类（请参阅自定义类创建）。

因此，

class A(B):
    c = 1

相当于：

A = type.__new__("A", (B,), {"c": 1})

当您使用 @staticmethod 注解一个方法时，在使用 type.__new__ 创建类之后会发生一些特殊的魔法。在类声明范围内，@staticmethod 函数只是 staticmethod 对象的实例，您无法调用它。装饰器可能应该在同一模块中的类定义上方或在单独的“装饰”模块中声明（取决于您有多少个装饰器）。一般来说，装饰器应该在类之外声明。一个值得注意的例外是属性类（请参阅 properties）。在您的情况下，如果您有类似颜色类的内容，那么在类声明中使用装饰器可能是有意义的：

class Color(object):

    def ___init__(self, color):
        self.color = color

     def ensure_same_color(f):
         ...

black = Color("black")

class TFord(object):
    def __init__(self, color):
        self.color = color

    @black.ensure_same_color
    def get():
        return 'Here is your shiny new T-Ford'

Answer 3

解决方案确实存在！

问题是尝试用作装饰器的静态方法实际上是 staticmethod 对象并且不可调用。

解决方案：staticmethod对象具有方法__get__，它接受任何参数并返回真实方法：python 文档 Python 3.5 及更高版本：

class StaticMethod(object):
    "Emulate PyStaticMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f

    def __get__(self, obj, objtype=None):
        return self.f

我提供的最小解决方案是：

class A():
    def __init__(self):
        self.n =  2

    @staticmethod
    def _returnBaseAndResult(func):
        from functools import wraps
        @wraps(func)
        def wrapper(*args, **kwargs):
            self = args[0]
            response = func(*args, **kwargs)
            return self.n, response
        return wrapper

    @_returnBaseAndResult.__get__('this can be anything')
    def square(self):
        return self.n**2

if __name__ == '__main__':
    a = A()
    print(a.square())

将打印 (2, 4)

Answer 4

ensure_black 返回一个未由 @staticmethod 修饰的 _aux 方法

您可以将非静态方法返回给 static_method

http://docs.python.org/library/functions.html#staticmethod