Python 的 with 语句详解


Posted in Python onJune 13, 2014

一、简介

with是从Python 2.5 引入的一个新的语法,更准确的说,是一种上下文的管理协议,用于简化try…except…finally的处理流程。with通过__enter__方法初始化,然后在__exit__中做善后以及处理异常。对于一些需要预先设置,事后要清理的一些任务,with提供了一种非常方便的表达。

with的基本语法如下,EXPR是一个任意表达式,VAR是一个单一的变量(可以是tuple),”as VAR”是可选的。

with EXPR as VAR:
    BLOCK

根据PEP 343的解释,with…as…会被翻译成以下语句:
mgr = (EXPR)
exit = type(mgr).__exit__  # Not calling it yet
value = type(mgr).__enter__(mgr)
exc = True
try:
    try:
        VAR = value  # Only if "as VAR" is present
        BLOCK
    except:
        # The exceptional case is handled here
        exc = False
        if not exit(mgr, *sys.exc_info()):
            raise
        # The exception is swallowed if exit() returns true
finally:
    # The normal and non-local-goto cases are handled here
    if exc:
        exit(mgr, None, None, None)

为什么这么复杂呢?注意finally中的代码,需要BLOCK被执行后才会执行finally的清理工作,因为当EXPR执行时抛出异常,访问mgr.exit执行就会报AttributeError的错误。

二、实现方式

根据前面对with的翻译可以看到,被with求值的对象必须有一个__enter__方法和一个__exit__方法。稍微看一个文件读取的例子吧,注意在这里我们要解决2个问题:文件读取异常,读取完毕后关闭文件句柄。用try…except一般会这样写:

f = open('/tmp/tmp.txt')
try:
    for line in f.readlines():
        print(line)
finally:
    f.close()

注意我们这里没有处理文件打开失败的IOError,上面的写法可以正常工作,但是对于每个打开的文件,我们都要手动关闭文件句柄。如果要使用with来实现上述功能,需要需要一个代理类:
class opened(object):
    def __init__(self, name):
        self.handle = open(name)
    def __enter__(self):
        return self.handle
    def __exit__(self, type, value, trackback):
        self.handle.close()
with opened('/tmp/a.txt') as f:
    for line in f.readlines():
        print(line)

注意我们定了一个名字叫opened的辅助类,并实现了__enter__和__exit__方法,__enter__方法没有参数,__exit__方法的3个参数,分别代表异常的类型、值、以及堆栈信息,如果没有异常,3个入参的值都为None。

如果你不喜欢定义class,还可以用Python标准库提供的contextlib来实现:

from contextlib import contextmanager
@contextmanager
def opened(name):
    f = open(name)
    try:
        yield f
    finally:
        f.close()
with opened('/tmp/a.txt') as f:
    for line in f.readlines():
        print(line)

使用contextmanager的函数,yield只能返回一个参数,而yield后面是处理清理工作的代码。在我们读取文件的例子中,就是关闭文件句柄。这里原理上和我们之前实现的类opened是相同的,有兴趣的可以参考一下contextmanager的源代码。

三、应用场景

废话了这么多,那么到底那些场景下该使用with,有没有一些优秀的例子?当然啦,不然这篇文章意义何在。以下摘自PEP 343。

一个确保代码执行前加锁,执行后释放锁的模板:

@contextmanager
    def locked(lock):
        lock.acquire()
        try:
            yield
        finally:
            lock.release()
    with locked(myLock):
        # Code here executes with myLock held.  The lock is
        # guaranteed to be released when the block is left (even
        # if via return or by an uncaught exception).

数据库事务的提交和回滚:
@contextmanager
        def transaction(db):
            db.begin()
            try:
                yield None
            except:
                db.rollback()
                raise
            else:
                db.commit()

重定向stdout:
@contextmanager
def stdout_redirected(new_stdout):
    save_stdout = sys.stdout
    sys.stdout = new_stdout
    try:
        yield None
    finally:
        sys.stdout = save_stdout
with opened(filename, "w") as f:
    with stdout_redirected(f):
        print "Hello world"

注意上面的例子不是线程安全的,再多线程环境中要小心使用。

四、总结

with是对try…expect…finally语法的一种简化,并且提供了对于异常非常好的处理方式。在Python有2种方式来实现with语法:class-based和decorator-based,2种方式在原理上是等价的,可以根据具体场景自己选择。

with最初起源于一种block…as…的语法,但是这种语法被很多人所唾弃,最后诞生了with,关于这段历史依然可以去参考PEP-343和PEP-340

Python 相关文章推荐
Python爬取APP下载链接的实现方法
Sep 30 Python
windows系统下Python环境的搭建(Aptana Studio)
Mar 06 Python
使用Python写CUDA程序的方法
Mar 27 Python
利用Python自带PIL库扩展图片大小给图片加文字描述的方法示例
Aug 08 Python
单利模式及python实现方式详解
Mar 20 Python
python使用opencv驱动摄像头的方法
Aug 03 Python
使用Python+wxpy 找出微信里把你删除的好友实例
Feb 21 Python
Python实现的北京积分落户数据分析示例
Mar 27 Python
python 自动识别并连接串口的实现
Jan 19 Python
Python实现王者荣耀自动刷金币的完整步骤
Jan 22 Python
解决TensorFlow训练模型及保存数量限制的问题
Mar 03 Python
python中pycryto实现数据加密
Apr 29 Python
python学习笔记:字典的使用示例详解
Jun 13 #Python
Python urlopen()函数 示例分享
Jun 12 #Python
python教程之用py2exe将PY文件转成EXE文件
Jun 12 #Python
Python struct模块解析
Jun 12 #Python
深度剖析使用python抓取网页正文的源码
Jun 11 #Python
python k-近邻算法实例分享
Jun 11 #Python
浅析python 内置字符串处理函数的使用方法
Jun 11 #Python
You might like
PHP中实现中文字符进制转换原理分析
2011/12/06 PHP
header跳转和include包含问题详解
2012/09/08 PHP
解析php防止form重复提交的方法
2013/07/01 PHP
php中解析带中文字符的url函数分享
2015/01/20 PHP
PHP基于curl后台远程登录正方教务系统的方法
2016/10/14 PHP
php 根据自增id创建唯一编号类
2017/04/06 PHP
由prototype_1.3.1进入javascript殿堂-类的初探
2006/11/06 Javascript
js 跨域和ajax 跨域问题小结
2009/07/01 Javascript
JavaScript作用域链示例分享
2014/05/27 Javascript
使用jquery清空、复位整个输入域
2015/04/02 Javascript
javascript伸缩菜单栏实现代码分享
2015/11/12 Javascript
jQuery实现简单的DIV拖动效果
2016/02/19 Javascript
用Vue写一个分页器的示例代码
2018/04/22 Javascript
javascript标准库(js的标准内置对象)总结
2018/05/26 Javascript
javascript实现滚轮轮播图片
2020/12/13 Javascript
使用python搭建Django应用程序步骤及版本冲突问题解决
2013/11/19 Python
python实现的登录和操作开心网脚本分享
2014/07/09 Python
python在控制台输出进度条的方法
2015/06/20 Python
Python中pygame的mouse鼠标事件用法实例
2015/11/11 Python
python实现爬虫统计学校BBS男女比例之多线程爬虫(二)
2015/12/31 Python
对python中的控制条件、循环和跳出详解
2019/06/24 Python
Python爬虫动态ip代理防止被封的方法
2019/07/07 Python
python爬取盘搜的有效链接实现代码
2019/07/20 Python
python的faker库用法
2019/11/28 Python
THE OUTNET英国官网:国际设计师品牌折扣网站
2016/08/14 全球购物
英国太阳镜品牌:Taylor Morris Eyewear
2018/04/18 全球购物
卡拉威高尔夫官方网站:Callaway Golf
2020/09/16 全球购物
如何判断计算机可能已经中马
2013/03/22 面试题
行政主管岗位职责
2013/11/18 职场文书
计算机专业推荐信范文
2013/11/27 职场文书
实习生自我鉴定范文
2013/12/05 职场文书
优秀毕业生找工作自荐信
2014/06/23 职场文书
2014年保卫科工作总结
2014/12/05 职场文书
2014年小学辅导员工作总结
2014/12/23 职场文书
律师催款函范文
2015/06/24 职场文书
论语读书笔记
2015/06/26 职场文书