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: 多模块(.py)中全局变量的导入

文章目录 global关键字可变类型和不可变类型数据的内存地址单模块(单个py文件)的全局变量示例总结 多模块(多个py文件)的全局变量from x import x导入全局变量示例 import x导入全局变量示例 总结 global关键字 global 的作用范围是模块(.py)级别: 当你在一个模块(文件)中使用 global 声明变量时,这个变量只在该模块的全局命名空

【Python编程】Linux创建虚拟环境并配置与notebook相连接

1.创建 使用 venv 创建虚拟环境。例如,在当前目录下创建一个名为 myenv 的虚拟环境: python3 -m venv myenv 2.激活 激活虚拟环境使其成为当前终端会话的活动环境。运行: source myenv/bin/activate 3.与notebook连接 在虚拟环境中,使用 pip 安装 Jupyter 和 ipykernel: pip instal

【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

引言 高斯过程(Gaussian Process,简称GP)是一种概率模型,用于描述一组随机变量的联合概率分布,其中任何一个有限维度的子集都具有高斯分布 文章目录 引言一、高斯过程1.1 基本定义1.1.1 随机过程1.1.2 高斯分布 1.2 高斯过程的特性1.2.1 联合高斯性1.2.2 均值函数1.2.3 协方差函数(或核函数) 1.3 核函数1.4 高斯过程回归(Gauss

【学习笔记】 陈强-机器学习-Python-Ch15 人工神经网络(1)sklearn

系列文章目录 监督学习:参数方法 【学习笔记】 陈强-机器学习-Python-Ch4 线性回归 【学习笔记】 陈强-机器学习-Python-Ch5 逻辑回归 【课后题练习】 陈强-机器学习-Python-Ch5 逻辑回归(SAheart.csv) 【学习笔记】 陈强-机器学习-Python-Ch6 多项逻辑回归 【学习笔记 及 课后题练习】 陈强-机器学习-Python-Ch7 判别分析 【学

nudepy,一个有趣的 Python 库!

更多资料获取 📚 个人网站:ipengtao.com 大家好,今天为大家分享一个有趣的 Python 库 - nudepy。 Github地址:https://github.com/hhatto/nude.py 在图像处理和计算机视觉应用中,检测图像中的不适当内容(例如裸露图像)是一个重要的任务。nudepy 是一个基于 Python 的库,专门用于检测图像中的不适当内容。该

pip-tools:打造可重复、可控的 Python 开发环境,解决依赖关系,让代码更稳定

在 Python 开发中,管理依赖关系是一项繁琐且容易出错的任务。手动更新依赖版本、处理冲突、确保一致性等等,都可能让开发者感到头疼。而 pip-tools 为开发者提供了一套稳定可靠的解决方案。 什么是 pip-tools? pip-tools 是一组命令行工具,旨在简化 Python 依赖关系的管理,确保项目环境的稳定性和可重复性。它主要包含两个核心工具:pip-compile 和 pip

bytes.split的用法和注意事项

当然,我很乐意详细介绍 bytes.Split 的用法和注意事项。这个函数是 Go 标准库中 bytes 包的一个重要组成部分,用于分割字节切片。 基本用法 bytes.Split 的函数签名如下: func Split(s, sep []byte) [][]byte s 是要分割的字节切片sep 是用作分隔符的字节切片返回值是一个二维字节切片,包含分割后的结果 基本使用示例: pa

HTML提交表单给python

python 代码 from flask import Flask, request, render_template, redirect, url_forapp = Flask(__name__)@app.route('/')def form():# 渲染表单页面return render_template('./index.html')@app.route('/submit_form',

Python QT实现A-star寻路算法

目录 1、界面使用方法 2、注意事项 3、补充说明 用Qt5搭建一个图形化测试寻路算法的测试环境。 1、界面使用方法 设定起点: 鼠标左键双击,设定红色的起点。左键双击设定起点,用红色标记。 设定终点: 鼠标右键双击,设定蓝色的终点。右键双击设定终点,用蓝色标记。 设置障碍点: 鼠标左键或者右键按着不放,拖动可以设置黑色的障碍点。按住左键或右键并拖动,设置一系列黑色障碍点

Python:豆瓣电影商业数据分析-爬取全数据【附带爬虫豆瓣,数据处理过程,数据分析,可视化,以及完整PPT报告】

**爬取豆瓣电影信息,分析近年电影行业的发展情况** 本文是完整的数据分析展现,代码有完整版,包含豆瓣电影爬取的具体方式【附带爬虫豆瓣,数据处理过程,数据分析,可视化,以及完整PPT报告】   最近MBA在学习《商业数据分析》,大实训作业给了数据要进行数据分析,所以先拿豆瓣电影练练手,网络上爬取豆瓣电影TOP250较多,但对于豆瓣电影全数据的爬取教程很少,所以我自己做一版。 目