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多进程通信Queue、Pipe、Value、Array实例
Nov 21 Python
Python自动连接ssh的方法
Mar 07 Python
Perl中著名的Schwartzian转换问题解决实现
Jun 02 Python
Django中Model的使用方法教程
Mar 07 Python
利用Python如何批量更新服务器文件
Jul 29 Python
Python3.5集合及其常见运算实例详解
May 01 Python
python与C、C++混编的四种方式(小结)
Jul 15 Python
python使用多线程编写tcp客户端程序
Sep 02 Python
python 图像的离散傅立叶变换实例
Jan 02 Python
Python3查找列表中重复元素的个数的3种方法详解
Feb 13 Python
Python figure参数及subplot子图绘制代码
Apr 18 Python
在Django中自定义filter并在template中的使用详解
May 19 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中动态HTML的输出技术
2006/10/09 PHP
网络资源
2006/10/09 PHP
如何提高MYSQL数据库的查询统计速度 select 索引应用
2007/04/11 PHP
golang与PHP输出excel示例
2016/07/22 PHP
javascript FormatNumber函数实现方法
2008/12/30 Javascript
在网页里看flash的trace数据的js类
2009/01/10 Javascript
jquery实现的一个导航滚动效果具体代码
2013/05/27 Javascript
js触发select onchange事件的小技巧
2014/08/05 Javascript
JS中三目运算符和if else的区别分析与示例
2014/11/21 Javascript
JavaScript结合AJAX_stream实现流式显示
2015/01/08 Javascript
jQuery简单实现提交数据出现loading进度条的方法
2016/03/29 Javascript
基于zepto.js简单实现上传图片
2016/06/21 Javascript
微信小程序 网络API Websocket详解
2016/11/09 Javascript
微信小程序开发实战教程之手势解锁
2016/11/18 Javascript
浅析JavaScript中作用域和作用域链
2016/12/06 Javascript
vue-ajax小封装实例
2017/09/18 Javascript
完美解决axios跨域请求出错的问题
2018/02/05 Javascript
node前端模板引擎Jade之标签的基本写法
2018/05/11 Javascript
Vue的watch和computed方法的使用及区别介绍
2018/09/06 Javascript
基于element-ui组件手动实现单选和上传功能
2018/12/06 Javascript
微信小程序获取用户绑定手机号方法示例
2019/07/21 Javascript
python实现获取序列中最小的几个元素
2014/09/25 Python
Python退火算法在高次方程的应用
2018/07/26 Python
用python代码将tiff图片存储到jpg的方法
2018/12/04 Python
Python实现的KMeans聚类算法实例分析
2018/12/29 Python
python中pathlib模块的基本用法与总结
2020/08/17 Python
python Autopep8实现按PEP8风格自动排版Python代码
2021/03/02 Python
使用html5制作loading图的示例
2014/04/14 HTML / CSS
加拿大床上用品、家居装饰、厨房和浴室产品购物网站:Linen Chest
2018/06/05 全球购物
家居设计专业个人自荐信范文
2013/11/26 职场文书
网吧消防安全制度
2014/01/28 职场文书
颁奖晚会主持词
2014/03/25 职场文书
企业趣味活动方案
2014/08/21 职场文书
学校运动会广播稿
2014/10/11 职场文书
高中教师个人工作总结
2015/02/10 职场文书
MySQL分区表实现按月份归类
2021/11/01 MySQL