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 相关文章推荐
30分钟搭建Python的Flask框架并在上面编写第一个应用
Mar 30 Python
Python实现统计英文单词个数及字符串分割代码
May 28 Python
python2.7读取文件夹下所有文件名称及内容的方法
Feb 24 Python
用TensorFlow实现多类支持向量机的示例代码
Apr 28 Python
Selenium(Python web测试工具)基本用法详解
Aug 10 Python
Python 中导入csv数据的三种方法
Nov 01 Python
解决项目pycharm能运行,在终端却无法运行的问题
Jan 19 Python
Python猜数字算法题详解
Mar 01 Python
python GUI库图形界面开发之PyQt5不规则窗口实现与显示GIF动画的详细方法与实例
Mar 09 Python
Pycharm如何自动生成头文件注释
Nov 14 Python
看看如何用Python绘制小米新版天价logo
Apr 20 Python
Python使用MapReduce进行简单的销售统计
Apr 22 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脚本的10个技巧(8)
2006/10/09 PHP
php+ajax实时刷新简单实例
2015/02/25 PHP
PHP超全局数组(Superglobals)介绍
2015/07/01 PHP
浅谈PHP eval()函数定义和用法
2016/06/21 PHP
php微信开发之关注事件
2018/06/14 PHP
我也种棵OO树JXTree[js+css+xml]
2007/04/02 Javascript
IE与FireFox的兼容性问题分析
2007/04/22 Javascript
Extjs中ComboBoxTree实现的下拉框树效果(自写)
2013/05/28 Javascript
固定表格行列(expression)在IE下适用
2013/07/25 Javascript
关于JavaScript的变量的数据类型的判断方法
2015/08/14 Javascript
jQuery自定义元素右键点击事件(实现案例)
2017/04/28 jQuery
浅谈开发eslint规则
2018/10/01 Javascript
微信小程序实现打卡日历功能
2020/09/21 Javascript
js实现图片局部放大效果详解
2019/03/18 Javascript
小程序如何使用分包加载的实现方法
2019/05/22 Javascript
微信小程序中使用 async/await的方法实例分析
2020/05/06 Javascript
Vue scoped及deep使用方法解析
2020/08/01 Javascript
[01:10]为家乡而战!完美世界城市挑战赛全国总决赛花絮
2019/07/25 DOTA
Django与JS交互的示例代码
2017/08/23 Python
django+echart数据动态显示的例子
2019/08/12 Python
Python配置文件处理的方法教程
2019/08/29 Python
pytorch 准备、训练和测试自己的图片数据的方法
2020/01/10 Python
python matplotlib imshow热图坐标替换/映射实例
2020/03/14 Python
Python的Django框架实现数据库查询(不返回QuerySet的方法)
2020/05/19 Python
List、Map、Set三个接口,存取元素时,各有什么特点?
2015/09/27 面试题
软件测试英文面试题
2012/10/14 面试题
采购主管的岗位职责
2013/12/17 职场文书
公司培训心得体会
2014/01/03 职场文书
党员干部反四风民主生活会对照检查材料思想汇报
2014/10/12 职场文书
公司行政主管岗位职责
2015/04/09 职场文书
总经理司机岗位职责
2015/04/10 职场文书
公司市场部岗位职责
2015/04/15 职场文书
浅谈Python从全局与局部变量到装饰器的相关知识
2021/06/21 Python
浅谈mysql增加索引不生效的几种情况
2021/06/23 MySQL
nginx请求限制配置方法
2021/07/09 Servers
opencv用VS2013调试时用Image Watch插件查看图片
2021/07/26 Python