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生成指定长度的随机数密码
Jan 23 Python
Python标准库os.path包、glob包使用实例
Nov 25 Python
深入理解python对json的操作总结
Jan 05 Python
Python使用pymysql小技巧
Jun 04 Python
python urllib urlopen()对象方法/代理的补充说明
Jun 29 Python
python实现自动解数独小程序
Jan 21 Python
Python生态圈图像格式转换问题(推荐)
Dec 02 Python
Python greenlet和gevent使用代码示例解析
Apr 01 Python
python/golang 删除链表中的元素
Sep 14 Python
python 将Excel转Word的示例
Mar 02 Python
浅析Python中的套接字编程
Jun 22 Python
python中redis包操作数据库的教程
Apr 19 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
编写PHP的安全策略
2006/10/09 PHP
PHP入门学习的几个不错的实例代码
2008/07/13 PHP
PHP调用Linux命令权限不足问题解决方法
2015/02/07 PHP
php curl 模拟登录并获取数据实例详解
2016/12/22 PHP
php 静态属性和静态方法区别详解
2017/04/09 PHP
JavaScript下通过的XMLHttpRequest发送请求的代码
2011/06/28 Javascript
javascript权威指南 学习笔记之javascript数据类型
2011/09/24 Javascript
使用Java实现简单的server/client回显功能的方法介绍
2013/05/03 Javascript
jQuery将所有被选中的checkbox某个属性值连接成字符串的方法
2015/01/24 Javascript
第六章之辅组类与响应式工具
2016/04/25 Javascript
Node.js配合node-http-proxy解决本地开发ajax跨域问题
2016/08/31 Javascript
JS动态遍历json中所有键值对的方法(不知道属性名的情况)
2016/12/28 Javascript
常用的javascript设计模式
2017/01/11 Javascript
基于JQuery和原生JavaScript实现网页定位导航特效
2017/04/03 jQuery
Nodejs+express+ejs简单使用实例代码
2017/09/18 NodeJs
javascript中神奇的 Date对象小结
2017/10/12 Javascript
jQuery表单校验插件validator使用方法详解
2020/02/18 jQuery
python解析json实例方法
2013/11/19 Python
Python提示[Errno 32]Broken pipe导致线程crash错误解决方法
2014/11/19 Python
利用Python绘制数据的瀑布图的教程
2015/04/07 Python
python中异常报错处理方法汇总
2016/11/20 Python
python实现多线程行情抓取工具的方法
2018/02/28 Python
python实现可视化动态CPU性能监控
2018/06/21 Python
python中dict()的高级用法实现
2019/11/13 Python
纯CSS3实现给头像加个光芒四射且旋转的背景动画效果
2014/05/07 HTML / CSS
香奈儿美国官网:CHANEL美国
2020/05/20 全球购物
linux面试相关问题
2013/04/28 面试题
文员个人的求职信范文
2013/09/26 职场文书
医学生就业推荐表自我鉴定
2014/03/26 职场文书
节能环保口号
2014/06/12 职场文书
2014年乡镇纪委工作总结
2014/12/19 职场文书
个人催款函范文
2015/06/24 职场文书
回门宴新娘答谢词
2015/09/29 职场文书
高中班主任心得体会
2016/01/07 职场文书
2017年大学生寒假社会实践活动总结
2016/04/06 职场文书
导游词之西递宏村
2019/12/10 职场文书