在类中使用装饰器

Question

我正在尝试在我的应用中实现一个简单的日志记录功能。

class messages(object):

    # Implement decorator here
    def on(self):
        def wrapper():
            # Do something here
        return wrapper

    def off(self):
        def wrapper():
            # Do something here
        return wrapper


class website(object):

    @messages.on #This line can be switched on/off
    def login(self):
        # Do a whole bunch of stuff here
        self.response = "[+] Login Succeeded!"

website = website()
website.login() # prints self.response based on @messages.on/off

但我不确定我需要在我的装饰器中应用什么。我曾尝试创建实例并添加参数，但大多会收到 TypeError。我对装饰师相当陌生。任何帮助将不胜感激，我希望下次记住这一点。

Answer 1

1. 如果你只想让 Dog 吠叫（如示例中所示），则无需启用装饰器

   class Dog(object):
       def __init__(self):
           self.sound = "Woof!"
   
       def bark(self):
           return self.sound
   

2. 如果你想为类中的某些函数启用日志记录，这里有一段代码，在 cmets 中有解释

   from functools import wraps
   
   class Utilities(object):
   
       @staticmethod  # no default first argument in logger function
       def logger(f):  # accepts a function
           @wraps(f)  # good practice https://docs.python.org/2/library/functools.html#functools.wraps
           def wrapper(self, *args, **kwargs):  # explicit self, which means this decorator better be used inside classes only
               print("Before:", self.sound)
               result = f(self, *args, **kwargs)
               print("After:", self.sound)
               return result
           return wrapper
   
   
   class Dog(object):
       def __init__(self):
           self.sound = "Woof!"
   
       @Utilities.logger
       def run(self):
           """Perform running movement"""
           print("Running")
   

例子：

>>> dog = Dog()
>>> dog.run()
Before: Woof!
Running
After: Woof!

尽管毕竟没有必要在 Utilities 类中存储装饰器功能 - 最好有一个名为 utils 的单独模块（文件）并将装饰器作为独立函数放在那里

Answer 2

以下是您可以使用的示例装饰器：

class Utilities:

    @staticmethod
    def add_logger(func):
        def wrapped_func(*args, **kwargs):
            # Sample logic, feel free to update this
            try:
                func_response = func(*args, **kwargs)
            except:
                print 'I am error handled by logger'
                func_response = None
            return func_response
        return wrapped_func

现在让我们定义你的类：

class Dog(object):

    @Utilities.add_logger 
    def bark(self):
        print 'In bark'

    @Utilities.add_logger 
    def my_error_function(self):
        print 'In my_error_function'
        raise Exception  # <--- Raises Exception

现在，让我们看看它是如何工作的：

>>> dog = Dog()
>>> dog.bark()
In bark
>>> dog.my_error_function()
In my_error_function
I am error handled by logger  # Content from logger in case of exception

注意：你不应该在这里创建一个class 来存储实用函数。创建一个单独的实用程序文件并在那里编写此类函数。

没有类，你的装饰器应该是这样的（比如说在 utility.py 中）：

def add_logger(func):
    def wrapped_func(*args, **kwargs):
        # Sample logic, feel free to update this
        try:
            func_response = func(*args, **kwargs)
        except:
            print 'I am error handled by logger'
            func_response = None
        return func_response
    return wrapped_func

要使用它，只需这样做：

import utility

class Dog(object):

    @utility.add_logger
    def bark(self):
        print 'In bark'