Python中@contextmanager装饰器的概念、注意事项与实例解析

Aria
Aria
发布时间:2026-10-15| 3人浏览过
原创

本文深入解析Python中@contextmanager装饰器的用法。该装饰器位于contextlib模块,允许通过函数定义上下文管理器,无需创建完整类。文章详细说明了其工作原理:yield前代码对应__enter__,yield后对应__exit__,并提供了计时、文件操作及数据库事务处理的实例代码,帮助开发者简化资源管理逻辑。

在Python编程中,装饰器常用于辅助方法功能。在上下文管理器的学习中,@contextmanager是一个重要的装饰器,它允许开发者在普通函数中定义上下文管理器逻辑,从而简化代码结构。接下来将详细介绍@contextmanager的概念、使用时的注意事项以及具体应用实例。

1、概念

@contextmanager是contextlib模块提供的装饰器,旨在将一个普通函数转换为上下文管理器。使用它无需手动创建类或单独实现__enter__()和__exit__()方法,即可实现上下文管理功能。

2、注意

@contextmanager的核心作用并非单纯简化上下文管理器的编写,而是定义上下文管理器的行为。它可以将原本不具备上下文管理器接口的类或函数,转换为支持上下文管理语法的对象。

3、实例


from contextlib import contextmanager
import time
@contextmanager
def demo(label):
  start = time.time()
  try:
    yield
  finally:
    end = time.time()
    print('{}: {}'.format(label, end - start))

with demo('counting'):
  n = 10000000
  while n > 0:
    n -= 1
# counting: 1.32399988174

参考上述代码示例,函数中yield语句之前的代码逻辑类似于上下文管理器中的__enter__方法部分;而yield之后的代码则对应__exit__方法的内容。若在执行过程中发生异常,异常处理逻辑将在yield语句处触发。

实例扩展:

实例一:


from contextlib import contextmanager
class File():
  def query(self):
    print('查询文件')

@contextmanager
def open():
  print('打开文件')
  yield File()
  print('关闭文件')

with open() as f:
  f.query()
  
# 结果 打开文件 查询文件 关闭文件

实例二:


from contextlib import contextmanager
class DataBase():
  def query(self):
    print('写入操作')
  @contextmanager
  def open(self):
    try:
      yield
      self.commit()
    except Exception as e:
      self.rollback()
      raise e

db = DataBase()
with db.open():
  db.query()

至此,关于Python中@contextmanager的用法介绍完毕。如需了解更多关于python中@contextmanager的知识,可查阅本站历史文章或继续阅读后续内容,感谢支持!

相关标签:

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

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 算法库。