详解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遍历指定文件及文件夹的方法
May 09 Python
python中类变量与成员变量的使用注意点总结
Apr 29 Python
python 函数传参之传值还是传引用的分析
Sep 07 Python
python select.select模块通信全过程解析
Sep 20 Python
解决Python2.7读写文件中的中文乱码问题
Apr 12 Python
Python爬虫获取图片并下载保存至本地的实例
Jun 01 Python
纯用NumPy实现神经网络的示例代码
Oct 24 Python
将python图片转为二进制文本的实例
Jan 24 Python
Python中Numpy mat的使用详解
May 24 Python
利用selenium爬虫抓取数据的基础教程
Jun 10 Python
python自动化测试之如何解析excel文件
Jun 27 Python
Python中sys模块功能与用法实例详解
Feb 26 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
用mysql内存表来代替php session的类
2009/02/01 PHP
使用php发送有附件的电子邮件-(PHPMailer使用的实例分析)
2013/04/26 PHP
javascript 网页跳转的方法
2008/12/24 Javascript
基于jquery的Repeater实现代码
2010/07/17 Javascript
js中eval详解
2012/03/30 Javascript
浅谈checkbox的一些操作(实战经验)
2013/11/20 Javascript
JavaScript 判断用户输入的邮箱及手机格式是否正确
2013/12/08 Javascript
javascript实现淘宝幻灯片广告展示效果
2015/04/27 Javascript
JavaScript简单遍历DOM对象所有属性的实现方法
2015/10/21 Javascript
纯js实现瀑布流布局及ajax动态新增数据
2016/04/07 Javascript
JS 清除字符串数组中,重复元素的实现方法
2016/05/24 Javascript
jQuery+Pdo编写login登陆界面
2016/08/01 Javascript
浅谈js中StringBuffer类的实现方法及使用
2016/09/02 Javascript
Node.js学习教程之HTTP/2服务器推送【译】
2017/10/31 Javascript
前端axios下载excel文件(二进制)的处理方法
2018/07/31 Javascript
Mint UI组件库CheckList使用及踩坑总结
2018/12/20 Javascript
jQuery子选择器与可见性选择器实例分析
2019/06/28 jQuery
react使用antd表单赋值,用于修改弹框的操作
2020/10/29 Javascript
10分钟学会js处理json的常用方法
2020/12/06 Javascript
Python中标准模块importlib详解
2017/04/16 Python
python实现kNN算法
2017/12/20 Python
Python使用itertools模块实现排列组合功能示例
2018/07/02 Python
python tornado使用流生成图片的例子
2019/11/18 Python
Python安装与卸载流程详细步骤(图解)
2020/02/20 Python
Python如何定义有默认参数的函数
2020/08/10 Python
Django执行源生mysql语句实现过程解析
2020/11/12 Python
瑞士设计师家具和家居饰品网上商店:Bruno Wickart
2019/03/18 全球购物
幼教求职信
2014/03/12 职场文书
副护士长竞聘演讲稿
2014/04/30 职场文书
城管大队整治方案
2014/05/06 职场文书
法人授权委托书样本
2014/09/19 职场文书
公证书格式
2015/01/23 职场文书
开会迟到检讨书范文
2015/05/06 职场文书
深入浅析Redis 集群伸缩原理
2021/05/15 Redis
pytorch锁死在dataloader(训练时卡死)
2021/05/28 Python
Feign调用全局异常处理解决方案
2021/06/24 Java/Android