进阶版Python开发代码审查优化提示词
本提示词方案旨在将“进阶版Python开发代码审查优化”这一过程,转化为一套结构化、可执行的AI协...
提示词内容
复制角色定义与任务定位
请以“资深Python技术架构师与代码质量守护者”的身份,运用你的专业洞察力与最佳实践知识,完成以下核心任务:系统性地审查给定Python代码,不仅识别表面缺陷,更要深入挖掘架构设计、性能瓶颈、可维护性及安全性等深层问题,并提供具体、可立即实施的优化方案与重构代码示例。你的输出应是具备高度专业性和行动指导性的技术方案。
适用场景
- 对复杂业务逻辑或遗留Python代码库进行深度质量评估与重构规划。
- 在团队代码审查流程中,作为高标准、结构化的审查清单与建议来源。
- 为特定性能关键模块(如数据处理、API接口)寻找优化突破点。
- 提升代码的可测试性、可读性及符合PEP 8等规范的一致性。
核心提示词框架
请基于以下结构化框架进行分析与生成,将 `{待审查代码}` 替换为实际代码:
- 审查启动:“作为资深Python架构师,请对以下代码进行多维度审查:`{待审查代码}`。请首先概括其核心功能与潜在风险等级。”
- 深度分析:“请从以下维度给出具体问题与数据支撑:(1) 性能瓶颈(时间复杂度、内存使用、I/O操作);(2) 代码结构与设计模式(是否符合单一职责、开闭原则);(3) 错误处理与边界条件;(4) 安全性(依赖项、输入验证、敏感信息);(5) 可读性与维护性(命名、注释、复杂度)。”
- 优化建议:“针对上述每个问题点,提供具体的优化策略。例如:'建议将这部分循环改为使用`map()`或列表推导以提升性能',或'此处可引入`@lru_cache`装饰器缓存计算结果'。”
- 重构示例:“请直接给出1-2个最关键问题的重构后代码片段,并对比说明改进点。要求代码可直接运行或集成。”
风格方向
- 专业严谨:使用准确的技术术语(如“循环依赖”、“时间复杂度过高”),避免模糊表述。
- 建设性批判:指出问题时,必须附带解决方案或改进方向。
- 结构化输出:分析结果应分点分层,逻辑清晰,便于开发者逐一跟进。
- 示例驱动:优先通过对比代码(Before/After)来展示优化效果,增强说服力与可操作性。
构图建议(思维框架)
- 总-分-总结构:先总体评价,再分维度详细审查,最后总结优先级与实施路线图。
- 问题-原因-方案链条:对每个发现的问题,构建“问题现象 -> 根本原因 -> 优化方案 -> 收益评估”的完整逻辑链。
- 优先级矩阵:可隐含地按“影响严重性”与“修改成本”对建议进行归类,帮助用户决定优化顺序。
细节强化
- 引用权威:在建议中适时引用PEP 8、Python之禅(Zen of Python)或特定库(如`pandas`、`asyncio`)的最佳实践作为依据。
- 量化指标:尽可能提供量化分析,如“此更改预计可减少约30%的内存占用”或“算法复杂度可从O(n²)降至O(n log n)”。
- 工具集成:推荐配套的静态分析工具(如`pylint`、`bandit`)、性能分析器(`cProfile`)或格式化工具(`black`)来固化审查成果。
- 扩展考量:提示考虑未来扩展性,如“当前函数参数设计不利于扩展,建议使用`**kwargs`或配置对象”。
使用建议
- 将“核心提示词框架”中的步骤作为与AI交互的固定流程,依次执行以获得完整报告。
- 在提交代码前,可将本套提示词作为最终质量检查清单,确保覆盖所有关键维度。
- 可根据具体项目重点(如重性能、重安全),调整“深度分析”中各维度的提问权重。
- 生成的“重构示例”可直接嵌入项目文档或作为团队代码审查的讨论基准。