python 上下文管理器

今天药忘吃喽~ 2022-06-07 09:08 305阅读 0赞

1.上下文管理器(Context managers)

上下文管理器允许你在有需要的时候，精确地分配和释放资源。

使用上下文管理器最广泛的案例就是with语句了。
想象下你有两个需要结对执行的相关操作，然后还要在它们中间放置一段代码。
上下文管理器就是专门让你做这种事情的。举个例子：

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

上面这段代码打开了一个文件，往里面写入了一些数据，然后关闭该文件。如果在往文件写数据时发生异常，它也会尝试去关闭文件。上面那段代码与这一段是等价的：

  1. file = open('some_file', 'w')
  2. try:
  3.     file.write('Hola!')
  4. finally:
  5.     file.close()

当与第一个例子对比时，我们可以看到，通过使用with，许多样板代码(boilerplate code)被消掉了。 这就是with语句的主要优势，它确保我们的文件会被关闭，而不用关注嵌套代码如何退出。

上下文管理器的一个常见用例，是资源的加锁和解锁，以及关闭已打开的文件（就像我已经展示给你看的）。

让我们看看如何来实现我们自己的上下文管理器。这会让我们更完全地理解在这些场景背后都发生着什么。

2.基于类的实现

一个上下文管理器的类，最起码要定义__enter__和__exit__方法。
让我们来构造我们自己的开启文件的上下文管理器，并学习下基础知识。

  1. class File(object):
  2.     def __init__(self, file_name, method):
  3.         self.file_obj = open(file_name, method)
  4.     def __enter__(self):
  5.         return self.file_obj
  6.     def __exit__(self, type, value, traceback):
  7.         self.file_obj.close()

通过定义__enter__和__exit__方法，我们可以在with语句里使用它。我们来试试：

  1. with File('demo.txt', 'w') as opened_file:
  2.     opened_file.write('Hola!')

我们的__exit__函数接受三个参数。这些参数对于每个上下文管理器类中的__exit__方法都是必须的。我们来谈谈在底层都发生了什么。

  1. with语句先暂存了File类的__exit__方法
  2. 然后它调用File类的__enter__方法
  3. __enter__方法打开文件并返回给with语句
  4. 打开的文件句柄被传递给opened_file参数
  5. 我们使用.write()来写文件
  6. with语句调用之前暂存的__exit__方法
  7. __exit__方法关闭了文件

3.处理异常

接下来我们来看看__exit__方法的这三个参数：type, value和traceback。
在第4步和第6步之间，如果发生异常，Python会将异常的type,value和traceback传递给__exit__方法。
它让__exit__方法来决定如何关闭文件以及是否需要其他步骤。在我们的案例中，我们并没有注意它们。

那如果我们的文件对象抛出一个异常呢？万一我们尝试访问文件对象的一个不支持的方法。举个例子：

  1. with File('demo.txt', 'w') as opened_file:
  2.     opened_file.undefined_function('Hola!')

我们来列一下，当异常发生时，with语句会采取哪些步骤。

  1. 它把异常的type,value和traceback传递给__exit__方法

  2. 它让__exit__方法来处理异常

  3. 如果__exit__返回的是True，那么这个异常就被优雅地处理了。

  4. 如果__exit__返回的是True以外的任何东西，那么这个异常将被with语句抛出。

在我们的案例中，__exit__方法返回的是None(如果没有return语句那么方法会返回None)。因此，with语句抛出了那个异常。

  1. Traceback (most recent call last):
  2.   File "<stdin>", line 2, in <module>
  3. AttributeError: 'file' object has no attribute 'undefined_function'

我们尝试下在__exit__方法中处理异常：

  1. class File(object):
  2.     def __init__(self, file_name, method):
  3.         self.file_obj = open(file_name, method)
  4.     def __enter__(self):
  5.         return self.file_obj
  6.     def __exit__(self, type, value, traceback):
  7.         print("Exception has been handled")
  8.         self.file_obj.close()
  9.         return True
  11. with File('demo.txt', 'w') as opened_file:
  12.     opened_file.undefined_function()
  14. # Output: Exception has been handled

我们的__exit__方法返回了True,因此没有异常会被with语句抛出。

这还不是实现上下文管理器的唯一方式。还有一种方式是基于生成器。

4.基于生成器的实现

我们还可以用装饰器(decorators)和生成器(generators)来实现上下文管理器。
Python有个contextlib模块专门用于这个目的。我们可以使用一个生成器函数来实现一个上下文管理器，而不是使用一个类。
让我们看看一个基本的，没用的例子：

  1. from contextlib import contextmanager
  3. @contextmanager
  4. def open_file(name):
  5.     f = open(name, 'w')
  6.     yield f
  7.     f.close()

OK啦！这个实现方式看起来更加直观和简单。然而，这个方法需要关于生成器、yield和装饰器的一些知识。在这个例子中我们还没有捕捉可能产生的任何异常。它的工作方式和之前的方法大致相同。

让我们小小地剖析下这个方法。

  1. Python解释器遇到了yield关键字。因为这个缘故它创建了一个生成器而不是一个普通的函数。

  2. 因为这个装饰器，contextmanager会被调用并传入函数名（open_file）作为参数。

  3. contextmanager函数返回一个以GeneratorContextManager对象封装过的生成器。

  4. 这个GeneratorContextManager被赋值给open_file函数，我们实际上是在调用GeneratorContextManager对象。

那现在我们既然知道了所有这些，我们可以用这个新生成的上下文管理器了，像这样：

  1. with open_file('some_file') as f:
  2.     f.write('hola!')

发表评论

表情：
评论列表 （有 0 条评论，305人围观）

还没有评论，来说两句吧...

相关阅读

    相关 Python上下文管理器

    1. 上下文管理器 一个类只要实现了 `__enter__()` 和 `__exit__()` 这个两个方法，通过该类创建的对象我们就称之为上下文管理器。 上下文管理器

    悠悠悠悠/ 0 赞/ 256 阅读

    相关 python的上下文管理器

    上下文管理器允许你在有需要的时候，精确地分配和释放资源。 使用上下文管理器最广泛的案例就是`with`语句了。 想象下你有两个需要结对执行的相关操作，然后还要在它们中间放

    た 入场券た 入场券/ 0 赞/ 304 阅读

    相关 Python深入 上下文管理器

    上下文管理器(context manager)是Python2.5开始支持的一种语法，用于规定某个对象的使用范围。一旦进入或者离开该使用范围，会有特殊操作被调用 (比如为对象分

    傷城~傷城~/ 0 赞/ 429 阅读