Python - 元类装饰器 - 如何使用 @classmethod

Question

我有以下 Python 元类，它为每个类添加了一个 deco_with_args 装饰器：

def deco_with_args(baz):
    def decorator(func):
        ...
        return func
    return decorator

class Foo(type):
    def __prepare__(name, bases):    
        return {'deco_with_args': deco_with_args}

这让我可以像这样使用装饰器：

class Bar(metaclass=Foo):
    @deco_with_args('baz')
    def some_function(self):
        ...

如何使deco_with_args 装饰器的行为类似于@classmethod，以便我可以从decorator 函数中访问Bar 类（或任何其他类）？

我尝试在deco_with_args 函数上使用@classmethod，但没有成功。

Answer 1

您可以使用descriptor protocol 来捕获您对方法的调用并将类作为参数添加：

def another_classmethod(baz):

  class decorator:
    def __init__(self, func):
      self.func = func
    def __get__(self, instance, owner):
      def new_call(*args, **kwargs):
        print(baz, self.func(owner, *args, **kwargs))
      return new_call

  return decorator


class Bar():
    @another_classmethod('baz')
    def some_function(cls):
        return f"test {cls.__name__}"

Bar.some_function()

这打印：

baz test Bar

这里的主要“技巧”是调用Bar.some_function()时的协议是先调用__get__，然后在__get__返回的函数上调用__call__。

请注意，__get__ 也会在您执行 Bar.some_function 时被调用，这就是在像 @property 这样的装饰器中使用的。

有一点需要注意，在使用 classmethod 时，您不应该将第一个参数命名为 self，因为它会造成混淆（这会使人们认为第一个参数是实例而不是类对象/类型）。

Answer 2

@classmethod 对装饰器没有任何用处，因为它不是通过类或实例调用的。 classmethod 是descriptor，描述符只对属性访问有效。换句话说，只有像 @Bar.deco_with_args('baz') 这样调用装饰器才会有帮助。

下一个问题是在执行装饰器时类还不存在。 Python 在创建类之前 执行函数体中的所有代码。所以无法访问deco_with_args或decorator中的类。

Answer 3

您的问题有两种解释 - 如果您需要 cls 在您的示例中名为 decorator 的函数被调用时可用（即您需要您的修饰方法成为类方法），它本身就足够了转化为类方法：

def deco_with_args(baz):
    def decorator(func):
        ...
        return classmethod(func)
    return decorator

第二个是如果你需要cls 在deco_with_args 本身被调用时可用，在创建装饰函数本身时，在类创建时。现在被列为接受的答案列出了一个简单的问题：运行类主体时该类还不存在，因此，在解析类结束时没有办法你可以拥有知道类本身的方法。

但是，与该答案试图暗示的不同，这不是真正的交易。您所要做的就是在类创建过程结束时懒惰地运行您的装饰器代码（需要cls 的代码）。你已经有了一个元类设置，所以这样做几乎是微不足道的，只需在你的装饰器代码周围添加另一个可调用层：

def deco_with_args(baz):
    def outter_decorator(func):
        def decorator(cls):
            # Code that needs cls at class creation time goes here
            ...

            return func
        return decorator
    outter_decorator._deco_with_args = True
    return outter_decorator

class Foo(type):
    def __prepare__(name, bases):    
        return {'deco_with_args': deco_with_args}

    def __init__(cls, cls_name, bases, namespace, **kwds):
        for name, method in cls.__dict__.items():
            if getattr(method, '_deco_with_args', False):
                cls.__dict__[name] = method(cls)

        super().__init__(cls_name, bases, namespace, **kwds)

当然，这将在类主体执行完成之后运行，但在运行 class 之后的任何其他 Python 语句之前。 如果您的装饰器会影响在类主体内部执行的其他元素，您需要做的就是将它们包装起来以保证延迟执行。