Python装饰器作为类成员

问题描述

我想为类函数创建一个装饰器,该装饰器将在函数的开头和结尾生成日志消息,并提供特定于运行该函数类实例的信息。我尝试过通过将装饰器创建为类成员来执行此操作,但这不起作用,因为装饰器期望将函数作为第一个参数,但作为类方法,它必须为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])

我不能将其移出类并通过使用@log(self)装饰类函数来将类实例作为参数传递,因为self不存在于函数之外。我该怎么办?

解决方法

您可以在类外定义装饰器,它可以很好地工作,但是您需要在包装器签名中显式引用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,**kwargs)
        logging.info(f"Finished (instance {self.bar}")
        return func(self,**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