从with关键字到编写自己简单的ContextManager（一）

Python with语句解析

最新推荐文章于 2025-11-29 16:24:14 发布

最新推荐文章于 2025-11-29 16:24:14 发布 · 138 阅读

文章标签：

#python #with

python 专栏收录该内容

13 篇文章

订阅专栏

本文首先介绍了Python中with表达式的用途及其如何简化try-except-finally的异常处理过程，特别是对于文件操作。随后通过自定义类`ConMgr`演示了如何实现`__enter__`和`__exit__`方法来创建一个上下文管理器。此外，还探讨了Python `contextlib`模块的使用，包括`contextmanager`装饰器如何简化上下文管理器的创建。

本文先介绍with表达式，然后再试图用with以及装饰器等知识实现自己的ContextManager

with可以干什么？我的理解是简化try except finally的工作，比如打开文件操作符，读文件，捕捉异常，最后关闭。这个例子是with最最常用的方法了，满大街都可以找到这个例子。
除文件open操作之外，其实其它很多操作也可以掐头去尾，留下中间关键操作就行。
那么该如何实现呢？按照python文档解释，只要实现__enter__和__exit__两个函数就可以。
很简单：

class ConMgr(object):
    def __init__(self):
        print("__init__ called")


    def __call__(self, *args):
        print("__call__ called")
        #: 可以把传进来的参数保存着，在with开始时运行
        self.args = args
        return self


    def __enter__(self):
        # 打印之前传进来的参数
        print("__enter__ called", self.args)
        return 'abcd'


    def __exit__(self, exc_type, exc_val, exc_tb):
        print("__exit__ called: exc_type = %s exc_val = %s exc_tb = %s "\
              % (exc_type, exc_val, exc_tb))
        return "exited"


def test1():
    c = ConMgr()
    with c('pppp') as tmp:
        print(tmp)
        print("haha")
        assert 1>2
        print(3)

test1()

输出结果是：

__init__ called
__call__ called
('__enter__ called', ('pppp',))
abcd
haha
__exit__ called: exc_type = <type 'exceptions.AssertionError'> exc_val =  exc_tb = <traceback object at 0x7f911003b128>

首先请注意，这里的c()是类的一个实例，就是一个普通类，而不是generator。当c('pppp')执行时，调用了__call__函数，__call__函数赶紧把传入的参数保存了下来，等进了with块之后，调用__enter__之时再把参数放出来。
另外__call__函数一定要返回self，因为with块运行完了之后，将会调用self.__exit__()如果不返回self将找不到__exit__函数。
然后就是as语句的tmp值实际上是__enter__的返回值，返回什么都可以，无所谓的，哪怕传个闭包。这里的好主意是把之前的args可以传给tmp。
最后请仔细看，当assert 1>2发生错误之后，with块没有执行完就调用__exit__函数了。通过这个函数的参数，我们来实现异常处理。

接下来介绍下python的contextlib这个模块。
可能有朋友不知到，这个模块没有主轴功能，主要是围绕with语句，提供了一些方便的util函数操作。
这个模块里面有一个contextmanager的装饰器，它可以省掉我们之前那么麻烦创建一个class然后补上__enter__和__exit__的过程，它利用工厂模式生成一个generator，然后就可以方便的使用with语句了。
关于官方contextlib模块里面的功能，我想自己能不能做一个山寨版出来，详细见[url=http://luozhaoyu.iteye.com/blog/1512917]下文[/url]