如何优化Python项目的测试结构设计_采用pytest的src布局避免导入冲突

风萱吖_9918

风萱吖_9918

2026-07-22

1103人浏览

原创

pytest + src 布局通过强制源码位于 src/ 下并配合 pyproject.toml 中 build-system、project.packages 和 pytest 配置,使模块导入路径唯一确定,彻底解决因当前目录被误判为包导致的导入冲突与 mock 失败问题。

如何优化python项目的测试结构设计_采用pytest的src布局避免导入冲突

为什么 pytest + src 布局能解决导入冲突

根本原因是 Python 的模块查找机制:当项目根目录被加入 sys.path(比如用 python -m pytest 启动),而你的模块又直接放在根下(如 myproject/main.py),pytest 会把根目录当成包来 import,导致 import myproject 和 from myproject import xxx 行为不一致——有时导入的是本地文件,有时是已安装的同名包,甚至报 ImportError: attempted relative import with no known parent package。

src 布局强制让所有源码只从 src/ 下发源,配合 pyproject.toml 中的 [build-system] 配置,pip 安装时自动把 src/ 加入路径,pytest 也能统一按包路径解析,彻底切断“当前目录即包”的歧义。

src 目录下怎么组织测试才能镜像又不冗余

tests/ 必须与 src/ 平级,且结构严格镜像,但不是复制粘贴。关键在“映射关系可预测”:

  • src/myapp/api/v1/endpoints.py → tests/test_api/test_v1/test_endpoints.py
  • src/myapp/shared/utils.py → tests/test_shared/test_utils.py
  • 测试文件名统一加 test_ 前缀,模块内函数用 def test_* 命名,pytest 才能自动发现
  • 不要在 tests/ 下建 __init__.py——它不是包,只是 pytest 的扫描路径;加了反而可能触发意外 import

pyproject.toml 里哪些配置决定 pytest 能否正确识别 src

缺一不可的三项:

  • [build-system] 必须指定构建后端,例如 requires = ["hatchling"],且 build-backend = "hatchling.build";setuptools 也行,但 hatchling 对 src 支持更干净
  • [project] 中的 name 和 packages 要匹配,推荐用 packages = [{include = "myapp", from = "src"}](把 src/myapp/ 当作安装包)
  • [tool.pytest.ini_options] 显式设 testpaths = ["tests"] 和 python_files = ["test_*.py"],避免 pytest 错扫根目录下的临时脚本

漏掉 packages 配置,pip install -e . 就不会把 src/myapp/ 注册进 site-packages,测试里 from myapp import ... 仍会失败。

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载

常见错误:测试里 mock 失败或找不到模块

90% 是路径错位导致的 patch 目标不对。比如你写:

from unittest.mock import patch

@patch("myapp.services.db.get_session")
def test_something(mock_session):
    ...

实际运行时却提示 ModuleNotFoundError: No module named 'myapp',说明 pytest 根本没把 myapp 当成可导入包——这时别急着改 patch 路径,先检查:

  • 是否执行过 pip install -e .(不是 pip install .)
  • python -c "import myapp; print(myapp.__file__)" 是否能成功输出路径?如果报错,说明安装未生效
  • 测试文件里 import myapp 是否报错?如果报错,patch 再准也没用
  • mock 路径必须是“运行时 import 的路径”,不是文件物理路径。例如 src/myapp/services/db.py 里的函数,在测试中应 patch "myapp.services.db.get_session",而非 "db.get_session"

最隐蔽的坑是 IDE 缓存:VS Code 或 PyCharm 可能沿用旧的 Python 解释器环境,删掉 .venv 重装、重启 IDE,比调半天 patch 更快。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1851

4

python能做什么
python能做什么

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

2023.07.25

5044

7

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

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

2023.07.31

1809

3

python教程
python教程

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

2023.08.03

30397

23

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

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

2023.08.04

3607

5

python eval
python eval

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

2023.08.04

3627

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2803

5

热门下载

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

精品课程

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