python 上下文管理器使用方法小结


Posted in Python onOctober 10, 2017

上下文管理器最常用的是确保正确关闭文件,

with open('/path/to/file', 'r') as f:
 f.read()

with 语句的基本语法,

with expression [as variable]:

  with-block

expression是一个上下文管理器,其实现了enter和exit两个函数。当我们调用一个with语句时, 依次执行一下步骤,

1.首先生成一个上下文管理器expression, 比如open('xx.txt').
2.执行expression.enter()。如果指定了[as variable]说明符,将enter()的返回值赋给variable.
3.执行with-block语句块.
4.执行expression.exit(),在exit()函数中可以进行资源清理工作.

with语句不仅可以管理文件,还可以管理锁、连接等等,如,

#管理锁
import threading
lock = threading.lock()
with lock:
 #执行一些操作
 pass

#数据库连接管理
def test_write():
 sql = """  #具体的sql语句
 """
 con = DBConnection()
 with con as cursor: 
  cursor.execute(sql)
  cursor.execute(sql)
  cursor.execute(sql)

自定义上下文管理器

上下文管理器就是实现了上下文协议的类 ,也就是要实现 __enter__()和__exit__()两个方法。

__enter__():主要执行一些环境准备工作,同时返回一资源对象。如果上下文管理器open("test.txt")的enter()函数返回一个文件对象。
__exit__():完整形式为exit(type, value, traceback),这三个参数和调用sys.exec_info()函数返回值是一样的,分别为异常类型、异常信息和堆栈。如果执行体语句没有引发异常,则这三个参数均被设为None。否则,它们将包含上下文的异常信息。_exit()方法返回True或False,分别指示被引发的异常有没有被处理,如果返回False,引发的异常将会被传递出上下文。如果exit()函数内部引发了异常,则会覆盖掉执行体的中引发的异常。处理异常时,不需要重新抛出异常,只需要返回False,with语句会检测exit()返回False来处理异常。

class test_query:
  def __init__(self):
    pass

  def query(self):
    print('query')

  def __enter__(self):
    # 如果是数据库连接就可以返回cursor对象
    # cursor = self.cursor
    # return cursor
    print('begin query,')
    return self #由于这里没有资源对象就返回对象
    
  def __exit__(self,exc_type,exc_value,traceback):
    if traceback is None:
      print('End')
    else:
      print('Error')

    # 如果是数据库连接提交操作
    # if traceback is None:
    #  self.commit()
    # else:
    #  self.rollback()
    
if __name__ == '__main__':
  with test_query() as q:
    q.query()

contextlib

编写enter和exit仍然很繁琐,因此Python的标准库contextlib提供了更简单的写法,

基本语法

@contextmanager
    def some_generator(<arguments>):
      <setup>
      try:
        yield <value>
      finally:
        <cleanup>

生成器函数some_generator就和我们普通的函数一样,它的原理如下:
some_generator函数在在yield之前的代码等同于上下文管理器中的enter函数.
yield的返回值等同于enter函数的返回值,即如果with语句声明了as <variable>,则yield的值会赋给variable.
然后执行<cleanup>代码块,等同于上下文管理器的exit函数。此时发生的任何异常都会再次通过yield函数返回。
例,
自动加括号

import contextlib

@contextlib.contextmanager
def tag(name):
  print('<{}>'.format(name))
  yield
  print('</{}>'.format(name))


if __name__ == '__main__':
  with tag('h1') as t:
    print('hello')
    print('context')

管理锁

@contextmanager
def locked(lock):
  lock.acquire()
  try:
    yield
  finally:
    lock.release()

with locked(myLock):
  #代码执行到这里时,myLock已经自动上锁
  pass
  #执行完后会,会自动释放锁

管理文件关闭

@contextmanager
def myopen(filename, mode="r"):
  f = open(filename,mode)
  try:
    yield f
  finally:
    f.close()

with myopen("test.txt") as f:
  for line in f:
    print(line)

管理数据库回滚

@contextmanager
def transaction(db):
  db.begin()
  try:
    yield 
  except:
    db.rollback()
    raise
  else:
    db.commit()

with transaction(mydb):
  mydb.cursor.execute(sql)
  mydb.cursor.execute(sql)
  mydb.cursor.execute(sql)
  mydb.cursor.execute(sql)

这就很方便!
如果一个对象没有实现上下文,我们就不能把它用于with语句。这个时候,可以用closing()来把该对象变为上下文对象。它的exit函数仅仅调用传入参数的close函数.
例如,用with语句使用urlopen():

import contextlib
from urllib.request import urlopen

if __name__ == '__main__':
  with contextlib.closing(urlopen('https://www.python.org')) as page:
    for line in page:
      print(line)
closing也是一个经过@contextmanager装饰的generator,这个generator编写起来其实非常简单:

@contextmanager
def closing(thing):
  try:
    yield thing
  finally:
    thing.close()

嵌套使用

import contextlib
from urllib.request import urlopen

if __name__ == '__main__':
  with contextlib.closing(urlopen('https://www.python.org')) as page,\
      contextlib.closing(urlopen('https://www.python.org')) as p:
    for line in page:
      print(line)
        print(p)

在2.x中需要使用contextlib.nested()才能使用嵌套,3.x中可以直接使用。

更多函数可以参考官方文档https://docs.python.org/3/library/contextlib.html

Python 相关文章推荐
python基础教程之字典操作详解
Mar 25 Python
python错误:AttributeError: 'module' object has no attribute 'setdefaultencoding'问题的解决方法
Aug 22 Python
理解生产者消费者模型及在Python编程中的运用实例
Jun 26 Python
python 中的list和array的不同之处及转换问题
Mar 13 Python
Python设计模式之命令模式原理与用法实例分析
Jan 11 Python
详解python爬虫系列之初识爬虫
Apr 06 Python
详解Python并发编程之从性能角度来初探并发编程
Aug 23 Python
Django Docker容器化部署之Django-Docker本地部署
Oct 09 Python
django formset实现数据表的批量操作的示例代码
Dec 06 Python
关于python tushare Tkinter构建的简单股票可视化查询系统(Beta v0.13)
Oct 19 Python
Pytorch实验常用代码段汇总
Nov 19 Python
python运行脚本文件的三种方法实例
Jun 25 Python
python中如何使用正则表达式的集合字符示例
Oct 09 #Python
python中如何使用正则表达式的非贪婪模式示例
Oct 09 #Python
Python 多进程和数据传递的理解
Oct 09 #Python
Python 加密的实例详解
Oct 09 #Python
Python 3实战爬虫之爬取京东图书的图片详解
Oct 09 #Python
Python3实战之爬虫抓取网易云音乐的热门评论
Oct 09 #Python
Python读取文件内容的三种常用方式及效率比较
Oct 07 #Python
You might like
PHP小程序自动提交到自助友情连接
2009/11/24 PHP
PHP中数据类型转换的三种方式
2015/04/02 PHP
PHP7标量类型declare用法实例分析
2016/09/26 PHP
PHP 网站修改默认访问文件的nginx配置
2017/05/27 PHP
thinkphp分页集成实例
2017/07/24 PHP
Gird事件机制初级读本
2007/03/10 Javascript
JQuery为textarea添加maxlength属性的代码
2010/04/07 Javascript
javascript实现简单的二级联动
2015/03/19 Javascript
jquery实现的横向二级导航效果代码
2015/08/26 Javascript
Bootstrap源码解读标签、徽章、缩略图和警示框(8)
2016/12/26 Javascript
js+canvas实现动态吃豆人效果
2017/03/22 Javascript
浅谈在koa2中实现页面渲染的全局数据
2017/10/09 Javascript
jQuery实现碰到边缘反弹的动画效果
2018/02/24 jQuery
jQuery 操作 HTML 元素和属性的方法
2018/11/12 jQuery
Electron 如何调用本地模块的方法
2019/02/01 Javascript
element-ui table行点击获取行索引(index)并利用索引更换行顺序
2020/02/27 Javascript
javascript实现京东登录显示隐藏密码
2020/08/02 Javascript
[01:14]英雄,所敬略同——2018完美盛典宣传视频
2018/12/05 DOTA
Python的__builtin__模块中的一些要点知识
2015/05/02 Python
Python实现定时任务
2017/02/08 Python
Python实现OpenCV的安装与使用示例
2018/03/30 Python
python读取几个G的csv文件方法
2019/01/07 Python
使用CodeMirror实现Python3在线编辑器的示例代码
2019/01/14 Python
python SVD压缩图像的实现代码
2019/11/05 Python
django 扩展user用户字段inlines方式
2020/03/30 Python
Python实现简单猜数字游戏
2021/02/03 Python
Rowdy Gentleman服装和配饰:美好时光
2019/09/24 全球购物
理工科学生的自我评价
2013/12/15 职场文书
农林环境专业求职信
2014/03/13 职场文书
融资租赁计划书
2014/04/29 职场文书
经销商年会策划方案
2014/05/29 职场文书
市场营销专业求职信
2014/06/17 职场文书
大学生,三分钟即兴演讲稿
2019/07/22 职场文书
Html5新增了哪些功能
2021/04/16 HTML / CSS
Python Pandas pandas.read_sql_query函数实例用法分析
2021/06/21 Python
台式电脑蓝牙适配器怎么安装?台式电脑蓝牙适配器安装教程
2022/04/08 数码科技