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实现颜色rgb和hex相互转换的函数
Mar 19 Python
python3实现暴力穷举博客园密码
Jun 19 Python
Python的装饰器使用详解
Jun 26 Python
Python PyQt5实现的简易计算器功能示例
Aug 23 Python
Python编程给numpy矩阵添加一列方法示例
Dec 04 Python
python机器学习之神经网络(三)
Dec 20 Python
浅析Python数据处理
May 02 Python
基于python实现KNN分类算法
Apr 23 Python
Python with关键字,上下文管理器,@contextmanager文件操作示例
Oct 17 Python
python生成任意频率正弦波方式
Feb 25 Python
python GUI库图形界面开发之PyQt5信号与槽基础使用方法与实例
Mar 06 Python
python实现xml转json文件的示例代码
Dec 30 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
哪吒敖丙传:新人物二哥敖乙出场 小敖丙奶气十足
2020/03/08 国漫
有道搜索和IP138的IP的API接口(PHP应用)
2012/11/29 PHP
php传值赋值和传地址赋值用法实例分析
2015/06/20 PHP
php构造方法中析构方法在继承中的表现
2016/04/12 PHP
Laravel框架用户登陆身份验证实现方法详解
2017/09/14 PHP
php实现将数据做成json的格式给前端使用
2018/08/21 PHP
jquery教程ajax请求json数据示例
2014/01/13 Javascript
jquery如何根据值设置默认的选中项
2014/03/17 Javascript
js实现网页倒计时、网站已运行时间功能的代码3例
2014/04/14 Javascript
jQuery常用数据处理方法小结
2015/02/20 Javascript
深入浅析AngularJS和DataModel
2016/02/16 Javascript
利用Node.js对文件进行重命名
2017/03/12 Javascript
解决IE7中使用jQuery动态操作name问题
2017/08/28 jQuery
Angular中封装fancyBox(图片预览)遇到问题小结
2017/09/01 Javascript
使用jQuery 操作table 完成单元格合并的实例
2017/12/27 jQuery
基于mpvue的小程序项目搭建的步骤
2018/05/22 Javascript
详解Angular6学习笔记之主从组件
2018/09/05 Javascript
五分钟搞懂Vuex实用知识(小结)
2019/08/12 Javascript
如何基于layui的laytpl实现数据绑定的示例代码
2020/04/10 Javascript
vue实现点击按钮“查看详情”弹窗展示详情列表操作
2020/09/09 Javascript
跟老齐学Python之从if开始语句的征程
2014/09/14 Python
Python的Django框架中的数据库配置指南
2015/07/17 Python
JSONLINT:python的json数据验证库实例解析
2017/11/28 Python
Python通过属性手段实现只允许调用一次的示例讲解
2018/04/21 Python
python 查找文件名包含指定字符串的方法
2018/06/05 Python
如何使用Python实现自动化水军评论
2019/06/26 Python
django实现将后台model对象转换成json对象并传递给前端jquery
2020/03/16 Python
Python实现上下文管理器的方法
2020/08/07 Python
绝对令人的惊叹的CSS3折叠效果(3D效果)整理
2012/12/30 HTML / CSS
西班牙英格列斯百货英国官网:El Corte Inglés英国
2017/10/30 全球购物
信息与计算科学专业推荐信
2014/02/23 职场文书
建房协议书
2014/04/11 职场文书
网络技术专业求职信
2014/05/02 职场文书
机关搬迁方案
2014/05/18 职场文书
2014年教师批评与自我批评思想汇报
2014/09/20 职场文书
反邪教学习心得体会
2016/01/15 职场文书