17 上下文管理器和With语句

目录链接://www.greatytc.com/p/e1e201bea601

什么是上下文管理器?

在任何一门编程语言中, 文件的输入输出、 数据库的连接断开等, 都是很常见的资源管理操作。但资源都是有限的, 在写程序时, 我们必须保证这些资源在使用过后得到释放, 不然就容易造成资源泄露。
下面这一段代码:

for x in range(10000000): 
    f = open('test.txt', 'w')
    f.write('hello') 

共打开了 10000000 个文件, 但是用完以后都没有关闭它们,这就是一个典型的资源泄露的例子。

为了解决这个问题, 不同的编程语言都引入了不同的机制。 在 Python 中, 对应的解决方式便是上下文管理器(context manager) 。

上下文管理器, 能够帮助你自动分配并且释放资源, 其中最典型的应用便是 with 语句。

上面代码的正确写法如下:

for x in range(10000000):
    with open('test.txt', 'w') as f:
        f.write('hello')

每次打开文件 “test.txt” , 并写入 ‘hello’ 之后, 这个文件便会自动关闭, 相应的资源也可以得到释放, 防止资源泄露。

with 语句的代码, 也可以用下面的形式表示:

f = open('test.txt', 'w')
try:
    f.write('hello')
finally:
    f.close()

另外一个典型的例子, 是 Python 中的 threading.lock 类。

想要获取一个锁,执行相应的操作, 完成后再释放, 那么代码就可以写成下面这样:

some_lock = threading.Lock()
some_lock.acquire()
try:
    ...
finally:
    some_lock.release()

对应的 with 语句:

some_lock = threading.Lock()
with somelock:
    ...

上下问管理器的实现

基于类的上下文管理器

自定义了一个上下文管理类 FileManager, 模拟 Python 的打开、 关闭文件操作:

class FileManager:
    def __init__(self, name, mode):
        print('calling __init__ method')
        self.name = name
        self.mode = mode 
        self.file = None
    def __enter__(self):
        print('calling __enter__ method')
        self.file = open(self.name, self.mode)
        return self.file
    def __exit__(self, exc_type, exc_val, exc_tb):
        print('calling __exit__ method')
        if self.file:
            self.file.close() 
with FileManager('test.txt', 'w') as f:
    print('ready to write to file')
    f.write('hello world')
基于类的上下文管理器.png

必须保证这个类包括方法 ”enter()” 和方法 “exit()” 。 其中, 方法 “enter()” 返回需要被管理的资源, 方法 “exit()” 里通常会存在一些释放、 清理资源的操作,

使用with 语句, 执行这个上下文管理器时:

with FileManager('test.txt', 'w') as f:
    f.write('hello world')

下面这四步操作会依次发生:

  1. 方法 “init()” 被调用, 程序初始化对象 FileManager, 使得文件名(name)是 "test.txt" , 文件模式 (mode) 是 'w' ;
  2. 方法 “enter()” 被调用, 文件 “test.txt” 以写入的模式被打开, 并且返回 FileManager对象赋予变量 f;
  3. 字符串 “hello world” 被写入文件 “test.txt” ;
  4. 方法 “exit()” 被调用, 负责关闭之前打开的文件流

方法 “exit()” 中的参数 “exc_type, exc_val, exc_tb” , 分别表⽰exception_type、 exception_value 和 traceback。 当我们执行含有上下文管理器的 with 语句时, 如果有异常抛出, 异常的信息就会包含在这三个变量中, 传入方法 “exit()” 。

我们就可以在方法 “exit()”中添加相应的异常处理,例子如下:

class Foo:
    def __init__(self):
        print('__init__ called')        
    def __enter__(self):
        print('__enter__ called')
        return self
    def __exit__(self, exc_type, exc_value, exc_tb):
        print('__exit__ called')
        if exc_type:
            print(f'exc_type: {exc_type}')
            print(f'exc_value: {exc_value}')
            print(f'exc_traceback: {exc_tb}')
            print('exception handled')
        return True
with Foo() as obj:
    raise Exception('exception raised').with_traceback(None)
“__exit__()”中添加相应的异常处理.png

基于生成器的上下文管理器

可以使用装饰器 contextlib.contextmanager, 来定义自己所需的基于生成器的上下文管理器, 用以支持with 语句。

前面的类上下文管理器 FileManager可以如下改写:

from contextlib import contextmanager
@contextmanager
def file_manager(name, mode):
    try:
        f = open(name, mode)
        yield f
    finally:
        f.close()     
with file_manager('test.txt', 'w') as f:
    f.write('hello world')
基于生成器的上下文管理器.png

函数 file_manager() 是一个生成器, 当我们执行 with 语句时, 便会打开文件, 并返回文件对象 f;当 with 语句执行完后, finally block 中的关闭文件操作便会执行。

不要忘记在方法 “exit()” 或者是 finally block 中释放资源

参考资料:

极客时间 Python核心技术与实战学习

Python核心技术与实战(极客时间)链接:
http://gk.link/a/103Sv


GitHub链接:
https://github.com/lichangke/LeetCode

知乎个人首页:
https://www.zhihu.com/people/lichangke/

简书个人首页:
//www.greatytc.com/u/3e95c7555dc7

个人Blog:
https://lichangke.github.io/

欢迎大家来一起交流学习

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

推荐阅读更多精彩内容