Python中的with语句与上下文管理器学习总结


Posted in Python onJune 28, 2016

0、关于上下文管理器
上下文管理器是可以在with语句中使用,拥有__enter__和__exit__方法的对象。

with manager as var:
  do_something(var)

相当于以下情况的简化:

var = manager.__enter__()
try:
  do_something(var)
finally:
  manager.__exit__()

换言之,PEP 343中定义的上下文管理器协议允许将无聊的try...except...finally结构抽象到一个单独的类中,仅仅留下关注的do_something部分。

__enter__方法首先被调用。它可以返回赋给var的值。as部分是可选的:如果它不出现,enter的返回值简单地被忽略。
with语句下的代码被执行。就像try子句,它们或者成功执行到底,或者break,continue或return,或者可以抛出异常。无论哪种情况,该块结束后,__exit__方法被调用。如果抛出异常,异常信息被传递给__exit__,这将在下一章节讨论。通常情况下,异常可被忽略,就像在finally子句中一样,并且将在__exit__结束后重新抛出。
比如说我们想确认一个文件在完成写操作之后被立即关闭:

>>> class closing(object):
...  def __init__(self, obj):
...   self.obj = obj
...  def __enter__(self):
...   return self.obj
...  def __exit__(self, *args):
...   self.obj.close()
>>> with closing(open('/tmp/file', 'w')) as f:
...  f.write('the contents\n')

这里我们确保了当with块退出时调用了f.close()。因为关闭文件是非常常见的操作,该支持已经出现在file类之中。它有一个__exit__方法调用close,并且本身可作为上下文管理器。

>>> with open('/tmp/file', 'a') as f:
...  f.write('more contents\n')

try...finally常见的用法是释放资源。各种不同的情况实现相似:在__enter__阶段资源被获得,在__exit__阶段释放,如果抛出异常也被传递。正如文件操作,往往这是对象使用后的自然操作,内置支持使之很方便。每一个版本,Python都在更多的地方提供支持。

1、如何使用上下文管理器:

如何打开一个文件,并写入"hello world"

filename="my.txt"
mode="w"
writer=open(filename,mode)
writer.write("hello world")
writer.close()

当发生异常时(如磁盘写满),就没有机会执行第5行。当然,我们可以采用try-finally语句块进行包装:

writer=open(filename,mode)
try:
  writer.write("hello world")
finally:
  writer.close()

当我们进行复杂的操作时,try-finally语句就会变得丑陋,采用with语句重写:

with open(filename,mode) as writer:
  writer.write("hello world")

as指代了从open()函数返回的内容,并把它赋给了新值。with完成了try-finally的任务。

2、自定义上下文管理器

with语句的作用类似于try-finally,提供一种上下文机制。要应用with语句的类,其内部必须提供两个内置函数__enter__和__exit__。前者在主体代码执行前执行,后者在主体代码执行后执行。as后面的变量,是在__enter__函数中返回的。

class echo():
  def output(self):
    print "hello world"
  def __enter__(self):
    print "enter"
    return self #可以返回任何希望返回的东西
  def __exit__(self,exception_type,value,trackback):
    print "exit"
    if exception_type==ValueError:
      return True
    else:
      return Flase
 
>>>with echo as e:
  e.output()

输出:
enter
hello world
exit
完备的__exit__函数如下:
def __exit__(self,exc_type,exc_value,exc_tb)

其中,exc_type:异常类型;exc_value:异常值;exc_tb:异常追踪信息

当__exit__返回True时,异常不传播

3、contextlib模块

contextlib模块的作用是提供更易用的上下文管理器,它是通过Generator实现的。contextlib中的contextmanager作为装饰器来提供一种针对函数级别的上下文管理机制,常用框架如下:

from contextlib import contextmanager
@contextmanager
def make_context():
  print 'enter'
  try:
    yield "ok"
  except RuntimeError,err:
    print 'error',err
  finally:
    print 'exit'
    
>>>with make_context() as value:
  print value

   
输出为:

enter
  ok
  exit

其中,yield写入try-finally中是为了保证异常安全(能处理异常)as后的变量的值是由yield返回。yield前面的语句可看作代码块执行前操作,yield之后的操作可以看作在__exit__函数中的操作。

以线程锁为例:

@contextlib.contextmanager
def loudLock():
  print 'Locking'
  lock.acquire()
  yield
  print 'Releasing'
  lock.release()
 
with loudLock():
  print 'Lock is locked: %s' % lock.locked()
  print 'Doing something that needs locking'
 
#Output:
#Locking
#Lock is locked: True
#Doing something that needs locking
#Releasing

4、contextlib.nested:减少嵌套

对于:

with open(filename,mode) as reader:
  with open(filename1,mode1) as writer:
    writer.write(reader.read())

可以通过contextlib.nested进行简化:

with contextlib.nested(open(filename,mode),open(filename1,mode1)) as (reader,writer):
  writer.write(reader.read())

在python 2.7及以后,被一种新的语法取代:

with open(filename,mode) as reader,open(filename1,mode1) as writer:
  writer.write(reader.read())

5、contextlib.closing()

file类直接支持上下文管理器API,但有些表示打开句柄的对象并不支持,如urllib.urlopen()返回的对象。还有些遗留类,使用close()方法而不支持上下文管理器API。为了确保关闭句柄,需要使用closing()为它创建一个上下文管理器(调用类的close方法)。

import contextlib
class myclass():
  def __init__(self):
    print '__init__'
  def close(self):
    print 'close()'
   
with contextlib.closing(myclass()):
  print 'ok'

   
输出:

__init__
ok
close()
Python 相关文章推荐
Python3.6日志Logging模块简单用法示例
Jun 14 Python
selenium+python自动化测试之多窗口切换
Jan 23 Python
详解python配置虚拟环境
Apr 08 Python
Python实现打砖块小游戏代码实例
May 18 Python
用Python识别人脸,人种等各种信息
Jul 15 Python
python 字符串常用函数详解
Sep 11 Python
python十进制转二进制的详解
Feb 07 Python
Selenium向iframe富文本框输入内容过程图解
Apr 10 Python
Tensorflow加载Vgg预训练模型操作
May 26 Python
简述 Python 的类和对象
Aug 21 Python
Python实现列表索引批量删除的5种方法
Nov 16 Python
Python 按比例获取样本数据或执行任务的实现代码
Dec 03 Python
深入解析Python中的上下文管理器
Jun 28 #Python
详解Python中contextlib上下文管理模块的用法
Jun 28 #Python
实例讲解Python中SocketServer模块处理网络请求的用法
Jun 28 #Python
Python中asyncore异步模块的用法及实现httpclient的实例
Jun 28 #Python
python 字典(dict)按键和值排序
Jun 28 #Python
简单谈谈python的反射机制
Jun 28 #Python
Python实现带百分比的进度条
Jun 28 #Python
You might like
PHP 数字左侧自动补0
2008/03/31 PHP
PHP的autoload自动加载机制使用说明
2010/12/28 PHP
PHP使用Nginx实现反向代理
2017/09/20 PHP
如何在centos8自定义目录安装php7.3
2019/11/28 PHP
JavaScript的Cookies
2008/01/16 Javascript
js操作textarea方法集合封装(兼容IE,firefox)
2011/02/22 Javascript
jQuery 选择表格(table)里的行和列及改变简单样式
2012/12/15 Javascript
JS求平均值的小例子
2013/11/29 Javascript
JS+Canvas 实现下雨下雪效果
2016/05/18 Javascript
jQuery加密密码到cookie的实现代码
2017/04/18 jQuery
angular $watch 一个变量的变化(实例讲解)
2017/08/02 Javascript
ES6中新增的Object.assign()方法详解
2017/09/22 Javascript
使用Angular CLI从蓝本生成代码详解
2018/03/24 Javascript
微信小程序开发背景图显示功能
2018/08/08 Javascript
vue动态改变背景图片demo分享
2018/09/13 Javascript
vue生命周期和react生命周期对比【推荐】
2018/09/19 Javascript
vue实现微信二次分享以及自定义分享的示例
2019/03/20 Javascript
详解webpack4.x之搭建前端开发环境
2019/03/28 Javascript
细说Vue组件的服务器端渲染的过程
2019/05/30 Javascript
Swiper.js实现移动端元素左右滑动
2019/09/08 Javascript
vue学习笔记之slot插槽用法实例分析
2020/02/29 Javascript
从零学python系列之新版本导入httplib模块报ImportError解决方案
2014/05/23 Python
Python3.6.2调用ffmpeg的方法
2019/01/10 Python
让你Python到很爽的加速递归函数的装饰器
2019/05/26 Python
Python正则表达式急速入门(小结)
2019/12/16 Python
基于python读取.mat文件并取出信息
2019/12/16 Python
pytorch判断是否cuda 判断变量类型方式
2020/06/23 Python
Lookfantastic美国/加拿大:英国知名美妆购物网站
2019/03/27 全球购物
应届生求职推荐信
2013/10/28 职场文书
技术人员面试提纲
2013/11/28 职场文书
大课间活动实施方案
2014/03/06 职场文书
员工考核评语大全
2014/04/26 职场文书
刑事附带民事诉讼答辩状
2015/05/22 职场文书
法人身份证明书
2015/06/18 职场文书
年终奖金发放管理制度,中小企业适用,拿去救急吧!
2019/07/12 职场文书
什么是SOLID
2022/03/24 Javascript