Python之上下文管理器

以下文章总结自《head first python》读书笔记

引子

从python处理一个文件说起，在Python中打开一个文件时，一般的代码逻辑如下：

file = open('test.txt')
for line in file:
    print(line)
file.close()

以上代码主要做了3件事：1）打开一个文件；2）处理文件，读取每一行并打印出来；3)关闭文件

但是对大多数程序员而言，处理文件常推荐使用的是一个with语句。如下：

with open('test.txt') as file:
    for line in file:
        print(line, end='')

明显的区别是，代码简洁了，没有close调用，这是通过with语句来实现的，只要它的代码组结束，就会自动调用close。这样做有效的避免了程序员处理完文件后忘记使用close。尤其如果是写文件的时候，如果忘记调用close可能会导致数据丢失或破坏。

而with语句就是一个Python内置的上下文管理器。with语句负责管理其代码组运行的上下文。

创建上下文管理器

首先，前面提到了with是一个内置的上下文管理器（标准库中也支持创建简单的上下文管理器，使用contextlib模块），如果要使用with控制某个外部变量（比如打开文件），一般要创建一个遵循上下文管理协议的类。

协议指出，创建的类必须至少定义两个方法: __enter__和__exit__。这就是协议，如果类遵循这个协议，就可以挂接到with语句。

__enter__完成建立

一个对象用于with语句时，在with语句的代码组开始之前，解释器会调用这个对象的__enter__方法。这样就可以在__enter__中执行必要的建立代码。

同时enter可以（但不是必须）向with语句返回一个值

__exit__完成清理

一旦with语句的代码组结束，解释器就会调用这个对象的__exit__方法。可以在exit方法中编辑对应的清理代码。

由于with语句的代码组有可能执行失败，exit方法必须在发生这种情况时进行处理。

__init__完成初始化

除了上述提到的enter和exit， 还可以根据需要为类增加其他方法，包括定义自己的__init__。如需要建立此方法，可以将初始化活动和建立活动分离。

定义__init__允许完成额外的对象初始化。init在enter之前运行。

总结一下，

为了挂接with语句，上下文管理协议需要创建一个提供以下内容的类：

1）__init__方法，来完成初始化（如果需要）

2) __enter__方法， 来完成所有建立工作

3) __exit__方法，来完成所有清理工作。

再回过头看之前打开文件的例子：

with open('test.txt') as file:
    for line in file:
        print(line, end='')

1）解释器遇到with语句时，首先调用与open（有一个py文件，定义了一个类，类名为open，包含init，enter，exit方法）调用关联的__init__

2)  一旦init执行，解释器会调用enter来确保调用Open的结果会赋给file变量。

3）with语句结束时，解释器会调用__exit__来完成清理，会确保打开的文件关闭，然后才继续。