Python深度解析：装饰器—提升代码灵活性与可维护性的艺术

2024-08-20 15:44
文章标签 python 代码 深度 解析 提升 灵活性 艺术 装饰 可维护性

本文主要是介绍Python深度解析：装饰器—提升代码灵活性与可维护性的艺术，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Python深度解析：装饰器—提升代码灵活性与可维护性的艺术

在Python编程中，装饰器是一种功能强大且优雅的工具，能够在不改变函数定义的前提下，动态地扩展或修改其行为。使用装饰器不仅能够提升代码的可读性和可重用性，还能在实际开发中实现更高效的解决方案。

装饰器的基本概念

定义与语法

装饰器本质上是一个高阶函数，它接收一个函数作为输入，并返回一个新的函数。通过在函数定义前添加@decorator_name语法，Python会在函数调用时首先执行装饰器逻辑，再调用函数本身。通过@decorator_name语法实际效果是和decorator_name(func) 是一样的，可以参考下面的例子


def simple_decorator(func):def wrapper(*args, **kwargs):print("Before function call")result = func(*args, **kwargs)print("After function call")return resultreturn wrapper@simple_decorator
def say_hello(name):print(f"Hello, {name}!")say_hello("Alice")
# Before function call
# Hello, Alice!
# After function callsimple_decorator(say_hello("Alice"))
# Before function call
# Hello, Alice!
# After function call

工作原理

装饰器的核心是函数包装，通过在wrapper函数中添加额外的逻辑，我们可以在函数执行前后插入自定义行为，这在日志记录、性能监控、权限验证等场景中非常有用。

编写自定义装饰器

编写一个自定义装饰器通常包括以下步骤：

  1. 定义一个接收函数作为参数的装饰器函数。
  2. 在装饰器函数内部定义一个包装函数，处理传入的参数和返回值。
  3. 在包装函数内编写所需的附加逻辑。
  4. 返回包装函数，使其替代原始函数。

以下示例展示了一个用于记录函数执行时间的装饰器：

import time
from functools import wrapsdef timing_decorator(func):@wraps(func)def wrapper(*args, **kwargs):start_time = time.time()result = func(*args, **kwargs)end_time = time.time()print(f"{func.__name__} executed in {end_time - start_time:.4f} seconds")return resultreturn wrapper@timing_decorator
def compute_square(n):return n * ncompute_square(4)

functools.wraps 的使用

在记录函数执行时间的例子里面，使用到了functools.wraps。它的作用是保留原始函数的元数据，比如 __name__ 和 __doc__ 的属性，我们可以看下面这个例子

from functools import wrapsdef simple_decorator(func):def wrapper(*args, **kwargs):print("Before function call")result = func(*args, **kwargs)print("After function call")return resultreturn wrapperdef simple_decorator_with_wraps(func):@wraps(func)def wrapper(*args, **kwargs):print("Before function call")result = func(*args, **kwargs)print("After function call")return resultreturn wrapper@simple_decorator
def my_function():"""This is my_function."""print("Executing my_function")@simple_decorator_with_wraps
def my_function2():"""This is my_function2."""print("Executing my_function")print(my_function.__name__)  # 输出：wrapper
print(my_function.__doc__)   # 输出：Noneprint(my_function2.__name__)  # 输出：my_function2
print(my_function2.__doc__)   # 输出：This is my_function2.

实际应用案例

装饰器在实际开发中的应用非常广泛。以下是几个典型场景：

  • 日志记录：自动记录函数的调用信息。
  • 性能测试：衡量函数的执行时间。
  • 事务处理：在数据库操作中确保事务的开始和提交。
  • 访问控制：在函数调用前进行权限验证。

这些应用不仅提高了代码的可维护性，也使得业务逻辑与辅助功能之间的耦合更低。

注意事项与常见问题

在使用装饰器时，可能会遇到以下问题：

  • 闭包的使用：装饰器的包装函数通常是闭包，正确处理闭包变量非常重要。
  • 装饰器顺序：当多个装饰器同时应用时，它们的执行顺序会影响最终结果。
  • 调试困难：装饰器会修改函数的行为，可能导致调试难度增加。使用functools.wraps可以帮助保留原函数的信息。

面试常见问题

实现一个记录函数的调用时间、参数、返回值日志的装饰器

import time
import logging
from functools import wraps# 设置日志记录
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')def log_execution(func):@wraps(func)def wrapper(*args, **kwargs):# 记录函数开始执行时间start_time = time.time()# 记录函数参数logging.info(f"Calling {func.__name__} with args: {args} and kwargs: {kwargs}")# 执行函数result = func(*args, **kwargs)# 记录函数结束时间和执行时间end_time = time.time()execution_time = end_time - start_time# 记录返回值和执行时间logging.info(f"{func.__name__} returned {result} in {execution_time:.4f} seconds")return resultreturn wrapper# 示例函数
@log_execution
def example_function(a, b, delay=1):time.sleep(delay)return a + b# 调用示例函数
example_function(5, 10, delay=2)

实现一个记录函数的执行时间的装饰器

import time
from functools import wrapsdef timing_decorator(func):@wraps(func)def wrapper(*args, **kwargs):# 记录开始时间start_time = time.time()# 执行函数result = func(*args, **kwargs)# 记录结束时间end_time = time.time()# 计算并打印执行时间execution_time = end_time - start_timeprint(f"{func.__name__} executed in {execution_time:.4f} seconds")return resultreturn wrapper# 示例函数
@timing_decorator
def example_function(a, b):time.sleep(1)  # 模拟耗时操作return a + b# 调用示例函数
result = example_function(5, 10)

定义一个带参数的装饰器

from functools import wrapsdef repeat_decorator(times):"""一个装饰器，它会重复执行被装饰的函数指定的次数"""def decorator(func):@wraps(func)def wrapper(*args, **kwargs):result = Nonefor _ in range(times):result = func(*args, **kwargs)return resultreturn wrapperreturn decorator# 示例函数
@repeat_decorator(times=3)
def greet(name):print(f"Hello, {name}!")# 调用示例函数
greet("Alice")

实现一个失败重试的装饰器

import time
from functools import wrapsdef retry_decorator(max_retries=3, delay=1, exceptions=(Exception,)):"""一个失败重试的装饰器。:param max_retries: 最大重试次数:param delay: 每次重试之间的延迟时间（秒）:param exceptions: 触发重试的异常类型元组"""def decorator(func):@wraps(func)def wrapper(*args, **kwargs):attempts = 0while attempts < max_retries:try:return func(*args, **kwargs)except exceptions as e:attempts += 1print(f"Attempt {attempts} failed: {e}")if attempts < max_retries:time.sleep(delay)else:print(f"All {max_retries} attempts failed.")raisereturn wrapperreturn decorator# 示例函数
@retry_decorator(max_retries=5, delay=2)
def unstable_function():# 模拟可能失败的操作if time.time() % 2 < 1:  # 模拟50%的概率失败raise ValueError("Simulated failure")return "Success!"# 调用示例函数
try:result = unstable_function()print(result)
except Exception as e:print(f"Function failed after all retries: {e}")

实现一个用于参数校验的装饰器

from functools import wrapsdef validate_params(**validators):"""参数校验装饰器。:param validators: 一个字典，键是参数名，值是校验函数或校验规则的元组。校验函数接收参数值并返回True或False，表示参数是否合法。校验规则元组可以包含预期的类型和一个可选的范围检查函数。"""def decorator(func):@wraps(func)def wrapper(*args, **kwargs):# 获取函数的参数名列表func_args = func.__code__.co_varnames# 对位置参数进行校验for i, arg in enumerate(args):if i < len(func_args):param_name = func_args[i]if param_name in validators:validate(arg, validators[param_name], param_name)# 对关键字参数进行校验for param_name, arg in kwargs.items():if param_name in validators:validate(arg, validators[param_name], param_name)return func(*args, **kwargs)return wrapperreturn decoratordef validate(value, validator, param_name):"""通用的验证函数，用于验证参数是否满足条件"""if isinstance(validator, tuple):expected_type = validator[0]range_check = validator[1] if len(validator) > 1 else lambda x: Trueif not isinstance(value, expected_type):raise TypeError(f"Parameter '{param_name}' must be of type {expected_type.__name__}")if not range_check(value):raise ValueError(f"Parameter '{param_name}' failed the range check.")elif callable(validator):if not validator(value):raise ValueError(f"Parameter '{param_name}' failed custom validation.")# 示例函数
@validate_params(x=(int, lambda v: v > 0),  # x 必须是正整数y=(float, lambda v: 0.0 <= v <= 1.0),  # y 必须是0到1之间的浮点数name=str  # name 必须是字符串
)
def process_data(x, y, name="default"):print(f"Processing data: x={x}, y={y}, name={name}")# 调用示例函数
try:process_data(10, 0.5, name="example")process_data(-1, 0.5, name="example")  # 这将引发TypeError
except Exception as e:print(f"Validation error: {e}")

实现一个限制函数调用次数限制的装饰器

from functools import wrapsdef limit_calls(max_calls, on_limit_reached=None):"""限制函数调用次数的装饰器。:param max_calls: 最大允许调用次数:param on_limit_reached: 当超过调用限制时执行的操作，可以是一个函数，也可以是一个值"""def decorator(func):calls = 0  # 内部计数器@wraps(func)def wrapper(*args, **kwargs):nonlocal calls # 这里使用闭包去处理计数器，可以根据实际使用情况调整if calls >= max_calls:if callable(on_limit_reached):return on_limit_reached(*args, **kwargs)else:return on_limit_reachedcalls += 1return func(*args, **kwargs)return wrapperreturn decorator# 示例函数
@limit_calls(max_calls=3, on_limit_reached="Function call limit reached")
def example_function(x, y):return x + y# 调用示例函数
print(example_function(1, 2))  # 1st call
print(example_function(3, 4))  # 2nd call
print(example_function(5, 6))  # 3rd call
print(example_function(7, 8))  # 4th call - exceeds limit

提供一个函数，在不改变原有的函数的情况下，增加一个参数

from functools import wrapsdef add_parameter(new_param_name, new_param_value):"""装饰器，用于在不改变原有函数的情况下增加一个新的参数。:param new_param_name: 新参数的名称:param new_param_value: 新参数的默认值"""def decorator(func):@wraps(func)def wrapper(*args, **kwargs):# 添加新参数到kwargskwargs[new_param_name] = new_param_valuereturn func(*args, **kwargs)return wrapperreturn decorator# 示例函数
def original_function(x, y):print(f"x = {x}, y = {y}")# 使用装饰器添加新参数
@add_parameter('z', 10)
def modified_function(x, y, **kwargs):print(f"x = {x}, y = {y}, z = {kwargs.get('z')}")# 调用示例函数
modified_function(1, 2)

备注： 本文会同步发布于个人微信公众号(smith日常碎碎念)。

这篇关于Python深度解析：装饰器—提升代码灵活性与可维护性的艺术的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1090485。

相关文章

Java中Redisson 的原理深度解析

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、
阅读更多...
Java HashMap的底层实现原理深度解析

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述：HashMap的宏观结构二、核心数据结构解析1. 数组（桶数组）2. 链表节点（Node
阅读更多...
Java 虚拟线程的创建与使用深度解析

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程？1.2 为什么需要虚拟线程？二、虚拟线程与平台线程对比代码对比示例：三
阅读更多...
Python版本信息获取方法详解与实战

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1
阅读更多...
一文解析C#中的StringSplitOptions枚举

一文解析C#中的StringSplitOptions枚举

《一文解析C#中的StringSplitOptions枚举》StringSplitOptions是C#中的一个枚举类型,用于控制string.Split()方法分割字符串时的行为,核心作用是处理分割后... 目录C#的StringSplitOptions枚举1.StringSplitOptions枚举的常用
阅读更多...
一文详解Python如何开发游戏

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,：本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D
阅读更多...
Python函数作用域与闭包举例深度解析

Python函数作用域与闭包举例深度解析

《Python函数作用域与闭包举例深度解析》Python函数的作用域规则和闭包是编程中的关键概念,它们决定了变量的访问和生命周期,：本文主要介绍Python函数作用域与闭包的相关资料,文中通过代码... 目录1. 基础作用域访问示例1：访问全局变量示例2：访问外层函数变量2. 闭包基础示例3：简单闭包示例4
阅读更多...
Python实现字典转字符串的五种方法

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法：2、使用str方法：3、使用循环和字符串拼接：4、使用字符
阅读更多...
Python版本与package版本兼容性检查方法总结

Python版本与package版本兼容性检查方法总结

《Python版本与package版本兼容性检查方法总结》：本文主要介绍Python版本与package版本兼容性检查方法的相关资料,文中提供四种检查方法,分别是pip查询、conda管理、PyP... 目录引言为什么会出现兼容性问题方法一：用 pip 官方命令查询可用版本方法二：conda 管理包环境方法
阅读更多...
MyBatis延迟加载与多级缓存全解析

MyBatis延迟加载与多级缓存全解析

《MyBatis延迟加载与多级缓存全解析》文章介绍MyBatis的延迟加载与多级缓存机制,延迟加载按需加载关联数据提升性能,一级缓存会话级默认开启,二级缓存工厂级支持跨会话共享,增删改操作会清空对应缓... 目录MyBATis延迟加载策略一对多示例一对多示例MyBatis框架的缓存一级缓存二级缓存MyBat
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2