目录/第 40 章 · 上下文管理器与 contextlib
第 40 章 / 70 · 进阶 · 语法机制

上下文管理器与 contextlib

with / __enter__ / __exit__ / @contextmanager / suppress / closing

先介绍1 个 demo6 个任务答案可展开

一、本章介绍

with 语句背后是「上下文管理器协议」:进入时调用 __enter__,离开时调用 __exit__,即使中途出错也能保证清理资源(关闭文件、释放锁、回滚事务)。

这一章先手写类实现协议,再学 contextlib 提供的快捷工具:@contextmanager 用生成器写上下文、suppress 忽略指定异常、nullcontext 空操作、closing 自动关闭对象。

本章要点

  • __enter__ 与 __exit__
  • with 自动清理资源
  • @contextmanager 生成器写法
  • contextlib.suppress 忽略异常
  • nullcontext 与 closing
  • 多个 with 同时管理

二、先看 demo

下面这个例子把本章涉及的用法尽量全面地串了一遍,代码带逐行注释,可以直接复制到本地 .py 文件运行。

案例

先看一个完整例子

介绍 · 逐行注释
from contextlib import contextmanager, suppress, nullcontext, closing

# 1) 手写协议类
class Tag:
    def __enter__(self):
        print("进入"); return self
    def __exit__(self, exc_type, exc, tb):
        print("退出"); return False   # False 表示不吞掉异常

with Tag() as t:
    print("做事")

# 2) @contextmanager:用生成器写上下文
@contextmanager
def tag2():
    print("开始")
    try:
        yield 42
    finally:
        print("结束")

with tag2() as v:
    print("值", v)

# 3) suppress 忽略指定异常
with suppress(ZeroDivisionError):
    1 / 0
print("依旧继续")

# 4) nullcontext 空上下文 / 多个 with
with nullcontext(7) as x, nullcontext(8) as y:
    print(x + y)

# 5) closing 自动调用 close()
class R:
    def close(self): print("已关闭")
with closing(R()) as r:
    print("用资源")
运行结果
进入
做事
退出
开始
值 42
结束
依旧继续
15
用资源
已关闭

要点:__exit__ 返回 False(默认不写返回值等价于 False)表示异常继续向外抛;返回 True 才会吞掉异常。@contextmanager 是最常用的写法:yield 之前是进入逻辑,yield 之后是清理逻辑,务必放在 finally 里。

三、6 个任务(自己先写,再看答案)

难度从入门到挑战逐步增加。每个任务的答案默认折叠,点开可看参考代码、运行结果;有第二种解法的也一并给出。代码都可以直接运行。

任务 1

自定义 __enter__/__exit__

自己写 · 附答案入门 ★☆☆
解题提示:本题主要用到 __enter__ 与 __exit__、with 自动清理资源、@contextmanager 生成器写法。先对照要求自己写一遍,卡住了再展开答案。

写个上下文类,进入返回 1,退出打印 bye

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
class C:
    def __enter__(self): return 1
    def __exit__(self,*a): print("bye")
with C() as x: print(x)
运行结果
1
bye
任务 2

异常时仍清理

自己写 · 附答案入门 ★☆☆
解题提示:本题主要用到 __enter__ 与 __exit__、with 自动清理资源、@contextmanager 生成器写法。先对照要求自己写一遍,卡住了再展开答案。

with 块里抛异常,验证 __exit__ 仍执行

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
class C:
    def __enter__(self): return self
    def __exit__(self,*a): print("清理")
try:
    with C():
        raise ValueError("x")
except ValueError:
    print("已捕获")
运行结果
清理
已捕获
任务 3

@contextmanager

自己写 · 附答案进阶 ★★☆
解题提示:本题主要用到 __enter__ 与 __exit__、with 自动清理资源、@contextmanager 生成器写法。先对照要求自己写一遍,卡住了再展开答案。

用 @contextmanager 写一个 yield 值的上下文

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
from contextlib import contextmanager
@contextmanager
def c():
    yield 9
with c() as v: print(v)
运行结果
9
任务 4

suppress 忽略异常

自己写 · 附答案进阶 ★★☆
解题提示:本题主要用到 __enter__ 与 __exit__、with 自动清理资源、@contextmanager 生成器写法。先对照要求自己写一遍,卡住了再展开答案。

用 suppress 忽略 ZeroDivisionError

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
from contextlib import suppress
with suppress(ZeroDivisionError):
    1/0
print("ok")
运行结果
ok
任务 5

多个 with

自己写 · 附答案挑战 ★★★
解题提示:本题主要用到 __enter__ 与 __exit__、with 自动清理资源、@contextmanager 生成器写法。先对照要求自己写一遍,卡住了再展开答案。

用两个 with 同时管理并打印结果

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
from contextlib import nullcontext
with nullcontext(2) as a, nullcontext(3) as b:
    print(a*b)
运行结果
6
任务 6

closing 自动关闭

自己写 · 附答案挑战 ★★★
解题提示:本题主要用到 __enter__ 与 __exit__、with 自动清理资源、@contextmanager 生成器写法。先对照要求自己写一遍,卡住了再展开答案。

用 closing 包一个带 close 的对象

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
from contextlib import closing
class R:
    def close(self): print("closed")
with closing(R()): print("using")
运行结果
using
closed