Python上下文管理器with块及@contextmanager的使用

 更新时间:2026年04月08日 09:13:22   作者:掐死你滴温柔  
本文主要介绍了上下文管理器和with块的知识,包括上下文管理器的作用、接口以及__enter__和__exit__方法的用法,同时,还介绍了@contextmanager的用法,它可以简化上下文管理器的创建过程

上下文管理器和with块

上下文管理器对象存在的目的是为了管理with块,就像迭代器的存在是为了管理for循环一样

with 语句存在的意义是对一些常用的 try/finally 结构予以简化。这种结构能够保障一段代码在运行完成后实施某项操作,就算该段代码因为 return 语句、异常或者 sys.exit() 调用而停止,也依旧执行指定的操作。finally 子句中的代码往往用于释放重要的资源,亦或是还原临时变动的状态。

上下文管理器接口包含了__enter__以及__exit__这两个方法。当 with 语句开始执行的时候,Python 会在上下文管理器对象上启用__enter__方法。待 with 块运行完毕,或者因某些缘由终止之后,Python 会在上下文管理器对象上调用__exit__方法。

  • __enter()__方法:当进入 with 语句时,__enter__() 方法会被调用。该方法通常用于执行一些准备工作,并返回一个资源对象,这个对象会被绑定到 as 后的变量名上。
  • __exit()__方法:当 with 语句块执行结束时,无论是否发生了异常,__exit__() 方法都会被调用。该方法通常用于执行一些清理操作,比如关闭文件、释放资源等。如果在 with 语句块中发生了异常,异常信息会作为参数传递给 __exit__() 方法。

下面是一个精心设计的上下文管理器执行操作案例

import sys


class LookingGlass:
    def __enter__(self):
        # 将原始的 sys.stdout.write 函数保存起来
        self.original_wirte = sys.stdout.write
        # 将 sys.stdout.write 函数替换为 reverse_write 方法
        sys.stdout.write = self.reverse_wirte
        # 返回一个字符串作为上下文管理器的上下文对象
        return 'QWERTYUIOP'

    def reverse_wirte(self, text):
        # 对传入的文本进行反转后输出
        return self.original_wirte(text[::-1])

    def __exit__(self, exc_type, exc_val, exc_tb):  # 如果一切正常,那么Python 调⽤__exit__ ⽅法时传⼊的参数是None, None, None
        # 在退出上下文管理器时,恢复原始的 sys.stdout.write 函数
        sys.stdout.write = self.original_wirte
        # 如果发生的异常是 ZeroDivisionError,输出相应提示信息
        if exc_type is ZeroDivisionError:
            print('Please DO NOT divide by zero!')
            return True  # 返回True,告诉解释器异常已处理


if __name__ == '__main__':
    with LookingGlass() as what:
        # print(obj)实质就是调用sys.stdout.write(obj+'\n')
        print("床前明月光")  # 光月明前床
        print("疑是地上霜")  # 霜上地是疑
        print(what)  # POIUYTREWQ
    print(what)  # QWERTYUIOP 处理上下文管理器,输出的文本正常,不再翻转

解释器调用__enter__方法时,除了隐式的self,不需要传入其他参数,传給__exit__方法的三个参数如下:

  • exc_type:异常类。
  • exc_value:异常实例。有时候会有参数传递给异常构造函数,例如错误消息,这些参数能够通过 exc_value.args获取。
  • exc_tb:trackback对象。

@contextmanager的用法

@contextmanager是一个十分实用且巧妙的工具。他将Python3个功能结合在一起:函数装饰器,生成器以及上下文管理器。

使用@contextmanager能减少创建上下文管理器的样板代码,因为不用编写一个类来定义__enter__和__exit__方法,而只要实现一个含有yield的生成器,来生成想要__enter__方法返回的值。

在使用@contextmanager装饰的生成器中,yiled把函数主体分成两部分,yield前面的代码在with块开始时(解释器调用__enter__方法时)执行。yield后面的代码在with块结束时(解释器调用__exit__方法时)执行。

继续上面的示例:

import sys
import contextlib


@contextlib.contextmanager
def looking_glass():
    original_text = sys.stdout.write

    def reverse_write(text):
        original_text(text[::-1])

    sys.stdout.write = reverse_write
    msg = ''
    # 这里处理异常是因为如果with块有异常抛出,Python会将其捕获,然后再looking_glass函数的yield表达式再次抛出
    # 但是那里又没有处理错误的代码,因此looking_glass函数将终止执行,永远无法恢复成原来的sys.stdout.write方法,导致系统处于无效状态。
    try:
        yield 'QWERTYUIOP'
    except ZeroDivisionError:
        msg = 'Please DO NOT divide by zero!'
    finally:
        sys.stdout.write = original_text
        if msg:
            print(msg)


if __name__ == '__main__':
    with looking_glass() as what:
        print("床前明月光")  # 光月明前床
        print("疑是地上霜")  # 霜上地是疑
        print(what)  # POIUYTREWQ
    print(what)  # QWERTYUIOP

其实@contextlib.contextmanager把函数包装成了实现__enter__和__exit__的类。

那个类的__enter__方法:

  • 调用生成器函数,获取生成器对象,姑且称之为gen。
  • 调用next(gen),驱动生成器对象执行到yield关键字位置。
  • 返回next(gen)产生的值,以便把产生的值绑定到as语句的目标变量上。

with语句终止,__exit__方法有以下作用:

  • 检查有没有异常传给exc_type,如果有则调用gen.throw(exception) ,在生成器函数主体的yield关键字所在的行抛出异常。
  • 否则调用next(gen),恢复执行生成器函数主体中yiled后面的代码。

因此在使用@contextmanager装饰器是,应该把yield放在try/finally语句中,这是不可避免的,因为我们永远不知道上下文管理器的用户会在with块中做什么。

@contextmanager还有一个鲜为人知的功能:它装饰的生成器也可以用做装饰器。例如:

@looking_glass()
def varse():
    print("举头望明月低头思故乡")

if __name__ == '__main__':
    varse() # 乡故思头低月明望头举

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Python实现图片浏览和选择工具

    Python实现图片浏览和选择工具

    这篇文章主要为大家详细介绍了如何使用Python实现一个图片浏览和选择工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-05-05
  • 利用Python批量循环读取Excel的技巧分享

    利用Python批量循环读取Excel的技巧分享

    这篇文章主要为大家详细介绍了何用Python批量循环读取Excel,文中的示例代码讲解详细,对我们的学习或工作有一定的帮助,感兴趣的可以了解一下
    2023-07-07
  • Django中select_related查询优化的具体实现

    Django中select_related查询优化的具体实现

    本文介绍了Django ORM中的N+1查询问题及其解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-12-12
  • python基于plotly实现画饼状图代码实例

    python基于plotly实现画饼状图代码实例

    这篇文章主要介绍了python基于plotly实现画饼状图代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • Python搭建Spark分布式集群环境

    Python搭建Spark分布式集群环境

    这篇文章主要介绍了Spark分布式集群环境搭建基于Python版,Apache Spark 是一个新兴的大数据处理通用引擎,提供了分布式的内存抽象。100 倍本文而是使用三台电脑来搭建一个小型分布式集群环境安装,需要的朋友可以参考下
    2019-07-07
  • Python获取apk文件URL地址实例

    Python获取apk文件URL地址实例

    需要提取apk文件的特定URL地址的朋友可以看一下这个代码实例。
    2013-11-11
  • pandas groupby 用法实例详解

    pandas groupby 用法实例详解

    在日常数据分析过程中,经常有分组的需求。具体来说,就是根据一个或者多个字段,将数据划分为不同的组,然后进行进一步分析,比如求分组的数量,分组内的最大值最小值平均值等,下面我们就来看看pandas中的groupby怎么使用,需要的朋友可以参考下
    2022-11-11
  • python处理cookie详解

    python处理cookie详解

    Cookie用于服务器实现会话,用户登录及相关功能时进行状态管理,本文介绍了使用python处理cookie的方法,需要的朋友可以参考下
    2014-02-02
  • python代码 输入数字使其反向输出的方法

    python代码 输入数字使其反向输出的方法

    今天小编就为大家分享一篇python代码 输入数字使其反向输出的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-12-12
  • 在linux系统下安装python librtmp包的实现方法

    在linux系统下安装python librtmp包的实现方法

    今天小编就为大家分享一篇在linux系统下安装python librtmp包的实现方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-07-07

最新评论