0

0

Python 项目目录结构演进的典型路径

舞夢輝影

舞夢輝影

发布时间:2026-02-20 14:23:00

|

969人浏览过

|

来源于php中文网

原创

src/目录非初始必需,仅当打包发布、ci报错或import失败时才需引入;__init__.py在需相对导入或版本管理时必须保留;tests/应置于根目录,配置与资源须分离并用importlib.resources加载。

python 项目目录结构演进的典型路径

为什么 src/ 目录不是一开始就必须加的

刚跑通第一个 python main.py 时,把所有代码塞进项目根目录完全没问题。这时候加 src/ 反而多一层路径跳转,import 写起来还容易错。等你开始写测试、打包、或者被 CI 报 ModuleNotFoundError 卡住,才是考虑挪进去的信号。

常见错误现象:pytest 能跑通,但 pip install -e . 后在别处 import mypackage 失败;或者 python -m mypackage 提示找不到模块。

  • 真正触发 src/ 的典型场景:需要发布到 PyPI,或团队里有人习惯从任意路径运行你的包
  • setup.pypyproject.tomlpackages=find_packages() 默认不扫描 src/,得显式写成 find_packages(where="src") 并配 package_dir={"": "src"}
  • src/ 后,本地开发时 IDE 可能默认不把 src/ 加进 PYTHONPATH,要手动设或靠 pyproject.toml[tool.setuptools] 配置补上

__init__.py 什么时候可以删、什么时候必须留

Python 3.3+ 支持隐式命名空间包,但现实里删 __init__.py 很容易翻车——尤其当你的包要被 importlib.util.spec_from_file_location 或某些打包工具(如 pyinstaller)处理时。

使用场景差异明显:纯数据包(比如只放 JSON/YAML 配置)可尝试无 __init__.py;但只要涉及 from . import xxx、相对导入、或想用 pkg_resources 查版本,它就得在。

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

Unscreen
Unscreen

AI智能视频背景移除工具

下载
  • 删了 __init__.py 后,pip install -e . 可能成功,但 importlib.import_module("mypackage.submod")ModuleNotFoundError
  • __init__.py 为空文件也行,但建议至少写 __version__ = "0.1.0",方便后续统一管理版本
  • 如果用了 pyproject.toml + setuptools,且包结构是 src/mypackage/__init__.py,那 src/ 下不能有 __init__.py,否则会被当成另一个顶层包

测试目录放哪?tests/src/tests/ 哪个更实际

tests/ 放项目根目录是主流选择,不是因为“规范”,而是因为 pytest 默认就扫这个路径,tox 和 CI 脚本也认它。放进 src/ 里反而让测试变成“被安装的代码”,既没必要又可能引发权限或打包问题。

容易踩的坑在于路径假设:很多新手写 from mypackage import foo 在测试里跑得通,但一换机器或改 sys.path 就崩——其实只是当前工作目录碰巧在项目根下。

  • 确保 pytest 运行时,src/PYTHONPATH 中(推荐用 pyproject.toml[tool.pytest.ini_options]pythonpath = ["src"]
  • 不要在 tests/ 里写 sys.path.insert(0, "../src"),这种硬编码路径在 CI 或不同操作系统下极不可靠
  • 如果真要隔离测试依赖,用 conftest.py 里的 pytest_configure 动态加路径,比改 sys.path 更可控

配置文件和静态资源该不该跟代码混放

开发阶段放一起省事,但上线后,配置(尤其是密钥、环境变量)和静态资源(模板、CSS、图片)必须分离。硬编码路径如 os.path.join(os.path.dirname(__file__), "../config.yaml") 是典型坏味道——一旦打包成 wheel 或用 zipimport__file__ 指向的就是 zip 包内路径,根本找不到上级目录。

真实痛点常出现在 Docker 部署:镜像里只复制了 src/pyproject.toml,结果运行时报 FileNotFoundError: [Errno 2] No such file or directory: 'config.yaml'

  • 配置文件优先走环境变量(os.getenv("DB_URL")),次选命令行参数,最后才读文件;文件路径用 importlib.resources.files("mypackage").joinpath("config.yaml")(Python 3.9+)或 pkg_resources.resource_filename("mypackage", "config.yaml")(兼容旧版)
  • 静态资源(如 Jinja2 模板)别放在 src/mypackage/ 下跟 Python 文件混着,单独建 templates/static/ 根目录,用 importlib.resources 加载
  • 如果用了 MANIFEST.in,记得加 include *.yaml *.j2 *.css,否则 pip install 后这些文件根本不会进安装目录

目录结构不是越“标准”越好,而是越贴近你下一个部署场景越稳。很多人卡在“不知道该不该动”,其实答案就藏在下一次 pip installdocker build 报错的那行日志里。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

442

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

322

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

pip安装使用方法
pip安装使用方法

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

349

2023.10.09

更新pip版本
更新pip版本

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

426

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、保存并关闭文件即可。

787

2024.12.23

python升级pip
python升级pip

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

361

2025.07.23

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

776

2026.02.13

热门下载

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

精品课程

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

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.6万人学习

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

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