Python 装饰者作为 class 成员

Question

我想为 class 函数创建一个装饰器，它将在函数的开始和结束处生成日志消息，其中包含特定于 class 实例运行函数的信息。我已经尝试通过将装饰器创建为 class 成员来做到这一点，但这不起作用，因为装饰器期望函数作为第一个参数，但作为 class 方法它需要 self。这是我到目前为止写的不起作用的内容：

import functools, logging

logging.basicConfig(format='%(asctime)s - %(levelname)s - %(funcName)s:%(message)s', 
                            datefmt='%Y-%m-%d %I:%M:%S %p',
                            level=logging.DEBUG)

class Foo:
    def __init__(self, bar):
        self.bar = bar
        
    def log(func):
        @functools.wraps(func)
        def wrapper_log(*args, **kwargs):
            logging.info(f"Started (instance {self.bar})")
            func(*args, **kwargs)
            logging.info(f"Finished (instance {self.bar}")
            return func(*args, **kwargs)
        return wrapper_log
        
    @log
    def test(self, a, b, c):
        pass
    
foo = Foo("bar")
foo.test(1, "b", [3, 4])

我无法将其移出 class 并通过使用 @log(self) 修饰 class 函数将 class 实例作为参数传递，因为 self 在函数之外不存在。我该怎么做？

Answer 1

您可以在 class 之外定义装饰器，它会工作得很好，但您需要在包装器签名中明确引用 self。

这项工作的原因是因为函数内部的所有定义仅在调用函数时才被评估。在函数 test 被调用时，它已经绑定到实例并且 self 将存在于它的命名空间中。

import functools, logging

logging.basicConfig(format='%(asctime)s - %(levelname)s - %(funcName)s:%(message)s', 
                            datefmt='%Y-%m-%d %I:%M:%S %p',
                            level=logging.DEBUG)

def log(func):
    @functools.wraps(func)
    def wrapper_log(self, *args, **kwargs):
        logging.info(f"Started (instance {self.bar})")
        func(self, *args, **kwargs)
        logging.info(f"Finished (instance {self.bar}")
        return func(self, *args, **kwargs)
    return wrapper_log

class Foo:
    def __init__(self, bar):
        self.bar = bar
        
    @log
    def test(self, a, b, c):
        pass
    
foo = Foo("bar")
foo.test(1, "b", [3, 4])

这将输出

2020-10-05 11:31:20 PM - INFO - wrapper_log:Started (instance bar)
2020-10-05 11:31:20 PM - INFO - wrapper_log:Finished (instance bar

Python 装饰者作为 class 成员

Python decorator as class member

python

decorator