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

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

冬婷酱_3527

冬婷酱_3527

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

|

442人浏览过

|

来源于php中文网

原创

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

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

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

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

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

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

分离配置、数据与代码

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

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • config/:存放 base.py、dev.py、prod.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.py 或 cli.py 放在项目根(非 src 内),作为 CLI 入口,仅做参数解析和调度,不写业务逻辑
  • Makefile 或 justfile 封装常用命令:make test、make format、make build,降低协作门槛
  • docs/ 存放 mkdocs.yml 和源文件;README.md 包含快速启动、环境要求、核心命令三要素

热门AI工具

更多
豆包大模型

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

WorkBuddy

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

超级简历WonderCV

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

DeepSeek

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

相关专题

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

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

2235

2023.08.07

json是什么
json是什么

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

3542

2023.08.23

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

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

1196

2023.10.13

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

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

4099

2025.09.10

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

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

3310

2023.10.09

更新pip版本
更新pip版本

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

7563

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

9222

2024.12.23

python升级pip
python升级pip

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

4787

2025.07.23

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

100

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

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

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