使用Python实现with结构的@contextmanager方法详解

 更新时间:2023年07月21日 09:36:50   作者:孔天逸  
这篇文章主要介绍了使用Python实现with结构的@contextmanager方法详解,这个结构的好处,一个是简洁,一个是当我们对文件操作的逻辑很长的时候,不会因为忘了关闭文件而造成不必要的错误,需要的朋友可以参考下

常见with结构

常见的with结构是在进行文件操作时,比如

# 中规中矩的写法
f = open("test.txt", "w")
f.write("hello world!")
f.close()
# 采用with结构
with open("test.txt", "w") as f:
  f.write("hello world!")

这个结构的好处,一个是简洁,一个是当我们对文件操作的逻辑很长的时候,不会因为忘了关闭文件而造成不必要的错误。

类似的,当我们在某些时候不希望遗忘一些重要的语句的时候,可以自己封装个with结构,比如关闭数据库链接等情况。

一般实现方法

with结构一般的实现方法是在定义类的时候重载__enter__方法和__exit__方法

比如我们可以通过如下代码来模拟一下上面两段代码前者到后者的转化

# -*- coding: utf-8 -*-
class myOpen():
    def __init__(self, name, state):
        self.f = open(name, state)
    # 返回值是with...as...中as出来的东西,如下面的f
    def __enter__(self):
        return self.f
    # 在with...as...语句块自动执行完之后执行
    def __exit__(self, exc_type, exc_val, exc_tb):
        self.f.close()
if __name__ == "__main__":
    with myOpen("test.txt", "w") as f:
        f.write("hello world!")

@contextmanager方法

好像上面这种方法实现起来with结构有那么一点点麻烦,那么就进入主题吧,有一种逼格又高,又简便的方法,先上代码,仍以打开文件为例:

# -*- coding: utf-8 -*-
from contextlib import contextmanager
@contextmanager
def myOpen(name, state):
  try:
    f = open(name, state)
    yield f
  finally:
      f.close()
if __name__ == "__main__":
  with myOpen("test.txt", "w") as f:
      f.write("hello world!")

可以看出这里只要定义一个函数,然后在它的头部加上@contextmanager就好了

这个函数应该怎么定义呢?我们去源码里看一下就好,里面给出了详细的注释

def contextmanager(func):
    """@contextmanager decorator.
    Typical usage:
        @contextmanager
        def some_generator(<arguments>):
            <setup>
            try:
                yield <value>
            finally:
                <cleanup>
    This makes this:
        with some_generator(<arguments>) as <variable>:
            <body>
    equivalent to this:
        <setup>
        try:
            <variable> = <value>
            <body>
        finally:
            <cleanup>
    """
    @wraps(func)
    def helper(*args, **kwds):
        return GeneratorContextManager(func(*args, **kwds))
    return helper

通过注释我们可以看到,我们可以通过给一个try…finally…结构的函数头部加上@contextmanager就可以通过with…as…结构来调用它了

这样try块中yield的数据被as出来,finally块中的数据在with..as..块结束的时候被执行。

到此这篇关于使用Python实现with结构的@contextmanager方法详解的文章就介绍到这了,更多相关Python实现with结构内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • python爬虫爬取bilibili网页基本内容

    python爬虫爬取bilibili网页基本内容

    这篇文章主要介绍了python爬虫爬取bilibili网页基本内容,用爬虫爬取bilibili网站排行榜游戏类的所有名称及链接,下面来看看具体的实现过程吧,需要的朋友可以参考一下
    2022-01-01
  • 使用pyplot.matshow()函数添加绘图标题

    使用pyplot.matshow()函数添加绘图标题

    这篇文章主要介绍了使用pyplot.matshow()函数添加绘图标题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-06-06
  • python中的% 是什么意思,起到什么作用呢

    python中的% 是什么意思,起到什么作用呢

    %Y会被无世纪的年份所替代,%m会被01到12之间的一个十进制月份数替代,其他依次类推,%在python的格式化输出,有转换字符的作用,本文给大家讲解python中的% 是什么意思,起到什么作用,感兴趣的朋友一起看看吧
    2022-12-12
  • Python中多进程处理的Process和Pool的用法详解

    Python中多进程处理的Process和Pool的用法详解

    在Python编程中,多进程是一种强大的并行处理技术,Python提供了两种主要的多进程处理方式:Process和Pool,本文将详细介绍这两种方式的使用,希望对大家有所帮助
    2024-02-02
  • 浅析Python 引号、注释、字符串

    浅析Python 引号、注释、字符串

    这篇文章主要介绍了Python 引号、注释、字符串的相关知识,文中给大家提到了python中一对单引号,一对双引号,三个单双引号的区别和用法,需要的朋友可以参考下
    2019-07-07
  • Python如何生成指定区间中的随机数

    Python如何生成指定区间中的随机数

    这篇文章主要介绍了Python如何生成指定区间中的随机数,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-07-07
  • python实现键盘输入的实操方法

    python实现键盘输入的实操方法

    在本篇文章里小编给各位分享了关于python怎么实现键盘输入的图文步骤以及相关知识点内容,需要的朋友们参考下。
    2019-07-07
  • YOLOv5车牌识别实战教程(四)模型优化与部署

    YOLOv5车牌识别实战教程(四)模型优化与部署

    这篇文章主要介绍了YOLOv5车牌识别实战教程(四)模型优化与部署,在这个教程中,我们将一步步教你如何使用YOLOv5进行车牌识别,帮助你快速掌握YOLOv5车牌识别技能,需要的朋友可以参考下
    2023-04-04
  • python密码学简单替代密码解密及测试教程

    python密码学简单替代密码解密及测试教程

    这篇文章主要介绍了python密码学简单替代密码解密及测试教程,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • python基础学习之如何对元组各个元素进行命名详解

    python基础学习之如何对元组各个元素进行命名详解

    python的元祖和列表类似,不同之处在于元祖的元素不能修改,下面这篇文章主要给大家介绍了关于python基础学习之如何对元组各个元素进行命名的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2018-07-07

最新评论