Pythoncontextlib为with语句上下文提供的工具

工具¶

提供的函数和类：

class contextlib.AbstractContextManager¶

一个为实现了 object.__enter__() 与 object.__exit__() 的类提供的 abstract base class。为 object.__enter__() 提供的一个默认实现是返回 self 而 object.__exit__() 是一个默认返回 None 的抽象方法。 参见 上下文管理器类型 的定义。

3.6 新版功能.

class contextlib.AbstractAsyncContextManager¶

一个为实现了 object.__aenter__() 与 object.__aexit__() 的类提供的 abstract base class。 为 object.__aenter__() 提供的一个默认实现是返回 self 而 object.__aexit__() 是一个默认返回 None 的抽象方法。 参见 异步上下文管理器 的定义。

3.7 新版功能.

@contextlib.contextmanager¶

这个函数是一个 decorator ，它可以定义一个支持 with 语句上下文的工厂函数， 而不需要创建一个类或区 __enter__() 与 __exit__() 方法。

尽管许多对象原生支持使用 with 语句，但有些需要被管理的资源并不是上下文管理器，并且没有实现 close() 方法而不能使用 contextlib.closing 。

下面是一个抽象的示例，展示如何确保正确的资源管理：

fromcontextlibimportcontextmanager
@contextmanager
defmanaged_resource(*args,**kwds):
# Code to acquire resource, e.g.:
resource=acquire_resource(*args,**kwds)
try:
yieldresource
finally:
# Code to release resource, e.g.:
release_resource(resource)
>>>withmanaged_resource(timeout=3600)asresource:
...# Resource is released at the end of this block,
...# even if code in the block raises an exception

被装饰的函数在被调用时，必须返回一个 generator-iterator。这个迭代器必须只 yield 一个值出来，这个值会被用在 with 语句中，绑定到 as 后面的变量，如果给定了的话。

当生成器发生 yield 时，嵌套在 with 语句中的语句体会被执行。 语句体执行完毕离开之后，该生成器将被恢复执行。 如果在该语句体中发生了未处理的异常，则该异常会在生成器发生 yield 时重新被引发。 因此，你可以使用 try...except...finally 语句来捕获该异常（如果有的话），或确保进行了一些清理。 如果仅出于记录日志或执行某些操作（而非完全抑制异常）的目的捕获了异常，生成器必须重新引发该异常。 否则生成器的上下文管理器将向 with 语句指示该异常已经被处理，程序将立即在 with 语句之后恢复并继续执行。

contextmanager() 使用 ContextDecorator 因此它创建的上下文管理器不仅可以用在 with 语句中，还可以用作一个装饰器。当它用作一个装饰器时，每一次函数调用时都会隐式创建一个新的生成器实例（这使得 contextmanager() 创建的上下文管理器满足了支持多次调用以用作装饰器的需求，而非“一次性”的上下文管理器）。

在 3.2 版更改: ContextDecorator 的使用。

@contextlib.asynccontextmanager¶

与 contextmanager() 类似，但创建的是一个 异步上下文管理器。

这个函数是一个 decorator ，它可以定义一个支持 asyncwith 语句的异步上下文管理器的工厂函数， 而不需要创建一个类或区分 __aenter__() 与 __aexit__() 方法。它必须被作用在一个 asynchronous generator 函数上

一个简单的示例：

fromcontextlibimportasynccontextmanager
@asynccontextmanager
asyncdefget_connection():
conn=awaitacquire_db_connection()
try:
yieldconn
finally:
awaitrelease_db_connection(conn)
asyncdefget_all_users():
asyncwithget_connection()asconn:
returnconn.query('SELECT ...')

3.7 新版功能.

contextlib.closing(thing)¶

返回一个在语句块执行完成时关闭 things 的上下文管理器。这基本上等价于

fromcontextlibimportcontextmanager
@contextmanager
defclosing(thing):
try:
yieldthing
finally:
thing.close()

并允许你编写这样的代码

fromcontextlibimportclosing
fromurllib.requestimporturlopen
withclosing(urlopen('http://www.python.org'))aspage:
forlineinpage:
print(line)

而无需显式地关闭 page 。 即使发生错误，在退出 with 语句块时， page.close() 也同样会被调用。

contextlib.nullcontext(enter_result=None)¶

返回一个从 __enter__ 返回 enter_result 的上下文管理器，除此之外不执行任何操作。它旨在用于可选上下文管理器的一种替代，例如：:

defmyfunction(arg,ignore_exceptions=False):
ifignore_exceptions:
# Use suppress to ignore all exceptions.
cm=contextlib.suppress(Exception)
else:
# Do not ignore any exceptions, cm has no effect.
cm=contextlib.nullcontext()
withcm:
# Do something

一个使用 enter_result 的例子：

defprocess_file(file_or_path):
ifisinstance(file_or_path,str):
# If string, open file
cm=open(file_or_path)
else:
# Caller is responsible for closing file
cm=nullcontext(file_or_path)
withcmasfile:
# Perform processing on the file

3.7 新版功能.

contextlib.suppress(*exceptions)¶

返回一个上下文管理器，如果任何一个指定的异常发生在使用该上下文管理器的 with 语句中，该异常将被它抑制，然后程序将从 with 语句结束后的第一个语句开始恢复执行。

与完全抑制异常的任何其他机制一样，该上下文管理器应当只用来抑制非常具体的错误，并确保该场景下静默地继续执行程序是通用的正确做法。

例如

fromcontextlibimportsuppress
withsuppress(FileNotFoundError):
os.remove('somefile.tmp')
withsuppress(FileNotFoundError):
os.remove('someotherfile.tmp')

这段代码等价于：

try:
os.remove('somefile.tmp')
exceptFileNotFoundError:
pass
try:
os.remove('someotherfile.tmp')
exceptFileNotFoundError:
pass

该上下文管理器是 reentrant 。

3.4 新版功能.

contextlib.redirect_stdout(new_target)¶

用于将 sys.stdout 临时重定向到一个文件或类文件对象的上下文管理器。

该工具给已有的将输出硬编码写到 stdout 的函数或类提供了额外的灵活性。

例如， help() 通常把输出写到 sys.stdout 。你可以通过重定向到一个 io.StringIO 来捕获该输出到一个字符串中。

f=io.StringIO()
withredirect_stdout(f):
help(pow)
s=f.getvalue()

如果要把 help() 的输出写到磁盘上的一个文件，重定向该输出到一个常规文件：

withopen('help.txt','w')asf:
withredirect_stdout(f):
help(pow)

如果要把 help() 的输出写到 sys.stderr ：

withredirect_stdout(sys.stderr):
help(pow)

需要注意的点在于， sys.stdout 的全局副作用意味着此上下文管理器不适合在库代码和大多数多线程应用程序中使用。它对子进程的输出没有影响。不过对于许多工具脚本而言，它仍然是一个有用的方法。

该上下文管理器是 reentrant 。

3.4 新版功能.

contextlib.redirect_stderr(new_target)¶

与 redirect_stdout() 类似，不过是将 sys.stderr 重定向到一个文件或类文件对象。

该上下文管理器是 reentrant 。

3.5 新版功能.

class contextlib.ContextDecorator¶

一个使上下文管理器能用作装饰器的基类。

与往常一样，继承自 ContextDecorator  的上下文管理器必须实现 __enter__ 与 __exit__ 。即使用作装饰器， __exit__ 依旧会保持可能的异常处理。

ContextDecorator 被用在 contextmanager() 中，因此你自然获得了这项功能。

ContextDecorator 的示例:

fromcontextlibimportContextDecorator
classmycontext(ContextDecorator):
def__enter__(self):
print('Starting')
returnself
def__exit__(self,*exc):
print('Finishing')
returnFalse
>>>@mycontext()
...deffunction():
...print('The bit in the middle')
...
>>>function()
Starting
Thebitinthemiddle
Finishing
>>>withmycontext():
...print('The bit in the middle')
...
Starting
Thebitinthemiddle
Finishing

这个改动只是针对如下形式的一个语法糖：

deff():
withcm():
# Do stuff

ContextDecorator 使得你可以这样改写：

@cm()
deff():
# Do stuff

这能清楚地表明， cm 作用于整个函数，而不仅仅是函数的一部分（同时也能保持不错的缩进层级）。

现有的上下文管理器即使已经有基类，也可以使用 ContextDecorator 作为混合类进行扩展：

fromcontextlibimportContextDecorator
classmycontext(ContextBaseClass,ContextDecorator):
def__enter__(self):
returnself
def__exit__(self,*exc):
returnFalse

注解

由于被装饰的函数必须能够被多次调用，因此对应的上下文管理器必须支持在多个 with 语句中使用。如果不是这样，则应当使用原来的具有显式 with 语句的形式使用该上下文管理器。

3.2 新版功能.

class contextlib.ExitStack¶

该上下文管理器的设计目标是使得在编码中组合其他上下文管理器和清理函数更加容易，尤其是那些可选的或由输入数据驱动的上下文管理器。

例如，通过一个如下的 with 语句可以很容易处理一组文件：

withExitStack()asstack:
files=[stack.enter_context(open(fname))forfnameinfilenames]
# All opened files will automatically be closed at the end of
# the with statement, even if attempts to open files later
# in the list raise an exception

每个实例维护一个注册了一组回调的栈，这些回调在实例关闭时以相反的顺序被调用（显式或隐式地在 with 语句的末尾）。请注意，当一个栈实例被垃圾回收时，这些回调将 不会 被隐式调用。

通过使用这个基于栈的模型，那些通过 __init__ 方法获取资源的上下文管理器（如文件对象）能够被正确处理。

由于注册的回调函数是按照与注册相反的顺序调用的，因此最终的行为就像多个嵌套的 with 语句用在这些注册的回调函数上。这个行为甚至扩展到了异常处理：如果内部的回调函数抑制或替换了异常，则外部回调收到的参数是基于该更新后的状态得到的。

这是一个相对底层的 API，它负责正确处理栈里回调退出时依次展开的细节。它为相对高层的上下文管理器提供了一个合适的基础，使得它能根据应用程序的需求使用特定方式操作栈。

3.3 新版功能.

enter_context(cm)¶

Enters a new context manager and adds its __exit__() method to

the callback stack. The return value is the result of the context

manager's own __enter__() method.

These context managers may suppress exceptions just as they normally

would if used directly as part of a with statement.

push(exit)¶

Adds a context manager's __exit__() method to the callback stack.

As __enter__ is not invoked, this method can be used to cover

part of an __enter__() implementation with a context manager's own

__exit__() method.

If passed an object that is not a context manager, this method assumes

it is a callback with the same signature as a context manager's

__exit__() method and adds it directly to the callback stack.

By returning true values, these callbacks can suppress exceptions the

same way context manager __exit__() methods can.

The passed in object is returned from the function, allowing this

method to be used as a function decorator.

callback(callback, *args, **kwds)¶

Accepts an arbitrary callback function and arguments and adds it to

the callback stack.

Unlike the other methods, callbacks added this way cannot suppress

exceptions (as they are never passed the exception details).

The passed in callback is returned from the function, allowing this

method to be used as a function decorator.

pop_all()¶

Transfers the callback stack to a fresh ExitStack instance

and returns it. No callbacks are invoked by this operation - instead,

they will now be invoked when the new stack is closed (either

explicitly or implicitly at the end of a with statement).

For example, a group of files can be opened as an "all or nothing"

operation as follows:

withExitStack()asstack:
files=[stack.enter_context(open(fname))forfnameinfilenames]
# Hold onto the close method, but don't call it yet.
close_files=stack.pop_all().close
# If opening any file fails, all previously opened files will be
# closed automatically. If all files are opened successfully,
# they will remain open even after the with statement ends.
# close_files() can then be invoked explicitly to close them all.

close()¶

Immediately unwinds the callback stack, invoking callbacks in the

reverse order of registration. For any context managers and exit

callbacks registered, the arguments passed in will indicate that no

exception occurred.

class contextlib.AsyncExitStack¶

An asynchronous context manager, similar

to ExitStack, that supports combining both synchronous and

asynchronous context managers, as well as having coroutines for

cleanup logic.

The close() method is not implemented, aclose() must be used

instead.

enter_async_context(cm)¶

Similar to enter_context() but expects an asynchronous context

manager.

push_async_exit(exit)¶

Similar to push() but expects either an asynchronous context manager

or a coroutine function.

push_async_callback(callback, *args, **kwds)¶

Similar to callback() but expects a coroutine function.

aclose()¶

Similar to close() but properly handles awaitables.

Continuing the example for asynccontextmanager():

asyncwithAsyncExitStack()asstack:
connections=[awaitstack.enter_async_context(get_connection())
foriinrange(5)]
# All opened connections will automatically be released at the end of
# the async with statement, even if attempts to open a connection
# later in the list raise an exception.

3.7 新版功能.

例子和配方¶

This section describes some examples and recipes for making effective use of

the tools provided by contextlib.

withExitStack()asstack:
forresourceinresources:
stack.enter_context(resource)
ifneed_special_resource():
special=acquire_special_resource()
stack.callback(release_special_resource,special)
# Perform operations that use the acquired resources

stack=ExitStack()
try:
x=stack.enter_context(cm)
exceptException:
# handle __enter__ exception
else:
withstack:
# Handle normal case

fromcontextlibimportcontextmanager,AbstractContextManager,ExitStack
classResourceManager(AbstractContextManager):
def__init__(self,acquire_resource,release_resource,check_resource_ok=None):
self.acquire_resource=acquire_resource
self.release_resource=release_resource
ifcheck_resource_okisNone:
defcheck_resource_ok(resource):
returnTrue
self.check_resource_ok=check_resource_ok
@contextmanager
def_cleanup_on_error(self):
withExitStack()asstack:
stack.push(self)
yield
# The validation check passed and didn't raise an exception
# Accordingly, we want to keep the resource, and pass it
# back to our caller
stack.pop_all()
def__enter__(self):
resource=self.acquire_resource()
withself._cleanup_on_error():
ifnotself.check_resource_ok(resource):
msg="Failed validation for {!r}"
raiseRuntimeError(msg.format(resource))
returnresource
def__exit__(self,*exc_details):
# We don't need to duplicate any of our resource release logic
self.release_resource()

cleanup_needed=True
try:
result=perform_operation()
ifresult:
cleanup_needed=False
finally:
ifcleanup_needed:
cleanup_resources()

fromcontextlibimportExitStack
withExitStack()asstack:
stack.callback(cleanup_resources)
result=perform_operation()
ifresult:
stack.pop_all()

fromcontextlibimportExitStack
classCallback(ExitStack):
def__init__(self,callback,*args,**kwds):
super(Callback,self).__init__()
self.callback(callback,*args,**kwds)
defcancel(self):
self.pop_all()
withCallback(cleanup_resources)ascb:
result=perform_operation()
ifresult:
cb.cancel()

fromcontextlibimportExitStack
withExitStack()asstack:
@stack.callback
defcleanup_resources():
...
result=perform_operation()
ifresult:
stack.pop_all()

fromcontextlibimportContextDecorator
importlogging
logging.basicConfig(level=logging.INFO)
classtrack_entry_and_exit(ContextDecorator):
def__init__(self,name):
self.name=name
def__enter__(self):
logging.info('Entering: %s',self.name)
def__exit__(self,exc_type,exc,exc_tb):
logging.info('Exiting: %s',self.name)

withtrack_entry_and_exit('widget loader'):
print('Some time consuming activity goes here')
load_widget()

@track_entry_and_exit('widget loader')
defactivity():
print('Some time consuming activity goes here')
load_widget()

>>> fromcontextlibimportcontextmanager
>>> @contextmanager
... defsingleuse():
... print("Before")
... yield
... print("After")
...
>>> cm=singleuse()
>>> withcm:
... pass
...
Before
After
>>> withcm:
... pass
...
Traceback (most recent call last):
...
RuntimeError: generator didn't yield

>>> fromcontextlibimportredirect_stdout
>>> fromioimportStringIO
>>> stream=StringIO()
>>> write_to_stream=redirect_stdout(stream)
>>> withwrite_to_stream:
... print("This is written to the stream rather than stdout")
... withwrite_to_stream:
... print("This is also written to the stream")
...
>>> print("This is written directly to stdout")
This is written directly to stdout
>>> print(stream.getvalue())
This is written to the stream rather than stdout
This is also written to the stream

>>> fromcontextlibimportExitStack
>>> stack=ExitStack()
>>> withstack:
... stack.callback(print,"Callback: from first context")
... print("Leaving first context")
...
Leaving first context
Callback: from first context
>>> withstack:
... stack.callback(print,"Callback: from second context")
... print("Leaving second context")
...
Leaving second context
Callback: from second context
>>> withstack:
... stack.callback(print,"Callback: from outer context")
... withstack:
... stack.callback(print,"Callback: from inner context")
... print("Leaving inner context")
... print("Leaving outer context")
...
Leaving inner context
Callback: from inner context
Callback: from outer context
Leaving outer context

>>> fromcontextlibimportExitStack
>>> withExitStack()asouter_stack:
... outer_stack.callback(print,"Callback: from outer context")
... withExitStack()asinner_stack:
... inner_stack.callback(print,"Callback: from inner context")
... print("Leaving inner context")
... print("Leaving outer context")
...
Leaving inner context
Callback: from inner context
Leaving outer context
Callback: from outer context