0

0

Python项目结构怎么设计_工程化目录规范解析

冷漠man

冷漠man

发布时间:2026-02-28 23:51:09

|

182人浏览过

|

来源于php中文网

原创

python项目结构设计核心是“可维护、可测试、可部署”,需按职责分层:src/为源码根目录,tests/与之镜像,config/、data/、scripts/物理隔离,依赖分层管理,入口与文档自成体系。

python项目结构怎么设计_工程化目录规范解析

Python项目结构设计核心是“可维护、可测试、可部署”,不是堆文件夹,而是按职责分层、隔离关注点。一个规范的结构能让新成员快速上手,CI流程稳定运行,打包发布不踩坑。

src/ 作为源码根目录(推荐)

避免把模块直接放在项目根目录下(即 不推荐 myproject/ 下直接放 main.pyutils.py)。应统一收口到 src/ 中:

  • src/myproject/ —— 实际包目录,含 __init__.py,所有业务代码、子模块都在此
  • pyproject.toml 中配置 [project]requires-pythondependencies,并设 [build-system] 使用 setuptoolshatchling
  • 安装时用 pip install -e .(开发模式),工具会自动识别 src/ 为源码起点,避免本地路径污染

分离配置、数据与代码

运行时依赖项不能硬编码,需物理隔离:

Pixlr Remove BG
Pixlr Remove BG

几秒钟删除图片背景

下载
  • config/:存放 base.pydev.pyprod.py,用 os.getenv()pydantic-settings 加载环境变量覆盖
  • data/:只读数据文件(如 CSV、JSON 样本)、模型权重(若小)、缓存目录(data/cache/)—— 不提交大文件,加 .gitignore
  • scripts/:非核心但需手动执行的脚本,如数据清洗、DB 初始化,不作为包导入使用

测试与依赖明确分层

测试不是附属,而是工程一等公民:

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

  • tests/src/ 平级,结构镜像(如 tests/test_api/ 对应 src/myproject/api/
  • pytest + pytest-cov,在 pyproject.toml 中配 [tool.pytest.ini_options] 指定 testpaths = ["tests"]
  • requirements/ 下拆分依赖:base.txt(核心)、dev.txt(含 black, mypy)、test.txt(含 pytest, responses

入口、构建与文档自成体系

让项目“开箱即用”:

  • app.pycli.py 放在项目根(非 src 内),作为 CLI 入口,仅做参数解析和调度,不写业务逻辑
  • Makefilejustfile 封装常用命令:make testmake formatmake build,降低协作门槛
  • docs/ 存放 mkdocs.yml 和源文件;README.md 包含快速启动、环境要求、核心命令三要素

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

450

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

326

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安装使用方法的更多内容。

371

2023.10.09

更新pip版本
更新pip版本

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

429

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

792

2024.12.23

python升级pip
python升级pip

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

367

2025.07.23

Golang 测试体系与代码质量保障:工程级可靠性建设
Golang 测试体系与代码质量保障:工程级可靠性建设

Go语言测试体系与代码质量保障聚焦于构建工程级可靠性系统。本专题深入解析Go的测试工具链(如go test)、单元测试、集成测试及端到端测试实践,结合代码覆盖率分析、静态代码扫描(如go vet)和动态分析工具,建立全链路质量监控机制。通过自动化测试框架、持续集成(CI)流水线配置及代码审查规范,实现测试用例管理、缺陷追踪与质量门禁控制,确保代码健壮性与可维护性,为高可靠性工程系统提供质量保障。

6

2026.02.28

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.6万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.7万人学习

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

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