学习
实践
活动
工具
TVP
写文章

针对Python的with语句与上下文管理器,为你详细解剖

一、with语句就是简洁版的try/finally语句

在我们日常使用场景中,经常会操作一些资源,比如文件对象、数据库连接、Socket连接等,资源操作完了之后,不管操作的成功与否,最重要的事情就是关闭该资源,否则资源打开太多而没有关闭,程序会报错,以文件操作为例,通常我们会这样写:

但既然close方法是必须的操作,那就没必要显式地调用,所以Python给我们提供了一种更优雅的方式,使用with语句:

在退出with语句下的代码块之后,f 对象会自动执行自己的close方法,实现资源的释放,简洁优雅。

二、上下文管理器原理

f 对象之所以会自动执行自己的close方法,是因为它是一个上下文管理器,所以我们要先说说什么是上下文管理器。

上下文管理器是内部实现了__enter__和__exit__方法的对象(比如下面EXPR表达式获取到的对象)

它的一般使用方法是:

上述代码的执行过程等价于:

f 对象就是把自己的close方法定义在了它的__exit__方法内部,实现了代码块BLOCK执行完之后自动关闭自身。

三、自定义上下文管理器

为了验证上述的执行过程,我们定义一个文件类,内部实现了__enter__和__exit__两个方法:

这时候File类就是一个上下文管理器

我们分别通过 with语句 和 try/finally语句 使用File类对文件进行写入操作

通过with语句执行:

控制台输出:

并得到了一个写了 Hello 的 file.txt 文件

通过try/finally语句执行:

控制台输出:

并得到了一个写了 Hello 的 file.txt 文件

两者输出一致,所以验证了二中执行过程的等价关系是正确的

四、__enter__和__exit__方法说明

1、__enter__方法说明

上下文管理器的__enter__方法是可以带返回值的,默认返回None,这个返回值通过with…as…中的 as 赋给它后面的那个变量,所以 with EXPR as VAR 就是将EXPR对象__enter__方法的返回值赋给 VAR。

当然with...as...并非固定组合,单独使用with...也是可以的,上下文管理器的__enter__方法还是正常执行,只是这个返回值并没有赋给一个变量,with下面的代码块也不能使用这个返回值。

2、__exit__方法说明

上下文管理器的__exit__方法接收3个参数exc_type、exc_val、exc_tb,如果代码块BLOCK发生了异常e并退出,这3个参数分别为type(e)、str(e)、e.__traceback__,否则都为None。

同样__exit__方法也是可以带返回值的,这个返回值应该是一个布尔类型True或False,默认为None(即False)。如果为False,异常会被抛出,用户需要进行异常处理。如果为True,则表示忽略该异常。

五、contextmanager 装饰器

Python还提供了一个contextmanager装饰器,允许用户将一个生成器定义为上下文管理器,该装饰器将生成器中的代码通过yield语句分成两部分,yield之前的代码为__enter__方法,yield之后的代码为__exit__方法,yield的返回值即__enter__方法的返回值,用于赋给as后的变量。

下面我们通过contextmanager装饰器也实现一个关于文件的上下文管理器:

说明:这里使用 try/finally 是确保yield的过程中就算出现异常,文件也能正常关闭,当然这里也能处理异常,使用 try/except/finally 即可。

通过with语句执行:

执行结果跟之前的上下文管理器执行结果一致,说明contextmanager装饰器也能定义一个上下文管理器。

之前写过一篇文章阐述了装饰器的原理,现在也知道了上下文管理器就是内部实现了__enter__和__exit__方法的对象,所以有兴趣的同学就可以去看看contextmanager装饰器的源码了,看看它是怎么把一个生成器变成上下文管理器的,其实稍微想想就知道,肯定是contextmanager装饰器把生成器加工成一个内部实现了__enter__和__exit__方法的对象,有时间的话另写一篇文章带大家看看contextmanager的源码。

六、总结

with语句是try/finally语句的替代,简化了资源调用之后的清理工作

with语句的操作对象是上下文管理器,它是内部实现了__enter__和__exit__方法的对象

__enter__方法可以带返回值,它通过with…as…语句中的as赋给它后面的变量;__exit__可返回布尔值,如果为False,异常会被抛出,用户需要进行异常处理,如果为True,则表示忽略该异常

Python还提供了contextmanager装饰器,进一步简化了上下文管理器的定义方法,它通过把生成器加工成一个内部实现了enter__`和`__exit方法的对象,从而实现生成器变上下文管理器

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181110A1QWXY00?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码关注腾讯云开发者

领取腾讯云代金券