深入理解Python中的装饰器（Decorators）：从基础到高级应用

置顶 m0_38123128

于 2024-07-08 10:04:12 发布

阅读量9.2k

点赞数 21

文章标签： python 开发语言

本文链接：https://blog.csdn.net/m0_38123128/article/details/140260446

版权

在Python编程中，装饰器（Decorators）是一个强大且灵活的特性，它允许我们在不修改原有函数代码的情况下，给函数增加新的功能。这种“包裹”或“增强”函数的方式，使得代码更加模块化和可重用。本文将带您从基础到高级，深入理解Python装饰器的概念、工作原理及其在实际项目中的应用。

一、装饰器的基础概念

装饰器本质上是一个函数，它可以接收一个函数作为参数并返回一个新的函数。这个新函数是对原函数的一种包装或增强，可以在不改变原函数代码的前提下，增加额外的功能。

基本语法：

def decorator(func):  
    def wrapper(*args, **kwargs):  
        # 在这里添加额外的功能  
        print("Before calling the function")  
        result = func(*args, **kwargs)  
        print("After calling the function")  
        return result  
    return wrapper  
  
@decorator  
def my_function():  
    print("Hello, this is my function.")  
  
# 调用my_function时，实际上调用的是wrapper函数  
my_function()

二、装饰器的工作原理

装饰器的工作流程可以分为以下几个步骤：

定义装饰器：首先定义一个装饰器函数，该函数接收一个函数作为参数。
定义包装函数：在装饰器函数内部，定义一个包装函数（wrapper），这个包装函数会调用原函数，并可以在调用前后添加额外的逻辑。
返回包装函数：装饰器函数返回这个包装函数。
使用@语法：在需要被装饰的函数定义前使用@符号加上装饰器名称，这样Python解释器会自动将这个函数作为参数传递给装饰器，并将返回的新函数（包装函数）赋值给原函数名。

三、装饰器的进阶应用

1. 带参数的装饰器

当被装饰的函数需要参数时，装饰器中的包装函数（wrapper）也需要能够接收这些参数。这通常通过*args和**kwargs实现。

def decorator(func):  
    def wrapper(*args, **kwargs):  
        print("Function is called with arguments:", args, kwargs)  
        result = func(*args, **kwargs)  
        return result  
    return wrapper  
  
@decorator  
def my_function(x, y):  
    return x + y  
  
print(my_function(3, 4))

2. 装饰器带参数

如果需要给装饰器本身传递参数，可以使用一个外层函数来封装装饰器。

def repeat(num_times):  
    def decorator(func):  
        def wrapper(*args, **kwargs):  
            for _ in range(num_times):  
                result = func(*args, **kwargs)  
            return result  
        return wrapper  
    return decorator  
  
@repeat(3)  
def say_hello():  
    print("Hello!")  
  
say_hello()  # 输出三次Hello!

3. 使用functools.wraps保留原函数信息

在使用装饰器时，原函数的元信息（如函数名、文档字符串等）会被包装函数所替代。为了保留这些信息，可以使用functools.wraps装饰器。

from functools import wraps  
  
def my_decorator(func):  
    @wraps(func)  
    def wrapper(*args, **kwargs):  
        print("Something is happening before the function is called.")  
        result = func(*args, **kwargs)  
        print("Something is happening after the function is called.")  
        return result  
    return wrapper  
  
@my_decorator  
def example():  
    """This is an example function."""  
    print("Hello from a function.")  
  
print(example.__doc__)  # 输出: This is an example function.