编写高质量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将博客内容html导出为Markdown格式

《Python将博客内容html导出为Markdown格式》Python将博客内容html导出为Markdown格式,通过博客url地址抓取文章,分析并提取出文章标题和内容,将内容构建成html,再转... 目录一、为什么要搞?二、准备如何搞?三、说搞咱就搞!抓取文章提取内容构建html转存markdown

Python获取中国节假日数据记录入JSON文件

《Python获取中国节假日数据记录入JSON文件》项目系统内置的日历应用为了提升用户体验,特别设置了在调休日期显示“休”的UI图标功能,那么问题是这些调休数据从哪里来呢?我尝试一种更为智能的方法:P... 目录节假日数据获取存入jsON文件节假日数据读取封装完整代码项目系统内置的日历应用为了提升用户体验,

Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

《PythonFastAPI+Celery+RabbitMQ实现分布式图片水印处理系统》这篇文章主要为大家详细介绍了PythonFastAPI如何结合Celery以及RabbitMQ实现简单的分布式... 实现思路FastAPI 服务器Celery 任务队列RabbitMQ 作为消息代理定时任务处理完整

Python Websockets库的使用指南

《PythonWebsockets库的使用指南》pythonwebsockets库是一个用于创建WebSocket服务器和客户端的Python库,它提供了一种简单的方式来实现实时通信,支持异步和同步... 目录一、WebSocket 简介二、python 的 websockets 库安装三、完整代码示例1.

揭秘Python Socket网络编程的7种硬核用法

《揭秘PythonSocket网络编程的7种硬核用法》Socket不仅能做聊天室,还能干一大堆硬核操作,这篇文章就带大家看看Python网络编程的7种超实用玩法,感兴趣的小伙伴可以跟随小编一起... 目录1.端口扫描器:探测开放端口2.简易 HTTP 服务器:10 秒搭个网页3.局域网游戏:多人联机对战4.

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》:本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.

Kotlin 作用域函数apply、let、run、with、also使用指南

《Kotlin作用域函数apply、let、run、with、also使用指南》在Kotlin开发中,作用域函数(ScopeFunctions)是一组能让代码更简洁、更函数式的高阶函数,本文将... 目录一、引言:为什么需要作用域函数?二、作用域函China编程数详解1. apply:对象配置的 “流式构建器”最

Python使用自带的base64库进行base64编码和解码

《Python使用自带的base64库进行base64编码和解码》在Python中,处理数据的编码和解码是数据传输和存储中非常普遍的需求,其中,Base64是一种常用的编码方案,本文我将详细介绍如何使... 目录引言使用python的base64库进行编码和解码编码函数解码函数Base64编码的应用场景注意

Python基于wxPython和FFmpeg开发一个视频标签工具

《Python基于wxPython和FFmpeg开发一个视频标签工具》在当今数字媒体时代,视频内容的管理和标记变得越来越重要,无论是研究人员需要对实验视频进行时间点标记,还是个人用户希望对家庭视频进行... 目录引言1. 应用概述2. 技术栈分析2.1 核心库和模块2.2 wxpython作为GUI选择的优

Python如何使用__slots__实现节省内存和性能优化

《Python如何使用__slots__实现节省内存和性能优化》你有想过,一个小小的__slots__能让你的Python类内存消耗直接减半吗,没错,今天咱们要聊的就是这个让人眼前一亮的技巧,感兴趣的... 目录背景:内存吃得满满的类__slots__:你的内存管理小助手举个大概的例子:看看效果如何?1.