如何在Python中编写null(无操作)上下文管理器？

Question

有时我需要一个无效的虚拟上下文管理器.然后,它可以用作更有用但可选的上下文管理器的替身.例如:

ctx_mgr = <meaningfulContextManager> if <condition> else <nullContextManager>
with ctx_mgr:
    ...

如何定义这样一个简单的空上下文管理器？Python库是否提供现成的？

我们希望将上下文与as子句一起使用的情况如何？

with ctx_mgr as resource:
    <operations on resource>

Answer 1

Python 3.7及以上版本:使用contextlib.nullcontext,专门为此设计.

在Python 3.7之前,标准库不提供专门为这些用例设计的上下文管理器,但有一些解决方法.

从Python 3.4开始,contextlib.suppress可以在第一种情况下用于此目的,即当没有as子句时:

ctx_mgr = <meaningfulContextManager> if <condition> else contextlib.suppress()

with ctx_mgr:
    ...

从Python 3.3开始,也可以使用类似的解决方法contextlib.ExitStack,虽然速度慢suppress(在我的测试中需要两倍的时间).

在Python 3.3之前,或者如果你as在Python 3.7之前需要一个子句,开发人员需要自己动手.这是一个可能的实现(请参阅底部的注释,但所有错误都是我的):

class NullContextManager(object):
    def __init__(self, dummy_resource=None):
        self.dummy_resource = dummy_resource
    def __enter__(self):
        return self.dummy_resource
    def __exit__(self, *args):
        pass

然后可以写:

ctx_mgr = <meaningfulContextManager> if <condition> else NullContextManager(dummy_resource)

with ctx_mgr as resource:
    <operations on resource>

当然,dummy_resource需要支持"有意义"资源所需的所有操作.因此,例如,如果有意义的上下文管理器on __enter__(),返回quack()在托管块内部生成的内容,dummy_resource则还需要支持它,尽管可能根本不做任何事情.

class DummyDuck(object):
    def quack()
        # Ssssh...
        pass

ctx_mgr = <meaningfulContextManager> if <condition> else NullContextManager(DummyDuck())

with ctx_mgr as someDuck:
    someDuck.quack()

来源:Python功能请求.非常感谢为讨论做出贡献的所有人.这是我尝试在一个自我回答的问题中总结其结果,以节省人们阅读这个长线程的时间.另请参阅Python文档中提到的这种用法ExitStack.

Answer 2

适用于 Python 3.6 及以下（包括 2.7）的简单解决方案：

from contextlib import contextmanager

@contextmanager
def nullcontext(enter_result=None):
    yield enter_result

从 Python 3.7 开始，您应该使用所提供的contextlib.nullcontext来代替。

Answer 3

从 Python 3.2 开始，memoryview(b'')可以用作无操作上下文管理器。请参阅https://docs.python.org/3/library/stdtypes.html#memoryview.release。

优点

• 无需进口

• 适用于 3.2+

• 大约快两倍contextlib.nullcontext

缺点

• 您可能想添加# no-op评论。