详解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读取环境变量的方法和自定义类分享
Nov 22 Python
用Python编写一个简单的俄罗斯方块游戏的教程
Apr 03 Python
Python 的类、继承和多态详解
Jul 16 Python
Python排序搜索基本算法之插入排序实例分析
Dec 11 Python
查找python项目依赖并生成requirements.txt的方法
Jul 10 Python
对Django url的几种使用方式详解
Aug 06 Python
python GUI库图形界面开发之PyQt5布局控件QHBoxLayout详细使用方法与实例
Mar 06 Python
Python 解析库json及jsonpath pickle的实现
Aug 17 Python
Python调用ffmpeg开源视频处理库,批量处理视频
Nov 16 Python
如何理解及使用Python闭包
Jun 01 Python
Python 中的 copy()和deepcopy()
Nov 07 Python
python标准库ElementTree处理xml
May 20 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
cmd下运行php脚本
2008/11/25 PHP
php引用计数器进行垃圾收集机制介绍
2012/09/19 PHP
PHP解析目录路径的3个函数总结
2014/11/18 PHP
php安装php_rar扩展实现rar文件读取和解压的方法
2016/11/17 PHP
Javascript 遍历对象中的子对象
2009/07/03 Javascript
boxy基于jquery的弹出层对话框插件扩展应用 弹出层选择器
2010/11/21 Javascript
javascript简单实现命名空间效果
2014/03/06 Javascript
谷歌地图打不开的解决办法
2014/08/07 Javascript
AngularJS表单编辑提交功能实例
2015/02/13 Javascript
nodejs初步体验篇
2015/11/23 NodeJs
javascript使用闭包模拟对象的私有属性和方法
2016/10/05 Javascript
全屏滚动插件fullPage.js使用实例解析
2016/10/21 Javascript
BootStrap modal模态弹窗使用小结
2016/10/26 Javascript
利用C/C++编写node.js原生模块的方法教程
2017/07/07 Javascript
layer实现关闭弹出层刷新父界面功能详解
2017/11/15 Javascript
AngularJS日期格式化常见操作实例分析
2018/05/17 Javascript
JavaScript栈和队列相关操作与实现方法详解
2018/12/07 Javascript
jQuery操作attr、prop、val()/text()/html()、class属性
2019/05/23 jQuery
通过Nodejs搭建网站简单实现注册登录流程
2019/06/14 NodeJs
js实现图片跟随鼠标移动效果
2019/10/16 Javascript
JavaScript进制转换实现方法解析
2020/01/18 Javascript
Element InfiniteScroll无限滚动的具体使用方法
2020/07/27 Javascript
[08:38]DOTA2-DPC中国联赛 正赛 VG vs Elephant 选手采访
2021/03/11 DOTA
Python中的类与对象之描述符详解
2015/03/27 Python
OpenCV3.0+Python3.6实现特定颜色的物体追踪
2019/07/23 Python
Django项目基础配置和基本使用过程解析
2019/11/25 Python
Pycharm如何导入python文件及解决报错问题
2020/05/10 Python
jupyter使用自动补全和切换默认浏览器的方法
2020/11/18 Python
联想法国官方网站:Lenovo法国
2018/10/18 全球购物
俄罗斯花园种植材料批发和零售网上商店:Беккер
2019/07/22 全球购物
大专生简历的自我评价
2013/11/26 职场文书
2015出纳试用期工作总结
2014/12/12 职场文书
小学音乐教师个人工作总结
2015/02/05 职场文书
监护人证明
2015/06/19 职场文书
趣味运动会赞词
2015/07/22 职场文书
通过feDisplacementMap和feImage实现水波特效
2022/04/24 HTML / CSS