0

0

Python 项目目录结构最佳实践

舞夢輝影

舞夢輝影

发布时间:2026-01-26 17:52:03

|

576人浏览过

|

来源于php中文网

原创

不能把所有代码塞进一个 main.py,因为会导致运行时导入错误、测试无法隔离、依赖难管理、CI/CD 构建失败,最常见的是 ModuleNotFoundError;必须使用 src/ 目录结构并正确配置 pyproject.toml 和包安装方式。

python 项目目录结构最佳实践

为什么不能把所有代码塞进一个 main.py

因为运行时导入会出错、测试无法隔离、依赖难管理、CI/CD 构建失败——最常见的是 ModuleNotFoundError: No module named 'xxx'。Python 的模块搜索路径(sys.path)默认只含当前目录和 site-packages,没有自动识别“项目根目录”的逻辑。你手动改 sys.path 或靠 IDE 注入路径,上线后就崩。

src/ 目录不是可选,是必须

把源码统一放在 src/ 下,能彻底切断“当前工作目录决定导入行为”的耦合。安装包时用 setuptoolspackage_dir={"": "src"} 映射,确保 pip install -e . 后,无论从哪执行脚本,import myproject 都指向 src/myproject/

示例结构:

myproject/
├── pyproject.toml
├── src/
│   └── myproject/
│       ├── __init__.py
│       ├── core.py
│       └── cli.py
└── tests/
    └── test_core.py

关键点:

立即学习Python免费学习笔记(深入)”;

  • pyproject.toml 中必须声明 packages = [{include = "myproject", from = "src"}](或用 find 配置)
  • 测试文件不能放在 src/ 里,否则会被打包进 wheel
  • 不推荐用 setup.py,它已过时且易绕过 src/ 隔离

配置文件和数据文件放哪?别放 src/

编码路径或用 __file__ 往上跳级找配置,会导致单元测试失败、Docker 构建时找不到文件、Windows/macOS 路径分隔符报错。正确做法是:由入口脚本(如 src/myproject/cli.py)接收配置路径参数,或通过环境变量指定,默认值用 pathlib.Path(__file__).parent.parent / "config" 定位到项目根下独立目录。

MusicAI
MusicAI

AI音乐生成工具

下载

建议结构:

myproject/
├── config/
│   ├── dev.yaml
│   └── prod.yaml
├── data/
│   └── sample.csv
├── src/
└── tests/

这样部署时可单独挂载 config/,测试时也能用 tmp_path 模拟。

测试和类型检查要覆盖真实导入路径

如果测试直接 import myproject.core 成功,但 python -m pytest tests/ 报错,说明测试没走 src/ 安装路径。必须确保:

  • 测试命令在项目根目录执行(不是 tests/ 子目录)
  • pytest.inipyproject.toml 中设 testpaths = ["tests"],不加 python_paths 等 hack
  • mypy 运行时传 --package myproject,而非对 src/myproject/ 目录扫描

否则类型检查会漏掉跨模块引用错误,比如 myproject.cli 导入 myproject.core 时用了未标注的返回值。

真正卡住人的从来不是目录怎么画,而是第一次 pip install -e . 后,发现 import 不生效、测试跑不通、CI 里路径全错——这些都源于没把 src/ 当成边界,而把它当成可有可无的装饰。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

373

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

437

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

803

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

371

2025.07.23

windows查看端口占用情况
windows查看端口占用情况

Windows端口可以认为是计算机与外界通讯交流的出入口。逻辑意义上的端口一般是指TCP/IP协议中的端口,端口号的范围从0到65535,比如用于浏览网页服务的80端口,用于FTP服务的21端口等等。怎么查看windows端口占用情况呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1518

2023.07.26

查看端口占用情况windows
查看端口占用情况windows

端口占用是指与端口关联的软件占用端口而使得其他应用程序无法使用这些端口,端口占用问题是计算机系统编程领域的一个常见问题,端口占用的根本原因可能是操作系统的一些错误,服务器也可能会出现端口占用问题。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1172

2023.07.27

windows照片无法显示
windows照片无法显示

当我们尝试打开一张图片时,可能会出现一个错误提示,提示说"Windows照片查看器无法显示此图片,因为计算机上的可用内存不足",本专题为大家提供windows照片无法显示相关的文章,帮助大家解决该问题。

836

2023.08.01

windows查看端口被占用的情况
windows查看端口被占用的情况

windows查看端口被占用的情况的方法:1、使用Windows自带的资源监视器;2、使用命令提示符查看端口信息;3、使用任务管理器查看占用端口的进程。本专题为大家提供windows查看端口被占用的情况的相关的文章、下载、课程内容,供大家免费下载体验。

463

2023.08.02

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号