详解Python中的with语句和上下文管理器
作者：Amo Xiang
如果你有阅读源码的习惯，可能会看到一些优秀的代码经常出现带有 with 关键字的语句，它通常用在什么场景呢？对于系统资源如文件、数据库连接、socket 而言，应用程序打开这些资源并执行完业务逻辑之后，必须做的一件事就是要关闭（断开）该资源。
比如 Python 程序打开一个文件，往文件中写内容，写完之后，就要关闭该文件，否则会出现什么情况呢？极端情况下会出现 Too many open files 的错误，因为系统允许你打开的最大文件数量是有限的。同样，对于数据库，如果连接数过多而没有及时关闭的话，就可能会出现 Can not connect to MySQL server Too many connections，因为数据库连接是一种非常昂贵的资源，不可能无限制的被创建。
一、with语句的使用
向文件中写入数据的示例代码(基础)：
# -*- coding: utf-8 -*-
# @Time : 2022-10-18 10:25
# @Author : AmoXiang
# @File : demo1.py
# @Software: PyCharm
# @Blog : https://blog.csdn.net/xw1680
# 1、以写的方式打开文件
f = open("1.txt", "w", encoding="utf8")
# 2、写入文件内容
f.write("hello world")
# 3、关闭文件
f.close()
代码说明如下：文件使用完后必须关闭，因为文件对象会占用操作系统的资源，并且操作系统同一时间能打开的文件数量也是有限的。这种写法可能出现一定的安全隐患，错误代码如下：
# -*- coding: utf-8 -*-
# @Time : 2022-10-18 10:25
# @Author : AmoXiang
# @File : demo1.py
# @Software: PyCharm
# @Blog : https://blog.csdn.net/xw1680
# 1、以写的方式打开文件
f = open("1.txt", "r", encoding="utf8")
# 2、写入文件内容
f.write("hello world")
# 3、关闭文件
f.close()
运行结果如下图所示：
代码说明：由于文件读写时都有可能产生 IOError，一旦出错，后面的 f.close() 就不会调用。为了保证无论是否出错都能正确地关闭文件，我们可以使用 try ... finally 来解决。安全写法, 代码如下：
# -*- coding: utf-8 -*-
# @Time : 2022-10-18 10:32
# @Author : AmoXiang
# @File : demo2.py
# @Software: PyCharm
# @Blog : https://blog.csdn.net/xw1680
try:
# 1、以读的方式打开文件
f = open("1.txt", "r")
# 2、读取文件内容
f.write("xxxxx")
except IOError as e:
print("文件操作出错", e)
finally:
# 3、关闭文件
f.close()
运行结果：
文件操作出错 not writable
这种方法虽然代码运行良好，但是缺点就是代码过于冗长，并且需要添加 try-except-finally 语句，不是很方便，也容易忘记。在这种情况下，Python 提供了 with 语句的这种写法，既简单又安全，并且 with 语句执行完成以后自动调用关闭文件操作，即使出现异常也会自动调用关闭文件操作。with 语句的示例代码：
# -*- coding: utf-8 -*-
# @Time : 2022-10-18 10:34
# @Author : AmoXiang
# @File : demo3.py
# @Software: PyCharm
# @Blog : https://blog.csdn.net/xw1680
# 1、以写的方式打开文件
with open("1.txt", "w") as f:
# 2、读取文件内容
f.write("hello world")
f.read() # 即使报错，文件资源也会关闭掉
二、上下文管理器
一个类只要实现了 __enter__() 和 __exit__() 这个两个方法，通过该类创建的对象我们就称之为上下文管理器对象。上下文管理器可以使用 with 语句，with 语句之所以这么强大，背后是由上下文管理器做支撑的，也就是说刚才使用 open 函数创建的文件对象就是就是一个上下文管理器对象。自定义上下文管理器类，模拟文件操作。定义一个 File 类，实现 __enter__() 和 __exit__() 方法，然后使用 with 语句来完成操作文件， 示例代码：
# -*- coding: utf-8 -*-
# @Time : 2022-10-18 10:38
# @Author : AmoXiang
# @File : demo4.py
# @Software: PyCharm
# @Blog : https://blog.csdn.net/xw1680
class File(object):
# 初始化方法
def __init__(self, file_name, mode):
# 定义变量保存文件名和打开模式
self.file_name = file_name
self.mode = mode
# 上文方法
def __enter__(self):
print("进入上文方法")
# 返回文件资源
self.f = open(self.file_name, self.mode)
return self.f
# 下文方法
def __exit__(self, exc_type, exc_val, exc_tb):
"""
with 语句中，即使发生异常信息，也会进入 __exit__ 中
:param exc_type: 发生异常时，异常的类型
:param exc_val: 发生异常时，异常的信息
:param exc_tb: 异常对象，堆栈信息
:return:如果返回False(代码没有书写返回值默认None，表示为False) 代表
异常发生以后，异常会继续向外传递。如果返回True，代表异常不再向外传递
"""
if exc_type:
print("发生了异常......")
return True
print("进入下文方法")
self.f.close()
if __name__ == '__main__':
with File("1.txt", "r") as file:
content = file.read()
print(content)
运行结果：
代码说明：
__enter__表示上文方法，需要返回一个操作文件对象__exit__表示下文方法，with 语句执行完成会自动执行，即使出现异常也会执行该方法。
上下文管理器的另外一种实现方式： 假如想要让一个函数成为上下文管理器，Python 还提供了一个 @contextmanager 的装饰器，更进一步简化了上下文管理器的实现方式。通过 yield 将函数分割成两部分，yield 上面的语句在 __enter__ 方法中执行，yield 下面的语句在 __exit__ 方法中执行，紧跟在 yield 后面的参数是函数的返回值。示例代码：
# -*- coding: utf-8 -*-
# @Time : 2022-10-18 10:54
# @Author : AmoXiang
# @File : demo5.py
# @Software: PyCharm
# @Blog : https://blog.csdn.net/xw1680
# 导入装饰器
from contextlib import contextmanager
# 装饰器装饰函数，让其称为一个上下文管理器对象
@contextmanager
def my_open(path, mode):
try:
# 打开文件
file = open(path, mode)
# yield之前的代码好比是上文方法
yield file
except Exception as e:
print(e)
finally:
print("over")
# yield下面的代码好比是下文方法
file.close()
# 使用with语句
with my_open('out.txt', 'w') as f:
f.write("hello , the simplest context manager")
三、小结
Python 提供了 with 语句 用于简化资源释放的操作，使用 with 语句 操作建立在上下文管理器(实现 __enter__ 和 __exit__ ) 的基础上。Python 还提供了一个 @contextmanager 装饰器，更进一步简化上下管理器的实现，让一个函数可以成为上下文管理器，结合 with 语句 来使用。
到此这篇关于详解Python中的with语句和上下文管理器的文章就介绍到这了,更多相关Python with语句和上下文管理器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！