Python 代码整理与重构
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_8f9cac4a/code-organizer。
技能介绍
解决什么问题
很多 Python 项目一开始只是脚本或实验代码,但随着模块增多,很快出现 命名不一致、import 混乱、目录职责不清、注释和文档缺失等问题。直接“重构”又容易过度:给几行脚本加完整测试、配置系统甚至 DDD 分层,会让项目变得更难读。
这个技能把整理过程约束为 先评估、再确认、后执行,避免默认执行所有优化。它不是自动格式化工具,而是围绕项目类型和工程化目标,给出一套可批准的整理方案。
技能如何工作
- 第一轮:策略选择:扫描项目规模、类型和主要问题,给出四个可选级别:
轻量清理、标准整理、深度重构、全面重构,并说明推荐理由。 - 第二轮:方案确认:列出目录调整、文件修改、删除项、新增配置和文档变更,等待明确批准。
- 执行阶段:按策略执行代码格式、命名规范、
import排序、类型标注、注释规范、死代码清理、配置参数化或测试补充。 - 文档生成:根据策略级别生成
README.md、CHANGELOG.md和NOTE.md,分别面向使用者、变更追踪和个人快速参考。
对 深度学习项目,它会优先处理 models/、data/、experiments/、超参数配置和日志机制;对 Web/API 项目,会关注路由、中间件和鉴权拆分;对 CLI/数据处理管道,会强调配置集中、日志与进度展示。
适用边界
该技能最适合 需要维护的 Python 项目,尤其是原型工具、数据处理脚本、小型服务或可发布库。它不适用于追求“看起来最规范”的盲目工程化:如果只是跑通实验,通常选择轻量或标准整理即可;只有项目需要团队协作、发布或长期维护时,才适合启用深度重构或全面重构。执行过程中仍依赖用户确认,不会未经批准删除文件或大幅调整结构。
使用场景
- 接手一个目录混乱的 Python 数据处理脚本,先确认策略,再清理未用 import 和重复逻辑。
- 维护一个小型 FastAPI 项目,希望按资源拆分 routes,并把硬编码配置提取为可追踪参数。
- 整理深度学习实验代码,把 models、data、experiments 分开,并将 lr、epochs 等超参数移入配置。
- 发布 Python 工具前,统一命名、import 排序、类型标注,并生成 README、CHANGELOG 和 NOTE。
适合人员
- 维护内部 Python 工具,但不想被强制加入完整测试和配置系统的工程师。
- 负责数据处理管道,需要清理重复逻辑并统一命名与 import 顺序的算法工程师。
- 准备把实验脚本整理成可发布库,希望确认目录结构和文档深度的开发者。
- 接手他人代码,需要先审阅变更方案再执行低风险提示的维护者。