一文读懂 with ... as 原理

对于文件、数据库连接、socket 等系统资源而言，应用程序打开这些资源并执行完业务逻辑之后，必须做的一件事就是要关闭（断开）该资源。否则会一直占用资源，影响性能。

---

以向文件写入数据为例

普通版：

f = open('file.txt', 'w')
f.write('waspvae')
f.close()

这种写法会有一个潜在的问题，如果在调用 write 的过程中出现了异常会导致后续代码无法执行，close 方法无法被调用，文件无法关闭，资源就会一直被该程序占用，无法释放。

改良版：

f = open('file.txt', 'w')
try:
    f.write('waspvae')
except IOError:
    print('error')
finally:
    f.close()

改良版虽然解决了出现异常无法关闭的问题，但代码有点复杂，不符合 python 精神。

终极版：

with open('file.txt', 'w') as f:
    f.write('waspvae')

终极版更加优雅、简洁。open 方法的返回值赋值给变量 f，with … as 后面的语句属于 with 的作用域，当离开 with 作用域的时候，系统能够自动调用 f.close() 方法，那么它的实现原理是什么？在讲 with 的原理前要涉及到另外一个概念，就是上下文管理器（Context Manager）。

上下文管理器

任何实现了 enter() 和 exit() 方法的对象都可称之为上下文管理器，上下文管理器对象可以使用 with 关键字。文件对象就是实现了上下文管理器

模拟实现一个自己的文件类，让该方法实现 enter() 和 exit() 方法。

class File():

    def __init__(self, filename, mode):
        self.filename = filename
        self.mode = mode

    def __enter__(self):
        print("entering")
        self.f = open(self.filename, self.mode)
        return self.f

    def __exit__(self, *args):
        print("will exit")
        self.f.close()
# 因为 FIle 类实现了上下文管理器，所以可以使用 with 语句
with File('file.txt', 'w') as f:
    print("writing")
    f.write('waspvae')

打印结果为：

entering
writing
will exit

首先调用该实例的 enter 方法，打印 entering，把返回结果绑定到变量 f 上，然后打印 writing，当 with 的作用域执行完毕，调用 exit 方法，打印 will exit ，关闭文件。

实现上下管理器的另一方式（contextmanager 装饰器）

在 contextlib 模块中，提供了 @contextmanager 装饰器，将一个生成器函数当成上下文管理器使用，上面的代码与下面的代码等效

from contextlib import contextmanager
@contextmanager
def file(filename, mode):
    print("entering")
    f = open(filename, mode)
    yield f
    print("will exit")
    f.close()
with File('file.txt', 'w') as f:
    print("writing")
    f.write('waspvae')

通过 yield 将函数分割成两部分，yield 之前的语句在 enter 方法中执行，yield 之后的语句在 exit 方法中执行。紧跟在 yield 后面的值是函数的返回值。