正确理解python中的关键字“with”与上下文管理器


Posted in Python onApril 21, 2017

前言

如果你有阅读源码的习惯,可能会看到一些优秀的代码经常出现带有 “with” 关键字的语句,它通常用在什么场景呢?今天就来说说 with 和 上下文管理器。

对于系统资源如文件、数据库连接、socket 而言,应用程序打开这些资源并执行完业务逻辑之后,必须做的一件事就是要关闭(断开)该资源。

比如 Python 程序打开一个文件,往文件中写内容,写完之后,就要关闭该文件,否则会出现什么情况呢?极端情况下会出现 "Too many open files" 的错误,因为系统允许你打开的最大文件数量是有限的。

同样,对于数据库,如果连接数过多而没有及时关闭的话,就可能会出现 "Can not connect to MySQL server Too many connections",因为数据库连接是一种非常昂贵的资源,不可能无限制的被创建。

来看看如何正确关闭一个文件。

普通版:

def m1():
 f = open("output.txt", "w")
 f.write("python之禅")
 f.close()

这样写有一个潜在的问题,如果在调用 write 的过程中,出现了异常进而导致后续代码无法继续执行,close 方法无法被正常调用,因此资源就会一直被该程序占用者释放。那么该如何改进代码呢?

进阶版:

def m2():
 f = open("output.txt", "w")
 try:
 f.write("python之禅")
 except IOError:
 print("oops error")
 finally:
 f.close()

改良版本的程序是对可能发生异常的代码处进行 try 捕获,使用 try/finally 语句,该语句表示如果在 try 代码块中程序出现了异常,后续代码就不再执行,而直接跳转到 except 代码块。而无论如何,finally 块的代码最终都会被执行。因此,只要把 close 放在 finally 代码中,文件就一定会关闭。

高级版:

def m3():
 with open("output.txt", "w") as f:
 f.write("Python之禅")

一种更加简洁、优雅的方式就是用 with 关键字。open 方法的返回值赋值给变量 f,当离开 with 代码块的时候,系统会自动调用 f.close() 方法, with 的作用和使用 try/finally 语句是一样的。那么它的实现原理是什么?

在讲 with 的原理前要涉及到另外一个概念,就是上下文管理器(Context Manager)。

上下文管理器

任何实现了 __enter__() __exit__() 方法的对象都可称之为上下文管理器,上下文管理器对象可以使用 with 关键字。显然,文件(file)对象也实现了上下文管理器。

那么文件对象是如何实现这两个方法的呢?我们可以模拟实现一个自己的文件类,让该类实现 __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()

__enter__() 方法返回资源对象,这里就是你将要打开的那个文件对象, __exit__() 方法处理一些清除工作。

因为 File 类实现了上下文管理器,现在就可以使用 with 语句了。

with File('out.txt', 'w') as f:
 print("writing")
 f.write('hello, python')

这样,你就无需显示地调用 close 方法了,由系统自动去调用,哪怕中间遇到异常 close 方法也会被调用。

contextlib

Python 还提供了一个 contextmanager 的装饰器,更进一步简化了上下文管理器的实现方式。通过 yield 将函数分割成两部分,yield 之前的语句在 __enter__ 方法中执行,yield 之后的语句在 __exit__ 方法中执行。紧跟在 yield 后面的值是函数的返回值。

from contextlib import contextmanager

@contextmanager
def my_open(path, mode):
 f = open(path, mode)
 yield f
 f.close()

调用

with my_open('out.txt', 'w') as f:
 f.write("hello , the simplest context manager")

总结

Python 提供了 with 语法用于简化资源操作的后续清除操作,是 try/finally 的替代方法,实现原理建立在上下文管理器之上。此外,Python 还提供了一个 contextmanager 装饰器,更进一步简化上下管理器的实现方式。以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

Python 相关文章推荐
Python logging模块学习笔记
May 24 Python
Python通过websocket与js客户端通信示例分析
Jun 25 Python
python爬虫获取京东手机图片的图文教程
Dec 29 Python
Python实现根据日期获取当天凌晨时间戳的方法示例
Apr 09 Python
django自带调试服务器的使用详解
Aug 29 Python
python sorted方法和列表使用解析
Nov 18 Python
Python面向对象之多态原理与用法案例分析
Dec 30 Python
jupyter notebook清除输出方式
Apr 10 Python
python和go语言的区别是什么
Jul 20 Python
Selenium webdriver添加cookie实现过程详解
Aug 12 Python
python在CMD界面读取excel所有数据的示例
Sep 28 Python
使用Python判断一个文件是否被占用的方法教程
Dec 16 Python
python妙用之编码的转换详解
Apr 21 #Python
简单谈谈Python中的元祖(Tuple)和字典(Dict)
Apr 21 #Python
Python学习笔记之解析json的方法分析
Apr 21 #Python
Python正则抓取网易新闻的方法示例
Apr 21 #Python
Python中shape计算矩阵的方法示例
Apr 21 #Python
Python使用正则表达式抓取网页图片的方法示例
Apr 21 #Python
用python找出那些被“标记”的照片
Apr 20 #Python
You might like
将兴奋、喜悦和坎加斯带到戴安娜:亚马逊公主
2020/03/03 欧美动漫
ThinkPHP采用模块和操作分析
2011/04/18 PHP
php中判断文件存在是用file_exists还是is_file的整理
2012/09/12 PHP
解析htaccess伪静态的规则
2013/06/18 PHP
php基础教程
2015/08/26 PHP
PHP抓取远程图片(含不带后缀的)教程详解
2016/10/21 PHP
php读取qqwry.dat ip地址定位文件的类实例代码
2016/11/15 PHP
Yii2框架配置文件(Application属性)与调试技巧实例分析
2019/05/27 PHP
jquery checkbox全选、取消全选实现代码
2010/03/05 Javascript
修改或扩展jQuery原生方法的代码实例
2015/01/13 Javascript
JQuery实现Ajax加载图片的方法
2015/12/24 Javascript
使用vue.js实现联动效果的示例代码
2017/01/10 Javascript
canvas 实现中国象棋
2017/02/17 Javascript
javaScript 连接打印机,打印小票的实例
2017/12/29 Javascript
webpack之devtool详解
2018/02/10 Javascript
jQuery实现的鼠标拖动浮层功能示例【拖动div等任何标签】
2018/12/29 jQuery
javascript使用Blob对象实现的下载文件操作示例
2020/04/18 Javascript
解决antd 表单设置默认值initialValue后验证失效的问题
2020/11/02 Javascript
vue 中this.$set 动态绑定数据的案例讲解
2021/01/29 Vue.js
[03:03]2014DOTA2西雅图国际邀请赛 Alliance战队巡礼
2014/07/07 DOTA
Python天气预报采集器实现代码(网页爬虫)
2012/10/07 Python
Python自动化开发学习之三级菜单制作
2017/07/14 Python
python 获取字符串MD5值方法
2018/05/29 Python
python环境路径配置以及命令行运行脚本
2019/04/02 Python
pytorch索引查找 index_select的例子
2019/08/18 Python
通过Python实现Payload分离免杀过程详解
2020/07/13 Python
python3通过subprocess模块调用脚本并和脚本交互的操作
2020/12/05 Python
CSS实现限制字数功能当对象内文本溢出时显示省略标记
2014/08/20 HTML / CSS
英国最全面的橄榄球联盟门票网站:Live Rugby Tickets
2018/10/06 全球购物
电大毕业生自我鉴定
2013/11/10 职场文书
采购员岗位职责
2013/11/15 职场文书
水污染治理工程专业求职信
2014/06/14 职场文书
公司领导班子对照检查存在问题整改措施
2014/10/02 职场文书
2015年学生管理工作总结
2015/05/26 职场文书
OpenCV-Python实现油画效果的实例
2021/06/08 Python
Python3 多线程(连接池)操作MySQL插入数据
2021/06/09 Python