3.4 contextlib:上下文管理器工具
contextlib模块包含的工具用于处理上下文管理器和with语句。
3.4.1 上下文管理器API
上下文管理器(context manager)负责管理一个代码块中的资源,会在进入代码块时创建资源,然后在退出代码块后清理这个资源。例如,文件就支持上下文管理器API,可以确保完成文件读写后关闭文件。
with open('pymotw.txt','wt') as f:
f.write('contents go here')
# File is automatically closed
上下文管理器由with语句启用,这个API包括两个方法。执行流进入with中的代码块时会运行__enter__()方法。它会返回在这个上下文中使用的一个对象。执行流离开with块时,则调用这个而上下文管理器的__exit__()方法来清理所使用的资源。
class Context:
def __init__(self):
print('__init__()')
def __enter__(self):
print('__enter__()')
return self
def __exit__(self,exc_type,exc_val,exc_tb):
print('__exit__()')
with Context():
print('Doing work in the context')
相对于try:finally块,结合上下文管理器和with语句是一种更紧凑的写法,因为总会调用上下文管理器的__exit__()方法,即使产生异常的情况下也会调用这个方法。
运行结果:
如果with语句的as子句中指定了名,那么__enter__()方法可以返回与这个名关联的任何对象。在这个例子中,Context会返回一个使用打开的上下文的对象。
class WithinContext:
def __init__(self,context):
print('WithinContext.__init__({})'.format(context))
def do_something(self):
print('WithinContext.do_something()')
def __del__(self):
print('WithinContext.__del__')
class Context:
def __init__(self):
print('Context.__init__()')
def __enter__(self):
print('Context.__enter__()')
return WithinContext(self)
def __exit__(self,exc_type,exc_val,exc_tb):
print('Context.__exit__()')
with Context() as c:
c.do_something()
与变量c关联的值是__enter__()返回的对象,这不一定是with语句中创建的Context实例。
运行结果:
exit()方法接受一些参数,其中包含with块中产生的所有异常的详细信息。
class Context:
def __init__(self,handle_error):
print('__init__({})'.format(handle_error))
self.handle_error = handle_error
def __enter__(self):
print('__enter__()')
return self
def __exit__(self,exc_type,exc_val,exc_tb):
print('__exit__()')
print(' exc_type =',exc_type)
print(' exc_val =',exc_val)
print(' exc_tb =',exc_tb)
return self.handle_error
with Context(True):
raise RuntimeError('error message handle')
print()
with Context(False):
raise RuntimeError('error message propagated')
如果上下文管理器可以处理这个异常,那么__exit__()应当返回一个true值来指示这个异常不需要传播。如果返回false,则会在__exit__()返回后再次抛出这个异常。
运行结果: