如何使用Python的装饰器函数给函数添加额外的功能？

Python的装饰器函数可以给函数添加额外的功能，这种做法被广泛应用在很多框架和库中。装饰器函数本身是一个函数，接受一个函数作为参数，然后返回一个包装过的新函数。被装饰的函数在调用时会被这个新函数代替，实现不修改原函数代码而对其进行功能扩展的目的。下面就具体介绍如何使用Python的装饰器函数给函数添加额外的功能。

1. 定义装饰器函数

首先需要定义一个装饰器函数，用来包装被装饰的函数。我们以打印函数执行时间为例子，在函数执行前后输出时间戳。

import time

def timeit(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print(f"{func.__name__} executed in {end - start} seconds")
        return result
    return wrapper

上述代码中，定义了一个装饰器函数timeit和一个内部函数wrapper。timeit函数接受一个func参数，表示被装饰的函数。wrapper函数接收任意个参数和关键字参数，主要实现函数被装饰后的逻辑，包括开始时间戳、函数调用和结束时间戳。最后输出函数执行时间，并返回执行结果。

2. 使用装饰器函数

定义好装饰器函数后，就可以将其应用到需要被装饰的函数上。例如，对于一个计算乘方的函数，我们可以使用装饰器函数timeit来监测其执行时间。

@timeit
def power(x, n):
    return x ** n

使用装饰器的语法非常简单，只需要在被装饰函数的定义前加上@decorator即可。上述代码中，将timeit装饰器应用到power函数上，从而将其替换为新函数wrapper。当调用power函数时，实际上调用的是装饰后的wrapper函数，它会自动计算函数执行时间并输出结果。

3. 带参数的装饰器函数

除了上述例子中的简单装饰器函数外，有时候我们需要传递参数来调整装饰器的行为。例如，在监测函数运行时间时，有时需要控制输出时间单位，以便更好地显示结果。这时可以添加一个参数来设置时间单位，代码如下所示。

def timeit(unit="s"):
    def decorator(func):
        def wrapper(*args, **kwargs):
            start = time.time()
            result = func(*args, **kwargs)
            end = time.time()
            if unit == "ms":
                print(f"{func.__name__} executed in {(end - start) * 1000:.2f} milliseconds")
            else:
                print(f"{func.__name__} executed in {end - start:.2f} seconds")
            return result
        return wrapper
    return decorator

在上面的代码中，我们定义了一个带参数的装饰器函数timeit，接受一个unit参数，表示时间单位。一个装饰器函数的内部函数也可以返回一个装饰器函数，这里我们定义了一个新的decorator函数，用来接收被装饰的函数func。wrapper函数中，根据时间单位unit的设定，选择相应的输出方式。

使用带参数的装饰器函数时，必须像调用函数一样，传递参数给装饰器函数本身。例如，我们可以将时间单位设置为毫秒，然后应用到power函数中。

@timeit(unit="ms")
def power(x, n):
    return x ** n

在这个例子中，由于装饰器函数带有参数，因此需要在使用@decorator语法时提供所需的参数。这里我们传递了参数unit="ms"，表示输出时间用毫秒表示。

4. 堆叠多个装饰器

Python允许在一个函数上同时应用多个装饰器。当有多个装饰器时，Python会依次执行每个装饰器函数，并按照顺序对函数进行修饰。下面的代码给出了一个简单的示例。

import random

def retry(max_retries=3):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for i in range(max_retries):
                try:
                    result = func(*args, **kwargs)
                    print(f"Attempt {i+1}: {func.__name__} succeeded")
                    return result
                except Exception as e:
                    print(f"Attempt {i+1}: {func.__name__} failed ({e})")
                    if i == max_retries - 1:
                        raise e
        return wrapper
    return decorator

@retry(max_retries=5)
@timeit(unit="ms")
def random_sleep():
    time.sleep(random.randint(100, 1000) / 1000)

在这个例子中，我们将两个装饰器retry和timeit应用到random_sleep函数上。retry函数用于多次重试失败的函数调用，timeit函数用于计算函数的运行时间。当函数出现异常时，retry会进行多次重试，直到达到指定的重试次数。timeit则用于计算经过多次重试后函数的平均运行时间。

运行这个函数，我们可以看到输出结果中包含了函数运行时间和多次重试的结果。

>>> random_sleep()
Attempt 1: random_sleep failed (KeyboardInterrupt())
Attempt 2: random_sleep failed (KeyboardInterrupt())
Attempt 3: random_sleep failed (KeyboardInterrupt())
Attempt 4: random_sleep failed (KeyboardInterrupt())
Attempt 5: random_sleep failed (KeyboardInterrupt())
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 7, in wrapper
KeyboardInterrupt
>>> 

在这个例子中，我们可以看到每次函数调用都被计时，重试信息也详细地输出了出来。这种方法可以轻松地通过在函数定义时使用多个装饰器来增强函数特性。

总结

Python的装饰器函数为我们提供了一种非常灵活的方式来扩展函数的功能，同时又不需要修改原函数代码。尽管装饰器函数看起来有些神秘，但理解了装饰器函数的工作原理后，你可以轻松地写出符合自己需求的装饰器函数。在实际开发中，我们可以使用装饰器函数来增强函数的特性，例如计时、缓存、重试等。这些特性可以让函数更加健壮和高效。