Codex列出了三条"潜在问题",不等于代码已经有三个缺陷。审查意见需要落到具体输入、代码路径和可观察的结果;修复之后,还要确认同一项检查真的从失败变成通过。
这一课继续使用资料整理助手。我们在新副本中故意加入一个小错误,用它走完"查看差异---提出问题---复现---修复---回归"的过程。这是教学改动,不是旧项目发生了生产事故。
创作说明:AI 辅助创作。
目标与前置条件
需要前面两份脚本:file_list.py生成CSV,summarize_list.py统计文件数和总字节数;以及已核验的Python解释器。练习只使用合成文件,不需要额外依赖或远程仓库。
本次在当前Codex会话中检查代码差异,并实际运行本地命令。下面的原生/review入口依据官方文档整理,菜单、独立审查模型与远程PR审查没有实测,不把普通对话审查冒充这些功能。
本课验收是:能解释一个已证实的问题,也能保留一条未被证实的意见;修复后用同一组检查核对结果,而不是只接受"已经修好"的描述。
第一步:先限定审查范围和业务要求
在Codex中先说明看哪份差异、按什么要求判断,以及暂时是否允许改代码。
text
先只审查,不修改文件。
比较candidate/summarize_list.py与第17课基线。
约定:每条合法CSV数据行代表一个文件,0字节文件也应计数;
总字节数应为各行size_bytes之和,行顺序不应影响结果。
优先找会改变结果的缺陷。每条意见给出文件位置、触发输入、
预期行为、实际代码路径和复现办法;没有证据的请标为待验证。
不要为了凑数量提出问题,也不要把命名或排版偏好当作功能错误。
如果项目是Git仓库,官方提供内置/review,可以选择审查未提交改动或相对基线分支的差异。审查结果仍需结合当前版本和测试核对。普通本地练习也可以在对话里明确给出两个文件,让Codex先解释差异。官方代码审查说明
注意"未提交改动"可能包含你自己或其他工具留下的内容。先确认范围,不能默认整个工作区都是这一次Codex任务产生的,也不要为了方便审查就自动暂存、覆盖或还原别人的文件。
第二步:准备一个能够暴露问题的小改动
在新的chapter19目录准备candidate和fixed两个普通副本,只复制前篇两个脚本及合成input,不复制旧输出或.git。以下命令中的python替换为已核验的解释器。
原摘要脚本允许非负整数字节数,并对每一行增加文件计数。我们故意在candidate/summarize_list.py的行校验后加入两行:
diff
if len(row) != 2 or not row[0] or not row[1].isascii() or not row[1].isdigit():
raise ValueError("CSV数据必须有路径和非负整数字节数")
+ if int(row[1]) == 0:
+ continue
count += 1
total_bytes += int(row[1])
这段新增代码看起来像是"跳过空内容"。但在本课约定下,合法的0字节文件仍然是一个文件,不能跳过整条记录。审查意见应该指向这一处条件,而不是笼统说"循环可能有问题"。
先用原有a.txt和b.txt运行,内容分别为不带换行的中和hi,共5字节:
powershell
# 在candidate目录执行
python -I -B file_list.py
python -I -B summarize_list.py
结果为2个文件、5字节,命令退出0。这组成功输入没有经过新增条件的continue分支,因而没有暴露问题。
第三步:用触发输入验证审查意见
在同一合成input中新建真正的0字节文件empty.txt,再次运行上面两条命令。生成的CSV包含三条记录:
csv
relative_path,size_bytes
input/a.txt,3
input/b.txt,2
input/empty.txt,0
本次实际观察:文件清单正确列出了空文件,但有错误的摘要脚本仍输出:
text
# 资料清单摘要
文件数:2
总字节数:5
预期应是3个文件、5字节。摘要命令依然退出0,说明退出码不能单独证明业务结果正确。
此时可以形成一条具体意见:在合法CSV包含0字节记录时,新增条件跳过了count += 1,导致文件数少算。总字节数碰巧不变,不能用它来替代文件计数检查。
第四步:把问题变成可重复的检查
将以下完整程序保存为chapter19/test_review.py,与candidate、fixed同级。它调用待审脚本的summarize函数,在练习目录内写入三个命名样例,不使用系统临时目录。只对新的合成练习使用,不拿已有业务输出当测试文件。
python
import csv
import importlib.util
from pathlib import Path
import sys
import unittest
BASE = Path(__file__).resolve().parent
target = (BASE / sys.argv.pop(1) / "summarize_list.py").resolve()
if not target.is_relative_to(BASE):
raise ValueError("目标必须在练习目录内")
spec = importlib.util.spec_from_file_location("review_target", target)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
class ReviewTest(unittest.TestCase):
def check_case(self, name, rows, expected_count):
case = (BASE / "test-output" / target.parent.name / name).resolve()
if not case.is_relative_to(BASE):
raise ValueError("输出必须在练习目录内")
(case / "output").mkdir(parents=True, exist_ok=True)
with (case / "output/file-list.csv").open("w", encoding="utf-8", newline="") as stream:
writer = csv.writer(stream)
writer.writerow(["relative_path", "size_bytes"])
writer.writerows(rows)
actual = module.summarize(case)
self.assertIn(f"文件数:{expected_count}\n", actual)
self.assertIn("总字节数:5\n", actual)
def test_normal(self):
self.check_case("normal", [("input/a.txt", 3), ("input/b.txt", 2)], 2)
def test_zero_byte(self):
self.check_case("zero-byte", [("input/a.txt", 3), ("input/b.txt", 2), ("input/empty.txt", 0)], 3)
def test_reordered(self):
self.check_case("reordered", [("input/b.txt", 2), ("input/a.txt", 3)], 2)
if __name__ == "__main__":
unittest.main()
这里的动态导入会运行目标Python模块,只传入自己掌握的合成脚本,不用于加载未知来源代码;练习目录及其父目录也不使用符号链接或目录联接。路径检查不是完整安全沙箱。
第五步:做最小修复,用同一组检查复跑
在fixed/summarize_list.py中保留原统计逻辑,不加入那两行筛选;如果已复制了错误版本,只删除这两行。不要顺手改CSV字段、标题、校验方式或其他功能。
在chapter19运行:
powershell
python -I -B test_review.py candidate -v
python -I -B test_review.py fixed -v
本次实际结果如下:
| 检查 | 含教学错误的candidate | 修复后的fixed |
|---|---|---|
| 两条普通记录:2文件/5字节 | 通过 | 通过 |
| 加入0字节记录:3文件/5字节 | 失败,少算1文件 | 通过 |
| 两条普通记录倒序:2文件/5字节 | 通过 | 通过 |
第一条测试命令退出1,报告3项检查、1项失败;第二条退出0,3项全部通过。我们还在fixed副本中重新运行清单和摘要两条业务命令,实际得到3个文件、5字节。包含前面的业务运行,本次共记录8条命令;第17课的源脚本与合成输入哈希保持不变。
"调整CSV行顺序可能改变总和"这条顾虑,在当前代码与倒序样例里没有得到支持。因此不把它列为已证实缺陷,也不为它增加无关排序逻辑。这个检查只覆盖所给样例,不代表证明所有输入都没有问题。
第六步:交付审查结论,不只交付一个修复文件
可以继续让Codex按下面的格式收尾:
text
报告本次确认的缺陷及触发条件,列出最小差异。
把候选版本和修复版本的检查命令、退出码、结果分开。
标明哪些意见尚未得到证实、哪些功能没有检查。
确认没有改动原始练习或无关文件,不自动提交、推送或合并。
对于真实仓库,审查完成、修复完成、提交、推送和合并是不同动作,应按任务范围分别处理。一次本地检查通过,也不能替代部署环境、依赖版本、权限或远程CI的验证。
常见错误与验收
- 只说"帮我看看代码":补充基线、业务要求和允许的动作。
- 把所有警告都当成事实:要求触发输入和代码证据,未验证就保留待验证状态。
- 只运行正常样例:增加能走到可疑分支的最小输入。
- 看到退出0就结束:核对文件数、字节数等真实交付结果。
- 修复后换一组更容易通过的检查:保留同一项失败样例,并复跑原来通过的样例。
能独立复现"空文件被漏计",能用同一组检查看到修复前失败、修复后通过,并说明倒序顾虑为什么暂不算缺陷,就完成了本课最小练习。
下一课讨论模型、推理力度和用量:怎样按任务选择,并基于实际可见选项和结果判断,而不是只看模型名称。