如何强制用.get(...)访问字典避免KeyErrors？工具与例外咨询

一、可检测字典方括号访问的工具 #

1. Ruff #

Ruff是快速的Python代码检查工具，可通过规则配置或自定义规则实现告警：

• 启用内置B009规则：针对在条件判断中依赖dict[key]的场景（如if key in d: return d[key]），提示改用d.get(key)；
• 自定义规则：通过Ruff的插件机制，编写简单规则拦截所有字典下标访问（d[foo]）并抛出告警，强制开发者使用get方法。

2. Pylint #

可通过自定义检查器或社区插件实现：

• 编写Pylint插件：检测AST中的Subscript节点，判断被索引对象是否为dict类型，若是则触发错误提示；
• 使用社区插件：如pylint-dict-keys，可检测不安全的字典键访问场景。

3. Mypy自定义插件 #

借助Mypy的插件系统，无缝整合进现有类型检查流程：

• 编写插件监听IndexExpr类型节点，当被索引对象为dict类型时，发出类型错误，提示使用get方法替代方括号访问。

二、get(...)无法替代方括号访问的场景 #

• 键必然存在的场景：若代码逻辑已确保键一定存在（比如提前通过if foo in d:校验，或使用TypedDict定义必填键），方括号访问更清晰表达“键存在”的意图，而get会返回Optional类型，需额外添加类型断言（如assert d.get(foo) is not None），增加冗余。
• 需要主动触发异常时：当键不存在属于异常情况，需抛出KeyError中断错误流程时，方括号访问的异常是合理信号。比如数据解析中缺失必要配置项，直接报错比返回None导致后续逻辑混乱更合适。
• 修改字典值的场景：get仅能读取值，无法直接修改字典。像d[foo] += 1这类操作，用get需写成d[foo] = d.get(foo, 0) + 1，代码冗余且在并发场景下可能出现竞态问题。
• 依赖特殊字典特性时：使用collections.defaultdict时，方括号访问不存在的键会自动生成默认值，而get不会触发这一特性，直接返回默认参数（或None），无法利用defaultdict的自动初始化能力。
• 类型注解精准性需求：若用TypedDict定义明确的键集合，方括号访问的类型是确定的（如int），而get会返回Optional[int]，与实际类型预期不符，需额外处理才能通过类型检查。

内容的提问来源于stack exchange，提问作者sk29910