Python with语句与上下文管理器使用说明

cugleem

于 2025-05-17 13:35:21 发布

阅读量456

点赞数 14

分类专栏： python技巧分享文章标签： python 开发语言

本文链接：https://blog.csdn.net/qq_17275369/article/details/148005345

版权

python技巧分享专栏收录该内容

28 篇文章

订阅专栏

Python `with` 语句与上下文管理器使用说明

with 语句是 Python 中用于资源管理的强大工具，它通过上下文管理器（Context Manager）实现了优雅的资源获取与释放机制。

一、`with` 语句的基本概念

1.1 什么是 `with` 语句

with 语句用于包装代码块的执行，允许开发者在进入和退出代码块时执行特定的操作。最常见的用途是确保文件、锁等资源在使用后被正确释放。

1.2 基本语法

with context_expression as target:
    # with 语句块
    # 在这里使用资源
# 离开这个块后，资源会被自动清理

1.3 经典示例：文件操作

# 传统方式
f = open('file.txt', 'r')
try:
    data = f.read()
finally:
    f.close()

# 使用 with 语句
with open('file.txt', 'r') as f:
    data = f.read()
# 文件会在代码块结束后自动关闭

二、上下文管理器的实现原理

2.1 上下文管理器协议

上下文管理器通过实现 __enter__ 和 __exit__ 两个特殊方法来定义：

__enter__(): 进入上下文时调用，返回值赋给 as 后的变量
__exit__(exc_type, exc_val, exc_tb): 退出上下文时调用，处理异常和清理工作

2.2 自定义上下文管理器示例

class MyContextManager:
    def __enter__(self):
        print("进入上下文")
        return self  # 可以返回任何值，通常返回 self 或资源对象
    
    def __exit__(self, exc_type, exc_val, exc_tb):
        print("退出上下文")
        if exc_type:  # 如果有异常发生
            print(f"异常处理: {exc_type}, {exc_val}")
        # 返回 True 表示异常已处理，False 或 None 会让异常继续传播
        return True  

# 使用自定义上下文管理器
with MyContextManager() as cm:
    print("在上下文中执行代码")
    # raise ValueError("故意抛出异常")  # 可以取消注释测试异常处理

三、`contextlib` 模块的工具

Python 标准库中的 contextlib 模块提供了创建上下文管理器的便捷方式。

3.1 `@contextmanager` 装饰器

使用生成器函数快速创建上下文管理器：

from contextlib import contextmanager

@contextmanager
def my_context():
    print("进入上下文 (准备资源)")
    resource = "资源对象"
    try:
        yield resource  # 这里是 with 块执行的地方
    finally:
        print("退出上下文 (清理资源)")

# 使用
with my_context() as r:
    print(f"在上下文中使用资源: {r}")
    # 资源会自动清理

3.2 其他实用工具

closing(thing): 为具有 close() 方法的对象创建上下文管理器
suppress(*exceptions): 抑制指定异常
nullcontext(): 什么都不做的上下文管理器

from contextlib import closing, suppress, nullcontext

# closing 示例
with closing(open('file.txt')) as f:
    data = f.read()

# suppress 示例
with suppress(FileNotFoundError):
    os.remove('somefile.tmp')

# nullcontext 示例
with nullcontext():
    print("这个上下文管理器什么都不做")

四、高级用法

4.1 嵌套上下文管理器

with open('input.txt') as fin, open('output.txt', 'w') as fout:
    for line in fin:
        fout.write(line.upper())

4.2 上下文管理器组合

from contextlib import ExitStack

with ExitStack() as stack:
    files = [stack.enter_context(open(fname)) for fname in filenames]
    # 所有文件会在退出时自动关闭

4.3 异步上下文管理器 (Python 3.5+)

class AsyncContextManager:
    async def __aenter__(self):
        print("异步进入上下文")
        return self
    
    async def __aexit__(self, exc_type, exc, tb):
        print("异步退出上下文")

async def main():
    async with AsyncContextManager() as acm:
        print("在异步上下文中")

# 运行: asyncio.run(main())

五、实际应用场景

5.1 资源管理

class DatabaseConnection:
    def __enter__(self):
        self.conn = connect_to_database()
        return self.conn
    
    def __exit__(self, exc_type, exc_val, exc_tb):
        self.conn.close()

with DatabaseConnection() as conn:
    conn.execute_query(...)

5.2 计时器

import time
from contextlib import contextmanager

@contextmanager
def timer():
    start = time.perf_counter()
    try:
        yield
    finally:
        end = time.perf_counter()
        print(f"耗时: {end - start:.3f}秒")

with timer():
    # 执行一些耗时操作
    time.sleep(1)

5.3 临时环境修改

import os
from contextlib import contextmanager

@contextmanager
def temporary_env(**kwargs):
    old_env = {k: os.environ.get(k) for k in kwargs}
    os.environ.update(kwargs)
    try:
        yield
    finally:
        for k, v in old_env.items():
            if v is None:
                os.environ.pop(k, None)
            else:
                os.environ[k] = v

with temporary_env(DEBUG='1'):
    print(os.getenv('DEBUG'))  # 输出 '1'
print(os.getenv('DEBUG'))      # 恢复原值