聊聊Python的上下文管理
上下文 & 上下文管理
在开发语言中,上下文
一般是指的程序执行期间的环境和状态。它包括了当前的作用域和变量及对象、函数调用栈、执行状态、异常处理等信息。上下文提供了程序执行所需的背景和条件,以确保代码的正确执行。
在Python语言中,上下文管理
是一种用于管理资源的特殊机制,它通过定义 __enter__()
和 __exit__()
方法,允许你在进入和离开特定代码块时执行特定的操作。
其中
-
__enter__
方法:在进入代码块时执行的操作。它应该返回一个值,该值将被分配给with
语句中的目标变量。 -
__exit__
方法:在离开代码块时执行的操作。它可以接受三个参数:异常类型、异常值和异常跟踪。
在 Python 中,有两种常见的方式来使用上下文管理器:with
语句和 contextlib
模块的装饰器。
with
语句
with
语句提供了一种简洁的方式来使用上下文管理器。它的语法如下:
with 上下文管理器 as 变量:
# 执行代码块
在进入代码块之前,会调用上下文管理器的 __enter__()
方法,它可以返回一个对象,将其赋值给变量。
然后执行代码块,无论代码块是否发生异常,都会在退出代码块后调用上下文管理器的 __exit__()
方法,用于释放资源或处理异常。
最常见的我们使用with
来操作文件就是 使用上下文管理器的例子
with open('/tmp/text.txt', 'r') as file:
data = file.read()
# 对文件进行操作
在上述示例中,open('/tmp/text.txt', 'r')
返回的文件对象被用作上下文管理器。
文件对象的 __enter__()
方法在进入代码块前被调用,打开文件并返回文件对象。
然后在代码块中对文件进行操作。
最后退出代码块后,文件对象的 __exit__()
方法被调用,自动关闭文件。
Question: 大家都知道 open 函数是Python内置函数,它本身是没有被装饰器装饰或者想类一样有那两个特殊方法,那么是如何能使用上下文管理呢?
我们做个实验如下
>>> file = '/tmp/1.txt'
>>> f = open(file, 'r')
>>> type(f)
<class '_io.TextIOWrapper'>
>>> f.__enter__
<built-in method __enter__ of _io.TextIOWrapper object at 0x7fb98a749860>
>>> f.__exit__
<built-in method __exit__ of _io.TextIOWrapper object at 0x7fb98a749860>
>>>
从上面看到 open
函数返回的是_io.TextIOWrapper
类,然后查看源码,发现 TextIOWrapper 继承自 _TextIOBase
而 _TextIOBase
继承自 _IOBase
。 在 _IOBase
中定义了 __enter__()
和 __exit__()
方法。
或者可以通过 如下代码快速发现继承关系
>>> import inspect
>>> inspect.getmro(type(f))
(<class '_io.TextIOWrapper'>, <class '_io._TextIOBase'>, <class '_io._IOBase'>, <class 'object'>)
但是这里有个疑惑,从子类和父类中都没有看到具体的 __enter__()
和 __exit__()
方法的实现(实现应该是如下所示)。网上咨询,有人说是通过Python的解释器实现的。
def __enter__(self):
# 打开文件
return self
def __exit__(self, type, value, traceback):
# 关闭文件
self.close()
contextlib.contextmanager
装饰器
在 contextlib
模块提供了一些用于创建上下文管理器的实用函数和装饰器。
其中最常用的是 contextmanager
装饰器,它可以将一个生成器函数转换为上下文管理器。
常见的用法如下
from contextlib import contextmanager
@contextmanager
def custom_context_manager():
# 进入代码块前的操作
# 获取资源
resource = acquire_resource()
try:
yield resource
# 退出代码块后的操作
finally:
# 释放资源
release_resource(resource)
在上述示例中,`custom_context_manager()` 是一个生成器函数,使用 `@contextmanager` 装饰器将其转换为上下文管理器。
在生成器函数内部,可以在 `yield` 语句前后进行进入和退出代码块的操作。
其中 `yield` 语句将资源返回给代码块,代码块执行完毕后,继续执行生成器函数的剩余部分,最后执行 `finally` 块来释放资源。
然后我们就可以使用`with` 语句来使用`上下文管理器` 了
```python
with custom_context_manager() as resource:
# 使用资源进行操作
在上述示例中,custom_context_manager()
返回的上下文管理器对象被用作 with
语句的上下文管理器。进入代码块前的操作在生成器函数的 yield
语句之前执行,退出代码块后的操作在生成器函数的 yield
语句之后执行。
总结
1、 contextlib
模块的装饰器提供了一种创建上下文管理器
的方法
2、with
语句提供了一种简洁的方式来使用上下文管理器
3、上下文管理器
都可以确保在进入和退出代码块时执行特定的操作,从而实现资源的正确管理
比如Django工程中的数据库连接
操作with connection.cursor() as cursor
、模板渲染
操作with render(request, 'template.html', context) as t
等都是使用了上下文管理器
如果你觉得有所收获,欢迎关注"菩提老鹰
"进行点赞和喜欢哦~
一起交流,分享知识,快乐生活,我是老鹰,我们下一期见~