0

0

Python 项目目录结构最佳实践

舞夢輝影

舞夢輝影

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

|

556人浏览过

|

来源于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" 定位到项目根下独立目录。

简单库存管理系统
简单库存管理系统

本系统是一个基于工厂模式的三层架构项目,基于VS2005 开发,结构简洁,配合动软Codematic代码生成器,可以使开发效率事半功倍,倍感轻松。本系统主要功能 1,物品类别管理 实现了物品类别的添加、修改、删除功能,方便库存物品分类管理。 2,物品管理 实现物品添加、修改,管理员可实时对物品做出库、入库记录,也可查看详细历史出入库记录。 3,商家管理 实现商家添加、修改、删除功能,方便公司和客户

下载

建议结构:

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

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

778

2023.06.15

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

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

685

2023.07.20

python能做什么
python能做什么

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

769

2023.07.25

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

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

739

2023.07.31

python教程
python教程

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

1445

2023.08.03

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

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

571

2023.08.04

python eval
python eval

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

580

2023.08.04

scratch和python区别
scratch和python区别

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

752

2023.08.11

拼多多赚钱的5种方法 拼多多赚钱的5种方法
拼多多赚钱的5种方法 拼多多赚钱的5种方法

在拼多多上赚钱主要可以通过无货源模式一件代发、精细化运营特色店铺、参与官方高流量活动、利用拼团机制社交裂变,以及成为多多进宝推广员这5种方法实现。核心策略在于通过低成本、高效率的供应链管理与营销,利用平台社交电商红利实现盈利。

14

2026.01.26

热门下载

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

精品课程

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

共4课时 | 21.8万人学习

Django 教程
Django 教程

共28课时 | 3.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

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

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