Python@contextmanager

上下文管理器

上下文管理器是实现了上下文管理协议的对象，其特有的语法是“with ...as”。主要用于保存和恢复各种全局状态，关闭文件等，并为try...except...finally提供了一个方便使用的封装。

上下文管理协议具体来说就是在类里面实现以下两个方法：

__enter__(): 从该方法进入运行时上下文，并返回当前对象或者与运行时上下文相关的其他对象。如果with语句有as关键词存在，返回值会绑定在as后的变量上。

__exit__(exc_type, exc_val, exc_tb): 退出运行时上下文，return True可以正常抛出异常，Flase则不会有错误信息。如果在执行with语句体时发生异常，那退出时参数会包括异常类型、异常值、异常追踪信息，否则，3个参数都是None。

class MyResource1:
    def __enter__(self):
        print('connect to resource')
        return self    # return可以是对象，然后会绑定到as后面的变量

    def __exit__(self, exc_type, exc_val, exc_tb):
        print('close resource connection')
        # __exit__方法 return Ture 异常会报错， return Flase 不会报错

    def query(self):
        print('query data')


with MyResource1() as r:
    r.query()

运行结果：
connect to resource
query data
close resource connection

contextlib 模块

对于上下文的管理，python也提供了内建的模块contextlib来实现相同的机制，而且这种通过生成器和装饰器实现的上下文管理器，看起来比with语句和手动实现上下文管理协议更优雅。

# 不再需要手动实现enter和exit方法
class MyResource2:

    def query(self):
        print('query data')

# contextmanager 简化上下文管理器复杂的定义
from contextlib import contextmanager


@contextmanager
def make_myresource():
    print('connect to resource')
    yield MyResource2()     # yield 相当于return 加 中断回执。yield后面的语句会最终回来继续执行
    print('close resource connection')


with make_myresource() as r:
    r.query()

一个实际应用例子：

from contextlib import contextmanager
# 一个应用场景，给一个书名前后加上书名号

@contextmanager
def book_mark():
    print('《', end='')
    yield   # yield 后面不一定要返回结果，纯粹起一个中断作用
    print('》', end='')

with book_mark():
    print("且将生活一饮而尽", end='')

# 衍生一种用法：在要执行的代码的前面和后面各补充一段代码
# 特别是对于一些框架的源码等，我们不能直接在源码里面修改
# 其次是追求封装性和复用性

由此，@contextmanager可以衍生另一种用法，不仅仅是简化上下文的定义，而是在我们需要执行的代码的前面和后面补充代码执行。