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。

相关文章

一文教你Python如何快速精准抓取网页数据

一文教你Python如何快速精准抓取网页数据

《一文教你Python如何快速精准抓取网页数据》这篇文章主要为大家详细介绍了如何利用Python实现快速精准抓取网页数据,文中的示例代码简洁易懂,具有一定的借鉴价值,有需要的小伙伴可以了解下... 目录1. 准备工作2. 基础爬虫实现3. 高级功能扩展3.1 抓取文章详情3.2 保存数据到文件4. 完整示例
阅读更多...
使用Python实现IP地址和端口状态检测与监控

使用Python实现IP地址和端口状态检测与监控

《使用Python实现IP地址和端口状态检测与监控》在网络运维和服务器管理中,IP地址和端口的可用性监控是保障业务连续性的基础需求,本文将带你用Python从零打造一个高可用IP监控系统,感兴趣的小伙... 目录概述：为什么需要IP监控系统使用步骤说明1. 环境准备2. 系统部署3. 核心功能配置系统效果展
阅读更多...
基于Python打造一个智能单词管理神器

基于Python打造一个智能单词管理神器

《基于Python打造一个智能单词管理神器》这篇文章主要为大家详细介绍了如何使用Python打造一个智能单词管理神器,从查询到导出的一站式解决,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 项目概述：为什么需要这个工具2. 环境搭建与快速入门2.1 环境要求2.2 首次运行配置3. 核心功能使用指
阅读更多...
Python实现微信自动锁定工具

Python实现微信自动锁定工具

《Python实现微信自动锁定工具》在数字化办公时代,微信已成为职场沟通的重要工具,但临时离开时忘记锁屏可能导致敏感信息泄露,下面我们就来看看如何使用Python打造一个微信自动锁定工具吧... 目录引言：当微信隐私遇到自动化守护效果展示核心功能全景图技术亮点深度解析1. 无操作检测引擎2. 微信路径智能获
阅读更多...
Python中pywin32 常用窗口操作的实现

Python中pywin32 常用窗口操作的实现

《Python中pywin32常用窗口操作的实现》本文主要介绍了Python中pywin32常用窗口操作的实现,pywin32主要的作用是供Python开发者快速调用WindowsAPI的一个... 目录获取窗口句柄获取最前端窗口句柄获取指定坐标处的窗口根据窗口的完整标题匹配获取句柄根据窗口的类别匹配获取句
阅读更多...
利用Python打造一个Excel记账模板

利用Python打造一个Excel记账模板

《利用Python打造一个Excel记账模板》这篇文章主要为大家详细介绍了如何使用Python打造一个超实用的Excel记账模板,可以帮助大家高效管理财务,迈向财富自由之路,感兴趣的小伙伴快跟随小编一... 目录设置预算百分比超支标红预警记账模板功能介绍基础记账预算管理可视化分析摸鱼时间理财法碎片时间利用财
阅读更多...
Python中的Walrus运算符分析示例详解

Python中的Walrus运算符分析示例详解

《Python中的Walrus运算符分析示例详解》Python中的Walrus运算符（:=）是Python3.8引入的一个新特性,允许在表达式中同时赋值和返回值,它的核心作用是减少重复计算,提升代码简... 目录1. 在循环中避免重复计算2. 在条件判断中同时赋值变量3. 在列表推导式或字典推导式中简化逻辑
阅读更多...
python处理带有时区的日期和时间数据

python处理带有时区的日期和时间数据

《python处理带有时区的日期和时间数据》这篇文章主要为大家详细介绍了如何在Python中使用pytz库处理时区信息,包括获取当前UTC时间,转换为特定时区等,有需要的小伙伴可以参考一下... 目录时区基本信息python datetime使用timezonepandas处理时区数据知识延展时区基本信息
阅读更多...
Python位移操作和位运算的实现示例

Python位移操作和位运算的实现示例

《Python位移操作和位运算的实现示例》本文主要介绍了Python位移操作和位运算的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录1. 位移操作1.1 左移操作 (<<)1.2 右移操作 (>>)注意事项：2. 位运算2.1
阅读更多...
Qt实现网络数据解析的方法总结

Qt实现网络数据解析的方法总结

《Qt实现网络数据解析的方法总结》在Qt中解析网络数据通常涉及接收原始字节流,并将其转换为有意义的应用层数据,这篇文章为大家介绍了详细步骤和示例,感兴趣的小伙伴可以了解下... 目录1. 网络数据接收2. 缓冲区管理（处理粘包/拆包）3. 常见数据格式解析3.1 jsON解析3.2 XML解析3.3 自定义
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2