如何在 Pytest 中彻底清理每个测试函数创建的数据库数据

云晨君_2368

云晨君_2368

2026-04-02

543人浏览

原创

在 FastAPI + SQLAlchemy 的单元测试中,仅靠 session.rollback() 无法清除其他会话(如 API 服务端)写入的数据;需通过事务隔离、表截断或依赖注入统一会话来确保测试间数据完全隔离。

在 fastapi + sqlalchemy 的单元测试中,仅靠 `session.rollback()` 无法清除其他会话(如 api 服务端)写入的数据;需通过事务隔离、表截断或依赖注入统一会话来确保测试间数据完全隔离。

在 Pytest 中为 FastAPI 编写数据库集成测试时,一个常见却易被忽视的问题是:测试函数内创建的数据未被真正清除,导致后续测试因残留数据而失败。根本原因在于——session.rollback() 只能回滚当前 SQLAlchemy 会话中尚未提交(commit)的变更,而你的 FastAPI 应用在处理 client.get() 请求时,使用的是独立的、由应用自身管理的数据库会话(通常通过依赖注入 get_db 提供)。该会话在请求结束时已自动 commit,因此 test_can_api_return_all_posts... 中创建的 5 篇文章已持久化到数据库,导致 test_can_api_detect_there_is_no_post... 读取到非空结果,断言失败。

✅ 推荐解决方案(按优先级排序)

方案一:统一数据库会话(推荐 ✅)

让测试客户端与应用服务端共享同一个测试会话,从根本上避免跨会话数据污染。这是 FastAPI 官方文档倡导的最佳实践:

# conftest.py 或测试模块顶部
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
from your_app.database import Base, get_db  # 替换为实际路径
from your_app.main import app  # FastAPI 实例

# 创建测试专用内存/临时数据库(推荐使用 PostgreSQL/SQLite 临时库)
TEST_DATABASE_URL = "sqlite:///./test.db"  # 或使用 :memory: 实现进程内隔离

engine = create_engine(TEST_DATABASE_URL, echo=False)
TestingSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

@pytest.fixture(scope="function")
def session():
    # 每次测试前重建表结构(确保干净状态)
    Base.metadata.create_all(bind=engine)
    db = TestingSessionLocal()
    try:
        yield db
    finally:
        db.rollback()  # 回滚本会话未提交变更
        db.close()
        Base.metadata.drop_all(bind=engine)  # 彻底清空(可选,配合 create_all 使用)

# 重载 FastAPI 的数据库依赖
@pytest.fixture(scope="function", autouse=True)
def override_dependency(session):
    app.dependency_overrides[get_db] = lambda: session
    yield
    app.dependency_overrides.clear()

✅ 优势:零数据残留、事务级原子性、性能好、符合测试隔离原则。
⚠️ 注意:确保 get_db 是你应用中实际注入数据库会话的依赖函数名。

方案二:测试后全局截断表(备选 ⚠️)

若因架构限制无法统一会话(如复用真实数据库连接),可在 fixture 结束时强制清空所有表:

import contextlib
from sqlalchemy import text

@pytest.fixture(scope="function")
def session(engine):
    Session = sessionmaker(bind=engine)
    session = Session()
    yield session
    session.rollback()
    session.close()

    # 强制清空所有表(PostgreSQL/SQLite 兼容写法)
    with contextlib.closing(engine.connect()) as conn:
        trans = conn.begin()
        # 按外键依赖逆序截断,避免约束冲突
        for table in reversed(Base.metadata.sorted_tables):
            conn.execute(text(f'TRUNCATE TABLE "{table.name}" RESTART IDENTITY CASCADE;'))
        trans.commit()

⚠️ 注意:TRUNCATE 在某些数据库(如 MySQL)中不支持 CASCADE,需改用 DELETE FROM table + ALTER SEQUENCE;生产环境禁止使用此方式。

❌ 不推荐的做法

  • 仅依赖 session.rollback():无法影响其他会话的已提交数据;
  • 在测试函数末尾手动 DELETE:易遗漏关联表、逻辑冗余、破坏测试简洁性;
  • 使用 scope="module" 级会话:多个测试共享状态,违背单元测试“独立性”原则。

总结

测试数据隔离的核心在于 控制数据库会话生命周期与作用域。优先采用「统一会话 + 事务回滚」方案,它轻量、可靠且与 FastAPI 设计哲学一致;若必须操作真实数据库,则辅以 TRUNCATE 清理,但务必验证 SQL 兼容性与执行权限。无论哪种方式,都应在 pytest fixture 的 yield 后置操作中完成清理,确保每次测试始于完全空白的数据库状态。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1771

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4624

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27357

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3307

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3307

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2563

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.9万人学习