0

0

Python项目结构如何设计_工程化实践

冷漠man

冷漠man

发布时间:2026-03-13 12:16:03

|

154人浏览过

|

来源于php中文网

原创

Python项目结构设计核心是分层清晰、职责明确、便于测试与部署,推荐以src为源码根目录,按业务域(如orders/payments)而非技术层组织模块,用pyproject.toml统一管理依赖与构建,并通过pre-commit、pytest、venv等机制保障工程化落地。

python项目结构如何设计_工程化实践

Python项目结构设计核心是“分层清晰、职责明确、便于测试与部署”。不是越复杂越好,而是让新成员能快速理解、CI/CD流程能稳定运行、本地开发和生产环境行为一致。

基础目录骨架:从src开始隔离源码

避免把模块直接放在项目根目录(即不推荐 myproject/xxx.py),而是用 src/ 显式包裹源码:

  • src/myapp/:主包,含 __init__.py,所有业务逻辑、API、模型放这里
  • tests/:与 src/ 平级,用绝对导入(如 from myapp.core import Calculator),确保测试代码不依赖路径hack
  • scripts/:存放运维脚本(如数据初始化、DB迁移触发)、非正式工具,不打包进发布包
  • configs/:配置文件按环境拆分(base.toml, dev.yaml, prod.env),通过环境变量加载,不硬编码

模块划分原则:按领域而非技术分层

少用“models / views / utils”这种纯技术分层(易导致职责扩散)。优先按业务域组织:

  • src/myapp/orders/:订单创建、状态机、退款逻辑
  • src/myapp/payments/:对接支付网关、异步对账、风控回调处理
  • src/myapp/shared/:跨域复用的类型定义(types.py)、通用异常(errors.py)、ID生成器等
  • 每个子包内可含 __init__.py 汇总对外接口,隐藏内部实现细节(如 from .service import process_order

依赖与构建:用pyproject.toml统一管理

弃用 setup.py,全部收敛到 pyproject.toml

CreateWise AI
CreateWise AI

为播客创作者设计的AI创作工具,AI自动去口癖、提交亮点和生成Show notes、标题等

下载

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

  • [build-system] 指定 setuptools-build-backendhatchling
  • [project] 声明 dependenciesoptional-dependencies(如 dev = ["pytest", "black"]
  • [project.optional-dependencies] 分组管理:测试、文档、部署工具等,按需安装(pip install ".[dev,docs]"
  • 配合 poetryhatch 可自动同步依赖、生成锁文件、构建发行包

工程化支撑点:让结构“活”起来

结构本身不产生价值,配套机制才关键:

  • 预提交钩子:用 pre-commit 统一执行 black 格式化、isort 导入排序、pylint 静态检查,保证代码风格一致
  • 测试即文档:每个核心模块配 test_*.py,用 pytest --doctest-modules src/ 自动运行模块docstring中的示例
  • 环境隔离:CI中用 python -m venv .venv && source .venv/bin/activate 确保干净环境;本地推荐 direnv 自动激活对应 .envrc
  • 可观察性入口:在 src/myapp/__main__.py 提供 CLI 入口(python -m myapp serve),支持 --config--log-level 等标准参数

热门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

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1958

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

658

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2401

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

47

2026.01.19

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

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

26

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号