Python上下文管理器和with块

python中with语句用起来很方便,那这后边的原理就是python中的上下文管理器。

1.什么是上下文管理器

上下文管理器用来定义/控制代码块得执行前得准备工作,以及程序执行后得收尾工作。比如文件读写前的打开,与读写后的关闭。 网络请求的建立与断开等等。
下边拿requests.session() 为例:

import requests
with requests.session() as session:
    response_html = session.get('http://www.baidu.com').text
    print (response_html)

为什么with语句块能控制网络的建立与释放,原因是实现了上下文管理协议(context management protocol),相关的两个魔法方法:
__enter__(self): 不接收参数,定义上下文管理器在with语句块开头所执行的操作,其方法返回的值绑定到,/as 后边所定义的变量。
__exit__(self, exc_type, exc_value, traceback):接收三个参数,exc_type 表示错误类型;exc_value 异常实例。有时会有参数传给异常构造方法,例如错误消息,这些参数可以使用exception_type获取。traceback:traceback对象

session的上下文协议源码


session源码

2.创建上下文管理器的两种方式

我们重新实现一个类似open()的类,只是在创建文件对象时和关闭文件对象时增加了提示。

2.1 实现上下文协议
class File(object):
    def __init__(self, file_path, mode):
        self.file_path = file_path
         self.mode = mode

    def __enter__(self):
        self.f = open(self.file_path, self.mode, encoding='utf-8')
        print(f"{self.file_path} is open")
        return self.f

    def __exit__(self, exc_type, exc_val, exc_tb):
        self.f.close()
        print(f"{self.file_path} is closed")


with File('test.txt', 'w') as f:
    f.write('董小贱')

输出结果:

test.txt is open
test.txt is closed
2.2 装饰器实现
from contextlib import contextmanager

@contextmanager
def file(file_path, mode):
    f = open(file_path, mode, encoding='utf-8')
    print(f"{file_path} is open")

    yield f
    f.close()
    print(f"{file_path} is closed")

with file('test.txt, 'w') as f:
    f.write('董小贱')

输出结果:

test.txt is open
test.txt is closed

在使用 @contextmanager 装饰的生成器中,yield 语句的作用是把函数的定义体分成两部 分:yield 语句前面的所有代码在 with 块开始时(即解释器调用 __enter__方法时)执行, yield 语句后面的代码在 with 块结束时(即调用 __exit__ 方法时)执行。

其实这里有个问题,如果在with块中抛出了一个异常,Python 解释器会将其捕获, 然后在 file 函数的 yield 表达式里再次抛出,但是代码中没有处理异常的代码,所以函数会终止,导致文件不能被关闭。所以我们要在yield处处理异常。

所以第二版:

from contextlib import contextmanager

@contextmanager
def file(file_path, mode):
    f = open(file_path, mode, encoding='utf-8')
    print(f"{file_path} is open")
    try:
        yield f
    except Exception as e:
        print (e) # 处理异常的操作
    finally:
        f.close()
        print(f"{file_path} is closed")
with file('24.txt', 'w') as f:
    f.write('董小贱')

注:实现上下文管理协议,即可使用with块。需要注意的是在 @contextmanager 装饰器装饰的生成器中,yield 与迭代没有任何关系。

上下文管理器一个很好的例子 原地文件读写管理器

更多细节,请参考 《流畅的python》的第十五章节。

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