Python中wrapper的用法介绍|极客教程

Python中wrapper的用法介绍

引言

在Python中，wrapper（包装器）是一种常见的编程技巧，它可以用于在函数运行之前或之后执行一些额外的逻辑。这是一种非常有用的工具，可以帮助我们实现一些特殊的功能，如日志记录、性能分析、输入验证等。本文将详细介绍Python中wrapper的用法，并提供一些示例代码来帮助读者更好地理解。

什么是wrapper

在Python中，wrapper是一个函数或一个类，它接受一个函数作为参数，并返回一个新的函数。这个新的函数通常会在包装的函数运行之前或之后执行一些额外的逻辑。wrapper的作用是将原始函数进行装饰，并对其进行一些改动或增强，而不需要修改原始函数的定义。

函数wrapper的用法

函数wrapper是最常见的一种wrapper形式，它可以通过将原始函数作为参数传递给wrapper函数来实现。

下面是一个简单的示例，展示了如何使用函数wrapper来记录函数的运行时间：

import time

def timer(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"函数 {func.__name__} 运行时间：{end_time - start_time} 秒")
        return result
    return wrapper

@timer
def my_function():
    time.sleep(1)

my_function()

运行结果：

函数 my_function 运行时间：1.0000019073486328 秒

在上面的示例中，我们定义了一个名为timer的wrapper函数。timer函数接受一个函数作为参数，并返回一个新的函数wrapper。wrapper函数内部通过调用原始函数并记录当前时间的方式来计算函数的运行时间。最后，wrapper函数会返回原始函数的运行结果，并打印出函数的运行时间。

为了使用timer函数装饰我们的函数my_function，我们使用了一个特殊的语法@timer。这个语法实际上等同于执行了my_function = timer(my_function)，它将my_function作为参数传递给timer函数，并将返回的新函数赋值给my_function。这样，当我们调用my_function时，实际上是调用了wrapper函数，从而实现了记录函数运行时间的功能。

需要注意的是，在使用wrapper装饰函数时，我们通常会使用@语法。这种方式比手动调用wrapper函数更简洁、直观，也更符合Pythonic的编程风格。

类wrapper的用法

除了函数wrapper，Python还支持类wrapper的使用。类wrapper的用法与函数wrapper类似，只是在类中我们需要定义__call__方法来作为wrapper函数。

下面是一个示例，展示了如何使用类wrapper来验证函数的输入参数是否合法：

class InputValidator:
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        for arg in args:
            if not isinstance(arg, int):
                raise TypeError("参数必须是整数类型")
        return self.func(*args, **kwargs)

@InputValidator
def add(a, b):
    return a + b

print(add(1, 2))

运行结果：

在上面的示例中，我们定义了一个名为InputValidator的类，它接受一个函数作为参数，并在__call__方法中进行输入参数的验证。如果输入参数不符合要求，则会抛出TypeError异常。

为了使用InputValidator类装饰我们的函数add，我们使用了与函数wrapper相同的语法@InputValidator。这会将add函数作为参数传递给InputValidator类，并将返回的新对象赋值给add。当我们调用add函数时，实际上是调用了InputValidator实例的__call__方法，从而实现了对输入参数的验证。

应用示例：使用wrapper实现缓存功能

现在我们已经了解了wrapper的用法，让我们尝试使用wrapper来实现一个常见的功能：缓存。

缓存是一种常见的技术，它可以帮助我们存储函数的运行结果，以便在后续的调用中直接返回缓存的结果，从而减少函数的执行时间。下面是一个示例，展示了如何使用wrapper来实现缓存功能：

def cache(func):
    cached_results = {}

    def wrapper(*args, **kwargs):
        key = (args, frozenset(kwargs.items()))
        if key in cached_results:
            return cached_results[key]
        result = func(*args, **kwargs)
        cached_results[key] = result
        return result

    return wrapper

@cache
def fibonacci(n):
    if n < 2:
        return n
    return fibonacci(n-1) + fibonacci(n-2)

print(fibonacci(10))

运行结果：

在上面的示例中，我们定义了一个名为cache的wrapper函数，它在内部创建了一个cached_results字典来存储函数的运行结果。在wrapper函数中，我们使用函数的输入参数作为键来查询cached_results字典，如果已经有缓存的结果，则直接返回缓存的结果；否则，调用原始函数求解，并将结果存入缓存中。最后，wrapper函数返回原始函数的运行结果。

为了使用cache函数装饰我们的函数fibonacci，我们使用了@cache语法。当我们调用fibonacci函数时，实际上是调用了wrapper函数，并在每次调用时检查缓存是否有结果。这使得我们可以在较大的输入值上快速计算斐波那契数列的结果。

需要注意的是，由于cached_results是定义在cache函数内部的变量，它会被作为闭包存储在wrapper函数中，并在每次调用wrapper函数时保持不变。这样，我们就可以方便地在不修改原始函数的情况下，实现缓存的功能。

总结

本文介绍了Python中wrapper的用法，并通过相应的示例代码详细解释了函数wrapper和类wrapper的使用。我们学习了如何使用wrapper来实现一些特殊的功能，如记录函数运行时间、验证函数输入参数的合法性和实现函数结果的缓存。wrapper是一种非常有用的编程技巧，可以帮助我们提高代码的重用性、灵活性和可维护性。