详解python with 上下文管理器


Posted in Python onSeptember 02, 2020

作为一个 Java 为母语的程序员来讲,学习起其他新的语言就难免任何事都与 Java 进行横向对比。Java 7 引入了能省去许多重复代码的 try-with-resources 特性,不用每回 try/finally 来释放资源(不便之处有局部变量必须声明在 try 之前,finally 里还要嵌套 try/catch 来处理异常)。比如下面的 Java 代码

try(InputStream inputStream = new FileInputStream("abc.txt")) {
  System.out.println(inputStream.read());
} catch (Exception ex) {
}

它相应的不使用 try-with-resources 语法的代码就是

InputStream inputStream = null;
try {
  inputStream = new FileInputStream("abc.txt");
} catch (Exception ex) {
} finally {
  if(inputStream != null) {
    try {
      inputStream.close();
    } catch (Exception ex) {
    }
  }
}

类似的 Python 也有自己的 try-with-resources 写法,就是 with 关键字,它的概念叫做上下文管理器(Context Manager)。

with 关键字的使用

with open('some_file', 'w') as opened_file:
  opened_file.write('Hola!')

以上的代码相当于

opened_file = open('some_file', 'w')
try:
  opened_file.write('Hola!')
finally:
  opened_file.close()

也就是 with 关键字打开的资源会在 with 语句块结束后自动调用相应的方法自动释放(无论 with 中操作是否有异常)。

with 用起来是很方便的,但是什么样的资源可以用 with 关键字?Python 是怎么知道要调用哪个方法来关闭资源的?进而如何实现自己的支持上下文管理器的 Python 类。

再次回顾 Java 的 try-with-resources 语法,try(...) 括号支持的类必须是实现了 AutoCloseable 接口,它的接口方法是

public void close() throws IOException

也就是 Java 的 try-with-resources 语法会自动调用以上方法来释放资源,要实现可被自动释放的 Java 就只须遵照这一规则就行。

而在 Python 中,能被 with 的类有两种实现方式

实现基本方法以支持上下文管理器的类

一个 Python 类要能被用于 with 上下文,必须实现至少 __enter__ __exit__ 方法。这两个方法的意思好理解,一个是创建资源后,后者是退出 with 语句块后。请看下面的例子

class File(object):
  def __init__(self, file_name, method):
    self.file_obj = open(file_name, method)
 
  def __enter__(self):
    print("---enter")
    return self.file_obj
 
  def __exit__(self, type, value, traceback):
    print("---exit")
    self.file_obj.close()
 
 
with File('data.txt', 'r') as data_file:
  print(data_file.read())

假设 data.txt 文件中的内容是

hello
world

那么以上程序执行后的输出就是

--enter
hello
world
---exit

  1. __enter__ 返回的值作为 with ... as data_file 中的 data_file 变量的值,如果 __enter__ 没有返回,data_file 得到的就是 NoneType object 了。
  2. __exit__ 可利用来释放资源
  3. 没有 __enter__ 方法试图用 with 的写法执行时会得到 AttributeErro: __enter__ 异常
  4. 同样,没有 __exit__ 方法试图用 with 的写法执行时会得到 AttributeErro: __exit__ 异常
  5. __exit__ 有其他额外的三个参数,可获得资源的值,以及能处理 with 块中执行出现异常的情况
  6. __exit__ 的返回值也有用途,如果它返回 True 则出现的异常不再向外传播,其他值的话直接向外抛

利用生成器(Generator) 和装饰器创建支持上下文管理器的方法

此种方式比较简单,不过逻辑控制上没有这么强。

from contextlib import contextmanager
 
@contextmanager
def open_file(name, method):
  f = open(name, method)
  yield f
  f.close()

使用 f 的执行代码将被放置在 yield f 所处的位置,with 使用以上方法。yield 后的 f 变量将是 with...as 后的变量值

with open_file('some_file', 'w') as file_object:
  file_object.write('hola!')

这里也要注意异常处理的情况,比如把上面代码打开文件的模式换作 r, 仍然试图去写文件,这样在 open_file 方法的 yield f 位置将产生异常,会造成 f.close() 得不到执行,不能正确释放该资源。

欲更具防御性,前面的 yield f 可以扩展也如下的形式

try:
  yield f
except Exception as ex:
  pass #处理异常,或继续向外抛
finally:
  f.close()

@contextmanager 装饰器内部也是封装为一个实现了 __enter__ __exit__ 方法的对象。

参考链接:Context Managers

以上就是详解python with 上下文管理器的详细内容,更多关于python with 上下文管理器的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
python下paramiko模块实现ssh连接登录Linux服务器
Jun 03 Python
python 3.0 模拟用户登录功能并实现三次错误锁定
Nov 01 Python
python spyder中读取txt为图片的方法
Apr 27 Python
Python基于property实现类的特性操作示例
Jun 15 Python
python+opencv打开摄像头,保存视频、拍照功能的实现方法
Jan 08 Python
Python使用paramiko操作linux的方法讲解
Feb 25 Python
python与字符编码问题
May 24 Python
Python OpenCV去除字母后面的杂线操作
Jul 05 Python
python中super()函数的理解与基本使用
Aug 30 Python
python中if和elif的区别介绍
Nov 07 Python
总结三种用 Python 作为小程序后端的方式
May 02 Python
Python实现Matplotlib,Seaborn动态数据图
May 06 Python
Python 的 __str__ 和 __repr__ 方法对比
Sep 02 #Python
Python datetime 如何处理时区信息
Sep 02 #Python
浅析python中的del用法
Sep 02 #Python
浅析NumPy 切片和索引
Sep 02 #Python
详解Python 函数参数的拆解
Sep 02 #Python
Python 常用日期处理 -- calendar 与 dateutil 模块的使用
Sep 02 #Python
python 常用日期处理-- datetime 模块的使用
Sep 02 #Python
You might like
不要轻信 PHP_SELF的安全问题
2009/09/05 PHP
用php来限制每个ip每天浏览页面数量的实现思路
2015/02/24 PHP
PHP生成推广海报的方法分享
2018/04/22 PHP
PHP 实现重载
2021/03/09 PHP
javascript正则表达式中参数g(全局)的作用
2010/11/11 Javascript
extjs两个tbar问题探讨
2013/08/08 Javascript
jquery弹出框的用法示例(一)
2013/08/26 Javascript
浅谈javascript事件取消和阻止冒泡
2015/05/26 Javascript
Bootstrap中的Dropdown下拉菜单更改为悬停(hover)触发
2016/08/31 Javascript
学习vue.js表单控件绑定操作
2016/12/05 Javascript
js转换对象为xml
2017/02/17 Javascript
原生JS实现垂直手风琴效果
2017/02/19 Javascript
JQuery和html+css实现带小圆点和左右按钮的轮播图实例
2017/07/22 jQuery
jQuery仿移动端支付宝键盘的实现代码
2018/08/15 jQuery
JavaScript数组方法的错误使用例子
2018/09/13 Javascript
JavaScript箭头函数中的this详解
2019/06/19 Javascript
微信小程序绘制图片发送朋友圈
2019/07/25 Javascript
Layui 带多选框表格监听事件以及按钮自动点击写法实例
2019/09/02 Javascript
JavaScript命令模式原理与用法实例详解
2020/03/10 Javascript
vue 调用 RESTful风格接口操作
2020/08/11 Javascript
Jquery Fade用法详解
2020/11/06 jQuery
Python复制目录结构脚本代码分享
2015/03/06 Python
python中Switch/Case实现的示例代码
2017/11/09 Python
深入flask之异步非堵塞实现代码示例
2018/07/31 Python
Python3.5装饰器典型案例分析
2019/04/30 Python
pandas的qcut()方法详解
2019/07/06 Python
解决Django删除migrations文件夹中的文件后出现的异常问题
2019/08/31 Python
PyCharm2019安装教程及其使用(图文教程)
2019/09/29 Python
Django mysqlclient安装和使用详解
2020/09/17 Python
matplotlib 范围选区(SpanSelector)的使用
2021/02/24 Python
利用css3画个同心圆示例代码
2017/07/03 HTML / CSS
美国购车网站:TrueCar
2016/10/19 全球购物
军训感想500字
2014/02/20 职场文书
五四演讲稿范文
2014/09/03 职场文书
2015年乡镇卫生院工作总结
2015/04/22 职场文书
2015年出纳年终工作总结
2015/05/14 职场文书