Python装饰器函数：如何使用装饰器修饰函数并添加一些功能？

Python中的装饰器是一个重要的概念，它可以被使用来修改其他函数的功能。它是一个非常强大的工具，可以使我们以更加简洁和优雅的方式来编写代码。在本文中，我们将深入探讨如何使用装饰器来修饰函数并添加一些功能。

首先，让我们来看看一个简单的例子，演示如何使用装饰器来添加一些额外的功能。假设我们有一个函数，它是用来计算两个数的和的。

def add_numbers(a, b):
    return a + b

现在，假设我们想要记录每次函数被调用的时间戳。我们可以使用一个装饰器来实现这个功能。这个装饰器本身就是一个函数，它接收一个函数作为参数，然后返回一个新的函数，这个新的函数将执行原始函数，并在执行后记录时间戳。

import time

def timestamp_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f'Function {func.__name__} was called at {start_time} and ended at {end_time}')
        return result
    return wrapper

@timestamp_decorator
def add_numbers(a, b):
    return a + b

print(add_numbers(1, 2)) # Output: Function add_numbers was called at 1635698008.730528 and ended at 1635698008.730528 3

在这个例子中，我们定义了一个叫做timestamp_decorator的装饰器函数。这个函数接收一个函数作为参数，然后返回一个新的函数——wrapper函数。wrapper函数将首先记录当前时间戳，然后调用原始的函数，最后再记录一次时间戳，并将结果返回。当我们使用装饰器来修饰add_numbers函数时，它实际上相当于执行了以下代码：

add_numbers = timestamp_decorator(add_numbers)

现在我们再来看看add_numbers函数的输出，我们可以注意到，它不仅输出了add_numbers函数的返回值，而且还打印了函数调用的时间戳。

接下来，让我们看一下这个装饰器是如何工作的。当我们调用修饰后的add_numbers函数时，它实际上是在调用timestamp_decorator函数返回的wrapper函数。wrapper函数首先记录了当前时间戳，接着调用了add_numbers函数，最后记录了第二个时间戳。在当前时间戳记录之后，我们可以通过调用原始函数来执行功能。原始函数的返回值被赋值给变量result，并随后返回。

最后，wrapper函数返回了结果，但是在返回前添加了一条打印时间戳的语句。我们在这个例子中看到的是一个相当简单的装饰器，它只添加了一些代码以记录时间戳。但是，装饰器可以执行更加复杂的操作，如缓存函数的结果，验证函数的参数，以及设置日志等。

在使用装饰器时，我们需要注意一些细节。例如，我们可能想要保留原始函数的名称和文档字符串，以便在调用help函数时可以看到正确的描述。为了避免这种情况，我们可以使用functools.wraps函数，它可以将原始函数的元数据复制到wrapper函数中。让我们修改上面的代码，以使用functools.wraps函数。

import time
from functools import wraps

def timestamp_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f'Function {func.__name__} was called at {start_time} and ended at {end_time}')
        return result
    return wrapper

@timestamp_decorator
def add_numbers(a, b):
    """
    This function adds two numbers together
    """
    return a + b

help(add_numbers)
print(add_numbers(1, 2)) # Output: Function add_numbers was called at 1635698008.730528 and ended at 1635698008.730528 3

在这个例子中，我们使用了functools.wraps函数，它可以将原始函数的名称、文档字符串、参数签名等信息复制到 wrapper函数 中，并且保证原始函数的元数据不被丢失。

除了使用装饰器修饰函数外，我们还可以使用装饰器装饰类。这样做的效果与装饰函数非常相似，但是引入了一些新的细节。让我们来看一个例子。

def my_decorator(klass):
    klass.new_method = lambda self: print('This is a new method added to the class')
    return klass

@my_decorator
class MyClass:
    pass

my_obj = MyClass()
my_obj.new_method() # Output: This is a new method added to the class

在这个例子中，我们定义了一个my_decorator装饰器函数，并将其用于MyClass类。该装饰器在类上添加了一个新的方法，该方法在类的实例上可用。

在这个例子中，装饰器被应用于类的定义，而不是类的实例。这意味着装饰器函数将接收MyClass类本身，而不是类的实例。在函数体内，我们可以修改类的属性和方法，以添加一些新的行为。

总结

装饰器是Python编程语言中非常强大的工具，可以用于在不修改原始函数代码的情况下添加或修改函数的功能。在本章中，我们深入探讨了装饰器的作用，并提供了几个简单的例子。我们看到了如何在函数上使用装饰器，并为一个函数添加了一些额外的功能。此外，我们还看到了如何使用装饰器来装饰类，并为类添加了新的方法和行为。装饰器是Python中非常强大和灵活的功能，应该在代码中经常使用。