详解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正则分析nginx的访问日志
Jan 17 Python
解决python使用open打开文件中文乱码的问题
Dec 29 Python
Python+树莓派+YOLO打造一款人工智能照相机
Jan 02 Python
Python字典循环添加一键多值的用法实例
Jan 20 Python
Python实现微信自动好友验证,自动回复,发送群聊链接方法
Feb 21 Python
将python文件打包成EXE应用程序的方法
May 22 Python
Django 实现Admin自动填充当前用户的示例代码
Nov 18 Python
python关闭占用端口方式
Dec 17 Python
python3爬取torrent种子链接实例
Jan 16 Python
Python安装whl文件过程图解
Feb 18 Python
python 已知平行四边形三个点,求第四个点的案例
Apr 12 Python
Python实现DBSCAN聚类算法并样例测试
Jun 22 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 auth_http类库进行身份效验
2009/03/19 PHP
PHP防止注入攻击实例分析
2014/11/03 PHP
PHP中round()函数对浮点数进行四舍五入的方法
2014/11/19 PHP
php强制更新图片缓存的方法
2015/02/11 PHP
PHP的运行机制与原理(底层)
2015/11/16 PHP
js 幻灯片的实现
2011/12/06 Javascript
JS的事件绑定深入认识
2014/06/26 Javascript
JavaScript设计模式之适配器模式介绍
2014/12/28 Javascript
jQuery获取剪贴板内容的方法
2016/06/16 Javascript
JavaScript简单获取系统当前时间完整示例
2016/08/02 Javascript
AngularJS基础 ng-src 指令简单示例
2016/08/03 Javascript
用Angular实时获取本地Localstorage数据,实现一个模拟后台数据登入的效果
2016/11/09 Javascript
JavaScript 总结几个提高性能知识点(推荐)
2017/02/20 Javascript
bootstrap选项卡扩展功能详解
2017/06/14 Javascript
详解bootstrap用dropdown-menu实现上下文菜单
2017/09/22 Javascript
vue 解决循环引用组件报错的问题
2018/09/06 Javascript
Vue中Axios从远程/后台读取数据
2019/01/21 Javascript
小程序中this.setData的使用和注意事项
2019/08/28 Javascript
vue和iview实现Scroll 数据无限滚动功能
2019/10/31 Javascript
echarts饼图各个板块之间的空隙如何实现
2020/12/01 Javascript
python小技巧——将变量保存在本地及读取
2020/11/13 Python
html5/css3响应式页面开发总结
2018/10/16 HTML / CSS
美国婴儿用品店:Babies”R”Us
2017/10/12 全球购物
Homestay中文官网:全球寄宿家庭
2018/10/18 全球购物
介绍一下JNDI的基本概念
2013/07/26 面试题
通信工程毕业生自荐信
2013/11/01 职场文书
新郎父亲婚宴答谢词
2014/01/11 职场文书
师德自我剖析材料范文
2014/10/06 职场文书
庆六一宣传标语
2014/10/08 职场文书
公司前台接待岗位职责
2015/04/03 职场文书
政府会议通知范文
2015/04/15 职场文书
新郎父母婚礼致辞
2015/07/27 职场文书
《大禹治水》教学反思
2016/02/22 职场文书
导游词之南迦巴瓦峰
2019/11/19 职场文书
关于HTML编码导致的乱码问题
2021/09/04 HTML / CSS
【js设计模式】SOLID五大设计原则
2022/03/24 Javascript