如何判断一个对象是否支持 getitem 但不是 dict

28次阅读

应使用 isinstance(obj, collections.abc.Mapping) and not isinstance(obj, dict) 判断非 dict 的字典式对象,因其能正确识别注册的虚拟子类(如 MappingproxyType),且排除仅支持整数索引的序列类型。

如何判断一个对象是否支持 getitem 但不是 dict

collections.abc.Mapping 判断是否是 dict-like 但排除 dict 本身

直接检查 hasattr(obj, '__getitem__') 太宽泛——列表、字符串、自定义类只要实现了 __getitem__ 就会返回 True,但这不表示它支持键值语义。真正想识别的是“行为像字典”的对象(支持任意不可变键、有映射语义),又明确不是 dict 实例。

推荐方式是组合判断:isinstance(obj, collections.abc.Mapping) 确保它符合映射协议(要求实现 __getitem____iter____len__),再用 not isinstance(obj, dict) 排除原生 dict

import collections.abc  def is_mapping_not_dict(obj):     return isinstance(obj, collections.abc.Mapping) and not isinstance(obj, dict)

注意:这个判断不会把 collections.defaultdicttypes.MappingProxyType 当作 dict 排除,它们是合法的非 dict 映射。

为什么不用 issubclass(type(obj), collections.abc.Mapping)

isinstance 而不是 issubclass(type(obj), ...),是因为很多类型(比如 types.MappingProxyType)并未显式继承 collections.abc.Mapping,而是通过 register() 注册为虚拟子类。只有 isinstance 能正确识别这类注册关系。

  • isinstance({}, collections.abc.Mapping)True
  • isinstance(types.MappingProxyType({'a': 1}), collections.abc.Mapping)True
  • issubclass(type(types.MappingProxyType({})), collections.abc.Mapping)False

常见误判场景和绕过方法

有些对象看似支持 __getitem__,但不符合映射语义(比如只接受整数索引),collections.abc.Mapping 协议能自然过滤掉它们:

  • listtuplestr:有 __getitem__,但不实现 __iter__ 返回键(而是返回元素),所以 isinstance(..., Mapping)False
  • collections.OrderedDict:是 Mapping,且不是 dictpython 3.7+ 后 dict 有序,但 OrderedDict 仍是独立类型),会被保留
  • 自定义类只实现 __getitem__ 但没实现 keys() 或没注册 Mapping:默认不被识别,避免误判;若真需支持,应显式 collections.abc.Mapping.register(MyClass)

性能与兼容性提醒

isinstance(obj, collections.abc.Mapping) 是轻量级协议检查,不触发任何方法调用,开销可忽略。但在 Python collections.abc 的某些子类注册行为略有差异,建议统一用 import collections.abc 而非旧式的 import collections

如果目标环境必须兼容 Python 2,这条路走不通——那时没有 collections.abc,只能退回到手动检查三个方法是否存在并尝试调用,但极易出错,不建议。

真正难处理的是那些故意模仿 dict 行为但未注册协议的类,这种情况下,你得看它的文档或源码,协议检查帮不上忙。

text=ZqhQzanResources