Python上下文管理器详解:with语句与contextlib模块实战

小岛来信
小岛来信
发布时间:2026-10-16| 4人浏览过
原创

本文深入解析Python上下文管理器,通过对比with语句与常规文件操作,阐明其自动资源释放的优势。详细讲解基于类的__enter__和__exit__实现原理,包括异常处理参数exc_type、exc_val和exc_tb的作用。最后介绍利用contextlib模块和生成器yield简化上下文管理器创建的方法,帮助开发者编写更安全、简洁的代码。

一、什么是上下文管理器

在处理文件时,我们常遇到如下代码结构,这正是上下文管理器的典型应用:


with open('test.txt', encoding='utf-8') as f:
    print(f.readlines())

该代码用于打开当前目录下的test.txt文件并读取打印其内容,其功能等价于以下常规写法:


f = open('test.txt', encoding='utf-8')
print(f.readlines())
f.close()

对比上述两种写法可知,使用with语句可自动调用f.close()关闭文件,从而减少手动管理资源所需的代码量。

那么,这种上下文管理器具体是如何实现的?下文将为您详细解析。

二、如何实现上下文管理器

1. 通过类实现

若要实现前述open所描述的上下文管理器功能,可通过定义一个类,并分别添加__enter__和__exit__两个魔术方法来完成,具体代码示例如下:


class DiyOpen(object):

    def __init__(self, filename, **kwargs):
        self.f = open(filename, **kwargs)

    def __enter__(self):
        return self.f

    def __exit__(self, exc_type, exc_val, exc_tb):
        print('关闭文件')
        self.f.close()


with DiyOpen('test.txt', encoding='utf-8') as f:
    print(f.readlines())

输出结果

['第一行\n', '第二行\n', '第三行'] 关闭文件

从输出可见,在打印文件内容结束后,自动触发了关闭文件的操作。

那么__enter__和__exit__的具体含义是什么?此外,__exit__方法接收的exc_type、exc_val和exc_tb这三个参数又代表什么?

1)_enter_

__enter__相对直观:当执行with语句时,该方法会被触发;若该方法有返回值,则将其赋值给as子句声明的变量,即示例中as f所绑定的f。

2)_exit_

__exit__在with块执行完毕后自动调用,其后续参数的含义如下:

  • exc_type:异常类型
  • exc_val:异常原因e
  • xc_tb:堆栈追踪信息

当with块内的代码发生报错时,除了停止执行with包含的代码外,还会将错误信息分别填入上述三个参数中。例如以下代码:


class DiyOpen(object):

    def __init__(self, filename, **kwargs):
        self.f = open(filename, **kwargs)

    def __enter__(self):
        return self.f

    def __exit__(self, exc_type, exc_val, exc_tb):
        print(exc_type)
        print(exc_val)
        print(exc_tb)
        self.f.close()


with DiyOpen('test.txt', encoding='utf-8') as f:
    print(f.no())

输出结果

<class 'AttributeError'> '_io.TextIOWrapper' object has no attribute 'no' <traceback object at 0x000002A34B834900>

需要注意的是:

  • 我们可以手动指定__exit__的返回值为True,以阻止异常向外抛出。
  • 若无异常发生,上述三个参数的值均为None。

2. 通过contextlib实现

Python内置了contextlib模块用于实现上下文管理器,该模块基于生成器yield机制工作,它允许我们无需创建类和__enter__/__exit__方法。

通过contextlib实现open功能的代码如下:


from contextlib import contextmanager

@contextmanager
def diy_open(filename, **kwargs):
    f = open(filename, **kwargs)  # __init__
    try:
        yield f  # __enter__
    finally:  # __exit__
        f.close()

with diy_open('test.txt', encoding='utf-8') as f:
    print(f.readlines())

总结

本文到此结束,希望能为读者提供帮助,也欢迎持续关注本站获取更多技术内容!

相关标签:

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。