Python魔术方法：上下文管理器(__enter__和__exit__)

　　参考：https://www.jianshu.com/p/067ab9c5ee73/

　　本文环境

　　win10 + python3.6

　　文件操作

　　一般文件操作可以通过open的方式获取一个文件对象fp，比如

# 以只读模式打开一个文件对象赋值给变量fp
fp = open(r'D:\learn-python3\常用内建模块\file.txt','r')
# print(fp.read())

　　然后我们可以通过fp对文件进行读操作，操作完成后，我们需要通过调用fp对象的close方法显示的关闭资源，以便让python可以正确的释放相关系统资源

# 关闭文件对象,关闭文件对象后无法使用文件对象的read()方法，会报ValueError: I/O operation on closed file.
# 未关闭文件对象可以使用read()方法，即使文件内容已经全部读取出来使用read()方法返回为空白
fp.close()

　　如果在close之前出现了异常，导致代码不能正常走到close，就会出现资源不能正常释放的情况

fp = open(r'D:\learn-python3\常用内建模块\file.txt','r')
# 以下代码出现异常不会执行下面的close()
1 / 0
fp.close()

　　一般可以通过try...except...finally来捕获异常，因为finally里面的代码是一定会走到，故可以把资源释放的动作放到这里

# 使用try关闭文件对象
def do_something():
    print('do_something')

def do_exc():
    print('do_exc')
fp = open(r'D:\learn-python3\常用内建模块\file.txt','r')
try:
    do_something()
    a = 1 / 0
except:
    do_exc()
finally:
    fp.close()

　　不管之前代码是否报错都会执行finally正确关闭文件对象资源。

　　上下文管理器

　　上面的代码虽然可以满足我们的要求，但是比较冗长，而且也不符合python提倡的代码简洁性，所以有一个概念就是上下文管理器，类比到代码就是with语句

# 使用with
with open(r'D:\learn-python3\常用内建模块\file.txt','r') as fp:
    do_something()

　　上面的代码，就可以自动的在执行完do_something()这段逻辑后正确的进行释放，会自动的调用close

　　实现自己的上下文管理器

　　可以通过定义一个类，满足上下文管理器协议的要求定义，就可以用with语句来调用，类里面需要定义__enter__和__exit__两个方法即可

# 类实现上下文管理
class MyContext:
    def __init__(self):
        print('__init__')

    def func(self):
        print('func')
    
    def __enter__(self):
        print('__enter__')

    def __exit__(self, exc_type, exc_value,traceback):
        print('__exit__')

def test():
    print('test')

with MyContext():
    test()

　　执行输出如下

__init__
__enter__
test
__exit__

　　输出很明显，首先初始化输出__init__ 

　　然后实现了上下文管理即with下的语句在执行前执行类的__enter__方法

　　在执行后执行类的__exit__方法 所以在执行test()的前后分别输出了__enter__和__exit__

　　假如我们在test里面出现 异常，再看看会执行那些方法

# 在with语句执行时报错
class MyContext:
    def __init__(self):
        print('__init__')

    def func(self):
        print('func')
    
    def __enter__(self):
        print('__enter__')

    def __exit__(self, exc_type, exc_value,traceback):
        print('__exit__')

def test():
    print('test')
    # 以下语句会出现异常
    1  / 0
with MyContext():
    test()

　　输出

__init__
__enter__
test
__exit__
Traceback (most recent call last):
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 67, in <module>
    test()
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 65, in test
    1  / 0
ZeroDivisionError: division by zero

　　注意：输出是先正常输出，然后再尾部抛出错误，即输出__exit__以后再抛出1/0执行的错误，而不是在输出test一个抛出1/0执行的错误

　　同样，所有的都执行了，就算test引发了异常，但是__exit__仍然会执行
上面都是用的with语句，现在来看看with...as

# 使用with..as
class MyContext:
    def __init__(self):
        print('__init__')
        
    def func(self):
        print('func')
        
    def __enter__(self):
        print('__enter__')
        
    def __exit__(self, exc_type, exc_value, traceback):
        print('__exit__')
        
# 这个with语句不等同于 my = MyContext()，而是等同于my = MyContext().__enter__()，由于__enter__并
# 没有返回任何值，默认就是None，故在调用my.fun()会抛出异常
with MyContext() as my:
    my.func()

　　输出结果

__init__
__enter__
__exit__
Traceback (most recent call last):
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 87, in <module>
    my.func()
AttributeError: 'NoneType' object has no attribute 'func'

　　因为__enter__方法没有定义返回所以返回为None使用调用fun()报错

　　我们把__enter__返回self自己

# 使用with..as __enter__返回自己 即可调用func()函数
class MyContext:
    def __init__(self):
        print('__init__')
        
    def func(self):
        print('func')
        
    def __enter__(self):
        print('__enter__')
        return self
        
    def __exit__(self, exc_type, exc_value, traceback):
        print('__exit__')
        
# 这个with语句不等同于 my = MyContext()，而是等同于my = MyContext().__enter__()，由于__enter__并
# 没有返回任何值，默认就是None，故在调用my.fun()会抛出异常
with MyContext() as my:
    my.func()

　　输出如下

　　正常实现了上下文即在执行的前后执行__enter__()和__exit__

__init__
__enter__
func
__exit__

　　执行顺序和异常抛出问题

　　1,在__enter__返回之前出现异常，那么上下文管理是没有形成的，此时__exit__是不能被执行的，除非显示调用（即self.__exit__()这样调用）

　　首先看__init__里面引发异常

# 在__enter__返回之前出现异常，那么上下文管理是没有形成的，此时__exit__是不能被执行的，除非显示调用（即self.__exit__()这样调用）
# __init__引发异常
class MyContext:
    def __init__(self):
        print('__init__')
        1 / 0
    def func(self):
        print('func')
        
    def __enter__(self):
        print('__enter__')
        return self
        
    def __exit__(self, exc_type, exc_value, traceback):
        print('__exit__')
        
# 这个with语句不等同于 my = MyContext()，而是等同于my = MyContext().__enter__()，由于__enter__并
# 没有返回任何值，默认就是None，故在调用my.fun()会抛出异常
with MyContext() as my:
    my.func()

　　结果只执行到了__init__，引发异常后，代码终止，连__enter__都无法执行

　　输出结果

__init__
Traceback (most recent call last):
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 128, in <module>
    with MyContext() as my:
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 115, in __init__
    1 / 0
ZeroDivisionError: division by zero

　　在来看__enter__出现异常

# __enter__出现异常
class MyContext:
    def __init__(self):
        print('__init__')
        
    def func(self):
        print('func')
        
    def __enter__(self):
        print('__enter__')
        1 / 0
        return self
        
    def __exit__(self, exc_type, exc_value, traceback):
        print('__exit__')
        
# 这个with语句不等同于 my = MyContext()，而是等同于my = MyContext().__enter__()，由于__enter__并
# 没有返回任何值，默认就是None，故在调用my.fun()会抛出异常
with MyContext() as my:
    my.func()

　　输出结果

__init__
__enter__
Traceback (most recent call last):
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 149, in <module>
    with MyContext() as my:
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 141, in __enter__
    1 / 0
ZeroDivisionError: division by zero

　　虽然执行到了__enter__，但是仍然没有执行__exit__，代码就终止了

　　2，__exit__的三个参数对应了引发异常后的三个参数，对应的就是sys.exc_info()返回的对象，如果没有引发异常，它们的值都是None
首先看下出现异常它们的值

# __exit__的三个参数对应了引发异常后的三个参数
class MyContext:
    def __init__(self):
        print('__init__')
        
    def func(self):
        1 / 0
        print('func')
        
    def __enter__(self):
        print('__enter__')
        return self
        
    def __exit__(self, exc_type, exc_value, traceback):
        print('__exit__')
        print(exc_type, exc_value, traceback)
        
# 这个with语句不等同于 my = MyContext()，而是等同于my = MyContext().__enter__()，由于__enter__并
# 没有返回任何值，默认就是None，故在调用my.fun()会抛出异常
with MyContext() as my:
    my.func()

　　输出结果

__init__
__enter__
__exit__
# 分别是异常类型，异常值和异常跟踪对象
<class 'ZeroDivisionError'> division by zero <traceback object at 0x000001AFB23683C8>
Traceback (most recent call last):
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 172, in <module>
    my.func()
  File "d:/learn-python3/学习脚本/上下文管理/use_enter_exit.py", line 158, in func
    1 / 0
ZeroDivisionError: division by zero

　　再来看看未出现异常的时候

class MyContext:
    def __init__(self):
        print('__init__')
        
    def func(self):
        #1 / 0
        print('func')
        
    def __enter__(self):
        print('__enter__')
        return self
        
    def __exit__(self, exc_type, exc_value, traceback):
        print('__exit__')
        print(exc_type, exc_value, traceback)
        
# 这个with语句不等同于 my = MyContext()，而是等同于my = MyContext().__enter__()，由于__enter__并
# 没有返回任何值，默认就是None，故在调用my.fun()会抛出异常
with MyContext() as my:
    my.func()

　　输出结果

__init__
__enter__
func
__exit__
None None None

　　3，__exit__默认是返回的None，上面的例子可以看出，异常虽然出现了，但是仍然会继续抛出，我们可以通过让__exit__返回True来屏蔽异常

# __exit__返回True屏蔽异常
class MyContext:
    def __init__(self):
        print('__init__')
        
    def func(self):
        1 / 0
        print('func')
        
    def __enter__(self):
        print('__enter__')
        return self
        
    def __exit__(self, exc_type, exc_value, traceback):
        print('__exit__')
        print(exc_type, exc_value, traceback)
        return True
# 这个with语句不等同于 my = MyContext()，而是等同于my = MyContext().__enter__()，由于__enter__并
# 没有返回任何值，默认就是None，故在调用my.fun()会抛出异常
with MyContext() as my:
    my.func()

　　输出结果

__init__
__enter__
__exit__
<class 'ZeroDivisionError'> division by zero <traceback object at 0x000001B010D478C8>

　　由于__exit__返回了True，异常被屏蔽，代码不会终止，会继续往下执行，但是注意，屏蔽异常，一定要自己在__exit__里面处理异常，或者你根本不care这个异常

　　总结

• __enter__需要返回一个对象，才能通过with...as把一个变量引用到这个对象上
• __exit__有4个参数，后面三个分别是exc_type, exc_value和traceback
• __enter__必须正确返回后(就算是返回默认的None)，上下文管理器协议才生效
• __exit__默认返回None，出现异常仍然会继续抛出，返回True则会屏蔽异常