如何在Python中组织大型项目的pytest目录结构

冬伟同学_1878

冬伟同学_1878

2026-11-19

436人浏览

原创

pytest测试需满足可发现性:文件须置于tests/或根目录,命名test_.py或_test.py且函数以test_开头;源码在src/时,应在pyproject.toml中配置pythonpath=["src"]确保导入;推荐按unit/integration/e2e分层而非与源码文件一一对应。

如何在python中组织大型项目的pytest目录结构

pytest目录结构要先满足“可发现性”,不是越深越好

pytest默认只在当前目录及子目录中递归查找test_*.py或*_test.py文件,且要求测试函数名以test_开头。如果目录嵌套过深、命名不规范,pytest根本不会执行——连报错都不会有,直接显示no tests ran。

常见错误现象:pytest运行后提示0 passed,但明明写了测试;或者只跑了一部分测试,另一些“消失”了。

  • 测试文件必须放在tests/(推荐)或项目根目录下,不能藏在src/或app/内部
  • 避免用__init__.py把tests/变成包——pytest不需要它,反而可能因导入路径干扰导致ImportError
  • 若项目源码在src/下,需通过python -m pytest或配置pythonpath确保测试能导入模块,而不是靠sys.path.append()硬塞

如何让测试正确导入源码:pyproject.toml里配pythonpath比改__init__.py更稳

大型项目通常把源码放在src/下(如src/myapp/),此时测试文件tests/test_core.py想导入myapp.core,会遇到ModuleNotFoundError。这不是pytest的问题,是Python模块搜索路径问题。

最可靠的做法是在pyproject.toml中声明:

[tool.pytest.ini_options]
pythonpath = ["src"]

这样pytest启动时自动把src/加入sys.path,所有测试都能干净导入myapp.*模块。

  • 不要在每个test_*.py里写sys.path.insert(0, "../src")——路径易错、不可移植、CI里常失效
  • 不要给tests/加__init__.py并尝试相对导入,pytest不按包逻辑加载测试模块
  • 如果用了setuptools的src布局,确认setup.py或pyproject.toml中packages配置与实际结构一致,否则pip install -e .后仍可能导入失败

测试分层建议:按功能边界切,别按代码文件一对一复制

有人习惯为每个.py写一个test_*.py,比如src/myapp/db.py → tests/test_db.py。这在初期可行,但项目变大后会导致测试耦合、维护成本飙升——比如db.py重构后,几十个测试文件都要检查是否受影响。

更可持续的做法是按「能力」或「场景」组织测试,而非按「实现文件」:

Python健壮编程
Python健壮编程

编写可靠Python代码,避免可变默认值、导入陷阱与运行时意外

下载
  • tests/unit/:纯函数、类方法,无外部依赖(用unittest.mock或pytest-mock隔离)
  • tests/integration/:连接真实DB、调用HTTP服务等,需环境准备(用pytest.fixture统一管理)
  • tests/e2e/:端到端流程,如模拟API请求→DB写入→缓存更新,通常运行慢、单独触发

示例结构:

myapp/
├── src/
│   └── myapp/
│       ├── __init__.py
│       ├── core.py
│       └── db.py
├── tests/
│   ├── __init__.py  # 可选,仅当需跨测试共享fixture时放空文件
│   ├── conftest.py  # 所有测试共用fixture、插件配置
│   ├── unit/
│   │   ├── test_core.py
│   │   └── test_db.py
│   ├── integration/
│   │   └── test_database_session.py
│   └── e2e/
│       └── test_user_signup_flow.py

conftest.py不是万能胶水,滥用会导致测试隐式依赖

conftest.py能让同级及子目录下的测试自动访问其中定义的fixture和hook,但它不支持跨目录继承——比如tests/unit/conftest.py里的fixture,tests/integration/下的测试拿不到。

容易踩的坑:

  • 在tests/conftest.py里全局mock某个模块(如requests.get),结果所有测试都绕过了真实网络调用,集成测试失去意义
  • 把数据库连接池、Redis客户端等重资源fixture设为scope="session",但没做清理,导致后续测试读到脏数据
  • 在conftest.py里修改sys.path或os.environ,影响其他测试的环境一致性

建议原则:fixture作用域尽量窄,优先用scope="function";跨层级共享逻辑,提取成独立模块(如tests/fixtures/db.py),再显式import。

复杂点往往不在结构本身,而在测试间的状态污染和隐式约定——目录可以重命名,但fixture生命周期、模块导入路径、环境变量设置,一旦出错很难定位。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1951

4

python能做什么
python能做什么

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

2023.07.25

5564

7

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

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

2023.07.31

1889

3

python教程
python教程

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

2023.08.03

33937

23

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

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

2023.08.04

3987

5

python eval
python eval

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

2023.08.04

3987

5

scratch和python区别
scratch和python区别

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

2023.08.11

1283

5

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

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

2023.08.10

636

4

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

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

2023.08.11

3083

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程