讲师中心 微信公众号
AI工具推荐 视频效率加速

为什么Python项目中推荐采用src目录结构进行模块布局

小婷同学_1407

小婷同学_1407

发布时间:2026-09-14 08:25:27

|

559人浏览过

|

来源于php中文网

原创

src目录结构通过物理隔离源码强制统一开发与用户环境:必须pip install -e .才能导入,避免本地侥幸成功;关键需在pyproject.toml的[project]中配置packages = [{include = "mypackage", from = "src"}],否则无效。

为什么python项目中推荐采用src目录结构进行模块布局

src目录结构能避免“本地导入侥幸成功”导致的环境不一致

你写完代码,python main.py 一跑就通,但用户 pip install mypackage 后却报 ModuleNotFoundError——这大概率是因为你没用 src/。Python 默认把当前工作目录(也就是项目根目录)加进 sys.path[0],所以扁平结构下,import mypackage 实际加载的是本地文件夹,不是安装后的包。而 src/ 把源码物理隔离,强制你必须先 pip install -e . 才能正常导入,让开发环境和用户环境行为对齐。

pyproject.toml里不配packages.from="src",src就等于白建

只建 src/ 目录不生效,关键在构建配置。常见错误是只写了 [build-system] 段,却漏掉 [project] 中的包声明:

[project]
name = "mypackage"
version = "0.1.0"
# 必须显式告诉打包工具:包名叫 mypackage,代码在 src/ 下
packages = [{include = "mypackage", from = "src"}]

验证是否生效很简单:pip install -e . && python -c "import mypackage; print(mypackage.__file__)",输出路径里必须含 src/,否则就是配置没起作用。

tests/ 必须与 src/ 平级,且用绝对导入而非相对路径

测试目录放错位置或写错导入语句,会直接绕过 src 的保护机制:

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载

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

  • ❌ 错误:把 tests/ 塞进 src/ 里,或放在子目录中
  • ❌ 错误:测试文件里写 from src.mypackage.utils import helper
  • ✅ 正确:tests/ 和 src/ 平级;测试中统一用 from mypackage.utils import helper

这样 pytest 在根目录运行时,才能通过已安装的包路径导入,而不是靠临时修改 sys.path 或硬编码路径——后者会让 CI 环境和本地行为不一致。

IDE 和类型检查器依赖 pyproject.toml 的 packages 声明

VS Code、PyCharm、mypy 这些工具不会自动理解 “src 是源码根”,它们靠 pyproject.toml 里的 packages 配置定位模块。如果没配,IDE 可能标红 from mypackage import xxx,类型检查也会失效。这不是插件问题,是配置缺失。尤其当你用 __init__.py 做版本声明(比如 __version__ = "0.1.0"),Flit 或 Hatch 会从这里读取动态版本——但前提是它们得先找到这个包,而这完全依赖 packages.from="src"。

真正容易被忽略的点是:src 不是目录习惯,而是导入契约。它不解决“怎么写代码”,而是定义“代码该怎么被加载”。一旦跳过这层约束,后续所有测试、CI、协作、发布都会在某个时间点突然崩塌——往往发生在你以为项目“差不多能用了”的时候。

热门AI工具

更多
讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

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

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

1771

2023.07.20

python能做什么
python能做什么

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

4604

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

27157

2023.08.03

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

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

3287

2023.08.04

python eval
python eval

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

3287

2023.08.04

scratch和python区别
scratch和python区别

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

1203

2023.08.11

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

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

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

80

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn