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实现的一只从百度开始不断搜索的小爬虫
Aug 13 Python
videocapture库制作python视频高速传输程序
Dec 23 Python
python实现电子词典
Apr 23 Python
Python3实现获取图片文字里中文的方法分析
Dec 13 Python
10 分钟快速入门 Python3的教程
Jan 29 Python
Pyinstaller 打包exe教程及问题解决
Aug 16 Python
python 循环数据赋值实例
Dec 02 Python
DRF框架API版本管理实现方法解析
Aug 21 Python
浅析python 字典嵌套
Sep 29 Python
python读取pdf格式文档的实现代码
Apr 01 Python
Python爬取英雄联盟MSI直播间弹幕并生成词云图
Jun 01 Python
python基础之类方法和静态方法
Oct 24 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学习 变量使用总结
2011/03/24 PHP
用Json实现PHP与JavaScript间数据交换的方法详解
2013/06/20 PHP
php读取远程gzip压缩网页的方法
2014/12/29 PHP
通过php删除xml文档内容的方法
2015/01/23 PHP
详解PHP执行定时任务的实现思路
2015/12/21 PHP
实例分析基于PHP微信网页获取用户信息
2017/11/24 PHP
PHP autoload使用方法及步骤详解
2020/09/05 PHP
javascript 面向对象全新理练之原型继承
2009/12/03 Javascript
JSDoc 介绍使用规范JsDoc的使用介绍
2011/02/12 Javascript
jq选项卡鼠标延迟的插件实例
2013/05/13 Javascript
JS实现的省份级联实例代码
2013/06/24 Javascript
通过length属性判断jquery对象是否存在
2013/10/18 Javascript
js定时器的使用(实例讲解)
2014/01/06 Javascript
js的隐含参数(arguments,callee,caller)使用方法
2014/01/28 Javascript
js图片自动轮播代码分享(js图片轮播)
2014/05/06 Javascript
jquery实用技巧之输入框提示语句
2016/07/28 Javascript
关于Jquery中的事件绑定总结
2016/10/26 Javascript
easyui combobox开启搜索自动完成功能的实例代码
2016/11/08 Javascript
js 原型对象和原型链理解
2017/02/09 Javascript
使用JavaScript实现在页面中显示距离2017年中秋节的天数
2017/09/26 Javascript
详解vue中async-await的使用误区
2018/12/05 Javascript
JavaScript本地储存:localStorage、sessionStorage、cookie的使用
2020/10/13 Javascript
[48:00]EG vs LGD 2018国际邀请赛淘汰赛BO3 第二场 8.26
2018/08/29 DOTA
python中requests模块的使用方法
2015/04/08 Python
Python中getattr函数和hasattr函数作用详解
2016/06/14 Python
python用装饰器自动注册Tornado路由详解
2017/02/14 Python
tf.truncated_normal与tf.random_normal的详细用法
2018/03/05 Python
python 已知平行四边形三个点,求第四个点的案例
2020/04/12 Python
微软俄罗斯官方网站:Microsoft俄罗斯
2016/09/18 全球购物
英国音乐设备和乐器商店:Gear4music
2017/10/16 全球购物
外企求职信范文分享
2013/12/31 职场文书
初中物理教学反思
2014/01/14 职场文书
通信研究生自荐信
2014/02/01 职场文书
自我管理的活动方案
2014/08/25 职场文书
群众路线教育实践活动心得体会(教师)
2014/10/31 职场文书
vue组件冲突之引用另一个组件出现组件不显示的问题
2022/04/13 Vue.js