欢迎来到 Python 学习计划的第 64 天!🎉
昨天我们学习了 文件写入与编码问题,掌握了如何安全地保存数据。今天,我们将深入理解 Python 中最优雅的语法之一——with 语句(上下文管理器)。
这是 异常与文件模块的最后一天。掌握 with 的底层原理,你不仅能正确使用它,还能创建自己的上下文管理器,让资源管理更加自动化和安全!
一、什么是上下文管理器?
1. 定义
上下文管理器(Context Manager) 是实现了 __enter__ 和 __exit__ 方法的对象,用于管理资源的获取和释放。
2. 为什么需要它?
在 [File 90](90-else 与 finally 的执行时机.md) 中我们学习了 finally 用于资源清理,但每次都写 try-finally 很繁琐。with 语句将这一模式封装起来,让代码更简洁。
# ❌ 繁琐的 try-finallyf = open("data.txt", "r")try: content = f.read()finally: f.close()# ✅ 优雅的 with 语句with open("data.txt", "r") as f: content = f.read()# 自动关闭文件,即使发生异常
3. 核心优势
- 自动资源管理:无需手动关闭文件、连接等。
- 异常安全:即使块内发生异常,资源也会被正确释放。
- 代码简洁:减少样板代码,提高可读性。
二、with 语句的底层原理
1. 执行流程
with 语句的执行过程等价于以下代码:
# with 语句with expression as variable: block# 等价于manager = expressionvariable = manager.__enter__()try: blockfinally: manager.__exit__(*sys.exc_info())
2. 两个核心方法
方法 | 调用时机 | 返回值 | 作用 |
|---|
__enter__
| 进入 with 块时 | 返回给 as 后的变量 | 获取资源 |
__exit__
| 离开 with 块时 | None 或 False 传播异常
| 释放资源 |
3. 手动实现等价代码
class FileManager: def __init__(self, filename, mode): self.filename = filename self.mode = mode self.file = None def __enter__(self): print("进入 with 块") self.file = open(self.filename, self.mode) return self.file # 返回给 as 后的变量 def __exit__(self, exc_type, exc_val, exc_tb): print("离开 with 块") if self.file: self.file.close() # 返回 None 或 False,异常会继续传播 return False# 使用with FileManager("data.txt", "r") as f: content = f.read()
三、exit 方法详解
1. 参数说明
__exit__ 接收三个参数,用于处理异常信息:
def __exit__(self, exc_type, exc_val, exc_tb): """ exc_type: 异常类型(如 ValueError) exc_val: 异常值(如错误信息) exc_tb: 异常堆栈跟踪对象 """ if exc_type: print(f"发生异常:{exc_type.__name__}: {exc_val}") # 返回 True 抑制异常,返回 False 或 None 让异常继续传播
2. 异常抑制
如果 __exit__ 返回 True,异常会被抑制,不会向上传播。
class SuppressError: def __enter__(self): return self def __exit__(self, exc_type, exc_val, exc_tb): print("捕获并抑制异常") return True # 抑制异常with SuppressError(): raise ValueError("这个异常不会传播")print("程序继续执行") # 会执行
3. 记录异常信息
可以在 __exit__ 中记录异常日志,然后让异常继续传播。
import loggingclass LogErrors: def __enter__(self): return self def __exit__(self, exc_type, exc_val, exc_tb): if exc_type: logging.error(f"{exc_type.__name__}: {exc_val}") return False # 让异常继续传播with LogErrors(): raise ValueError("记录日志后继续传播")
四、contextlib 模块(简化实现)
Python 提供了 contextlib 模块,可以用更简单的方式创建上下文管理器。
1. @contextmanager 装饰器
使用生成器函数代替类实现。
from contextlib import contextmanager@contextmanagerdef open_file(filename, mode): f = open(filename, mode) try: yield f # yield 前的代码是 __enter__,之后是 __exit__ finally: f.close()# 使用with open_file("data.txt", "r") as f: content = f.read()
2. 带异常处理的生成器
from contextlib import contextmanager@contextmanagerdef transaction(db): db.begin() try: yield db db.commit() except Exception: db.rollback() raise # 重新抛出异常# 使用with transaction(database) as db: db.execute("INSERT INTO users ...")
3. closing() 工具
为有 close() 方法的对象快速创建上下文管理器。
from contextlib import closingimport urllib.requestwith closing(urllib.request.urlopen("http://example.com")) as response: content = response.read()
4. suppress() 工具
抑制特定异常,等价于前面的 SuppressError。
from contextlib import suppresswith suppress(FileNotFoundError): os.remove("不存在的文件.txt")# 不会抛出异常# 等价于try: os.remove("不存在的文件.txt")except FileNotFoundError: pass
五、OOP 实战应用
1. 数据库连接管理器
from typing import Optionalfrom contextlib import contextmanagerclass DatabaseConnection: """数据库连接上下文管理器""" def __init__(self, host: str, port: int, database: str): self.host = host self.port = port self.database = database self.connection = None def __enter__(self): print(f"连接到 {self.host}:{self.port}/{self.database}") # 模拟连接 self.connection = {"host": self.host, "connected": True} return self.connection def __exit__(self, exc_type, exc_val, exc_tb): print("关闭数据库连接") if self.connection: self.connection["connected"] = False # 返回 False,让异常继续传播 return False def execute(self, sql: str): if not self.connection or not self.connection["connected"]: raise RuntimeError("数据库未连接") print(f"执行 SQL: {sql}") return []# 使用with DatabaseConnection("localhost", 3306, "mydb") as db: db.execute("SELECT * FROM users")# 输出:# 连接到 localhost:3306/mydb# 执行 SQL: SELECT * FROM users# 关闭数据库连接
2. 计时器上下文管理器
import timefrom contextlib import contextmanager@contextmanagerdef timer(name: str = "操作"): """计时上下文管理器""" start = time.time() try: yield finally: elapsed = time.time() - start print(f"{name} 耗时:{elapsed:.4f}秒")# 使用with timer("数据处理"): time.sleep(1) result = sum(range(1000000))with timer("文件读取"): with open("data.txt", "w") as f: f.write("test")
3. 临时目录管理器
import osimport shutilfrom pathlib import Pathfrom contextlib import contextmanager@contextmanagerdef temporary_directory(path: str): """创建临时目录,退出时自动删除""" dir_path = Path(path) dir_path.mkdir(parents=True, exist_ok=True) print(f"创建临时目录:{dir_path}") try: yield dir_path finally: print(f"删除临时目录:{dir_path}") shutil.rmtree(dir_path, ignore_errors=True)# 使用with temporary_directory("temp/data") as tmp_dir: # 在临时目录中操作 (tmp_dir / "file.txt").write_text("内容") print(f"临时文件:{tmp_dir / 'file.txt'}")# 退出后目录自动删除
六、常见误区与注意事项
1. exit 返回值的影响
# 返回 True:抑制异常class SuppressAll: def __exit__(self, *args): return Truewith SuppressAll(): raise ValueError("不会传播")print("继续执行") # 会执行# 返回 False/None:传播异常class PropagateError: def __exit__(self, *args): return Falsewith PropagateError(): raise ValueError("会传播")print("不会执行") # 不会执行
2. 嵌套 with 语句
可以嵌套多个 with 语句,Python 3.10+ 支持括号写法。
# 传统写法with open("input.txt") as f_in: with open("output.txt", "w") as f_out: f_out.write(f_in.read())# Python 3.10+ 括号写法with ( open("input.txt") as f_in, open("output.txt", "w") as f_out): f_out.write(f_in.read())
3. 不要在 exit 中抛出异常
如果 __exit__ 中抛出异常,会覆盖 with 块中的原始异常。
class BadExit: def __exit__(self, *args): raise RuntimeError("清理时出错")with BadExit(): raise ValueError("原始错误")# 最终只看到 RuntimeError,原始错误丢失
4. yield 只能使用一次
使用 @contextmanager 时,生成器只能 yield 一次。
# ❌ 错误@contextmanagerdef bad_context(): setup() yield yield # 第二次 yield 会报错 cleanup()# ✅ 正确@contextmanagerdef good_context(): setup() try: yield finally: cleanup()
七、总结
知识点 | 说明 |
|---|
上下文管理器 | 实现 __enter__ 和 __exit__ 的对象 |
enter | 进入 with 块时调用,返回资源 |
exit | 离开 with 块时调用,清理资源 |
@contextmanager | 用生成器简化上下文管理器实现 |
suppress() | 抑制特定异常 |
closing() | 为有 close() 方法的对象创建上下文 |
异常传播 | __exit__ 返回 True 抑制,False 传播
|
核心要点
with 自动管理资源,无需手动 close()。__exit__ 接收异常信息,可选择是否抑制。@contextmanager 简化实现,用 yield 分隔进入和退出逻辑。- 嵌套
with 支持多资源管理,Python 3.10+ 支持括号语法。 - 不要在
__exit__ 中抛出异常,会覆盖原始错误。
🎉 模块总结:异常与文件(第 57-64 天)
📌 明日预告:为什么需要类型提示?
恭喜!你已完成 异常与文件模块(第 57-64 天)!
明天我们将回顾并进入 类型提示模块的复习与综合实战!
- 主题:类型提示与异常处理综合实战
- 核心问题:
- 如何为文件操作函数添加类型提示?
- 如何设计带异常处理的类型安全 API?
- 上下文管理器的类型如何标注?
- 综合项目:实现类型安全的配置管理器
💡 提前思考:
with open(...) as f: 中 f 的类型是什么?- 如何用类型提示表示函数可能抛出异常?
- 如何将今天学的上下文管理器与类型提示结合?