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中的map()函数和reduce()函数的用法
Apr 27 Python
基于Django模板中的数字自增(详解)
Sep 05 Python
详解python OpenCV学习笔记之直方图均衡化
Feb 08 Python
python之Flask实现简单登录功能的示例代码
Dec 24 Python
在pycharm 中添加运行参数的操作方法
Jan 19 Python
python3读取图片并灰度化图片的四种方法(OpenCV、PIL.Image、TensorFlow方法)总结
Jul 04 Python
python定位xpath 节点位置的方法
Aug 27 Python
Python笔记之工厂模式
Nov 20 Python
python创建n行m列数组示例
Dec 02 Python
python基于opencv检测程序运行效率
Dec 28 Python
Django中使用Json返回数据的实现方法
Jun 03 Python
Python实现简单的2048小游戏
Mar 01 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生成N个不重复的随机数实例
2013/11/12 PHP
php像数组一样存取和修改字符串字符
2014/03/21 PHP
在php中设置session用memcache来存储的方法总结
2016/01/14 PHP
PHP7多线程搭建教程
2017/04/21 PHP
老生常谈php中传统验证与thinkphp框架(必看篇)
2017/06/10 PHP
javascript面向对象之Javascript 继承
2010/05/04 Javascript
js中eval详解
2012/03/30 Javascript
A标签触发onclick事件而不跳转的多种解决方法
2013/06/27 Javascript
简单实用jquery版三级联动select示例
2013/07/04 Javascript
js验证整数加保留小数点的简单实例
2013/12/02 Javascript
jquery操作select大全
2014/04/25 Javascript
分享一则javascript 调试技巧
2015/01/02 Javascript
JS修改iframe页面背景颜色的方法
2015/04/01 Javascript
简单的jQuery入门指引
2015/07/28 Javascript
AngularJS模块学习之Anchor Scroll
2016/01/19 Javascript
JavaScript事件类型中焦点、鼠标和滚轮事件详解
2016/01/25 Javascript
JavaScript简单实现弹出拖拽窗口(一)
2016/06/17 Javascript
第一次接触神奇的Bootstrap导航条
2016/08/09 Javascript
解析利用javascript如何判断一个数为素数
2016/12/08 Javascript
详解数组Array.sort()排序的方法
2020/05/09 Javascript
修改UA在PC中访问只能在微信中打开的链接方法
2017/11/27 Javascript
jquery实现左右轮播切换效果
2018/01/01 jQuery
详解如何给React-Router添加路由页面切换时的过渡动画
2019/04/25 Javascript
[01:30:15]DOTA2-DPC中国联赛 正赛 Ehome vs Aster BO3 第二场 2月2日
2021/03/11 DOTA
python中threading超线程用法实例分析
2015/05/16 Python
python实现BackPropagation算法
2017/12/14 Python
Python生成指定数量的优惠码实操内容
2019/06/18 Python
python2和python3应该学哪个(python3.6与python3.7的选择)
2019/10/01 Python
python设置代理和添加镜像源的方法
2020/02/14 Python
Python hashlib模块的使用示例
2020/10/09 Python
标签和贴纸印刷:Lightning Labels
2018/03/22 全球购物
全球领先的全景影像品牌:Insta360
2019/08/21 全球购物
Python面试题:Python里面如何生成随机数
2015/03/12 面试题
老同学聚会感言
2014/02/23 职场文书
颂军魂爱军营演讲稿
2014/09/13 职场文书
成绩单评语
2015/01/04 职场文书