python 之装饰器(Decorators)

最新推荐文章于 2024-05-19 23:31:32 发布

Orangejuz

最新推荐文章于 2024-05-19 23:31:32 发布

阅读量840

点赞数 24

分类专栏： python学习文章标签： python

本文链接：https://blog.csdn.net/Orange_hhh/article/details/136915828

版权

python学习专栏收录该内容

16 篇文章 0 订阅

订阅专栏

装饰器本质上也是一个函数，他可以让其他函数在不需要做任何代码变动的前提下，增加额外的功能，可以接受一个函数作为参数，并返回一个新的函数。

1. 装饰器的定义

装饰器的基本语法是使用@符号，后面跟着装饰器的名称。这个符号应该放在函数定义的上方。

2. 装饰器的示例代码

装饰器代码示例：

def my_decorator(func):  
    def wrapper():  
        print("Before function call")  
        func()  
        print("After function call")  
    return wrapper  
  
@my_decorator  
def say_hello():  
    print("Hello!")  
  
say_hello()

在这个例子中，my_decorator是一个装饰器。当它被应用到say_hello函数上时，它会返回一个新的函数wrapper。这个新的函数在调用原始函数say_hello之前和之后都打印一条消息。因此，当你调用say_hello()时，实际上是在调用wrapper()函数，它会首先打印"Before function call"，然后调用say_hello()打印"Hello!“，最后打印"After function call”。

3. 常见的装饰器用法

日志记录：装饰器可以用来在函数执行前后添加日志记录。这有助于跟踪函数的调用情况，以及在出现问题时进行调试。

import logging  
  
def log_decorator(func):  
    def wrapper(*args, **kwargs):  
        logging.info(f"Calling {func.__name__} with args: {args} and kwargs: {kwargs}")  
        result = func(*args, **kwargs)  
        logging.info(f"{func.__name__} returned: {result}")  
        return result  
    return wrapper  
  
@log_decorator  
def add_numbers(a, b):  
    return a + b  

# 测试  
add_numbers(3, 4)

性能分析：通过装饰器，你可以测量函数的执行时间，从而分析代码的性能。这对于优化性能瓶颈非常有用。

import time  
  
def timing_decorator(func):  
    def wrapper(*args, **kwargs):  
        start_time = time.time()  
        result = func(*args, **kwargs)  
        end_time = time.time()  
        print(f"Function {func.__name__} took {end_time - start_time:.6f} seconds to execute.")  
        return result  
    return wrapper  
  
@timing_decorator  
def slow_function():  
    time.sleep(1)  # 模拟耗时操作  
  
# 测试  
slow_function()

权限检查：装饰器可以用于实现权限检查，确保只有具有特定权限的用户才能调用特定的函数或方法。

def permission_decorator(func):  
    def wrapper(*args, **kwargs):  
        if not has_permission():  # 假设这是检查权限的函数  
            print("Permission denied!")  
            return None  
        return func(*args, **kwargs)  
    return wrapper  
  
def has_permission():  
    # 这里应该是检查用户权限的逻辑  
    # 返回True表示有权限，返回False表示无权限  
    return True  # 示例中直接返回True，实际中需要根据用户或环境判断  
  
@permission_decorator  
def sensitive_operation():  
    print("Executing sensitive operation...")  
  
# 测试  
sensitive_operation()

缓存结果：对于计算成本较高的函数，可以使用装饰器来缓存其结果，以便在后续调用时直接返回缓存的结果，从而提高效率。

def cache_decorator(func):  
    cache = {}  
    def wrapper(*args):  
        if args in cache:  
            return cache[args]  
        result = func(*args)  
        cache[args] = result  
        return result  
    return wrapper  
  
@cache_decorator  
def fibonacci(n):  
    if n <= 1:  
        return n  
    return fibonacci(n-1) + fibonacci(n-2)  
  
# 测试  
print(fibonacci(10))  # 第一次计算，结果会被缓存  
print(fibonacci(10))  # 第二次计算，直接从缓存中获取结果，不会重新计算

函数注册：装饰器可以用于自动注册函数到某个注册表或容器中，方便后续的管理和调用。
函数参数校验：装饰器可以在函数调用前对参数进行校验，确保传入的参数符合预期，从而避免在函数内部进行繁琐的参数检查。
事务管理：对于需要数据库操作的函数，装饰器可以用来实现事务管理，确保在出现异常时能够回滚事务，保持数据的一致性。
异常处理：装饰器可以用来统一处理函数抛出的异常，例如记录异常信息、发送报警邮件等。
函数替换或增强：装饰器可以在不修改原始函数代码的情况下，替换或增强函数的功能。这对于扩展现有库或框架的功能非常有用。

4. pytest 框架中装饰器的用法

组织测试用例：装饰器可以帮助你根据特定的条件或属性对测试用例进行分组或标记。例如，你可以使用@pytest.mark.skipif装饰器来跳过某些特定条件下不应该运行的测试用例。同样，你可以使用@pytest.mark.xfail来标记预期失败的测试用例。
参数化测试：pytest提供了@pytest.mark.parametrize装饰器，允许你为测试函数提供多组参数和预期结果，从而执行参数化测试。这可以极大地减少冗余代码，并提高测试覆盖率。
依赖管理和测试顺序：虽然pytest默认不保证测试函数的执行顺序，但你可以使用装饰器（结合其他机制）来管理测试之间的依赖关系。例如，你可以使用pytest-ordering插件和相应的装饰器来指定测试的执行顺序。
自定义钩子：pytest具有一个强大的插件系统，允许你通过编写自定义插件来扩展其功能。在这些插件中，你可以定义自己的装饰器来实现特定的测试逻辑或行为。
简化复杂逻辑：对于需要在多个测试用例中重复使用的复杂逻辑，你可以将其封装在装饰器中，从而减少测试代码的冗余。这使得测试用例更加简洁和易于维护。