编写高质量Python (第26条) 用 functools.wraps 定义函数装饰器

2023-12-03 08:28

本文主要是介绍编写高质量Python (第26条) 用 functools.wraps 定义函数装饰器,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

第26条 用 functools.wraps 定义函数装饰器

​ Python 中有一个特殊写法,可以用装饰器来封装某个函数,从而让函数在执行这个函数之前与执行完这个函数之后,分别运行某些代码。这意味着,调用者传给参数的参数值、函数返回给调用者的值,以及函数抛出的异常,都可以由装饰器访问并修改。这是个很有用 的机制,能够保证用户以正确的方式使用函数,也能用来调试程序或实现函数注册功能,此外还有很多用途。

​ 例如,假设我们要把函数执行时收到的参数与返回的值记录下来。这在调试递归函数是很有用的,因为我们要知道,这个函数执行每一层递归时,输入的是什么参数,返回的是什么值。下面我们就定义这样一个装饰器,在实现这个修饰器时,用 *args 与 **kwargs 表示受修饰的原函数 func 所收到的参数(参见 第22条和第23条)。

def trace(func):def wrapper(*args, **kwargs):result = func(*args, **kwargs)print(f'{func.__name__}({args!r},{kwargs!r})'f' -> {result!r}')return resultreturn wrapper

​ 写好之后,我们用 @ 符号把修饰器运用在想要调试的函数上面。

@trace
def fibonacci(n):"""Return the n-th Fibonacci number """if n in (0, 1):return nreturn (fibonacci(n - 2) + fibonacci(n - 1))

​ 这样写,相当于先把受修饰的函数传给修饰器,然后将修饰器所返回的值赋给原来那个函数。这样的话,如果我们继续通过原来的那个名字调用函数,那么执行的就是修饰之后的函数。

fibonacci = trace(fibonacci)

​ 修饰过的 fibonacci 函数,会在执行自身的代码之前,先执行 wrapper 里位于 func(*args, **kwargs) 那一行之前的逻辑;并且在执行完自身的代码后,执行 wrapper 里位于 func (*args, **kwargs) 那一行之后的逻辑。本例中,它会在执行完自身的代码之后,打印这次执行所用的参数与返回值,这样就能看到整个递归栈的情况了。

fibonacci(4)>>>
fibonacci((0,),{}) -> 0
fibonacci((1,),{}) -> 1
fibonacci((2,),{}) -> 1
fibonacci((1,),{}) -> 1
fibonacci((0,),{}) -> 0
fibonacci((1,),{}) -> 1
fibonacci((2,),{}) -> 1
fibonacci((3,),{}) -> 2
fibonacci((4,),{}) -> 3

​ 这样写确实能满足需求,但是会带来一个我们不愿意看到的副作用。修饰器返回的那个值,也就是刚才调用的 fibonacci ,它的名字并不叫 “fibonacci”。

print(fionacci)>>>
<function trace.<locals>.wrapper at 0x1090ad120>

​ 这种现象解释起来并不困难。trace 函数返回的,是它里面定义的 wrapper 函数,所以,当我们把这个返回值赋给 fibonacci 之后,fibonacci 这个名称所表示的自然就是 wrapper 了。问题在于,这样可能会干扰那些想要利用 introspection 机制来运作的工具,例如调试器(debugger)(参见 第80条)。

​ 例如,如果用内置的 help 函数来查看修饰后的 fibonacci,那么打印出来的并不是我们想看的帮助文档,他本来该打印前面定义时写的那行 'Return the n-th Fibonacci number’文本才对。

help(fabonacci)>>>
Help on function wrapper in module __main__:wrapper(*args, **kwargs)

​ 对象序列化器(object serializer, 参见 第68条) 也无法正常运作,因为它不能确定受修饰函数的位置。

import pickle
pickle.dumps(fibonacci)>>>
Traceback ...
AttributeError: Can't pickle local object 'trace.<locals>.wrapper'

​ 要像解决这些问题,可以改用 functools 内置模块之中的 wraps 辅助函数来实现。wraps 本身也是个修饰器,它可以帮助你编写自己的装饰器。把它运作到 wrapper 函数上面,它就会将重要的元数据 (metadata) 全都从内部函数复制到外部函数。

from functools import wrapsdef trace(func):@wraps(func)def wrapper(*args, **kwargs):result = func(*args, **kwargs)print(f'{func.__name__}({args!r},{kwargs!r})'f' -> {result!r}')return resultreturn wrapper@trace
def fibonacci(n):"""Return the n-th Fibonacci number """if n in (0, 1):return nreturn (fibonacci(n - 2) + fibonacci(n - 1))

​ 现在我们就可以通过 help 函数看到正确的文档了。虽然原来的 fibonacci 函数现在封装在装饰器上,但我们还可以看到它的文档。

help(fibonacci)>>>
Help on function fibonacci in module __main__:fibonacci(n)Return the n-th Fibonacci number

​ 对象序列化,也正常了。

print(pickle.dumps(fibonacci))>>>
b'\x80\x04\x95\x1a\x00\x00\x00\x00\x00\x00\x00\x8c\x08__main__\x94\x8c\tfibonacci\x94\x93\x94.'

​ 除了这里讲到的几个方面之外,Python 函数还有很多属性(例如 __name__,_moudle_,__annotations__)也应该在受到封装时得以保留,这样才能让相关的接口正常运作。wraps 可以帮助保存这些属性,使程序表现出正确的行为。

这篇关于编写高质量Python (第26条) 用 functools.wraps 定义函数装饰器的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/448768

相关文章

如何使用 Python 读取 Excel 数据

《如何使用Python读取Excel数据》:本文主要介绍使用Python读取Excel数据的详细教程,通过pandas和openpyxl,你可以轻松读取Excel文件,并进行各种数据处理操... 目录使用 python 读取 Excel 数据的详细教程1. 安装必要的依赖2. 读取 Excel 文件3. 读

Python的time模块一些常用功能(各种与时间相关的函数)

《Python的time模块一些常用功能(各种与时间相关的函数)》Python的time模块提供了各种与时间相关的函数,包括获取当前时间、处理时间间隔、执行时间测量等,:本文主要介绍Python的... 目录1. 获取当前时间2. 时间格式化3. 延时执行4. 时间戳运算5. 计算代码执行时间6. 转换为指

利用Python调试串口的示例代码

《利用Python调试串口的示例代码》在嵌入式开发、物联网设备调试过程中,串口通信是最基础的调试手段本文将带你用Python+ttkbootstrap打造一款高颜值、多功能的串口调试助手,需要的可以了... 目录概述:为什么需要专业的串口调试工具项目架构设计1.1 技术栈选型1.2 关键类说明1.3 线程模

Python ZIP文件操作技巧详解

《PythonZIP文件操作技巧详解》在数据处理和系统开发中,ZIP文件操作是开发者必须掌握的核心技能,Python标准库提供的zipfile模块以简洁的API和跨平台特性,成为处理ZIP文件的首选... 目录一、ZIP文件操作基础三板斧1.1 创建压缩包1.2 解压操作1.3 文件遍历与信息获取二、进阶技

Python Transformers库(NLP处理库)案例代码讲解

《PythonTransformers库(NLP处理库)案例代码讲解》本文介绍transformers库的全面讲解,包含基础知识、高级用法、案例代码及学习路径,内容经过组织,适合不同阶段的学习者,对... 目录一、基础知识1. Transformers 库简介2. 安装与环境配置3. 快速上手示例二、核心模

Python正则表达式语法及re模块中的常用函数详解

《Python正则表达式语法及re模块中的常用函数详解》这篇文章主要给大家介绍了关于Python正则表达式语法及re模块中常用函数的相关资料,正则表达式是一种强大的字符串处理工具,可以用于匹配、切分、... 目录概念、作用和步骤语法re模块中的常用函数总结 概念、作用和步骤概念: 本身也是一个字符串,其中

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数?getopt模块基础实际应用示例与其他参数处理方式的比较常见问http

python实现svg图片转换为png和gif

《python实现svg图片转换为png和gif》这篇文章主要为大家详细介绍了python如何实现将svg图片格式转换为png和gif,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录python实现svg图片转换为png和gifpython实现图片格式之间的相互转换延展:基于Py

Python中的getopt模块用法小结

《Python中的getopt模块用法小结》getopt.getopt()函数是Python中用于解析命令行参数的标准库函数,该函数可以从命令行中提取选项和参数,并对它们进行处理,本文详细介绍了Pyt... 目录getopt模块介绍getopt.getopt函数的介绍getopt模块的常用用法getopt模

Python利用ElementTree实现快速解析XML文件

《Python利用ElementTree实现快速解析XML文件》ElementTree是Python标准库的一部分,而且是Python标准库中用于解析和操作XML数据的模块,下面小编就来和大家详细讲讲... 目录一、XML文件解析到底有多重要二、ElementTree快速入门1. 加载XML的两种方式2.