正确理解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中random模块用法实例分析
May 19 Python
Python求两个文本文件以行为单位的交集、并集与差集的方法
Jun 17 Python
Python 装饰器实现DRY(不重复代码)原则
Mar 05 Python
python实现对求解最长回文子串的动态规划算法
Jun 02 Python
python画图--输出指定像素点的颜色值方法
Jul 03 Python
Python re 模块findall() 函数返回值展现方式解析
Aug 09 Python
python字典的遍历3种方法详解
Aug 10 Python
python绘制规则网络图形实例
Dec 09 Python
pytorch之ImageFolder使用详解
Jan 06 Python
Pandas对DataFrame单列/多列进行运算(map, apply, transform, agg)
Jun 14 Python
python温度转换华氏温度实现代码
Dec 06 Python
Pandas直接读取sql脚本的方法
Jan 21 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
简单谈谈PHP vs Node.js
2015/07/17 PHP
PHP二进制与字符串之间的相互转换教程
2016/10/14 PHP
PDO实现学生管理系统
2020/03/21 PHP
Javascript的IE和Firefox兼容性汇编(zz)
2007/02/02 Javascript
textarea的value是html文件源代码,存成html文件的代码
2007/04/20 Javascript
快速排序 php与javascript的不同之处
2011/02/22 Javascript
兼容FF和IE的动态table示例自写
2013/10/21 Javascript
Listloading.js移动端上拉下拉刷新组件
2016/08/04 Javascript
vue-vuex中使用commit提交mutation来修改state的方法详解
2018/09/16 Javascript
关于layui的下拉搜索框异步加载数据的解决方法
2019/09/28 Javascript
javascript的delete运算符知识点总结
2019/11/19 Javascript
npx create-react-app xxx创建项目报错的解决办法
2020/02/17 Javascript
javascript canvas检测小球碰撞
2020/04/17 Javascript
Vue.js暴露方法给WebView的使用操作
2020/09/07 Javascript
python修改字典内key对应值的方法
2015/07/11 Python
Python基于Floyd算法求解最短路径距离问题实例详解
2018/05/16 Python
实用自动化运维Python脚本分享
2018/06/04 Python
python scp 批量同步文件的实现方法
2019/01/03 Python
python 调用钉钉机器人的方法
2019/02/20 Python
PyTorch搭建多项式回归模型(三)
2019/05/22 Python
sklearn-SVC实现与类参数详解
2019/12/10 Python
python通用读取vcf文件的类(复制粘贴即可用)
2020/02/29 Python
pygame用blit()实现动画效果的示例代码
2020/05/28 Python
Python爬虫获取op.gg英雄联盟英雄对位胜率的源码
2021/01/29 Python
CSS3制作轮播图的一种方法
2019/11/11 HTML / CSS
老板电器官方购物商城:老板油烟机、燃气灶、消毒柜、电烤箱
2018/05/30 全球购物
一套软件测试笔试题
2014/07/25 面试题
EJB的几种类型
2012/08/15 面试题
开办加工厂创业计划书
2014/01/03 职场文书
师德演讲稿范文
2014/05/06 职场文书
售后客服工作职责
2014/06/16 职场文书
八项规定对照检查材料
2014/08/31 职场文书
如何写早恋检讨书
2014/09/10 职场文书
人事任命书范本
2015/09/21 职场文书
oracle DGMGRL ORA-16603报错的解决方法(DG Broker)
2021/04/06 Oracle
Mysql文件存储图文详解
2021/06/01 MySQL