使用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结构内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • pytorch+sklearn实现数据加载的流程

    pytorch+sklearn实现数据加载的流程

    这篇文章主要介绍了pytorch+sklearn实现数据加载,之前在训练网络的时候加载数据都是稀里糊涂的放进去的,也没有理清楚里面的流程,今天整理一下,加深理解,也方便以后查阅,需要的朋友可以参考下
    2022-11-11
  • 使用Python解决序列重叠问题

    使用Python解决序列重叠问题

    这篇文章主要为大家详细介绍了如何使用Python解决序列重叠问题,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-03-03
  • Python模拟登录的多种方法(四种)

    Python模拟登录的多种方法(四种)

    这篇文章主要介绍了Python模拟登录的多种方法,大概给大家提供了四种方法,每种方法给大家介绍的都很详细,感兴趣的朋友跟随脚本之家小编一起看看吧
    2018-06-06
  • Python中的引用知识点总结

    Python中的引用知识点总结

    在本文里我们给大家整理了关于Python中的引用知识点以及相关代码总结,需要的朋友们跟着学习下。
    2019-05-05
  • python单向循环链表实例详解

    python单向循环链表实例详解

    这篇文章主要为大家详细介绍了python单向循环链表实例,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05
  • python绘制lost损失曲线加方差范围的操作方法

    python绘制lost损失曲线加方差范围的操作方法

    这篇文章主要介绍了python绘制lost损失曲线加方差范围的操作方法,首先大家需要导入必要的包及数据的获取方法,本文给大家介绍的非常详细,需要的朋友可以参考下
    2021-10-10
  • python数据库PooledDB连接池初始化使用示例

    python数据库PooledDB连接池初始化使用示例

    这篇文章主要为大家介绍了python数据库PooledDB连接池初始化使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Python OpenCV绘制各类几何图形详解

    Python OpenCV绘制各类几何图形详解

    这篇文章将详细讲解如何使用OpenCV绘制各类几何图形,包括cv2.line()、v2.circle()、cv2.rectangle()、cv2.ellipse()、cv2.polylines()、cv2.putText()函数。需要的可以参考一下
    2022-01-01
  • 解决Python中定时任务线程无法自动退出的问题

    解决Python中定时任务线程无法自动退出的问题

    今天小编就为大家分享一篇解决Python中定时任务线程无法自动退出的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-02-02
  • python实现用户管理系统

    python实现用户管理系统

    这篇文章主要为大家详细介绍了python实现用户管理系统,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01

最新评论