with 与 "上下文管理器"

with的使用

---

with 的使用

def func():
    with open("output.txt", "r") as f:
        f.write("Python之禅")

一种更加简洁、优雅的方式就是用 with 关键字。open 方法的返回值赋值给变量 f，当离开 with 代码块的时候，系统能够自动调用 f.close() 方法，那么它的实现原理是什么？在讲 with 的原理前要涉及到另外一个概念，就是上下文管理器（Context Manager）

上下文管理器

上下文管理器本质就是能够支持with操作。

任何实现了 enter() 和 exit() 方法的对象都可称之为上下文管理器，上下文管理器对象可以使用 with 关键字。显然，文件（file）对象也实现了上下文管理器协议。

那么文件对象是如何实现这两个方法的呢？我们可以模拟实现一个自己的文件类，让该类实现 enter() 和 exit() 方法

"""
使用 with 实现上下文管理器
还可以利用 上下文管理器 自动关闭数据库资源 **注意**这样返回的就是游标对象
"""


class MyFunc(object):
    """实现上下文管理器"""

    def __init__(self, file_name, mode):
        self.file_name = file_name
        self.mode = mode

    def __enter__(self):
        self.f_obj = open(self.file_name, self.mode)
        return self.f_obj          # __enter__函数返回的是打开资源的对象

    def __exit__(self, exc_type, exc_val, exc_tb):
        self.f_obj.close()


with open("file_name", "r") as file_obj:
    content = file_obj.read()

print(content)

适用场景:

with语句适用于对资源进行访问的场合，确保不管使用过程中是否发生异常都会执行必要的“清理” 操作，释放资源，比如文件使用后自动关闭、线程中锁的自动获取和释放等。

实现上下文管理器的另外方式

Python 还提供了一个 contextmanager 的装饰器，更进一步简化了上下文管理器的实现方式。通过 yield 将函数分割成两部分，yield 之前的语句在 enter 方法中执行，yield 之后的语句在 exit 方法中执行。紧跟在 yield 后面的值是函数的返回值。

第二种方式需要使用@contextlib装饰器

from contextlib import contextmanager


@contextmanager
def func(path, node):
    f = open(path, node)
    yield f  # 注意` 如果 open 时报错,则不会关闭资源.既不建议使用该方法.
    f.close()


#  调用
with open("paht", "r") as f:
    content = f.read()

总结:

Python 提供了 with 语法用于简化资源操作的后续清除操作，实现原理建立在上下文管理器协议(实现enter和exit)之上
with使用代码中如果在打开过程中发生异常，需要使用try-except进行捕获
Python 还提供了一个 contextmanager 装饰器，更进一步简化上下管理器的实现方式。