写点什么

Python 装饰器,增强代码的魔力

  • 2024-05-20
    湖南
  • 本文字数:1838 字

    阅读完需:约 6 分钟

装饰器的基本概念

在 Python 中,装饰器是一种设计模式,用于在不修改原始函数代码的情况下,给函数添加新的功能。装饰器本质上是一个函数,它接收一个函数作为参数并返回一个新的函数。这种用法在 Python 中非常强大,因为它允许开发者以一种非侵入性的方式增强现有代码。

装饰器的基本语法如下:

def decorator(func):    def wrapper(*args, **kwargs):        # 在这里添加装饰逻辑        result = func(*args, **kwargs)  # 调用原始函数        # 可以在这里添加更多逻辑        return result    return wrapper
# 使用装饰器@decoratordef function_to_decorate(x, y): return x + y
复制代码

使用@decorator语法是将function_to_decorate函数作为参数传递给decorator函数的简写方式。

带参数的装饰器

有时,你可能需要创建一个装饰器,它在应用到函数上时可以接受参数。这可以通过创建一个返回装饰器的函数来实现:

def decorator_with_args(arg1, arg2):    def decorator(func):        def wrapper(*args, **kwargs):            print(f"Decorator arguments: {arg1}, {arg2}")            return func(*args, **kwargs)        return wrapper    return decorator
@decorator_with_args('value1', 'value2')def function_to_decorate(x, y): return x + y
复制代码

使用场景

以下介绍一些装饰器的使用场景,这些使用场景比较常见,可以加深装饰器的理解。

日志记录

装饰器可以用来记录函数的调用情况,包括其参数和返回值。

import logging
def log_decorator(func): def wrapper(*args, **kwargs): logging.info(f"Calling {func.__name__} with args: {args}, kwargs: {kwargs}") result = func(*args, **kwargs) logging.info(f"{func.__name__} returned {result}") return result return wrapper
@log_decoratordef add(x, y): return x + y
复制代码

性能测试

装饰器可以用于测量函数的执行时间。

import time
def time_decorator(func): def wrapper(*args, **kwargs): start = time.time() result = func(*args, **kwargs) end = time.time() print(f"{func.__name__} took {end - start:.4f} seconds to run") return result return wrapper
@time_decoratordef compute_heavy_function(data): # 模拟耗时计算 time.sleep(1) return data
复制代码

事务处理

在涉及数据库操作的函数上使用装饰器,可以确保事务的正确性。

def transaction_decorator(func):    def wrapper(*args, **kwargs):        try:            result = func(*args, **kwargs)            db.commit()  # 假设db是数据库连接对象        except Exception as e:            db.rollback()            raise e        return result    return wrapper
@transaction_decoratordef update_data(record): # 执行数据库更新操作 pass
复制代码

权限检查

在执行某些函数之前,可以使用装饰器来检查用户是否有相应的权限。

def permission_decorator(permission_required):    def decorator(func):        def wrapper(*args, **kwargs):            if not current_user.has_permission(permission_required):                raise PermissionError            return func(*args, **kwargs)        return wrapper    return decorator
@permission_decorator('edit_post')def edit_post(post_id): # 编辑帖子的逻辑 pass
复制代码

缓存

装饰器可以用于缓存函数的结果,以避免重复计算。

def cache_decorator(func):    cache = {}    def wrapper(*args, **kwargs):        key = (args, tuple(kwargs.items()))        if key not in cache:            cache[key] = func(*args, **kwargs)        return cache[key]    return wrapper
@cache_decoratordef expensive_function(param): # 执行昂贵计算 pass
复制代码

结论

装饰器是 Python 中一种强大的工具,它通过高阶函数和闭包机制,以一种简洁和表达性的方式扩展了函数的功能。无论是日志记录、性能测试、事务管理、权限验证还是缓存,装饰器都提供了一种优雅的解决方案。然而,装饰器也可能使代码变得难以理解,特别是在嵌套使用多个装饰器时。因此,使用装饰器时应该考虑其可读性和性能影响,并在适当的时候添加清晰的注释。


作者:程序员一点

链接:https://juejin.cn/post/7369044948329824308

用户头像

欢迎关注,一起学习,一起交流,一起进步 2020-06-14 加入

公众号:做梦都在改BUG

评论

发布
暂无评论
Python装饰器,增强代码的魔力_Python_我再BUG界嘎嘎乱杀_InfoQ写作社区