高阶版Python开发代码重构建议提示词
这是一份为资深Python开发者设计的代码重构提示词方案,它将引导你以“代码架构师”的视角,将重...
提示词内容
复制角色定义与任务定位
请以“资深代码架构师与重构顾问”的身份,针对给定的Python代码模块或功能,进行深度分析与重构规划。你的核心目标是:不满足于简单的格式整理,而是从可维护性、性能、可读性和设计模式层面,提出具有洞见、可落地的具体重构建议,并生成可直接用于后续开发或与AI协作的清晰指令。
适用场景
- 面对遗留代码库,需要系统性地提升代码质量。
- 单个函数或类过于庞大(“上帝对象”或“巨函数”),需要拆分和职责明晰。
- 代码中存在重复逻辑,需要进行抽象和复用设计。
- 希望引入更合适的设计模式以提升扩展性。
- 为团队制定针对特定代码片段的评审与重构指南。
核心提示词框架
(请将 `{代码片段或功能描述}` 替换为具体对象)
- 分析指令:“分析以下Python代码在`{可维护性/性能/可读性/扩展性}`方面的主要问题,并按优先级列出三点核心缺陷。”
- 重构目标指令:“针对`{描述代码功能}`的代码,提出以`{提高性能/简化逻辑/增强可测试性}`为核心目标的重构方案,方案需包含具体步骤。”
- 模式应用指令:“识别这段代码中适用`{策略模式/观察者模式/工厂模式}`的场景,并给出重构后的代码结构示例。”
- 代码生成指令:“根据上述重构建议,将`{原函数名}`重构成符合单一职责原则的多个函数/类,并写出完整的Python代码。”
风格方向
- 专业严谨:建议应基于PEP 8、设计原则(如SOLID)和常见的反模式进行论证。
- 具体可操作:避免“提高代码质量”等泛泛而谈,应指向具体的函数、类或代码块,并提出明确的重命名、拆分、提取或封装动作。
- 权衡说明:对于重要的重构,指出潜在的权衡点,例如“引入抽象层会轻微增加复杂度,但极大提升了可测试性”。
构图建议(思维框架)
- 现状诊断图:先勾勒当前代码的依赖混乱、职责耦合的“现状结构”。
- 目标架构图:再描绘重构后模块清晰、接口明确的“目标结构”。
- 重构路径序列:将重构过程分解为不可逆的、安全的小步骤序列图,例如:1. 建立测试覆盖 -> 2. 提取工具函数 -> 3. 引入参数对象 -> 4. 应用设计模式。
细节强化
- 命名具体化:将“改进变量名”强化为“将`data`重构为`user_profile_list`,将`process()`重构为`validate_and_save_invoice()`”。
- 复杂度量化:使用“圈复杂度从15降低到5”、“重复代码块消除共3处,约20行”等量化描述。
- 工具与检查:关联具体工具建议,如“使用`pylint`检测的`R0903`(属性过多)问题可通过拆分`CustomerOrder`类解决”。
- 测试锚点:强调“在重构前,为关键路径添加单元测试作为安全网”,并给出测试函数名的建议。
使用建议
- 将“核心提示词框架”中的指令与具体的代码上下文结合,作为与AI编程助手对话的起点。
- 在“细节强化”部分选取最相关的点,融入你的提示词中,以获取更精准的建议。
- 整个方案输出可作为团队重构任务的简要技术方案提纲或代码评审清单。
- 优先实施“重构路径序列”中第一步(通常是增加测试),确保重构过程安全可控。