Python上下文管理器

原创

wx608ac0afda75d 2021-12-10 15:05:05 ©著作权

©著作权归作者所有：来自51CTO博客作者wx608ac0afda75d的原创作品，请联系作者获取转载授权，否则将追究法律责任

with语句会设置一个临时的上下文，交给上下文管理器对象控制，并且负责清理上下文。

比如在打开文件时通常都会使用with语句：

with open("a.txt") as f:
    f.read()

with块执行完后会自动关闭文件。

Python上下文管理器对象存在的目的就是管理with语句。

实现一个上下文管理器

上下文管理器协议包含__enter__和__exit__两个方法，所以要实现一个上下文管理器，就得实现这两个方法，比如：

class LookingGlass:

    def __enter__(self):
        import sys
        self.original_write = sys.stdout.write
        sys.stdout.write = self.reverse_write
        return 'JABBERWOCKY'

    def reverse_write(self, text):
        self.original_write(text[::-1])

    def __exit__(self, exc_type, exc_value, traceback):
        import sys
        sys.stdout.write = self.original_write
        if exc_type is ZeroDivisionError:
            print('Please DO NOT divide by zero!')
            return True

__enter__是上下文管理器的入口，在with语句开始运行时调用。
__exit__是上下文管理器的出口，在with语句运行结束后调用。

上下文管理器对象是在执行with后面的表达式得到的：

with LookingGlass() as what:
    print(what)

as子句是可选的，在as执行前就已经得到了上下文管理器对象，在as执行时实际就已经调用__enter__了。

把生成器变为上下文管理器

使用@contextmanager装饰器能减少创建上下文管理器的样板代码量，只需要实现一个有yield语句的生成器，生成想让__enter__方法返回的值。

示例：

import contextlib


@contextlib.contextmanager
def looking_glass():
    import sys
    original_write = sys.stdout.write

    def reverse_write(text):
        original_write(text[::-1])

    sys.stdout.write = reverse_write
    msg = ''
    try:
        yield 'JABBERWOCKY'
    except ZeroDivisionError:
        msg = 'Please DO NOT divide by zero!'
    finally:
        sys.stdout.write = original_write
        if msg:
            print(msg)