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

本文环境

win7_64 + Python 2.7.10

文件操作

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

fp = open('test.txt', 'r')

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

fp.close()

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

fp = open('test.txt', 'r')
a = 1 / 0 # 这里引发了异常,下面的代码无法执行
fp.close()

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

fp = open('test.txt', 'r')
try:
    do_something()
    a = 1/ 0
except:
    do_exc()
finally:
    fp.close() # 能正确释放

上下文管理器

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

with open('test.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__

执行顺序很明显
假如我们在test里面出现了异常,在看看会执行哪些方法

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')
    return 1 / 0 #这里引发异常
        
with MyContext():
    test()

结果

__init__
__enter__
test
__exit__
Traceback (most recent call last):
  File "test.py", line 19, in <module>
    test()
  File "test.py", line 16, in test
    return 1 / 0
ZeroDivisionError: integer division or modulo by zero

同样,所有的都执行了,就算test引发了异常,但是__exit__仍然会执行
上面都是用的with语句,现在来看看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 "test.py", line 15, in <module>
    my.func()
AttributeError: 'NoneType' object has no attribute 'func'

我们把__enter__返回self自己

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 MyContext() as my:
    my.func()

结果就可以正常执行

__init__
__enter__
func
__exit__

执行顺序和异常抛出问题

  1. __enter__返回之前出现异常,那么上下文管理器是没有形成的,此时__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 MyContext() as my:
    my.func()

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

__init__
Traceback (most recent call last):
  File "test.py", line 16, in <module>
    with MyContext() as my:
  File "test.py", line 4, in __init__
    1 / 0
ZeroDivisionError: integer division or modulo by zero

在来看看__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 MyContext() as my:
    my.func()

结果是

__init__
__enter__
Traceback (most recent call last):
  File "test.py", line 16, in <module>
    with MyContext() as my:
  File "test.py", line 10, in __enter__
    1 / 0
ZeroDivisionError: integer division or modulo by zero

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

  1. __exit__的三个参数对应了引发异常后的三个参数,对应的就是sys.exc_info()返回的对象,如果没有引发异常,它们的值都是None
    首先看下出现异常它们的值
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 MyContext() as my:
    my.func()

结果是

__init__
__enter__
__exit__
# 分别是异常类型,异常值和异常跟踪对象
(<type 'exceptions.ZeroDivisionError'>, ZeroDivisionError('integer division or modulo by zero',), <traceback object at 0x000000000269EC08>)
Traceback (most recent call last):
  File "test.py", line 18, in <module>
    my.func()
  File "test.py", line 6, in func
    1 / 0
ZeroDivisionError: integer division or modulo by zero

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

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__')
        print(exc_type, exc_value, traceback)
        
with MyContext() as my:
    my.func()

结果是

__init__
__enter__
func
__exit__
# 三个值都是None
(None, None, None)
  1. __exit__默认是返回的None,上面的例子可以看出,异常虽然出现了,但是仍然会继续抛出,我们可以通过让__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 MyContext() as my:
    my.func()

结果是

__init__
__enter__
__exit__
(<type 'exceptions.ZeroDivisionError'>, ZeroDivisionError('integer division or modulo by zero',), <traceback object at 0x000000000267EC08>)

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

总结

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

参考

https://docs.python.org/2/reference/datamodel.html#with-statement-context-managers
https://docs.python.org/2/reference/compound_stmts.html#the-with-statement

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容