详解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使用bs4获取58同城城市分类的方法
Jul 08 Python
利用Python爬虫给孩子起个好名字
Feb 14 Python
Python实现二维数组按照某行或列排序的方法【numpy lexsort】
Sep 22 Python
python导出hive数据表的schema实例代码
Jan 22 Python
python3中函数参数的四种简单用法
Jul 09 Python
利用Python半自动化生成Nessus报告的方法
Mar 19 Python
详解用Python练习画个美队盾牌
Mar 23 Python
Python符号计算之实现函数极限的方法
Jul 15 Python
Django之路由层的实现
Sep 09 Python
Python3实现zip分卷压缩过程解析
Oct 09 Python
Python 创建TCP服务器的方法
Jul 28 Python
VSCODE配置Markdown及Markdown基础语法详解
Jan 19 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新手上路(十一)
2006/10/09 PHP
php简单提示框alert封装函数
2010/08/08 PHP
php4与php5的区别小结(配置异同)
2011/12/20 PHP
PHP内核学习教程之php opcode内核实现
2016/01/27 PHP
PHP+Ajax实现验证码的实时验证
2016/07/20 PHP
jQuery lazyload 的重复加载错误以及修复方法
2010/11/19 Javascript
简单介绍JavaScript数据类型之隐式类型转换
2015/12/28 Javascript
Vue.directive 自定义指令的问题小结
2018/03/04 Javascript
深入浅出理解JavaScript高级定时器原理与用法
2018/08/02 Javascript
小程序兼容安卓和IOS数据处理问题及坑
2018/09/18 Javascript
详解KOA2如何手写中间件(装饰器模式)
2018/10/11 Javascript
详解在Angular4中使用ng2-baidu-map的方法
2019/06/19 Javascript
layui表格数据重载
2019/07/27 Javascript
浅谈Vue SSR中的Bundle的具有使用
2019/11/21 Javascript
vue element-ui中table合计指定列求和实例
2020/11/02 Javascript
深入解析Python编程中super关键字的用法
2016/06/24 Python
利用Python循环(包括while&amp;for)各种打印九九乘法表的实例
2017/11/06 Python
Python中类的初始化特殊方法
2017/12/01 Python
python基于物品协同过滤算法实现代码
2018/05/31 Python
python 用lambda函数替换for循环的方法
2018/06/09 Python
python IDLE 背景以及字体大小的修改方法
2019/07/12 Python
详解Django将秒转换为xx天xx时xx分
2019/09/27 Python
使用Matplotlib 绘制精美的数学图形例子
2019/12/13 Python
Python实现word2Vec model过程解析
2019/12/16 Python
Python第三方库的几种安装方式(小结)
2020/04/03 Python
python -v 报错问题的解决方法
2020/09/15 Python
利用python+ffmpeg合并B站视频及格式转换的实例代码
2020/11/24 Python
Python基于Socket实现简易多人聊天室的示例代码
2020/11/29 Python
Gap英国官网:Gap UK
2018/07/18 全球购物
分解成质因数(如435234=251*17*17*3*2,据说是华为笔试题)
2014/07/16 面试题
毕业生的自我鉴定该怎么写
2013/12/02 职场文书
幼儿园美术教学反思
2014/01/31 职场文书
班委竞选演讲稿
2014/04/28 职场文书
美丽家庭事迹材料
2014/05/03 职场文书
辞职信模板(中英文版)
2015/02/27 职场文书
Ubuntu18.04下QT开发Android无法连接设备问题解决实现
2022/06/01 Java/Android