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 相关文章推荐
Python使用bs4获取58同城城市分类的方法
Jul 08 Python
Python的Tornado框架实现图片上传及图片大小修改功能
Jun 30 Python
python 全文检索引擎详解
Apr 25 Python
Python文件的读写和异常代码示例
Oct 31 Python
对tf.reduce_sum tensorflow维度上的操作详解
Jul 26 Python
解决pycharm安装后代码区不能编辑的问题
Oct 28 Python
解决pycharm回车之后不能换行或不能缩进的问题
Jan 16 Python
Python上下文管理器类和上下文管理器装饰器contextmanager用法实例分析
Nov 07 Python
Python如何爬取qq音乐歌词到本地
Jun 01 Python
python解释器安装教程的方法步骤
Jul 02 Python
matplotlib设置颜色、标记、线条,让你的图像更加丰富(推荐)
Sep 25 Python
解决python3安装pandas出错的问题
May 20 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
用Socket发送电子邮件
2006/10/09 PHP
让你的PHP同时支持GIF、png、JPEG
2006/10/09 PHP
php中通过虚代理实现延迟加载的实现代码
2011/06/10 PHP
PHP new static 和 new self详解
2017/02/19 PHP
php 读取文件夹下所有图片、文件的实例
2018/10/17 PHP
Laravel validate error处理,ajax,json示例
2019/10/25 PHP
Laravel 修改验证异常的响应格式实例代码详解
2020/05/25 PHP
向fckeditor编辑器插入指定代码的方法
2007/05/25 Javascript
js form 验证函数 当前比较流行的错误提示
2009/06/23 Javascript
jQuery学习笔记之DOM对象和jQuery对象
2010/12/22 Javascript
在Ubuntu上安装最新版本的Node.js
2014/07/14 Javascript
js和jquery中循环的退出和继续下一个循环
2014/09/03 Javascript
JavaScript表格常用操作方法汇总
2015/04/15 Javascript
微信小程序首页的分类功能和搜索功能的实现思路及代码详解
2018/09/11 Javascript
小程序云开发获取不到数据库记录的解决方法
2019/05/18 Javascript
Vue学习笔记之计算属性与侦听器用法
2019/12/07 Javascript
Python strip lstrip rstrip使用方法
2008/09/06 Python
跟老齐学Python之使用Python查询更新数据库
2014/11/25 Python
Go语言基于Socket编写服务器端与客户端通信的实例
2016/02/19 Python
Python实现的桶排序算法示例
2017/11/29 Python
在Windows中设置Python环境变量的实例讲解
2018/04/28 Python
python pycurl验证basic和digest认证的方法
2018/05/02 Python
pyqt5对用qt designer设计的窗体实现弹出子窗口的示例
2019/06/19 Python
整理HTML5的一些新特性与Canvas的常用属性
2016/01/29 HTML / CSS
大学生毕业求职的自我评价
2013/09/29 职场文书
优秀求职信范文分享
2014/01/26 职场文书
1亿有多大教学反思
2014/05/01 职场文书
2014年业务工作总结
2014/11/17 职场文书
保送生自荐信
2015/03/06 职场文书
2015年基建工作总结范文
2015/05/23 职场文书
签约仪式致辞
2015/07/30 职场文书
2019新学期家长会工作计划
2019/08/21 职场文书
Goland使用Go Modules创建/管理项目的操作
2021/05/06 Golang
python四个坐标点对图片区域最小外接矩形进行裁剪
2021/06/04 Python
Android开发 使用文件储存的方式保存QQ密码
2022/04/24 Java/Android
Mysql数据库group by原理详解
2022/07/07 MySQL