使用这些包装器升级您的 Python 游戏，以获得最大的效率和可读性。

Python 是迄今为止我最喜欢的编程语言，因为它简单的语法和在机器学习和 Web 开发等各个领域的强大应用。

尽管我已经编码了五年多，但除非绝对必要，否则装饰器很少出现在我的雷达上，例如使用 @staticmethod 装饰器来表示类中的静态方法。

然而，在最近的一次合并请求审查中，当我的同事向我的一个函数引入了计时器装饰器时，我的看法发生了变化。 它激发了我对装饰器可以提供的众多其他功能的好奇心，从而提高了代码的简洁性和可读性。

因此，在这篇短文中，我们将探讨 Python 包装器的概念，并展示五个可以改进 Python 开发过程的示例。

Python 包装器

Python 包装器是添加到另一个函数的函数，然后可以添加附加功能或修改其行为，而无需直接更改其源代码。 它们通常作为装饰器实现，装饰器是一种特殊的函数，将另一个函数作为输入并对其功能进行一些更改。

包装函数在各种场景中都很有用：

功能扩展：我们可以通过用装饰器包装我们的函数来添加日志记录、性能测量或缓存等功能。

代码可重用性：我们可以将包装函数甚至一个类应用于多个实体，可以避免代码重复，并确保不同组件之间的行为一致。

行为修改：我们可以拦截输入参数，例如，验证输入变量，而不需要许多断言行。

例子

让我向您展示一些使包装成为我们日常工作中必须的示例：

1 — 计时器

该包装函数测量函数的执行时间并打印经过的时间。 它对于分析和优化代码很有用。

import time

def timer(func):
    def wrapper(*args, **kwargs):
        # start the timer
        start_time = time.time()
        # call the decorated function
        result = func(*args, **kwargs)
        # remeasure the time
        end_time = time.time()
        # compute the elapsed time and print it
        execution_time = end_time - start_time
        print(f"Execution time: {execution_time} seconds")
        # return the result of the decorated function execution
        return result
    # return reference to the wrapper function
    return wrapper

为了在Python中创建装饰器，我们需要定义一个名为timer的函数，它接受一个名为func的参数来表明它是一个装饰器函数。 在计时器函数内部，我们定义了另一个称为包装器的函数，它接受通常传递给我们想要装饰的函数的参数。

在包装函数中，我们使用提供的参数调用所需的函数。 我们可以使用以下行来完成此操作：result = func(*args, **kwargs)。

最后，包装函数返回装饰函数的执行结果。 装饰器函数应该返回对我们刚刚创建的包装器函数的引用。

要使用装饰器，您可以使用 @ 符号将其应用到所需的函数。

@timer
def train_model():
    print("Starting the model training function...")
    # simulate a function execution by pausing the program for 5 seconds
    time.sleep(5) 
    print("Model training completed!")

train_model() 

输出:

Starting the model training function…

Model Training completed!

Execution time: 5.006425619125366 seconds

2— Debugger

可以创建一个附加的有用包装函数，通过打印每个函数的输入和输出来促进调试。 这种方法使我们能够深入了解各种函数的执行流程，而不会因多个打印语句而使我们的应用程序混乱。

def debug(func):
    def wrapper(*args, **kwargs):
        # print the fucntion name and arguments
        print(f"Calling {func.__name__} with args: {args} kwargs: {kwargs}")
        # call the function
        result = func(*args, **kwargs)
        # print the results
        print(f"{func.__name__} returned: {result}")
        return result
    return wrapper

我们可以使用 __name__ 参数来获取被调用函数的名称，然后使用 args 、 kwargsparameters 来打印传递给函数的内容。

@debug
def add_numbers(x, y):
    return x + y
add_numbers(7, y=5,)  # Output: Calling add_numbers with args: (7) kwargs: {'y': 5} \n add_numbers returned: 12

3 — 异常处理程序

包装器的Exception_handler将捕获除法函数中引发的任何异常并进行相应的处理。

我们可以根据您的要求在包装函数中自定义异常处理，例如记录异常或执行其他错误处理步骤。

def exception_handler(func):
    def wrapper(*args, **kwargs):
        try:
            return func(*args, **kwargs)
        except Exception as e:
            # Handle the exception
            print(f"An exception occurred: {str(e)}")
            # Optionally, perform additional error handling or logging
            # Reraise the exception if needed
    return wrapper

这对于整理我们的代码并建立处理异常和记录错误的统一过程非常有用。

@exception_handler
def divide(x, y):
    result = x / y
    return result
divide(10, 0)  # Output: An exception occurred: division by zero

4 — 输入验证器

此包装函数根据指定的条件或数据类型验证函数的输入参数。 它可以用来保证输入数据的正确性和一致性。

另一种方法是在我们想要验证输入数据的函数内创建无数断言行。

要向装饰添加验证，我们需要用另一个函数包装装饰器函数，该函数接受一个或多个验证函数作为参数。 这些验证函数负责检查输入值是否满足某些标准或条件。

validate_input 函数本身现在充当装饰器。 在包装函数内部，根据提供的验证函数检查输入和关键字参数。 如果任何参数未通过验证，则会引发 ValueError 并显示一条指示无效参数的消息。

def validate_input(*validations):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for i, val in enumerate(args):
                if i < len(validations):
                    if not validations[i](val):
                        raise ValueError(f"Invalid argument: {val}")
            for key, val in kwargs.items():
                if key in validations[len(args):]:
                    if not validations[len(args):][key](val):
                        raise ValueError(f"Invalid argument: {key}={val}")
            return func(*args, **kwargs)
        return wrapper
    return decorator

要调用经过验证的输入，我们需要定义验证函数。 例如，可以使用两个验证函数。 第一个函数 (lambda x: x > 0) 检查参数 x 是否大于 0，第二个函数 (lambda y: isinstance(y, str)) 检查参数 y 是否为字符串类型。

确保验证函数的顺序与其要验证的参数的顺序相对应非常重要。

@validate_input(lambda x: x > 0, lambda y: isinstance(y, str))
def divide_and_print(x, message):
    print(message)
    return 1 / x

divide_and_print(5, "Hello!")  # Output: Hello! 1.0

5 — 重试

此包装器重试函数执行指定次数，并在重试之间有延迟。 在处理偶尔由于临时问题而失败的网络或 API 调用时，它非常有用。

为了实现这一点，我们可以为装饰器定义另一个包装函数，类似于我们前面的示例。 然而，这次我们不是提供验证函数作为输入变量，而是传递特定的参数，例如 max_attemps 和 delay 。

当调用装饰函数时，将调用包装函数。 它记录尝试的次数（从 0 开始）并进入 while 循环。 该循环尝试执行修饰函数，如果成功则立即返回结果。 但是，如果发生异常，它会增加尝试计数器并打印一条错误消息，指示尝试次数和发生的特定异常。 然后，它会使用 time.sleep 等待指定的延迟，然后再次尝试该函数。

import time

def retry(max_attempts, delay=1):
    def decorator(func):
        def wrapper(*args, **kwargs):
            attempts = 0
            while attempts < max_attempts:
                try:
                    return func(*args, **kwargs)
                except Exception as e:
                    attempts += 1
                    print(f"Attempt {attempts} failed: {e}")
                    time.sleep(delay)
            print(f"Function failed after {max_attempts} attempts")
        return wrapper
    return decorator

为了调用该函数，我们可以指定最大尝试次数以及每次调用该函数之间的持续时间（以秒为单位）。

@retry(max_attempts=3, delay=2)
def fetch_data(url):
    print("Fetching the data..")
    # raise timeout error to simulate a server not responding..
    raise TimeoutError("Server is not responding.")
fetch_data("https://example.com/data")  # Retries 3 times with a 2-second delay between attempts

结论

Python 包装器是强大的工具，可以提升您的 Python 编程体验。 通过使用包装器，您可以简化复杂的任务、提高代码可读性并提高工作效率。

在本文中，我们探讨了 Python 包装器的五个示例：

定时器包装器

调试器包装器

异常处理程序包装器

输入验证器包装器

函数重试包装器

将这些包装器合并到您的项目中将帮助您编写更清晰、更高效的 Python 代码，并将您的编程技能提升到一个新的水平。