Python-with及上下文管理器——__enter__()和__exit__()

上下文管理器与装饰器类似,它们都是包装其他代码的工具。但装饰器用于包装定义的代码块(如函数或类),而上下文管理器可以包装任意格式的代码块。
有一些任务,可能事先需要设置,事后做清理工作。这种时候用上下文管理器就可以相当方便地进行处理。
例如,在对文件进行读写操作时,通常得这样进行

try:
    file = open("/tmp/foo.txt")
    data = file.read()
finally:
    file.close()

这样的写法虽然没有问题,但总是需要手动关闭文件,很可能忘记关闭文件句柄,引起漏洞。

在python2.5后新增了关键字with,使用with语句即可进入上下文管理器,它可以在执行完代码之后自动帮我们关闭文件,因此上述代码可改写成:

with open('test.txt') as f:
    data = f.read()

with究竟是如何工作的,或者说上面提到的上下文管理器究竟是什么?
with语句的作用实际上就是对其后的代码求值(本例中即为调用open函数)。该表达式返回一个对象,该对象包含两个特殊方法:__enter__()__exit__()

  • 紧跟with后面的语句被求值后,返回对象的__enter__()方法被调用,这个方法的返回值将被赋值给as后面的变量。当with后面的代码块全部被执行完之后,将调用前面返回对象的__exit__()方法。

我们可以通过如下实例来看

class Sample:
    def __enter__(self):
        print("__enter__")
        return "sample"

    def __exit__(self, type, value, trace):
        print("__exit__")


def get_sample():
    return Sample()


with get_sample() as sample:
    print(sample)
>>>
__enter__
sample
__exit__

整个过程有如下几步:

  1. __enter__()方法被执行
  2. __enter__()方法返回的值赋值给as后的变量sample
  3. 执行代码块
  4. __exit__()方法被调用
    可以看出,with语句是进入上下文管理器的入口且默认执行__enter__函数,而退出上下文管理器时默认执行__exit__函数。

由上我们可以知道,打开和关闭资源(如文件和数据库连接)是编写上下文管理器的一个重要应用。但除此之外,上下文管理器还有另一个重要功能:

异常处理

with语句的表达式的作用是返回一个遵循特定协议的对象,该对象必须定义一个 __enter__方法和一个__exit__方法。

除了self参数,__enter__方法不接受任何参数,如果有as变量(as子句是可选项 ),返回值赋给as后的变量。

除了self参数,__exit__方法还带有三个位置参数:

  • exc_type:一个异常类型
  • exc_instance :一个异常实例
  • traceback :一个回溯

无异常时它们全为None,但如果在代码块内有异常发生,则参数被填充

上下文管理器必须定义__exit__方法,该方法可以选择性地处理包装代码块中出现的异常,或者处理其他需要关闭上下文管理器状态的事情。如果exit方法接收一个异常,它可以

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

推荐阅读更多精彩内容