Python中的上下文管理器相关知识详解


Posted in Python onSeptember 19, 2019

前言

with 这个关键字,对于每一学习Python的人,都不会陌生。

操作文本对象的时候,几乎所有的人都会让我们要用 with open ,这就是一个上下文管理的例子。你一定已经相当熟悉了,我就不再废话了。

with open('test.txt') as f:
  print f.readlines()

什么是上下文管理器?

基本语法

with EXPR as VAR:
  BLOCK

先理清几个概念

1. 上下文表达式:with open('test.txt') as f:

2. 上下文管理器:open('test.txt')

3. f 不是上下文管理器,应该是资源对象。

如何写上下文管理器?

要自己实现这样一个上下文管理,要先知道上下文管理协议。

简单点说,就是在一个类里,实现了__enter__和__exit__的方法,这个类的实例就是一个上下文管理器。

例如这个示例:

class Resource():
  def __enter__(self):
    print('===connect to resource===')
    return self
  def __exit__(self, exc_type, exc_val, exc_tb):
    print('===close resource connection===')     
  def operate(self):
    print('===in operation===')     
with Resource() as res:
  res.operate()

我们执行一下,通过日志的打印顺序。可以知道其执行过程。
===connect to resource==
===in operation===
===close resource connection===

从这个示例可以很明显的看出,在编写代码时,可以将资源的连接或者获取放在__enter__中,而将资源的关闭写在__exit__ 中。

为什么要用上下文管理器?

学习时多问自己几个为什么,养成对一些细节的思考,有助于加深对知识点的理解。

为什么要使用上下文管理器?

在我看来,这和 Python 崇尚的优雅风格有关。

  • 可以以一种更加优雅的方式,操作(创建/获取/释放)资源,如文件操作、数据库连接;
  • 可以以一种更加优雅的方式,处理异常;

第一种,我们上面已经以资源的连接为例讲过了。

而第二种,会被大多数人所忽略。这里会重点讲一下。

大家都知道,处理异常,通常都是使用 try...execept.. 来捕获处理的。这样做一个不好的地方是,在代码的主逻辑里,会有大量的异常处理代理,这会很大的影响我们的可读性。

好一点的做法呢,可以使用 with 将异常的处理隐藏起来。

仍然是以上面的代码为例,我们将1/0 这个一定会抛出异常的代码写在 operate 里

class Resource():
  def __enter__(self):
    print('===connect to resource===')
    return self
 
  def __exit__(self, exc_type, exc_val, exc_tb):
    print('===close resource connection===')
    return True
 
  def operate(self):
    1/0
 
with Resource() as res:
  res.operate()

运行一下,惊奇地发现,居然不会报错。

这就是上下文管理协议的一个强大之处,异常可以在__exit__ 进行捕获并由你自己决定如何处理,是抛出呢还是在这里就解决了。在__exit__ 里返回 True(没有return 就默认为 return False),就相当于告诉 Python解释器,这个异常我们已经捕获了,不需要再往外抛了。

在 写__exit__ 函数时,需要注意的事,它必须要有这三个参数:

  • exc_type:异常类型
  • exc_val:异常值
  • exc_tb:异常的错误栈信息

当主逻辑代码没有报异常时,这三个参数将都为None。

理解并使用 contextlib

在上面的例子中,我们只是为了构建一个上下文管理器,却写了一个类。如果只是要实现一个简单的功能,写一个类未免有点过于繁杂。这时候,我们就想,如果只写一个函数就可以实现上下文管理器就好了。

这个点Python早就想到了。它给我们提供了一个装饰器,你只要按照它的代码协议来实现函数内容,就可以将这个函数对象变成一个上下文管理器。

我们按照 contextlib 的协议来自己实现一个打开文件(with open)的上下文管理器。

import contextlib
 @contextlib.contextmanager
def open_func(file_name):
  # __enter__方法
  print('open file:', file_name, 'in __enter__')
  file_handler = open(file_name, 'r')
     # 【重点】:yield
  yield file_handler
   # __exit__方法
  print('close file:', file_name, 'in __exit__')
  file_handler.close()
  return
 with open_func('/Users/MING/mytest.txt') as file_in:
  for line in file_in:
    print(line)

在被装饰函数里,必须是一个生成器(带有yield),而yield之前的代码,就相当于__enter__里的内容。yield 之后的代码,就相当于__exit__ 里的内容。

上面这段代码只能实现上下文管理器的第一个目的(管理资源),并不能实现第二个目的(处理异常)。

如果要处理异常,可以改成下面这个样子。

import contextlib
@contextlib.contextmanager
def open_func(file_name):
  # __enter__方法
  print('open file:', file_name, 'in __enter__')
  file_handler = open(file_name, 'r')
  try:
    yield file_handler
  except Exception as exc:
    # deal with exception
    print('the exception was thrown')
  finally:
    print('close file:', file_name, 'in __exit__')
    file_handler.close()
    return
with open_func('/Users/MING/mytest.txt') as file_in:
  for line in file_in:
    1/0
    print(line)

好像只要讲到上下文管理器,大多数人都会谈到打开文件这个经典的例子。

但是在实际开发中,可以使用到上下文管理器的例子也不少。我这边举个我自己的例子。

在OpenStack中,给一个虚拟机创建快照时,需要先创建一个临时文件夹,来存放这个本地快照镜像,等到本地快照镜像创建完成后,再将这个镜像上传到Glance。然后删除这个临时目录。

这段代码的主逻辑是创建快照,而创建临时目录,属于前置条件,删除临时目录,是收尾工作。

虽然代码量很少,逻辑也不复杂,但是“创建临时目录,使用完后再删除临时目录”这个功能,在一个项目中很多地方都需要用到,如果可以将这段逻辑处理写成一个工具函数作为一个上下文管理器,那代码的复用率也大大提高。

代码是这样的

Python中的上下文管理器相关知识详解

总结起来,使用上下文管理器有三个好处:

  • 提高代码的复用率;
  • 提高代码的优雅度;
  • 提高代码的可读性;

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
使用Python编写类UNIX系统的命令行工具的教程
Apr 15 Python
python编写简单爬虫资料汇总
Mar 22 Python
Python部署web开发程序的几种方法
May 05 Python
Python使用正则表达式获取网页中所需要的信息
Jan 29 Python
python去除扩展名的实例讲解
Apr 23 Python
mac安装pytorch及系统的numpy更新方法
Jul 26 Python
Django中的ajax请求
Oct 19 Python
python实现windows壁纸定期更换功能
Jan 21 Python
python flask框架实现重定向功能示例
Jul 02 Python
python实现读取excel文件中所有sheet操作示例
Aug 09 Python
Python制作词云图代码实例
Sep 09 Python
Django实现基于类的分页功能
Oct 31 Python
Python Opencv提取图片中某种颜色组成的图形的方法
Sep 19 #Python
pandas read_excel()和to_excel()函数解析
Sep 19 #Python
python openvc 裁剪、剪切图片 提取图片的行和列
Sep 19 #Python
vscode 配置 python3开发环境的方法
Sep 19 #Python
python实现简易学生信息管理系统
Apr 05 #Python
Python字符串大小写转换拼接删除空白
Sep 19 #Python
python BlockingScheduler定时任务及其他方式的实现
Sep 19 #Python
You might like
PHP数据库链接类(PDO+Access)实例分享
2013/12/05 PHP
header导出Excel应用示例
2014/01/24 PHP
关于php支持分块与断点续传文件下载功能代码
2014/05/09 PHP
php中curl、fsocket、file_get_content三个函数的使用比较
2014/05/09 PHP
PHP实现登录注册之BootStrap表单功能
2017/09/03 PHP
基于jquery的让页面控件不可用的实现代码
2010/04/27 Javascript
利用jQuery实现可输入搜索文字的下拉框
2013/10/23 Javascript
JS按回车键实现登录的方法
2014/08/25 Javascript
Javascript中的匿名函数与封装介绍
2015/03/15 Javascript
Bootstrap模态框禁用空白处点击关闭
2016/10/20 Javascript
Bootstrap栅格系统使用方法及页面调整变形的解决方法
2017/03/10 Javascript
Angular组件化管理实现方法分析
2017/03/17 Javascript
JavaScript设置名字输入不合法的实现方法
2017/05/23 Javascript
vue封装第三方插件并发布到npm的方法
2017/09/25 Javascript
jQuery中常用动画效果函数知识点整理
2018/08/19 jQuery
vue实现动态列表点击各行换色的方法
2018/09/13 Javascript
浅谈vue同一页面中拥有两个表单时,的验证问题
2018/09/18 Javascript
微信小程序整合使用富文本编辑器的方法详解
2019/04/25 Javascript
基于Layui自定义模块的使用方法详解
2019/09/14 Javascript
[00:59]DOTA2英雄背景故事——上古巨神
2020/06/28 DOTA
在Python中marshal对象序列化的相关知识
2015/07/01 Python
python删除列表内容
2015/08/04 Python
详解Python 正则表达式模块
2018/11/05 Python
centos6.5安装python3.7.1之后无法使用pip的解决方案
2019/02/14 Python
3种python调用其他脚本的方法
2020/01/06 Python
python3将变量写入SQL语句的实现方式
2020/03/02 Python
关于Django Models CharField 参数说明
2020/03/31 Python
Python word文本自动化操作实现方法解析
2020/11/05 Python
Python爬虫设置Cookie解决网站拦截并爬取蚂蚁短租的问题
2021/02/22 Python
中国跨镜手机配件批发在线商店:TVC-Mall
2019/08/20 全球购物
静态变量和实例变量的区别
2015/07/07 面试题
2014年会演讲稿范文
2014/01/06 职场文书
2014年医院后勤工作总结
2014/12/06 职场文书
学生会任命书范本
2015/09/21 职场文书
检讨书范文
2019/04/16 职场文书
看完这篇文章获得一些java if优化技巧
2021/07/15 Java/Android