Python上下文管理器with块及@contextmanager的用法

2024-05-14 11:20

本文主要是介绍Python上下文管理器with块及@contextmanager的用法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

上下文管理器和with块

上下文管理器对象存在的目的是为了管理with块,就像迭代器的存在是为了管理for循环一样

with 语句存在的意义是对一些常用的 try/finally 结构予以简化。这种结构能够保障一段代码在运行完成后实施某项操作,就算该段代码因为 return 语句、异常或者 sys.exit() 调用而停止,也依旧执行指定的操作。finally 子句中的代码往往用于释放重要的资源,亦或是还原临时变动的状态。

上下文管理器接口包含了__enter__以及__exit__这两个方法。当 with 语句开始执行的时候,Python 会在上下文管理器对象上启用__enter__方法。待 with 块运行完毕,或者因某些缘由终止之后,Python 会在上下文管理器对象上调用__exit__方法。

  • __enter()__方法:当进入 with 语句时,__enter__() 方法会被调用。该方法通常用于执行一些准备工作,并返回一个资源对象,这个对象会被绑定到 as 后的变量名上。
  • __exit()__方法:当 with 语句块执行结束时,无论是否发生了异常,__exit__() 方法都会被调用。该方法通常用于执行一些清理操作,比如关闭文件、释放资源等。如果在 with 语句块中发生了异常,异常信息会作为参数传递给 __exit__() 方法。

下面是一个精心设计的上下文管理器执行操作案例

import sysclass LookingGlass:def __enter__(self):# 将原始的 sys.stdout.write 函数保存起来self.original_wirte = sys.stdout.write# 将 sys.stdout.write 函数替换为 reverse_write 方法sys.stdout.write = self.reverse_wirte# 返回一个字符串作为上下文管理器的上下文对象return 'QWERTYUIOP'def reverse_wirte(self, text):# 对传入的文本进行反转后输出return self.original_wirte(text[::-1])def __exit__(self, exc_type, exc_val, exc_tb):  # 如果一切正常,那么Python 调⽤__exit__ ⽅法时传⼊的参数是None, None, None# 在退出上下文管理器时,恢复原始的 sys.stdout.write 函数sys.stdout.write = self.original_wirte# 如果发生的异常是 ZeroDivisionError,输出相应提示信息if exc_type is ZeroDivisionError:print('Please DO NOT divide by zero!')return True  # 返回True,告诉解释器异常已处理if __name__ == '__main__':with LookingGlass() as what:# print(obj)实质就是调用sys.stdout.write(obj+’\n’)print("床前明月光")  # 光月明前床print("疑是地上霜")  # 霜上地是疑print(what)  # POIUYTREWQprint(what)  # QWERTYUIOP 处理上下文管理器,输出的文本正常,不再翻转

解释器调用__enter__方法时,除了隐式的self,不需要传入其他参数,传給__exit__方法的三个参数如下:

  • exc_type:异常类。
  • exc_value:异常实例。有时候会有参数传递给异常构造函数,例如错误消息,这些参数能够通过 exc_value.args获取。
  • exc_tb:trackback对象。

@contextmanager的用法

@contextmanager是一个十分实用且巧妙的工具。他将Python3个功能结合在一起:函数装饰器,生成器以及上下文管理器。

使用@contextmanager能减少创建上下文管理器的样板代码,因为不用编写一个类来定义__enter__和__exit__方法,而只要实现一个含有yield的生成器,来生成想要__enter__方法返回的值。

在使用@contextmanager装饰的生成器中,yiled把函数主体分成两部分,yield前面的代码在with块开始时(解释器调用__enter__方法时)执行。yield后面的代码在with块结束时(解释器调用__exit__方法时)执行。

继续上面的示例:

import sys
import contextlib@contextlib.contextmanager
def looking_glass():original_text = sys.stdout.writedef reverse_write(text):original_text(text[::-1])sys.stdout.write = reverse_writemsg = ''# 这里处理异常是因为如果with块有异常抛出,Python会将其捕获,然后再looking_glass函数的yield表达式再次抛出# 但是那里又没有处理错误的代码,因此looking_glass函数将终止执行,永远无法恢复成原来的sys.stdout.write方法,导致系统处于无效状态。try:yield 'QWERTYUIOP'except ZeroDivisionError:msg = 'Please DO NOT divide by zero!'finally:sys.stdout.write = original_textif msg:print(msg)if __name__ == '__main__':with looking_glass() as what:print("床前明月光")  # 光月明前床print("疑是地上霜")  # 霜上地是疑print(what)  # POIUYTREWQprint(what)  # QWERTYUIOP

其实@contextlib.contextmanager把函数包装成了实现__enter__和__exit__的类。

那个类的__enter__方法:

  1. 调用生成器函数,获取生成器对象,姑且称之为gen。
  2. 调用next(gen),驱动生成器对象执行到yield关键字位置。
  3. 返回next(gen)产生的值,以便把产生的值绑定到as语句的目标变量上。

with语句终止,__exit__方法有以下作用

  1. 检查有没有异常传给exc_type,如果有则调用gen.throw(exception) ,在生成器函数主体的yield关键字所在的行抛出异常。
  2. 否则调用next(gen),恢复执行生成器函数主体中yiled后面的代码。

因此在使用@contextmanager装饰器是,应该把yield放在try/finally语句中,这是不可避免的,因为我们永远不知道上下文管理器的用户会在with块中做什么。

@contextmanager还有一个鲜为人知的功能:它装饰的生成器也可以用做装饰器。例如:


@looking_glass()
def varse():print("举头望明月低头思故乡")if __name__ == '__main__':varse() # 乡故思头低月明望头举

 

 

这篇关于Python上下文管理器with块及@contextmanager的用法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

Python实现文件批量重命名器

《Python实现文件批量重命名器》在日常工作和学习中,我们经常需要对大量文件进行重命名操作,本文将介绍一个使用Python开发的文件批量重命名工具,提供了多种重命名模式,有需要的小伙伴可以了解下... 目录前言功能特点模块化设计1.目录路径获取模块2.文件列表获取模块3.重命名模式选择模块4.序列号参数配

Python使用python-docx实现自动化处理Word文档

《Python使用python-docx实现自动化处理Word文档》这篇文章主要为大家展示了Python如何通过代码实现段落样式复制,HTML表格转Word表格以及动态生成可定制化模板的功能,感兴趣的... 目录一、引言二、核心功能模块解析1. 段落样式与图片复制2. html表格转Word表格3. 模板生

Python FastAPI实现JWT校验的完整指南

《PythonFastAPI实现JWT校验的完整指南》在现代Web开发中,构建安全的API接口是开发者必须面对的核心挑战之一,本文将深入探讨如何基于FastAPI实现JWT(JSONWebToken... 目录一、JWT认证的核心原理二、项目初始化与环境配置三、安全密码处理机制四、JWT令牌的生成与验证五、

Python使用Turtle实现精确计时工具

《Python使用Turtle实现精确计时工具》这篇文章主要为大家详细介绍了Python如何使用Turtle实现精确计时工具,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考一下... 目录功能特点使用方法程序架构设计代码详解窗口和画笔创建时间和状态显示更新计时器控制逻辑计时器重置功能事件

Go 语言中的 Struct Tag 的用法详解

《Go语言中的StructTag的用法详解》在Go语言中,结构体字段标签(StructTag)是一种用于给字段添加元信息(metadata)的机制,常用于序列化(如JSON、XML)、ORM映... 目录一、结构体标签的基本语法二、json:"token"的具体含义三、常见的标签格式变体四、使用示例五、使用

mysql中的group by高级用法详解

《mysql中的groupby高级用法详解》MySQL中的GROUPBY是数据聚合分析的核心功能,主要用于将结果集按指定列分组,并结合聚合函数进行统计计算,本文给大家介绍mysql中的groupby... 目录一、基本语法与核心功能二、基础用法示例1. 单列分组统计2. 多列组合分组3. 与WHERE结合使

python进行while遍历的常见错误解析

《python进行while遍历的常见错误解析》在Python中选择合适的遍历方式需要综合考虑可读性、性能和具体需求,本文就来和大家讲解一下python中while遍历常见错误以及所有遍历方法的优缺点... 目录一、超出数组范围问题分析错误复现解决方法关键区别二、continue使用问题分析正确写法关键点三

使用Python实现调用API获取图片存储到本地的方法

《使用Python实现调用API获取图片存储到本地的方法》开发一个自动化工具,用于从JSON数据源中提取图像ID,通过调用指定API获取未经压缩的原始图像文件,并确保下载结果与Postman等工具直接... 目录使用python实现调用API获取图片存储到本地1、项目概述2、核心功能3、环境准备4、代码实现

8种快速易用的Python Matplotlib数据可视化方法汇总(附源码)

《8种快速易用的PythonMatplotlib数据可视化方法汇总(附源码)》你是否曾经面对一堆复杂的数据,却不知道如何让它们变得直观易懂?别慌,Python的Matplotlib库是你数据可视化的... 目录引言1. 折线图(Line Plot)——趋势分析2. 柱状图(Bar Chart)——对比分析3

Python模拟串口通信的示例详解

《Python模拟串口通信的示例详解》pySerial是Python中用于操作串口的第三方模块,它支持Windows、Linux、OSX、BSD等多个平台,下面我们就来看看Python如何使用pySe... 目录1.win 下载虚www.chinasem.cn拟串口2、确定串口号3、配置串口4、串口通信示例5