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

如何在大型Python企业项目中规范化管理多层级的包与目录结构?

落强酱_3816

落强酱_3816

发布时间:2026-11-04 07:36:33

|

354人浏览过

|

来源于php中文网

原创

src/my_project双层结构非多此一举,它通过隔离源码与项目根、配合可编辑安装和pyproject.toml配置,确保导入稳定、避免命名冲突、支持可靠测试与发布。

如何在大型python企业项目中规范化管理多层级的包与目录结构?

为什么 src/my_project 这种双层结构不是“多此一举”

很多人看到 src/ 下还套一层同名包(比如 src/my_project/),第一反应是“绕路”。但问题不在路径长,而在 Python 的导入机制和发布逻辑。如果你把所有代码平铺在项目根目录下,import utils 在运行时可能意外导入了本地未安装的 utils.py,也可能被系统已装的第三方 utils 包干扰——尤其当测试或 CI 环境里执行 python -m pytest 时,当前目录自动加入 sys.path,导致模块解析顺序错乱。

用 src/my_project 结构,配合 pyproject.toml 中的 [project] requires-python = ">=3.9" 和 [build-system] 配置,能确保: - 安装时只暴露 my_project 这个顶层包名(用户 pip install . 后只能 import my_project) - 开发时通过 pip install -e . 建立可编辑安装,避免相对导入或 sys.path 手动追加 - 测试运行时,pytest 自动识别 src/ 为源码根,from my_project.utils import helper 始终稳定

包内分层要按“变化频率”而非“功能名词”切

别一上来就建 models/、views/、controllers/——这种 MVC 切法在纯 Python 服务里容易僵化。真正影响维护成本的是“谁会频繁改、谁改了会影响谁”。比如:

  • 配置文件(config/)和日志工具(utils/logger.py)几乎不随业务迭代变动,适合放到底层,被所有模块依赖
  • 数据库模型(domain/models.py)和 API 序列化器(api/serializers.py)经常一起改,但和定时任务逻辑(tasks/)基本无关,应划到同一变更域
  • 第三方对接适配器(adapters/payment_gateway.py)必须隔离,因为换支付渠道时只动它,不能波及核心订单服务

所以推荐先按“稳定性梯度”建包:core/(最稳)、domain/(业务实体)、services/(编排逻辑)、adapters/(最易变),而不是按技术角色硬套。

__init__.py 不只是“让文件夹变包”的空文件

在大型项目里,__init__.py 是显式声明公共接口的契约文件。比如 my_project/services/__init__.py 里写:

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

Python Pep Authoring
Python Pep Authoring

依据官方 python/peps仓库规则起草、审阅、编辑或准备 Python 改进提案(PEP),用于处理 PEP 文本和元数据头部。

下载
from .order_service import create_order, cancel_order
from .user_service import get_user_profile
<p><strong>all</strong> = ["create_order", "cancel_order", "get_user_profile"]

这样外部 from my_project.services import * 才可控;否则 IDE 和静态检查工具(如 mypy)无法推断哪些符号是该模块对外承诺的。更关键的是,它防止内部重构时意外暴露私有实现——比如你把 _validate_payment 从 order_service.py 移到 utils/validation.py,只要不把它加进 __init__.py,上层代码就根本感知不到这个改动。

常见错误包括:__init__.py 留空导致子模块无法被正确发现;或过度导出(比如把整个 from . import * 放进去),造成循环导入风险。

tests/ 目录必须与 src/ 结构镜像,但不能复制导入路径

很多团队把 tests/ 放在根目录,里面建 test_services.py、test_adapters.py,看着整齐,但实际写测试时极易出错。正确做法是让 tests/ 的目录层级与 src/my_project/ 对齐,例如:

tests/
├── __init__.py
├── test_core.py
├── domain/
│   ├── __init__.py
│   └── test_models.py
├── services/
│   ├── __init__.py
│   └── test_order_service.py
└── adapters/
    ├── __init__.py
    └── test_payment_gateway.py

这样每个测试文件都能用绝对导入(from my_project.services.order_service import create_order),和生产代码一致。如果测试里写 from ..services import order_service 这类相对导入,一旦 pytest 工作目录切换(比如从项目根跑 vs 从 tests 目录跑),就会报 ImportError: attempted relative import with no known parent package。

容易忽略的一点:CI 脚本里必须显式指定 --import-mode=importlib(pytest 7.0+ 默认值),否则某些插件可能仍走旧路径解析逻辑,导致测试通过但本地复现失败。

热门AI工具

更多
Seko
Seko Hot

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

DeepSeek

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

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

超级简历WonderCV

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

WorkBuddy

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

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

1851

2023.07.20

python能做什么
python能做什么

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

5064

2023.07.25

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

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

1809

2023.07.31

python教程
python教程

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

30517

2023.08.03

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

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

3627

2023.08.04

python eval
python eval

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

3647

2023.08.04

scratch和python区别
scratch和python区别

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

1243

2023.08.11

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

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

616

2023.08.10

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

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

精品课程

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

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