Python装饰器作为类成员

我想为类函数创建一个decorator，它将在函数的开始和结束处生成日志消息，其中包含特定于运行该函数的类实例的信息。我已经尝试通过将decorator创建为类成员来实现这一点，但这不起作用，因为decorator希望函数作为第一个参数，但作为类方法，它必须是

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

不存在于函数之外。我该怎么做呢？

您可以在类之外定义decorator，它可以正常工作，但是您需要在包装签名中明确地引用

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

---

您可以在类之外定义decorator，它可以正常工作，但是您需要在包装签名中明确地引用

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

---

您正在调用

func

两次-在日志和返回之间~为什么不将日志调用移到

包装器\u log

函数之外？我也做过类似的工作。虽然我已经创建了一个没有functool.wrapps（）的装饰程序~。您可能希望保存返回值并返回您正在调用的

func

两次-在日志之间，并使用return~为什么不将日志调用移到

包装器\u log

函数之外？我也做过类似的工作。虽然我已经创建了一个没有functool.wrapps（）的装饰程序~。您可能希望保存返回值并返回该值，谢谢！我注意到日志格式中的%（funcName）显示的是包装函数的名称，而不是类中的函数。我认为@functools.wrapps（func）应该保留原始函数的元数据以供内省。你知道如何解决这个问题吗？这是日志模块的一个错误，它使用了错误的名称。

包装

功能完成其工作。请参考此答案了解更多详细信息，谢谢！我注意到日志格式中的%（funcName）显示的是包装函数的名称，而不是类中的函数。我认为@functools.wrapps（func）应该保留原始函数的元数据以供内省。你知道如何解决这个问题吗？这是日志模块的一个错误，它使用了错误的名称。

包装

功能完成其工作。请参考此答案了解更多详细信息