在 Python 处理文件的时候我们使用 with 关键词来进行文件的资源关闭,但是并不是只有文件操作才能使用 with 语句。今天就让我们一起学习 Python 中的上下文管理 contextlib。
上下文管理器
上下文,简而言之,就是程式所执行的环境状态,或者说程式运行的情景。既然提及上下文,就不可避免的涉及 Python 中关于上下文的魔法。上下文管理器(context manager)是 Python2.5 开始支持的一种语法,用于规定某个对象的使用范围。一旦进入或者离开该使用范围,会有特殊操作被调用。它的语法形式是 with...as...,主要应用场景资源的创建和释放。例如,文件就支持上下文管理器,可以确保完成文件读写后关闭文件句柄。
with open('password.txt', 'wt') as f:
f.write('contents go here')
# 文件会自动关闭
__enter__和__exit__
with 方法的实现涉及到两个魔法函数__enter__和__exit__。
执行流进入 with 中的代码块时会执行__enter__方法,它会返回在这个上下文中使用的一个对象。执行流离开 with 块时,则调用这个上下文管理器的__exit__方法来清理所使用的资源。
class Context:
def __init__(self):
print("int __init__")
def __enter__(self):
print("int __enter__")
def __exit__(self, exc_type, exc_val, exc_tb):
print("in __exit__")
if __name__ == '__main__':
with Context():
print('start with ')
输出
int __init__
int __enter__
Doing work in context
in __exit__
相对于使用 try:finally 块,使用 with 语句代码看起来更紧凑,with 代码块执行的时候总会调用__exit__方法,即使出现了异常。
如果给 with 语句的 as 子句指定一个别名,那么__enter__方法可以返回与这个名关联的任何对象。
import requests
class Request:
def __init__(self):
self.session = requests.session()
def get(self, url, headers=None):
if headers is None:
headers = {}
response = self.session.get(url)
return response
class Context:
def __init__(self):
print("int __init__")
def __enter__(self):
print("int __enter__")
return Request()
def __exit__(self, exc_type, exc_val, exc_tb):
print("in __exit__")
if __name__ == '__main__':
with Context() as t:
req = t.get("https://wwww.baidu.com")
print(req.text)
这里的 t 就是__enter__方法返回的 Request 对象的实例,然后我们可以调用该实例的一些方法。
如果上下文中出现异常,可以通过修改__exit__方法,如果返回值为 true,则可以把异常打印出来,如果为 false 则会抛出异常。
class Context:
def __init__(self,flag):
self.flag = flag
def __enter__(self):
print("int __enter__")
return self
def __exit__(self, exc_type, exc_val, exc_tb):
print("in __exit__")
print(f"{exc_type=}") #Python3.8 的语法等价于 f"exc_type={exc_type}"
print(f"{exc_val=}")
print(f"{exc_v