__missing__是dict子类中处理缺失键的特殊方法,仅在通过d[key]访问不存在的键触发KeyError时被调用;它不响应.get()、in、.pop()等操作。

__missing__ 是什么,它在什么情况下被调用
__missing__ 是一个特殊方法,仅当类继承自 dict 且在通过 [] 查找键失败时才被触发。它**不会**在使用 .get()、.pop() 或 in 判断时调用,这点非常关键——很多人误以为它是“通用缺省处理”,其实它只对 d[key] 这种 KeyError 场景生效。
它的签名必须是 def __missing__(self, key):,且必须返回一个值(或显式 raise KeyError)。返回值会直接作为 d[key] 的结果;如果抛出异常,则传播出去。
如何正确实现一个带 __missing__ 的字典子类
最常见错误是忘记继承 dict,或者把 __missing__ 写成静态方法/类方法。它必须是实例方法,且仅对内置 dict 行为有效(collections.UserDict 不会调用它)。
- 必须继承
dict,不能只实现该方法而不继承 -
__missing__只在key not in self为 True 且触发KeyError时进入,不替代.setdefault() - 返回值不能是
None并期望“自动忽略”——它会被原样返回,调用方看到的就是你 return 的东西
示例:
立即学习“Python免费学习笔记(深入)”;
图片提示词生成器?不止如此。 马甲系统 —— 把脑海中的画面,翻译成AI能理解的专业表达。 用得越多,它越懂你:首次需要多问几句确认方向,用久了几乎一说就懂。 用得越多,它越快:缓存机制让后续对话越来越省。 RAG进化:成功案例持续入库,越跑越聪明。 输入「新手指南」查看完整功能介绍
class DefaultDict(dict):
def __missing__(self, key):
return f"missing-{key}"
<p>d = DefaultDict(a=1, b=2)
print(d["a"]) # 1
print(d["c"]) # "missing-c"
print(d.get("c")) # None(<strong>missing</strong> 不触发)
__missing__ 和 defaultdict 的区别与选型建议
defaultdict 是 collections 模块提供的现成方案,内部不依赖 __missing__,而是重写了 __getitem__。两者行为相似但机制不同:前者是“按需构造默认值”,后者是“查不到时回调”。
-
defaultdict的 factory 函数每次访问缺失键都会执行,适合轻量初始化(如list、int) -
__missing__更灵活,可基于key值动态计算返回值(比如路由映射、环境变量 fallback) -
defaultdict不支持带参数的 factory;若需传参,__missing__更直接 - 注意性能:如果
__missing__中做了耗时操作(如 IO、正则匹配),而代码高频访问不存在的键,会明显拖慢
例如实现“带前缀的配置访问”:
class PrefixDict(dict):
def __init__(self, data, prefix="cfg_"):
super().__init__(data)
self.prefix = prefix
def __missing__(self, key):
full_key = self.prefix + str(key)
return super().get(full_key) # 注意:这里用 get,避免无限递归
<p>cfg = PrefixDict({"cfg_host": "localhost"})
print(cfg["host"]) # "localhost"
容易踩的坑:递归调用、不可变对象、类型混淆
最常见的 crash 就是 __missing__ 里又触发自身调用,比如误用 self[key] 或没检查是否存在就调用父类方法。
- 绝对不要在
__missing__中写return self[key]—— 必然递归爆栈 - 如果父类不是
dict(比如你继承的是Mapping),__missing__根本不会被调用 - 返回值类型最好和已有值一致,否则下游用
isinstance(d[key], str)可能意外失败 - Python 3.9+ 支持
dict类型提示,但__missing__不影响类型检查器推断,别指望 mypy 能帮你捕获逻辑错误
调试时可以加日志确认是否进入:print(f"[MISSING] {key}"),但上线后记得删掉——因为 __missing__ 很可能在热路径上被频繁触发。

















