详解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 25 Python
对Python的Django框架中的项目进行单元测试的方法
Apr 11 Python
Python实现动态添加属性和方法操作示例
Jul 25 Python
Flask之flask-session的具体使用
Jul 26 Python
pycharm恢复默认设置或者是替换pycharm的解释器实例
Oct 29 Python
Python实战之制作天气查询软件
May 14 Python
Python字典对象实现原理详解
Jul 01 Python
Python字典生成式、集合生成式、生成器用法实例分析
Jan 07 Python
TensorFlow2.X结合OpenCV 实现手势识别功能
Apr 08 Python
python实现与redis交互操作详解
Apr 21 Python
Django如何实现密码错误报错提醒
Sep 04 Python
Python用dilb提取照片上人脸的示例
Oct 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
PHP支持多种格式图片上传(支持jpg、png、gif)
2011/11/03 PHP
PHP反转字符串函数strrev()函数的用法
2012/02/04 PHP
php选择排序法实现数组排序实例分析
2015/02/16 PHP
PHP7如何开启Opcode打造强悍性能详解
2018/05/11 PHP
thinkPHP5框架自定义验证器实现方法分析
2018/06/11 PHP
php创建类并调用的实例方法
2019/09/25 PHP
使用Node.js实现一个简单的FastCGI服务器实例
2014/06/09 Javascript
JQuery鼠标移到小图显示大图效果的方法
2015/06/10 Javascript
浅谈angularjs module返回对象的坑(推荐)
2016/10/21 Javascript
Bootstrap基本组件学习笔记之分页(12)
2016/12/08 Javascript
jQuery Validate设置onkeyup验证的实例代码
2016/12/09 Javascript
JS中with的替代方法与String中的正则方法详解
2016/12/23 Javascript
详解vue-router和vue-cli以及组件之间的传值
2017/07/04 Javascript
vue-resource调用promise取数据方式详解
2017/07/21 Javascript
Vue路由管理器Vue-router的使用方法详解
2020/02/05 Javascript
[00:34]TI7不朽珍藏III——地穴编织者不朽展示
2017/07/15 DOTA
[54:05]DOTA2-DPC中国联赛定级赛 SAG vs iG BO3第一场 1月9日
2021/03/11 DOTA
Python urlopen()函数 示例分享
2014/06/12 Python
python进阶教程之异常处理
2014/08/30 Python
利用QT写一个极简单的图形化Python闹钟程序
2015/04/07 Python
合并百度影音的离线数据( with python 2.3)
2015/08/04 Python
python开发之IDEL(Python GUI)的使用方法图文详解
2015/11/12 Python
python实现可以断点续传和并发的ftp程序
2016/09/13 Python
Python实现视频下载功能
2017/03/14 Python
selenium+python截图不成功的解决方法
2019/01/30 Python
python实现感知机线性分类模型示例代码
2019/06/02 Python
python网络编程之多线程同时接受和发送
2019/09/03 Python
NumPy排序的实现
2020/01/21 Python
python误差棒图errorbar()函数实例解析
2020/02/11 Python
Canvas获取视频第一帧缩略图的实现
2020/11/11 HTML / CSS
英国游戏机和游戏购物网站:365games.co.uk
2018/06/18 全球购物
英国领先的体验日提供商:Buyagift
2019/04/19 全球购物
党的群众路线教育实践活动领导班子整改方案
2014/10/25 职场文书
会议欢迎词
2015/01/23 职场文书
python3.7.2 tkinter entry框限定输入数字的操作
2021/05/22 Python
mongoDB数据库索引快速入门指南
2022/03/23 MongoDB