Python上下文管理器Content Manager

在 Python 中,我们会经常听到上下文管理器(Context Manager),那我们探讨下这是什么,又有什么功能。

在 Python 中的上下文管理器中,使用 with 打开文件是使用最多的,其中离开 with 包含的语句后会执行一些类似于清理的工作,如关闭文件,关闭连接对象等操作。

实践

我们在代码实践的时候,忽略了在同一代码片段中,先打开文件,然后直接对文件进行其他处理,因为这样没有任何意义,资源是处于被占用的情况。

先看下面检测的代码：

#!/usr/bin/env python
# _*_ coding: UTF-8 _*_
# MedusaSorcerer Script
import os

class OpenFile:
   def __init__(self):
       self.file = None

def open(self, path):
       self.file = open(path, 'w')

if __name__ == '__main__':
   file_path = 'medusa.md'
   file = OpenFile()
   file.open(file_path)
   os.remove(file_path)

代码中我们把文件对象,进行了实例属性的方式引用,在此之后,我们使用 os 模块进行删除被写入的文件。执行改代码片段后,会出现以下内容：

Traceback (most recent call last):
  File "medusa/main.py", line 19, in <module>
    os.remove(file_path)
PermissionError: [WinError 32] 另一个程序正在使用此文件，进程无法访问。: 'medusa.md'

Process finished with exit code 1

那是因为被删除的文件没有得到资源释放。我们在上面的基础上进行套用函数的方式：

#!/usr/bin/env python
# _*_ coding: UTF-8 _*_
# MedusaSorcerer Script
import os

class OpenFile:
   def __init__(self):
       self.file = None

def open(self, path):
       self.file = open(path, 'w')

def open_file(path):
   file = OpenFile()
   file.open(path)

if __name__ == '__main__':
   file_path = 'medusa.md'
   open_file(file_path)
   os.remove(file_path)

这段代码会成功的被执行成功,原因是当你执行函数的时候,函数内的临时变量将被回收释放,因此 OpenFile 的实例对象被释放了,实例属性也就不存在而被释放,所以会执行成功。

那是否我们的操作都应该使用函数包裹的方式执行呢？with 的出现,完美解决了这个问题：

#!/usr/bin/env python
# _*_ coding: UTF-8 _*_
# MedusaSorcerer Script
import os

if __name__ == '__main__':
   file_path = 'medusa.md'
   with open(file_path, 'w') as f:
       print(f)
   os.remove(file_path)

在 with 语法中,将后面打开文件的操作,返回的文件对象,赋值给 f 变量,在结构体中输出了 f 变量的内容,并且在结构体外删除了该文件：

medusa\python.exe medusa/main.py
<_io.TextIOWrapper name='medusa.md' mode='w' encoding='cp936'>

Process finished with exit code 0

在没有使用 close() 的情况下,依旧可以对文件进行删除,这就是上下文管理的美妙。

实现

上下文管理,实际上是实现了 __enter__ 和 __exit__ 方法：

#!/usr/bin/env python
# _*_ coding: UTF-8 _*_
# MedusaSorcerer Script

class Medusa:

def __init__(self):
       print('__init__')

def __enter__(self):
       print('__enter__')

def __exit__(self, exc_type, exc_val, exc_tb):
       print('__exit__')

if __name__ == '__main__':
   medusa = Medusa()
   with medusa:
       print('with object')
   print('finish')

以下是输出结果：

__init__
__enter__
with object
__exit__
finish

我们发现魔法方法在结合某些语法后会发生自动调度,所以,上下文管理中就在自动调度中，关闭了某些对象。

优点

实现上下文管理可以简化我们的代码,让代码更加简单易读,使用最少的代码量,就可以完成全部工作。

来源：https://juejin.cn/post/6973175837046603806