详解Python with/as使用说明


Posted in Python onDecember 13, 2018

with/as

使用open打开过文件的对with/as都已经非常熟悉,其实with/as是对try/finally的一种替代方案。

当某个对象支持一种称为"环境管理协议"的协议时,就会通过环境管理器来自动执行某些善后清理工作,就像finally一样:不管中途是否发生异常,最终都会执行某些清理操作。

用法:

with expression [as var]:
 with_block_code

当expression返回的对象是支持环境管理协议的时候,就可以使用with。as var是可选的,如果不使用as var,expression返回对象将被丢弃,如果使用as var,就会将expression的返回对象赋值给变量var。

整个流程大致如下:先评估expression,如果支持环境管理协议,然后开始with/as语句块结构,当准备退出with语句块的时候,将执行对象中定义的善后操作。工作机制的细节见下文。

例如,open()返回的文件对象是支持环境管理协议的,所以可以用with/as来安全地打开文件:

with open(r'd:\a\b\c\a.log') as logfile:
 for line in logfile:
  print(line)
  ...more code here...

整个过程是先open(),然后with/as,输出每一行后将要退出with语句块的时候,环境管理器根据文件对象中定义的操作关闭文件。

它实际上等价于:

myfile = open(r'd:\a\b\c\a.log')
try:
 for line in myfile:
  print(line)
  ...more code here...
finally:
 myfile.close()

虽然在文件不被引用之后,垃圾回收器会自动回收这个文件对象,但是垃圾回收器的回收操作是有等待时间的。换句话说,如果不使用with/as打开文件,也不显示close()关闭文件,那么这个文件很可能会在用完之后保持空闲一段时间,然后才被垃圾回收器回收。

with/as不仅用于文件打开/关闭,锁操作也支持环境管理协议,也就是说,在有需要的时候会自动释放锁资源。

嵌套多个环境管理器

在python 3.1之后,with as支持多个环境管理器,使用逗号隔开即可。

with A() as a, B() as b:
 ...statements...

它等价于嵌套的with:

with A() as a:
 with B() as b:
  ...statements...

多环境管理器管理的多个对象会在with语句块中出现异常的时候,或者执行完with语句块的时候全部自动被清理(例如文件关闭操作)。

例如,打开两个文件,将它们的内容通过zip()合并在一起,并且同时关闭它们:

with open('a.file') as f1, open('b.file') as f2:
 for pair in zi[(f1, f2):
  print(pair)

自定义环境管理器

无论是文件还是锁,都是别人已经写好了环境管理器的对象。我们自己也可以写环境管理器,让它可以使用with/as,这实际上属于运算符重载的范畴。

要写自己的环境管理器,先了解with/as的工作机制的细节:

  1. 先评估expression,评估的返回结果是一个对象,这个对象要具有 __enter__ __exit__ 方法,返回的对象称为"环境管理器"
  2. 然后调用环境管理器的 __enter__ 方法。 __enter__ 方法的返回值赋值给 as 指定的变量,或者直接丢弃(没有使用as)
  3. 然后执行with语句块中的内容
  4. 如果执行with语句块中的内容时抛出了异常,将调用 __exit__(type,value,traceback) 方法,其中这3个和异常相关的参数来源于 sys.exc_info 。如果 __exit__ 返回值为False,则会自动重新抛异常以便传播异常,否则异常被认为合理处理
  5. 如果with语句块中的内容没有抛异常,则直接调用 __exit__(None,None,None) ,即这三个参数都传递为None值

看一个简单的示例:

class TraceBlock:
 def message(self, arg):
  print('running ' + arg)

 def __enter__(self):
  print('starting with block')
  return self

 def __exit__(self, exc_type, exc_value, exc_tb):
  if exc_type is None:
   print('exited normally\n')
  else:
   print('raise an exception! ' + str(exc_type))
   return False

上面的 __enter__ 方法返回的对象会赋值给as关键字指定的变量,在这个示例中即将对象自身返回。如果有需求,可以返回其它对象。

上面的 __exit__ 中,如果异常的类型为None,说明with语句块中的语句执行过程没有抛异常,正常结束即可。但是如果有异常,则要求返回False,实际上上面的 return False 可以去掉,因为函数没有return时默认返回None,它的布尔值代表的就时False。

测试下:

with TraceBlock() as action:
 action.message("test 1")
 print("reached")
 
print('-' * 20, "\n")

with TraceBlock() as action:
 action.message("test 2")
 raise TypeError
 print("not reached")

结果如下:

starting with block
running test 1
reached
exited normally

--------------------

starting with block
running test 2
raise an exception! <class 'TypeError'>
Traceback (most recent call last):
  File "g:/pycode/list.py", line 23, in <module>
    raise TypeError
TypeError

定义环境管理器不是件简单的事。一般来说,如果不是很复杂的需求,直接使用try/finally来定义相关操作即可。

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

Python 相关文章推荐
python实现的各种排序算法代码
Mar 04 Python
Python的函数嵌套的使用方法
Jan 24 Python
python判断一个数是否能被另一个整数整除的实例
Dec 12 Python
django的settings中设置中文支持的实现
Apr 28 Python
python实时检测键盘输入函数的示例
Jul 17 Python
Python 实现取多维数组第n维的前几位
Nov 26 Python
Python生成词云的实现代码
Jan 14 Python
使用python实现飞机大战游戏
Mar 23 Python
Python SMTP配置参数并发送邮件
Jun 16 Python
python 三边测量定位的实现代码
Apr 22 Python
python中的装饰器该如何使用
Jun 18 Python
Python使用永中文档转换服务
May 06 Python
在python中以相同顺序shuffle两个list的方法
Dec 13 #Python
对python GUI实现完美进度条的示例详解
Dec 13 #Python
PyTorch 1.0 正式版已经发布了
Dec 13 #Python
修改python plot折线图的坐标轴刻度方法
Dec 13 #Python
python画图系列之个性化显示x轴区段文字的实例
Dec 13 #Python
Python实现的各种常见分布算法示例
Dec 13 #Python
Python线性拟合实现函数与用法示例
Dec 13 #Python
You might like
在服务端进行目录建立、删除,文件上传、删除的过程的php代码
2008/09/10 PHP
php mssql 分页SQL语句优化 持续影响
2009/04/26 PHP
解析php中的escape函数
2013/06/29 PHP
PHP之浮点数计算比较以及取整数不准确的解决办法
2015/07/29 PHP
通过javascript获取iframe里的值示例代码
2013/06/24 Javascript
JavaScript简单实现网页回到顶部功能
2013/11/12 Javascript
javascript:void(0)是什么意思示例介绍
2013/11/17 Javascript
获得Javascript对象属性个数的示例代码
2013/11/21 Javascript
解决js中window.open弹出的是上次的缓存页面问题
2013/12/29 Javascript
JavaScript实现三阶幻方算法谜题解答
2014/12/29 Javascript
实现placeholder效果的方案汇总
2015/06/11 Javascript
JavaScript中用于四舍五入的Math.round()方法讲解
2015/06/15 Javascript
Vue.js实现网格列表布局转换方法
2017/08/25 Javascript
JavaScript数组特性与实践应用深入详解
2018/12/30 Javascript
详解vue项目中调用百度地图API使用方法
2019/04/25 Javascript
vue spa应用中的路由缓存问题与解决方案
2019/05/31 Javascript
利用d3.js实现蜂巢图表带动画效果
2019/09/03 Javascript
JS中自定义事件的使用与触发操作实例分析
2019/11/01 Javascript
python3访问sina首页中文的处理方法
2014/02/24 Python
通过数据库向Django模型添加字段的示例
2015/07/21 Python
Python+Wordpress制作小说站
2017/04/14 Python
python3.4实现邮件发送功能
2018/05/28 Python
详解python3安装pillow后报错没有pillow模块以及没有PIL模块问题解决
2019/04/17 Python
Python使用Pyqt5实现简易浏览器(最新版本测试过)
2020/04/27 Python
Python如何输出警告信息
2020/07/30 Python
python实现磁盘日志清理的示例
2020/11/05 Python
python中random模块详解
2021/03/01 Python
类成员函数的重载、覆盖和隐藏区别
2016/01/27 面试题
如何用JQuery进行表单验证
2013/05/29 面试题
养殖项目策划书范文
2014/01/13 职场文书
签约仪式策划方案
2014/06/02 职场文书
2015年试用期工作总结
2014/12/12 职场文书
征求意见函
2015/06/05 职场文书
2015年教师节新闻稿
2015/07/17 职场文书
CSS实现五种常用的2D转换
2021/12/06 HTML / CSS
python文件与路径操作神器 pathlib
2022/04/01 Python