Python上下文管理器和with块详解


Posted in Python onSeptember 09, 2017

上下文管理器和with块,具体内容如下

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

with 语句的目的是简化 try/finally 模式。这种模式用于保证一段代码运行完毕后执行某项操作,即便那段代码由于异常、 return 语句或 sys.exit() 调用而中止,也会执行指定的操作。 finally 子句中的代码通常用于释放重要的资源,或者还原临时变更的状态。

==上下文管理器协议包含enter和exit两个方法==。 with 语句开始运行时,会在上下文管理器对象上调用enter方法。 with 语句运行结束后,会在上下文管理器对象上调用exit方法,以此扮演 finally 子句的角色。

==执行 with 后面的表达式得到的结果是上下文管理器对象,把值绑定到目标变量上(as 子句)是在上下文管理器对象上调用enter方法的结果==。with 语句的 as 子句是可选的。对 open 函数来说,必须加上 as子句,以便获取文件的引用。不过,有些上下文管理器会返回 None,因为没什么有用的对象能提供给用户。

with open('mirror.py') as fp:
  ...

自定义的上下文类:

class A:
  def __init__(self, name):
    self.name = name

  def __enter__(self):
    print('enter')
    return self.name

  def __exit__(self, exc_type, exc_val, exc_tb):
    print('gone')

with A('xiaozhe') as dt:
  print(dt)

contextlib模块

contextlib 模块中还有一些类和其他函数,使用范围更广。

closing:如果对象提供了 close() 方法,但没有实现enter/exit协议,那么可以使用这个函数构建上下文管理器。
suppress:构建临时忽略指定异常的上下文管理器。
@contextmanager:==这个装饰器把简单的生成器函数变成上下文管理器==,这样就不用创建类去实现管理器协议了。
ContextDecorator:这是个基类,用于定义基于类的上下文管理器。这种上下文管理器也能用于装饰函数,在受管理的上下文中运行整个函数
ExitStack:这个上下文管理器能进入多个上下文管理器。 with 块结束时, ExitStack 按照后进先出的顺序调用栈中各个上下文管理器的exit方法。

==使用最广泛的是 @contextmanager 装饰器,因此要格外留心。这个装饰器也有迷惑人的一面,因为它与迭代无关,却要使用 yield 语句==。

使用@contextmanager

@contextmanager 装饰器能减少创建上下文管理器的样板代码量,不用编写一个完整的类定义enter和exit方法,而只需实现有一个 yield 语句的生成器,生成想让enter方法返回的值。

在使用 @contextmanager 装饰的生成器中, yield 语句的作用是把函数的定义体分成两部分: ==yield 语句前面的所有代码在 with 块开始时(即解释器调用enter方法时)执行, yield 语句后面的代码在 with 块结束时(即调用exit方法时)执行==。

import contextlib

@contextlib.contextmanager
def test(name):
  print('start')
  yield name
  print('end')

with test('zhexiao123') as dt:
  print(dt)
  print('doing something')

实现原理

contextlib.contextmanager 装饰器会把函数包装成实现enter和exit方法的类。类的名称是 _GeneratorContextManager。

这个类的enter方法有如下作用:
1. 调用生成器函数,保存生成器对象(这里把它称为 gen)。
2. 调用 next(gen),执行到 yield 关键字所在的位置。
3. 返回 next(gen) 产出的值,以便把产出的值绑定到 with/as 语句中的目标变量上。

with 块终止时,exit方法会做以下几件事:

1. 检查有没有把异常传给 exc_type;如果有,调用 gen.throw(exception),在生成器函数定义体中包含 yield 关键字的那一行抛出异常。
2. 否则,调用 next(gen),继续执行生成器函数定义体中 yield 语句之后的代码。

异常处理

为了告诉解释器异常已经处理了,exit方法会返回 True,此时解释器会压制异常。如果exit方法没有显式返回一个值,那么解释器得到的是 None,然后向上冒泡异常。

使用 @contextmanager 装饰器时,默认的行为是相反的:装饰器提供的exit方法假定发给生成器的所有异常都得到处理了,因此应该压制异常。 如果不想让 @contextmanager 压制异常,必须在被装饰的函数中显式重新抛出异常。

上面的代码有个bug:如果在 with 块中抛出了异常, Python 解释器会将其捕获,然后在 test 函数的 yield 表达式里再次抛出。但是,那里没有处理错误的代码,因此 test 函数会中止。

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

import contextlib

@contextlib.contextmanager
def test(name):
  print('start')

  try:
    yield name
  except:
    raise ValueError('error')
  finally:
    print('end')

with test('zhexiao123') as dt:
  print(dt)
  print('doing something')

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python基础教程之自定义函数介绍
Aug 29 Python
python实现搜索指定目录下文件及文件内搜索指定关键词的方法
Jun 28 Python
解决python2.7 查询mysql时出现中文乱码
Oct 09 Python
python模块简介之有序字典(OrderedDict)
Dec 01 Python
对numpy 数组和矩阵的乘法的进一步理解
Apr 04 Python
python设定并获取socket超时时间的方法
Jan 12 Python
Python3的高阶函数map,reduce,filter的示例详解
Jul 23 Python
Python中的self用法详解
Aug 06 Python
Django-xadmin+rule对象级权限的实现方式
Mar 30 Python
django的autoreload机制实现
Jun 03 Python
python 爬取免费简历模板网站的示例
Sep 27 Python
python多线程和多进程关系详解
Dec 14 Python
Python使用asyncio包处理并发详解
Sep 09 #Python
Python协程的用法和例子详解
Sep 09 #Python
python利用dir函数查看类中所有成员函数示例代码
Sep 08 #Python
Python使用回溯法子集树模板解决爬楼梯问题示例
Sep 08 #Python
Python使用回溯法子集树模板获取最长公共子序列(LCS)的方法
Sep 08 #Python
python中实现指定时间调用函数示例代码
Sep 08 #Python
Python基于回溯法子集树模板解决最佳作业调度问题示例
Sep 08 #Python
You might like
允许phpmyadmin空密码登录的配置方法
2011/05/29 PHP
基于AppServ,XAMPP,WAMP配置php.ini去掉警告信息(NOTICE)的方法详解
2013/05/07 PHP
解决PhpMyAdmin中导入2M以上大文件限制的方法分享
2014/06/06 PHP
图解找出PHP配置文件php.ini的路径的方法
2014/08/20 PHP
php中heredoc与nowdoc介绍
2014/12/25 PHP
php简单统计中文个数的方法
2016/09/30 PHP
PHP操作Postgresql封装类与应用完整实例
2018/04/24 PHP
js 禁止选择功能实现代码(兼容IE/Firefox)
2010/04/23 Javascript
使用jQuery jqPlot插件绘制柱状图
2014/12/18 Javascript
JavaScript对象属性检查、增加、删除、访问操作实例
2015/07/08 Javascript
详解Angularjs中的依赖注入
2016/03/11 Javascript
Vue.js基础学习之class与样式绑定
2017/03/20 Javascript
JS中用EL表达式获取上下文参数值的方法
2018/03/28 Javascript
记录vue项目中遇到的一点小问题
2019/05/14 Javascript
Vue+tracking.js 实现前端人脸检测功能
2020/04/16 Javascript
JavaScript自定义超时API代码实例
2020/04/30 Javascript
如何在 Vue 中使用 JSX
2021/02/14 Vue.js
python教程之用py2exe将PY文件转成EXE文件
2014/06/12 Python
Python内置函数dir详解
2015/04/14 Python
Python干货:分享Python绘制六种可视化图表
2018/08/27 Python
python字典值排序并取出前n个key值的方法
2018/10/17 Python
Python生成MD5值的两种方法实例分析
2019/04/26 Python
Python寻找路径和查找文件路径的示例
2019/07/10 Python
opencv实现简单人脸识别
2021/02/19 Python
python 浅谈serial与stm32通信的编码问题
2019/12/18 Python
Anaconda+VSCode配置tensorflow开发环境的教程详解
2020/03/30 Python
解决Keras的自定义lambda层去reshape张量时model保存出错问题
2020/07/01 Python
如何在mac下配置python虚拟环境
2020/07/06 Python
Python selenium键盘鼠标事件实现过程详解
2020/07/28 Python
Python爬虫设置Cookie解决网站拦截并爬取蚂蚁短租的问题
2021/02/22 Python
HTML5 manifest离线缓存的示例代码
2018/08/08 HTML / CSS
Java Servlet的主要功能和作用是什么
2014/02/14 面试题
医学生个人求职信范文
2013/09/24 职场文书
师范应届生语文教师求职信
2013/10/29 职场文书
结婚喜宴迎宾词
2015/08/10 职场文书
python开发制作好看的时钟效果
2022/05/02 Python