guzhujushi
6758e81c9d
save_table 的两处收尾（用户授权代改）： - 后缀校验原先藏在 if/else 分支的 else 里，排在 path.parent.mkdir(...) 之后， 传 sub/x.txt 会先把 sub\ 建出来再抛 ValueError。改成守卫子句，集中在 mkdir 之前， 校验段结束后才产生副作用；此时 else 分支自然消失，用回 if/else 两路分派 - __all__ 与下一个 def 之间补回第二个空行（PEP 8 / E302） 测试： - 新增 test_save_table_validates_before_touching_disk， 断言参数非法时 tmp_path 下一个条目都不留（ValueError 与 TypeError 两条路径） - 40 passed / 44 skipped，两套环境一致；ruff All checks passed 文档： - docs/dev/personal-pitfalls.md 追加条目 5（参数校验排在副作用之后） 与条目 6（把 lint 的"没报错"当成"没问题"），索引表同步加行 - STATUS：io.py 收尾，L0 第 3 项完成；测试计数 40 - CHANGELOG：Fixed 段补两条
6.2 KiB
6.2 KiB
个人易错点（只追加）
本文件的规矩
- 只追加。 已有条目一个字都不改、不重排、不润色。发现写错了 → 在末尾补一条"更正"，不要回头改。
- 不通读。 追加前只做两件事：
rg -i "<关键词>" docs/dev/personal-pitfalls.md看有没有记过； 看一眼下面的索引表最后一行拿编号。全文只在复盘时才读。- 一条写三行：现象 / 为什么会错 / 以后怎么防。 写不出"为什么会错"就先别记——那说明还没想清楚。
- 记规律，不记事故。"今天又忘了"不新开条目，在已有条目下把
复发加一。
追加模板
### N. <一句话>
- 现象：
- 为什么会错：
- 以后怎么防：
- 首次：YYYY-MM-DD｜复发：0
索引
| # | 一句话 | 首次 |
|---|---|---|
| 1 | 类型判断只写 int，漏掉 np.int64 这类 numpy 标量 |
2026-10-01 |
| 2 | 以为 # TODO(L0) 只是普通注释 |
2026-10-01 |
| 3 | 签名里的类型注解和 docstring 说的不一致 | 2026-10-01 |
| 4 | 只覆盖自己的状态，忘了第三方库还在用 numpy 旧全局 | 2026-10-01 |
| 5 | 参数校验排在副作用（建目录 / 写文件）之后 | 2026-10-01 |
| 6 | 把 lint 的"没报错"当成"没问题" | 2026-10-01 |
1. 类型判断只写 int，漏掉 np.int64 这类 numpy 标量
- 现象：
get_rng(np.int64(42))不报错，但种子被静默忽略、退回全局流——结果不可复现，且没有任何提示。 - 为什么会错：
np.int64不是 pythonint的子类（isinstance(np.int64(42), int)是False）， 但np.float64是float的子类。numpy 标量的继承关系不统一，凭直觉一定会翻车。 - 以后怎么防：写类型分支时默认假设"这个值可能来自 numpy"。判断用
isinstance(x, (int, np.integer))， 取值统一int(x)归一化；并且给所有非预期类型加raise TypeError兜底—— 宁可报错，也不要静默走默认分支。 - 首次：2026-10-01｜复发：0
2. 以为 # TODO(L0) 只是普通注释
- 现象：函数实现完了，
# TODO(L0)还挂在末尾。 - 为什么会错：本仓库把
TODO(L0)/TODO(L1)/TODO(v0.2)当进度标记用：docs/03-roadmap.md靠它划分档位，STATUS.md靠它统计"还剩哪些没做"。实现完不删，等于骗自己。 - 以后怎么防：实现完成时顺手删掉该函数里的
TODO(...)。 全仓还剩多少没做，一条rg "TODO\(" src/就能数出来。 - 首次：2026-10-01｜复发：0
3. 签名里的类型注解和 docstring 说的不一致
- 现象：
def get_rng(random_state: int | None = None)，docstring 却写"已经是np.random.Generator时原样返回"。 - 为什么会错：类型注解是给读代码的人和 pyright 看的契约。注解说只收 int/None、docstring 说还收 Generator， 两处打架时合法用法会被 IDE 标红，真正的错误反而看不出来。
- 以后怎么防：改签名和改 docstring 必须同一次做完。
本项目所有
random_state的注解统一写int | np.integer | np.random.Generator | None。 - 首次：2026-10-01｜复发：1
4. 只覆盖自己的状态，忘了第三方库还在用 numpy 旧全局
- 现象：
set_seed换掉了本包的生成器，但 sklearn / statsmodels 里random_state=None的路径 仍不可复现（测试直接挂）。 - 为什么会错：numpy 有两套随机状态——旧的
np.random.*全局单例，和新的Generator。 第三方库大量仍在走旧的那套（check_random_state(None)），自己新建一个 Generator 管不到它们。 - 以后怎么防：凡是"设全局状态"的函数，先列清单——自己的、numpy 旧的、标准库
random的、 第三方框架的，逐个决定要不要一起设，并在 docstring 里写清到底覆盖了哪几个。 - 首次：2026-10-01｜复发：0
5. 参数校验排在副作用（建目录 / 写文件）之后
- 现象：
save_table先path.parent.mkdir(parents=True, exist_ok=True)，再在if suffix == '.csv' ... else: raise ValueError里判断后缀。传sub/x.txt时， 空目录sub\已经建出来了，函数才抛ValueError——错误路径上留下垃圾。 - 为什么会错：函数体是照着"顺利流程"顺着写下来的——先建目录、再按分支干活；
校验顺手塞进分支的
else里，于是校验自动排到了最后。分支越多，越会有路径漏掉。 会传染：isinstance校验改到mkdir前面之后，后缀校验还是留在原地， 因为它藏在分支里，看起来"已经检查过了"。 - 以后怎么防：函数体分三段写——① 所有校验 → ② 所有副作用（建目录 / 写文件 /
联网 / 改全局状态）→ ③ 主逻辑。校验用守卫子句集中在开头，不要塞进分支里；
凡是
raise的行，位置必须在校验段内，不能出现在副作用段之后。 写完自问一句："这个参数不合法时，磁盘 / 网络 / 全局状态会不会已经动过了？" - 首次：2026-10-01｜复发：0
6. 把 lint 的"没报错"当成"没问题"
- 现象：
__all__与下一个def之间只留了 1 个空行（PEP 8 要求 2 个），ruff check src tests照样打印 "All checks passed!"。 - 为什么会错：版本号看着一样，覆盖的规则却是两回事。ruff 0.16 里
E302（函数间空行）属于 preview 规则，不在select = ["E"]的默认集合里—— 加了也会被"because preview is not enabled"忽略掉，安安静静不报。 根本问题是：lint 只检查你 select 的那部分，而默认规则集本来就不是 PEP 8 全集。 把"我配的检查全过了"读成"这份代码符合规范"，是把自己没开的检查当成了已经通过的检查。 - 以后怎么防：把 lint 结论限定成"我 select 的规则里没问题"，别说成"没问题"。
想看全貌就偶尔跑一次
ruff check --select ALL --preview（只当参考，别直接开进 CI， 会淹没在噪声里）；纯格式问题交给ruff format，它是 formatter，不受select影响。 - 首次：2026-10-01｜复发：0