SuperAPI AI 工具集

python-project-structure

编程与开发

查看项目

更新于 10-16 00:30

技能介绍

用途:帮助设计结构清晰、模块边界明确、公共接口显式、易于维护的 Python 项目,适用于从零新建项目、重构现有代码库、定义模块公共 API、选择目录结构、安排测试文件位置以及创建可复用库包。

主要能力与核心概念:模块内聚(把一起变化的代码放在一起,每个模块有单一明确用途);显式接口(用 all 声明公共成员,未列出者为内部实现细节);扁平层级(优先浅目录,仅在存在真实子域时增加深度);统一约定(命名与组织模式全项目一致)。

常见模式:一个文件一个概念,文件承担无关职责或超过约 300-500 行时考虑拆分;用 all 定义公共 API;优先扁平目录结构;测试文件可选同目录放置或平行 tests 目录,需全项目统一;用 init.py 暴露干净的包接口并声明 version;按架构分层(api、services、repositories、models、schemas、config),依赖只向下;复杂应用可按业务域组织(users、orders、shared)。

命名与导入:文件和模块用 snake_case,避免晦涩缩写,类名与文件名对应;优先使用绝对导入,相对导入在模块移动或重组时可能失效。

最佳实践:保持文件聚焦、显式定义 all、优先扁平结构、使用绝对导入、保持一致、文件名匹配内容、分离关注点、用 README 说明结构。

限制:资料未提供具体安装命令、依赖、收费或平台信息;行数阈值等建议随复杂度变化,需结合实际判断。