浅析Python 3 中的with语句

在python开发中，尤其是文件操作中经常会碰到 with语法，常见格式如下：

with open(r'fisher.py','r') as f:
    print(f.read())

之前总是会得过且过，但是今天又遇到了更深层次的问题，索性就直接拿下with用法。

1. 首先要确定什么样的对象可以使用with语句？

实现了上下文协议的对象就可以使用with语句。对于实现了上下文协议的对象，我们通常称为上下文管理器。

2. 一个上下文管理器如何实现上下文协议呢

实现了__enter__和__exit__这两个方法就是实现了上下文协议。

下面我们实现一个最简单的例子来理解上面的概念

class Test:
    enter= 'Enter...'
    exit='Exit...'
    def __enter__(self):
        print(Test.enter)

    def __exit__(self, exc_type, exc_val, exc_tb):
        print(Test.exit)

with Test():
    print('This is test')

执行结果>
Enter...
This is test
Exit...

上面例子中Test类的实例实现了__enter__ 和__exit__方法，所以它是上下文管理器。
可以看到with语句首先执行了类中__enter__中的代码，再去执行with语句中的代码，最后去执行类中__exit__中的代码。

通常我们还会在with后面加上一个as,例如最开始对文件的操作，with open(r'fisher.py','r') as f，接下来的操作都会用f这个变量来进行，那么这里的f是不是上下文管理器呢？

答案是”不是的“。
为了解答这个问题，可以稍微修改一下代码：

class Test:
    enter= 'Enter...'
    exit='Exit...'
    def __enter__(self):
        print(Test.enter)
        return Test.enter

    def __exit__(self, exc_type, exc_val, exc_tb):
        print(Test.exit)

with Test() as obj:
    print('This is test')
    print(obj)

Enter...
This is test
Enter...
Exit...

分析上面执行的结果，当我们打印obj这个变量的时候打印的是“Enter…"。

事实上，with 语句中的as后面是__enter__函数return的结果。

为了验证上面猜想，我们再次修改代码：

class Test:
    enter= 'Enter...'
    exit='Exit...'
    def __enter__(self):
        print(Test.enter)
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        print(Test.exit)

    def fun(self):
        print('fun execute!!!')

with Test() as obj:
    obj.fun()

Enter...
fun execute!!!
Exit...

这样也就证实了as后的参数是__enter__函数return回来的内容。

了解了__enter__的内容，接下来看看__exit__这个函数：

def __exit__(self,exc_type, exc_val, exc_tb)

首先必须先确定一点，在定义__exit__函数时，四个形参缺一不可。如果参数不是四个程序就会报错。
一般__exit__都是用来做资源回收，除了这个功能以外它还能进行异常处理。exit 四个参数中的后三个都和异常处理有关。

没有异常的情况下，__exit__后三个参数默认都是None。现在让程序主动产生一个异常，修改代码：

class Test:
    enter= 'Enter...'
    exit='Exit...'
    def __enter__(self):
        print(Test.enter)
        return self

    def __exit__(self,exc_type, exc_val, exc_tb):
        print(f'exc_type:{exc_type}')
        print(f'exc_val:{exc_val}')
        print(f'exc_tb:{exc_tb}')
        print(Test.exit)
        return True

    def fun(self):
        print('fun execute!!!')

with Test() as obj:
    1 / 0
    obj.fun()

Enter...
exc_type:<class 'ZeroDivisionError'>
exc_val:division by zero
exc_tb:<traceback object at 0x00000189BA413408>
Exit...

在上面我们进行了除零操作引发了一个异常并且打印__exit__后三个参数的值。可以看到”exc_type“返回异常类型，”exc_val“返回异常值，”exc_tb“返回traceback对象。

足够细心的话应该还能发现我们让__exit__返回了True。
事实上，__exit__函数只能返回True或者False，当我们不指定返回值的时候默认为False。
当我们return True，__exit__方法执行完成后with外部将不会抛出异常。
当我们return False,__exit__方法执行完成后with外部还会抛出异常

我们修改__exit__返回值为False，并且设置异常捕获：

class Test:
    enter= 'Enter...'
    exit='Exit...'
    def __enter__(self):
        print(Test.enter)
        return self

    def __exit__(self,exc_type, exc_val, exc_tb):
        print(f'exc_type:{exc_type}')
        print(f'exc_val:{exc_val}')
        print(f'exc_tb:{exc_tb}')
        print(Test.exit)
        return False

    def fun(self):
        print('fun execute!!!')

try:
    with Test() as obj:
        1 / 0
        obj.fun()
except Exception :
    print("Exception captured")

Enter...
exc_type:<class 'ZeroDivisionError'>
exc_val:division by zero
exc_tb:<traceback object at 0x000001C863053408>
Exit...
Exception captured

上面最后一行结果就是我们捕获到了异常。如果去掉return语句，执行结果也和上面一样，因为默认返回False。