详解python with 上下文管理器

作为一个 Java 为母语的程序员来讲，学习起其他新的语言就难免任何事都与 Java 进行横向对比。Java 7 引入了能省去许多重复代码的 try-with-resources 特性，不用每回 try/finally 来释放资源(不便之处有局部变量必须声明在 try 之前，finally 里还要嵌套 try/catch 来处理异常)。比如下面的 Java 代码

try(InputStream inputStream = new FileInputStream("abc.txt")) {
  System.out.println(inputStream.read());
} catch (Exception ex) {
}

它相应的不使用 try-with-resources 语法的代码就是

InputStream inputStream = null;
try {
  inputStream = new FileInputStream("abc.txt");
} catch (Exception ex) {
} finally {
  if(inputStream != null) {
    try {
      inputStream.close();
    } catch (Exception ex) {
    }
  }
}

类似的 Python 也有自己的 try-with-resources 写法，就是 with 关键字，它的概念叫做上下文管理器(Context Manager)。

with 关键字的使用

with open('some_file', 'w') as opened_file:
  opened_file.write('Hola!')

以上的代码相当于

opened_file = open('some_file', 'w')
try:
  opened_file.write('Hola!')
finally:
  opened_file.close()

也就是 with 关键字打开的资源会在 with 语句块结束后自动调用相应的方法自动释放(无论 with 中操作是否有异常)。

with 用起来是很方便的，但是什么样的资源可以用 with 关键字？Python 是怎么知道要调用哪个方法来关闭资源的？进而如何实现自己的支持上下文管理器的 Python 类。

再次回顾 Java 的 try-with-resources 语法，try(...) 括号支持的类必须是实现了 AutoCloseable 接口，它的接口方法是

public void close() throws IOException

也就是 Java 的 try-with-resources 语法会自动调用以上方法来释放资源，要实现可被自动释放的 Java 就只须遵照这一规则就行。

而在 Python 中，能被 with 的类有两种实现方式

实现基本方法以支持上下文管理器的类

一个 Python 类要能被用于 with 上下文，必须实现至少 __enter__ 和 __exit__ 方法。这两个方法的意思好理解，一个是创建资源后，后者是退出 with 语句块后。请看下面的例子

class File(object):
  def __init__(self, file_name, method):
    self.file_obj = open(file_name, method)

  def __enter__(self):
    print("---enter")
    return self.file_obj

  def __exit__(self, type, value, traceback):
    print("---exit")
    self.file_obj.close()

with File('data.txt', 'r') as data_file:
  print(data_file.read())

假设 data.txt 文件中的内容是

hello
world

那么以上程序执行后的输出就是

--enter
hello
world
---exit

  1. __enter__ 返回的值作为 with ... as data_file 中的 data_file 变量的值，如果 __enter__ 没有返回，data_file 得到的就是 NoneType object 了。
  2. __exit__ 可利用来释放资源
  3. 没有 __enter__ 方法试图用 with 的写法执行时会得到 AttributeErro: __enter__ 异常
  4. 同样，没有 __exit__ 方法试图用 with 的写法执行时会得到 AttributeErro: __exit__ 异常
  5. __exit__ 有其他额外的三个参数，可获得资源的值，以及能处理 with 块中执行出现异常的情况
  6. __exit__ 的返回值也有用途，如果它返回 True 则出现的异常不再向外传播，其他值的话直接向外抛

利用生成器(Generator) 和装饰器创建支持上下文管理器的方法

此种方式比较简单，不过逻辑控制上没有这么强。

from contextlib import contextmanager

@contextmanager
def open_file(name, method):
  f = open(name, method)
  yield f
  f.close()

使用 f 的执行代码将被放置在 yield f 所处的位置，with 使用以上方法。yield 后的 f 变量将是 with...as 后的变量值

with open_file('some_file', 'w') as file_object:
  file_object.write('hola!')

这里也要注意异常处理的情况，比如把上面代码打开文件的模式换作 r, 仍然试图去写文件，这样在 open_file 方法的 yield f 位置将产生异常，会造成 f.close() 得不到执行，不能正确释放该资源。

欲更具防御性，前面的 yield f 可以扩展也如下的形式

try:
  yield f
except Exception as ex:
  pass #处理异常，或继续向外抛
finally:
  f.close()

@contextmanager 装饰器内部也是封装为一个实现了 __enter__ 和 __exit__ 方法的对象。

参考链接：Context Managers

以上就是详解python with 上下文管理器的详细内容，更多关于python with 上下文管理器的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • python中with语句结合上下文管理器操作详解

    前言 所谓上下文管理器即在一个类中重写了__enter__方法和__exit__方法的类就可以成为上下文管理器类. 我们可以通过with语句结合上下文管理器简化一些操作. 使用with语句结合自定义上下文管理器完成数据库相应的操作,代码实现如下: # 1. 导入模块 import pymysql # 创建自定义上下文管理器对象 class MyDatabase(object): # 接收参数并创建数据库连接对象 def __init__(self, host, port, user, passw

  • Python上下文管理器和with块详解

    上下文管理器和with块,具体内容如下 上下文管理器对象存在的目的是管理 with 语句,就像迭代器的存在是为了管理 for 语句一样. with 语句的目的是简化 try/finally 模式.这种模式用于保证一段代码运行完毕后执行某项操作,即便那段代码由于异常. return 语句或 sys.exit() 调用而中止,也会执行指定的操作. finally 子句中的代码通常用于释放重要的资源,或者还原临时变更的状态. ==上下文管理器协议包含enter和exit两个方法==. with 语句开

  • Python中的with语句与上下文管理器学习总结

    0.关于上下文管理器 上下文管理器是可以在with语句中使用,拥有__enter__和__exit__方法的对象. with manager as var: do_something(var) 相当于以下情况的简化: var = manager.__enter__() try: do_something(var) finally: manager.__exit__() 换言之,PEP 343中定义的上下文管理器协议允许将无聊的try...except...finally结构抽象到一个单独的类中,

  • Python with语句上下文管理器两种实现方法分析

    本文实例讲述了Python with语句上下文管理器.分享给大家供大家参考,具体如下: 在编程中会经常碰到这种情况:有一个特殊的语句块,在执行这个语句块之前需要先执行一些准备动作:当语句块执行完成后,需要继续执行一些收尾动作.例如,文件读写后需要关闭,数据库读写完毕需要关闭连接,资源的加锁和解锁等情况. 对于这种情况python提供了上下文管理器(Context Manager)的概念,可以通过上下文管理器来定义/控制代码块执行前的准备动作,以及执行后的收尾动作. 一.为何使用上下文管理器 1.

  • Python中的上下文管理器和with语句的使用

    Python2.5之后引入了上下文管理器(context manager),算是Python的黑魔法之一,它用于规定某个对象的使用范围.本文是针对于该功能的思考总结. 为什么需要上下文管理器? 首先,需要思索下为什么需要引入上下文管理器. 在正常情况下,管理各种系统资源(如文件).数据库连接时,通常是先打开这些资源,执行完相应的业务逻辑,最后关闭资源. 举两个例子: 1.使用Python打开一个文件写入内容,之后需要关闭这个文件.如果不正常关闭的话可能会在文件操作时出现异常,因为系统允许你打开的

  • Python with关键字，上下文管理器，@contextmanager文件操作示例

    本文实例讲述了Python with关键字,上下文管理器,@contextmanager文件操作.分享给大家供大家参考,具体如下: demo.py(with 打开文件): # open 方法的返回值赋值给变量 f,当离开 with 代码块的时候,系统会自动调用 f.close() 方法 # with 的作用和使用 try/finally 语句是一样的. with open("output.txt", "r") as f: f.write("XXXXX&qu

  • 正确理解python中的关键字“with”与上下文管理器

    前言 如果你有阅读源码的习惯,可能会看到一些优秀的代码经常出现带有 "with" 关键字的语句,它通常用在什么场景呢?今天就来说说 with 和 上下文管理器. 对于系统资源如文件.数据库连接.socket 而言,应用程序打开这些资源并执行完业务逻辑之后,必须做的一件事就是要关闭(断开)该资源. 比如 Python 程序打开一个文件,往文件中写内容,写完之后,就要关闭该文件,否则会出现什么情况呢?极端情况下会出现 "Too many open files" 的错误,

  • 详解python with 上下文管理器

    作为一个 Java 为母语的程序员来讲,学习起其他新的语言就难免任何事都与 Java 进行横向对比.Java 7 引入了能省去许多重复代码的 try-with-resources 特性,不用每回 try/finally 来释放资源(不便之处有局部变量必须声明在 try 之前,finally 里还要嵌套 try/catch 来处理异常).比如下面的 Java 代码 try(InputStream inputStream = new FileInputStream("abc.txt"))

  • Python实现上下文管理器的方法

    问题 你想自己去实现一个新的上下文管理器,以便使用with语句. 解决方案 实现一个新的上下文管理器的最简单的方法就是使用 contexlib 模块中的 @contextmanager 装饰器. 下面是一个实现了代码块计时功能的上下文管理器例子: import time from contextlib import contextmanager @contextmanager def timethis(label): start = time.time() try: yield finally:

  • 详解Python中的装饰器、闭包和functools的教程

    装饰器(Decorators) 装饰器是这样一种设计模式:如果一个类希望添加其他类的一些功能,而不希望通过继承或是直接修改源代码实现,那么可以使用装饰器模式.简单来说Python中的装饰器就是指某些函数或其他可调用对象,以函数或类作为可选输入参数,然后返回函数或类的形式.通过这个在Python2.6版本中被新加入的特性可以用来实现装饰器设计模式. 顺便提一句,在继续阅读之前,如果你对Python中的闭包(Closure)概念不清楚,请查看本文结尾后的附录,如果没有闭包的相关概念,很难恰当的理解P

  • 详解python中的装饰器

    在了解装饰器之前,我们需要知道什么闭包是什么鬼! 闭包:在一个函数内定义了一个函数f,并且这个函数f引用外部变量,在把这个函数f当做返回值返回. 上述说了闭包的三个条件: 1 函数内定义了一个函数f 2 f函数引用了外部变量 3 f被当做返回值返回 def t1():#定义t1函数 x=2 def f():#t1函数内部定义了f函数 print(x)#f函数引用了不属于自己内部的变量x return f #f被当做返回值返回 而装饰器有是什么鬼呢?其实闭包的一种运用. 装饰器:在不改变函数(当然

  • 详解Python GUI工具取色器

    详解Python GUI工具取色器

    Python 提供了多个图形开发界面的库,几个常用 Python GUI 库如下: Tkinter: Tkinter 模块(Tk 接口)是 Python 的标准 Tk GUI 工具包的接口 .Tk 和 Tkinter 可以在大多数的 Unix 平台下使用,同样可以应用在 Windows 和 Macintosh 系统里.Tk8.0 的后续版本可以实现本地窗口风格,并良好地运行在绝大多数平台中. wxPython:wxPython 是一款开源软件,是 Python 语言的一套优秀的 GUI 图形库,

  • 详解利用上下文管理器扩展Python计时器

    目录 一个 Python 定时器上下文管理器 了解 Python 中的上下文管理器 理解并使用 contextlib 创建 Python 计时器上下文管理器 使用 Python 定时器上下文管理器 写在最后 上文中,我们一起学习了手把手教你实现一个 Python 计时器.本文中,云朵君将和大家一起了解什么是上下文管理器 和 Python 的 with 语句,以及如何完成自定义.然后扩展 Timer 以便它也可以用作上下文管理器.最后,使用 Timer 作为上下文管理器如何简化我们自己的代码. 上

  • 深入学习Python中的上下文管理器与else块

    前言 本文主要个大家介绍了关于Python上下文管理器与else块的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧. 在开始之前,我们先来看看下面这段话: 最终,上下文管理器可能几乎与子程序(subroutine)本身一样重要.目前,我们只了解了上下文管理器的皮毛--Basic 语言有with 语句,而且很多语言都有.但是,在各种语言中 with 语句的作用不同,而且做的都是简单的事,虽然可以避免不断使用点号查找属性,但是不会做事前准备和事后清理.不要觉得名字一样,就意

  • Python中的上下文管理器相关知识详解

    Python中的上下文管理器相关知识详解

    前言 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. 上下文管理器:o

  • Python上下文管理器全实例详解

    Python上下文管理器 简介 最近用到这个,仔细了解了一下,感觉是十分有用的,记录一下 使用场景 当我们需要获取一个临时打开的资源,并在使用完毕后进行资源释放和异常处理,利用try-catch语句可以完成,举个例子. 打开文件: f = None try: print("try") f = open("__init__.py", "r") print(f.read()) except Exception as e: print("ex

随机推荐