SuperAPI AI 工具集

old-python-code-review

编程与开发

查看项目

更新于 11-13 16:18

技能介绍

Old Python Code Review 是一个按需运行的单遍 Python 代码审查技能,用于对代码改动做正确性、安全性和风格层面的审查。它明确不适用于合并前的多审查者审计,此类场景应改用 audit-code-reviewer。

用途

  • 对指定仓库的 Python 代码改动进行单遍审查,输出按严重程度排序的发现。
  • 结合仓库自身的规则文件和活动计划,让审查结论与项目约定保持一致。

主要能力与检查范围

  • 计划一致性:实现与测试是否符合活动计划的范围、顺序与验收标准。
  • 计划漂移:行为变更未同步更新计划或 changelog,或计划声称完成而代码只完成部分。
  • 正确性:边界情况、差一逻辑、过期假设、API 误用、兼容性破坏。
  • 安全性:不安全的 eval/exec、命令注入、路径穿越、反序列化风险、验证薄弱。
  • 可维护性:死代码、隐藏耦合、命名不清、逻辑重复、脆弱测试。
  • Python 风格:使用制表符缩进、尽量导入模块名而非导入符号、不使用相对导入、直接访问必需键、最小化 try/except、仅可运行脚本带 shebang、命令示例使用 source source_me.sh && python ...。
  • Pytest 风格:小型确定性测试、普通 assert、稳定且聚焦行为的预期、文件系统测试使用 tmp_path,不对日期、集合大小、必需键列表、硬编码默认值、函数名等脆弱细节做断言。
  • 性能仅在确有实质相关性时考虑。

使用方式

  1. 应用 repo-rules-reader 读取请求的仓库规则文件。
  2. 默认审查基线:在存在时读取 AGENTS.md、docs/REPO_STYLE.md、docs/PYTHON_STYLE.md、docs/PYTEST_STYLE.md,以及 docs/CHANGELOG.md。
  3. 提取与审查相关的规则,尤其是如何运行 Python、Python 风格、pytest 风格、仓库工作流规则和最新 changelog 条目。
  4. 先检查改动文件(git diff、git status --short),再检查相关调用点。
  5. 若仓库有 docs/active_plans/,识别管辖该改动的活动计划文档;否则跳过计划一致性步骤。
  6. 若存在活动计划,将代码与测试映射到计划需求、验收标准与约束;否则跳过。
  7. 按严重程度排序发现:计划不一致/回归(如适用)、正确性/安全性、可维护性。
  8. 对可直接修复的问题提供具体、最小的修改,并给出前后对比示例。
  9. 明确标注不确定之处,并针对不清楚的逻辑或契约提出有针对性的审查问题。

输出契约

  • 先列发现,按严重程度排序。
  • 每条发现包含:严重程度(P1 严重、P2 高、P3 中、P4 低)、文件路径与行号、风险与可能影响、建议修改。
  • 发现之后附:待解决问题、测试缺口与残余风险、简要总结。

修复指引

  • 优先采用保持行为不变的小范围局部修改,除非修复 bug 必须改变行为。
  • 修复需符合仓库 Python 风格与测试约定。
  • 对每个改变行为的修复补充或调整测试。

适用场景

  • 日常开发中对 Python 改动做快速单遍审查。
  • 需要结合仓库风格规范、pytest 约定和活动计划进行一致性检查的审查任务。

限制

  • 仅提供单遍审查,不替代合并前的多审查者审计。
  • 计划一致性等步骤仅在存在 docs/active_plans/ 与活动计划时执行,否则跳过。
  • 性能问题仅在确有实质相关性时才会被纳入审查。