python应用目录规划(python的目录)
off999 2025-07-28 19:41 22 浏览 0 评论
Python 大型应用目录结构规划(企业级最佳实践)
核心原则
- 模块化:按业务功能拆分,高内聚低耦合
- 可扩展性:支持插件机制和动态加载
- 环境隔离:清晰区分开发/测试/生产环境
- 自动化:内置标准化的构建测试部署流程
- 可维护性:结构自说明,新成员能快速理解
完整目录结构
project-root/ # 项目根目录(Git仓库根目录)
├── .github/ # CI/CD工作流配置
│ └── workflows/
│ ├── ci.yml # 持续集成流程
│ └── cd.yml # 持续部署流程
│
├── .vscode/ # IDE配置(可选)
│ ├── settings.json
│ └── extensions.json
│
├── config/ # 配置中心
│ ├── base/ # 基础配置
│ │ ├── logging.yaml # 日志配置
│ │ ├── database.py # 数据库连接池
│ │ └── constants.py # 全局常量
│ │
│ ├── dev/ # 开发环境
│ │ ├── __init__.py
│ │ └── settings.toml
│ │
│ ├── test/ # 测试环境
│ └── prod/ # 生产环境(敏感配置通过Vault注入)
│
├── src/ # 主代码库
│ └── your_project/ # 项目主包
│ ├── __init__.py # 包初始化
│ ├── application/ # 业务逻辑层
│ │ ├── services/ # 业务服务
│ │ │ ├── user_service.py
│ │ │ └── payment_service.py
│ │ │
│ │ ├── models/ # 业务模型(DTO/BO)
│ │ │ ├── user.py
│ │ │ └── order.py
│ │ │
│ │ └── use_cases/ # 业务用例
│ │ ├── checkout_use_case.py
│ │ └── report_generation.py
│ │
│ ├── domain/ # 领域层(DDD)
│ │ ├── entities/ # 聚合根/实体
│ │ ├── value_objects/ # 值对象
│ │ ├── events/ # 领域事件
│ │ └── repositories/ # 仓储接口
│ │
│ ├── infrastructure/ # 基础设施层
│ │ ├── database/ # 数据访问
│ │ │ ├── migrations/ # 数据库迁移脚本
│ │ │ ├── models.py # ORM映射
│ │ │ └── repositories_impl/ # 仓储实现
│ │ │
│ │ ├── cache/ # 缓存实现(Redis/Memcached)
│ │ ├── message_broker/ # 消息队列实现
│ │ └── third_party/ # 第三方服务集成
│ │
│ ├── interfaces/ # 接口层
│ │ ├── web/ # Web接口
│ │ │ ├── api/ # REST API
│ │ │ │ ├── v1/ # 版本控制
│ │ │ │ │ ├── routers/
│ │ │ │ │ ├── schemas/ # Pydantic模型
│ │ │ │ │ └── dependencies.py
│ │ │ │ ├── v2/
│ │ │ │ └── middleware/ # 中间件
│ │ │ │
│ │ │ ├── templates/ # HTML模板(如需要)
│ │ │ └── static/ # 静态资源
│ │ │
│ │ ├── rpc/ # gRPC接口
│ │ ├── cli/ # 命令行接口
│ │ └── event_handlers/ # 事件处理器
│ │
│ ├── utils/ # 公共工具
│ │ ├── security/ # 安全相关
│ │ ├── logging/ # 日志扩展
│ │ ├── error_handling/ # 异常处理
│ │ └── helpers.py # 通用辅助函数
│ │
│ └── main.py # 应用入口
│
├── tests/ # 测试套件
│ ├── unit/ # 单元测试
│ │ ├── application/
│ │ ├── domain/
│ │ └── utils/
│ │
│ ├── integration/ # 集成测试
│ │ ├── database/
│ │ └── api/
│ │
│ ├── e2e/ # 端到端测试
│ │ └── workflows/ # 核心业务流程测试
│ │
│ ├── benchmark/ # 性能测试
│ └── conftest.py # pytest全局fixture
│
├── scripts/ # 运维脚本
│ ├── deployment/ # 部署相关
│ │ ├── docker/
│ │ │ ├── Dockerfile
│ │ │ └── docker-compose.yml
│ │ ├── k8s/ # Kubernetes配置
│ │ └── ansible/ # Ansible脚本
│ │
│ ├── data/ # 数据处理
│ │ ├── migration/ # 数据迁移
│ │ └── seeding/ # 数据初始化
│ │
│ ├── monitoring/ # 监控脚本
│ └── maintenance.py # 系统维护任务
│
├── docs/ # 项目文档
│ ├── architecture/ # 架构设计
│ ├── api-reference/ # API文档
│ ├── decisions/ # 技术决策记录
│ └── onboarding.md # 新成员指南
│
├── requirements/ # 依赖管理
│ ├── base.in # 核心依赖
│ ├── dev.in # 开发环境
│ ├── test.in # 测试环境
│ └── prod.in # 生产环境
│
├── .env.example # 环境变量示例
├── .pre-commit-config.yaml # 代码提交前检查
├── pyproject.toml # 项目元数据(PEP518)
├── Makefile # 项目自动化命令
└── README.md # 项目入口文档
关键目录解析
分层(src/your_project)
接口层 interfaces :HTTP/RPC/CLI入口,只做参数校验和格式转换
应用层 application :业务流程编排,事务边界控制
领域层 domain :核心业务逻辑,与技术实现解耦
基础设施层 infrastructure :数据库/缓存等具体实现
配置(config/)
# config/__init__.py
import os
ENV = os.getenv("APP_ENV", "dev")
def load_config():
if ENV == "prod":
from .prod import settings
elif ENV == "test":
from .test import settings
else:
from .dev import settings
return settings
current_config = load_config()
测试(tests/)
测试类型 | 覆盖范围 | 执行频率 | 工具组合 |
单元测试 | 独立函数/类 | 每次提交 | pytest + unittest.mock |
集成测试 | 模块间交互/数据库 | 每日 | pytest + testcontainers |
E2E测试 | 完整API流程 | 发布前 | playwright + pytest |
性能测试 | 关键路径响应时间 | 版本发布 | locust + py-spy |
契约测试 | 微服务间接口 | 接口变更 | pytest + pact |
部署(scripts/deployment)
容器化部署
# Dockerfile 多阶段构建
FROM python:3.11-slim AS builder
COPY requirements/prod.txt .
RUN pip install --no-cache-dir -r prod.txt
FROM python:3.11-slim AS runtime
COPY --from=builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
COPY ./src /app
ENV PYTHONPATH=/app
CMD ["python", "/app/your_project/main.py"]
依赖(requirements/)
# requirements/base.in
fastapi==0.95.0
sqlalchemy[asyncio]==2.0.10
pydantic-settings==2.0.2
# requirements/dev.in
-r base.in
pytest==7.3.1
ipdb==0.13.9
jupyterlab==3.6.3
# 使用pip-tools管理:
pip-compile --output-file=requirements.txt requirements/prod.in
大型项目
project-root/
└── services/ # 微服务拆分子目录
├── user-service/ # 独立服务
│ ├── src/ # 服务专用代码
│ └── tests/
│
├── order-service/
├── payment-service/
└── shared-lib/ # 公共库
├── common-utils/
├── database-client/
└── messaging-sdk/
实践清单
环境一致性:所有环境使用相同Python版本(pyenv + .python-version)
启动优化:冷启动时间超过5秒需拆分懒加载
依赖安全:定期扫描漏洞(safety/dependabot)
文档自动化:API文档随代码更新(FastAPI/Sphinx)
监控埋点:关键路径添加性能探针(OpenTelemetry)
资源限制:数据库连接池/线程池上限配置
异常处理:全局异常处理器记录堆栈
配置分离:敏感信息使用环境变量或配置中心
相关推荐
- Linux 网络协议栈_linux网络协议栈
-
前言;更多学习资料(包含视频、技术学习路线图谱、文档等)后台私信《资料》免费领取技术点包含了C/C++,Linux,Nginx,ZeroMQ,MySQL,Redis,fastdfs,MongoDB,Z...
- 揭秘 BPF map 前生今世_bpfdm
-
1.前言众所周知,map可用于内核BPF程序和用户应用程序之间实现双向的数据交换,为BPF技术中的重要基础数据结构。在BPF程序中可以通过声明structbpf_map_def...
- 教你简单 提取fmpeg 视频,音频,字幕 方法
-
ffmpeg提取视频,音频,字幕方法(HowtoExtractVideo,Audio,SubtitlefromOriginalVideo?)1.提取视频(ExtractVi...
- Linux内核原理到代码详解《内核视频教程》
-
Linux内核原理-进程入门进程进程不仅仅是一段可执行程序的代码,通常进程还包括其他资源,比如打开的文件,挂起的信号,内核内部的数据结构,处理器状态,内存地址空间,或多个执行线程,存放全局变量的数据段...
- Linux C Socket UDP编程详解及实例分享
-
1、UDP网络编程主要流程UDP协议的程序设计框架,客户端和服务器之间的差别在于服务器必须使用bind()函数来绑定侦听的本地UDP端口,而客户端则可以不进行绑定,直接发送到服务器地址的某个端口地址。...
- libevent源码分析之bufferevent使用详解
-
libevent的bufferevent在event的基础上自己维护了一个buffer,这样的话,就不需要再自己管理一个buffer了。先看看structbufferevent这个结构体struct...
- 一次解决Linux内核内存泄漏实战全过程
-
什么是内存泄漏:程序向系统申请内存,使用完不需要之后,不释放内存还给系统回收,造成申请的内存被浪费.发现系统中内存使用量随着时间的流逝,消耗的越来越多,例如下图所示:接下来的排查思路是:1.监控系统中...
- 彻底搞清楚内存泄漏的原因,如何避免内存泄漏,如何定位内存泄漏
-
作为C/C++开发人员,内存泄漏是最容易遇到的问题之一,这是由C/C++语言的特性引起的。C/C++语言与其他语言不同,需要开发者去申请和释放内存,即需要开发者去管理内存,如果内存使用不当,就容易造成...
- linux网络编程常见API详解_linux网络编程视频教程
-
Linux网络编程API函数初步剖析今天我们来分析一下前几篇博文中提到的网络编程中几个核心的API,探究一下当我们调用每个API时,内核中具体做了哪些准备和初始化工作。1、socket(family...
- Linux下C++访问web—使用libcurl库调用http接口发送解析json数据
-
一、背景这两天由于一些原因研究了研究如何在客户端C++代码中调用web服务端接口,需要访问url,并传入json数据,拿到返回值,并解析。 现在的情形是远程服务端的接口参数和返回类型都是json的字符...
- 平衡感知调节:“系统如人” 视角下的架构设计与业务稳定之道
-
在今天这个到处都是数字化的时代,系统可不是一堆冷冰冰的代码。它就像一个活生生的“数字人”,没了它,业务根本转不起来。总说“技术要为业务服务”,但实际操作起来问题不少:系统怎么才能快速响应业务需求?...
- 谈谈分布式文件系统下的本地缓存_什么是分布式文件存储
-
在分布式文件系统中,为了提高系统的性能,常常会引入不同类型的缓存存储系统(算法优化所带来的的效果可能远远不如缓存带来的优化效果)。在软件中缓存存储系统一般可分为了两类:一、分布式缓存,例如:Memca...
- 进程间通信之信号量semaphore--linux内核剖析
-
什么是信号量信号量的使用主要是用来保护共享资源,使得资源在一个时刻只有一个进程(线程)所拥有。信号量的值为正的时候,说明它空闲。所测试的线程可以锁定而使用它。若为0,说明它被占用,测试的线程要进入睡眠...
- Qt编写推流程序/支持webrtc265/从此不用再转码/打开新世界的大门
-
一、前言在推流领域,尤其是监控行业,现在主流设备基本上都是265格式的视频流,想要在网页上直接显示监控流,之前的方案是,要么转成hls,要么魔改支持265格式的flv,要么265转成264,如果要追求...
- 30 分钟搞定 SpringBoot 视频推拉流!实战避坑指南
-
30分钟搞定SpringBoot视频推拉流!实战避坑指南在音视频开发领域,SpringBoot凭借其快速开发特性,成为很多开发者实现视频推拉流功能的首选框架。但实际开发中,从环境搭建到流处理优...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (77)
- python封装 (57)
- python写入txt (66)
- python读取文件夹下所有文件 (59)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)