课程大纲 第 69 课,共 148 课 · 没人能误用的 API
没人能误用的 API

没有布尔陷阱

为什么重要 不打开函数看一看,copy(src, dst, True, False) 是读不懂的。把两个标志互换一下,一次试运行就变成了一次真正的覆盖。具名的选项能让每一次调用都说明它在做什么。

一个数据团队有一个在两个存储之间复制记录的辅助函数:copy_records(src, dst, overwrite, dry_run)。上个月,有人以 copy_records(a, b, False, True) 的方式调用它,本意是“试运行,不要覆盖”,却弄错了顺序,覆盖了一张生产环境的表。你要替换掉它。

布尔陷阱:一个只有 True 或 False 的参数,所以调用处说明不了它的含义,也很容易被互换。

copy_records(src, dst, on_conflict="keep", mode="dry_run")
轮到你了

编写 copy_records(src, dst, *, on_conflict, mode)。src 和 dst 是字典。对于 src 中的每一个键:如果它不在 dst 中,就复制它;如果在,由 on_conflict 决定:"keep"(保留 dst 的值)、"overwrite"(使用 src 的值),或 "fail"(抛出 ValueError,并且完全不改变任何东西)。mode 是 "apply"(修改 dst)或 "dry_run"(什么都不改)。返回被写入(或者将会被写入)的键的排序列表。

隐藏的误用脚本会尝试下面的每一种;每一种都必须抛出 TypeError 或 ValueError,并让 dst 保持不变:按位置传递选项、漏掉任何一个选项(没有默认值:调用者必须做出选择)、任何不恰好是那些具名字符串之一的值(拼写错误、其他的大小写、True、False、None),以及旧的 overwrite= 关键字。

发现这节课有问题?报告它 · 就这节课提问

这个练习即将开放

完成它前面的那一课,这一课就会解锁。整门课程免费,无需账号,而且你现在就可以阅读这节课。