(转载)http://yuez.me/python-zhong-de-guan-jian-zi-with-xiang-jie/
在 Python 2.5 中,with
关键字被加入。它将常用的 try ... except ... finally ...
模式很方便的被复用。看一个最经典的例子:
在这段代码中,无论with
中的代码块在执行的过程中发生任何情况,文件最终都会被关闭。如果代码块在执行的过程中发生了一个异常,那么在这个异常被抛出前,程序会先将被打开的文件关闭。
再看另外一个例子。
在发起一个数据库事务请求的时候,经常会用类似这样的代码:
如果将发起事务请求的操作变成可以支持with
关键字的,那么用像这样的代码就可以了:
下面,详细的说明一下with
的执行过程,并用两种常用的方式实现上面的代码。
with 的一般执行过程
一段基本的with
表达式,其结构是这样的:
其中:EXPR
可以是任意表达式;as VAR
是可选的。其一般的执行过程是这样的:
- 计算
EXPR
,并获取一个上下文管理器。 - 上下文管理器的
__exit()__
方法被保存起来用于之后的调用。 - 调用上下文管理器的
__enter()__
方法。 - 如果
with
表达式包含as VAR
,那么EXPR
的返回值被赋值给VAR
。 - 执行
BLOCK
中的表达式。 - 调用上下文管理器的
__exit()__
方法。如果BLOCK
的执行过程中发生了一个异常导致程序退出,那么异常的type
、value
和traceback
(即sys.exc_info()
的返回值)将作为参数传递给__exit()__
方法。否则,将传递三个None
。
将这个过程用代码表示,是这样的:
这个过程有几个细节:
- 如果上下文管理器中没有
__enter()__
或者__exit()__
中的任意一个方法,那么解释器会抛出一个AttributeError
。 - 在
BLOCK
中发生异常后,如果__exit()__
方法返回一个可被看成是True
的值,那么这个异常就不会被抛出,后面的代码会继续执行。
接下来,用两种方法来实现上面来实现上面的过程的吧。
实现上下文管理器类
第一种方法是实现一个类,其含有一个实例属性db
和上下文管理器所需要的方法__enter()__
和__exit()__
。
了解with
的执行过程后,这个实现方式是很容易理解的。下面介绍的实现方式,其原理理解起来要复杂很多。
使用生成器装饰器
在Python的标准库中,有一个装饰器可以通过生成器获取上下文管理器。使用生成器装饰器的实现过程如下:
第一眼上看去,这种实现方式更为简单,但是其机制更为复杂。看一下其执行过程吧:
- Python解释器识别到
yield
关键字后,def
会创建一个生成器函数替代常规的函数(在类定义之外我喜欢用函数代替方法)。 - 装饰器
contextmanager
被调用并返回一个帮助函数,这个帮助函数在被调用后会生成一个GeneratorContextManager
实例。最终with
表达式中的EXPR
调用的是由contentmanager
装饰器返回的帮助函数。 -
with
表达式调用transaction(db)
,实际上是调用帮助函数。帮助函数调用生成器函数,生成器函数创建一个生成器。 - 帮助函数将这个生成器传递给
GeneratorContextManager
,并创建一个GeneratorContextManager
的实例对象作为上下文管理器。 -
with
表达式调用实例对象的上下文管理器的__enter()__
方法。 -
__enter()__
方法中会调用这个生成器的next()
方法。这时候,生成器方法会执行到yield db
处停止,并将db
作为next()
的返回值。如果有as VAR
,那么它将会被赋值给VAR
。 -
with
中的BLOCK
被执行。 -
BLOCK
执行结束后,调用上下文管理器的__exit()__
方法。__exit()__
方法会再次调用生成器的next()
方法。如果发生StopIteration
异常,则pass
。 - 如果没有发生异常生成器方法将会执行
db.commit()
,否则会执行db.rollback()
。
再次看看上述过程的代码大致实现:
总结
Python的with
表达式包含了很多Python特性,花点时间吃透with
是一件非常值得的事情。