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 相关文章推荐
Windows下Python使用Pandas模块操作Excel文件的教程
May 31 Python
基于Python中numpy数组的合并实例讲解
Apr 04 Python
python计算列表内各元素的个数实例
Jun 29 Python
Python使用sort和class实现的多级排序功能示例
Aug 15 Python
Python通用循环的构造方法实例分析
Dec 19 Python
对Python w和w+权限的区别详解
Jan 23 Python
使用pytorch完成kaggle猫狗图像识别方式
Jan 10 Python
python+gdal+遥感图像拼接(mosaic)的实例
Mar 10 Python
python如何爬取动态网站
Sep 09 Python
自己搭建resnet18网络并加载torchvision自带权重的操作
May 13 Python
Python 机器学习工具包SKlearn的安装与使用
May 14 Python
Python激活Anaconda环境变量的详细步骤
Jun 08 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 max_execution_time执行时间问题
2011/07/17 PHP
php类的扩展和继承用法实例
2015/06/20 PHP
PHP版本常用的排序算法汇总
2015/12/20 PHP
laravel5.2实现区分前后台用户登录的方法
2017/01/11 PHP
PHP接入支付宝接口失效流程详解
2020/11/10 PHP
如何重写Laravel异常处理类详解
2020/12/20 PHP
找到了一篇jQuery与Prototype并存的冲突的解决方法
2007/08/29 Javascript
json简单介绍
2008/06/10 Javascript
jQuery插件开发的两种方法及$.fn.extend的详解
2014/01/16 Javascript
Javascript 中创建自定义对象的方法汇总
2014/12/04 Javascript
JavaScript动态修改背景颜色的方法
2015/04/16 Javascript
详解vue渲染函数render的使用
2017/12/12 Javascript
jQuery实现的简单对话框拖动功能示例
2018/06/05 jQuery
Vue.js watch监视属性知识点总结
2019/11/11 Javascript
python写的ARP攻击代码实例
2014/06/04 Python
Mac下Supervisor进程监控管理工具的安装与配置
2014/12/16 Python
Python中使用partial改变方法默认参数实例
2015/04/28 Python
在python环境下运用kafka对数据进行实时传输的方法
2018/12/27 Python
python执行精确的小数计算方法
2019/01/21 Python
使用python3批量下载rbsp数据的示例代码
2019/12/20 Python
Python数据库封装实现代码示例解析
2020/09/05 Python
纯css实现照片墙3D效果的示例代码
2017/11/13 HTML / CSS
雅诗兰黛旗下走天然植物路线的彩妆品牌:Prescriptives
2016/08/14 全球购物
波兰最大的度假胜地和城市公寓租赁运营商:Sun & Snow
2018/10/18 全球购物
size?丹麦官网:英国伦敦的球鞋精品店
2019/04/15 全球购物
求职信格式范本
2013/11/15 职场文书
药品采购员岗位职责
2014/02/08 职场文书
联谊会主持词
2014/03/26 职场文书
四风问题民主生活会对照检查材料思想汇报
2014/09/27 职场文书
中学生检讨书范文
2014/11/03 职场文书
劳动仲裁代理词范文
2015/05/25 职场文书
教师个人工作总结范文2015
2015/10/14 职场文书
创业计划书之个人工作室
2019/08/22 职场文书
利用前端HTML+CSS+JS开发简单的TODOLIST功能(记事本)
2021/04/13 Javascript
Android 中的类文件和类加载器详情
2022/06/05 Java/Android
Spring Cloud OpenFeign模版化客户端
2022/06/25 Java/Android