在 Python 中,@contextmanager 是一个装饰器,用于将一个生成器函数转换为一个上下文管理器。
上下文管理器是一种用于管理资源的机制,通过 with 语句来使用。常见的例子如文件操作,在进入 with 代码块时获取资源(打开文件),在离开 with 代码块时自动释放资源(关闭文件)。
使用 @contextmanager 装饰器的函数需要遵循特定的模式:
函数内部必须包含一个 yield 语句。
yield 语句之前的代码在 with 语句进入时执行(类似于 __enter__ 方法)。
yield 语句之后的代码在 with 语句退出时执行,无论是否有异常(类似于 __exit__ 方法)。
以下是一个简单的示例来说明其用法:
from contextlib import contextmanager
@contextmanager
def my_context():
print("Entering the context")
yield
print("Exiting the context")
with my_context():
print("Inside the context")
在上述示例中:
- 当执行
with my_context(): 时,首先会打印 Entering the context。
- 然后执行
with 代码块中的内容,即 print("Inside the context")。
- 当离开
with 代码块时,无论是否有异常,都会执行 yield 之后的代码,打印 Exiting the context 。
这样可以方便地创建自定义的上下文管理器,用于更灵活地管理资源或执行特定的初始化和清理操作。例如,您可以在 yield 之前获取数据库连接,在 yield 之后关闭连接。