Python中isinstance重载机制的源码解析与正确用法

判断继承关系

利用Python内置函数 isinstance(object, classinfo) 能够检测一个对象是否属于特定类的实例。这种归属关系既可以是直接的父子类关系，也可以是间接的多层继承，甚至涉及抽象基类的判定。

官方文档指出实例检查支持重载行为，相关说明可见 customizing-instance-and-subclass-checks 章节。依据 PEP 3119 规范：

The primary mechanism proposed here is to allow overloading the built-in functions isinstance() and issubclass(). The overloading works as follows: The call isinstance(x, C) first checks whether C.__instancecheck__ exists, and if so, calls C.__instancecheck__(x) instead of its normal implementation.

上述规范的含义是，执行 isinstance(x, C) 时，系统应优先查找类 C 是否定义了 __instancecheck__ 方法。若存在该方法，则直接调用 C.__instancecheck__(x) 并返回其结果，从而覆盖默认的继承关系判断逻辑。

这种机制常用于实现“鸭子类型”的兼容检查。我通过实际代码进行了测试验证。

class Sizeable(object):
  def __instancecheck__(cls, instance):
    print("__instancecheck__ call")
    return hasattr(instance, "__len__")

class B(object):
  pass

b = B()
print(isinstance(b, Sizeable)) # output:False

测试结果显示只输出了 False，且并未触发 __instancecheck__ 方法的调用。这引发了疑问：为什么重载机制未生效？

没有运行的 __instancecheck__

鉴于官方文档描述可能不够详尽，为厘清原理，我们从 isinstance 的底层源码入手进行追踪分析。

[abstract.c]
int
PyObject_IsInstance(PyObject *inst, PyObject *cls)
{
  _Py_IDENTIFIER(__instancecheck__);
  PyObject *checker;

  /* Quick test for an exact match */
  if (Py_TYPE(inst) == (PyTypeObject *)cls)
    return 1;
  ....
}

源码中存在一种快速匹配逻辑：Py_TYPE(inst) == (PyTypeObject *)cls，这等同于 type(inst) is cls。若此快速匹配成功，函数将直接返回，不再检查 __instancecheck__。这表明文档中关于“优先检查是否存在 C.__instancecheck__”的描述在特定情况下是不准确的。继续向下分析源码：

  /* We know what type's __instancecheck__ does. */
  if (PyType_CheckExact(cls)) {
    return recursive_isinstance(inst, cls);
  }

展开宏 PyType_CheckExact 的定义：

[object.h]
#define PyType_CheckExact(op) (Py_TYPE(op) == &PyType_Type)

这意味着，如果 cls 是由 type 直接构造的类（除显式指定 metaclass 外，绝大多数类均如此），则判断逻辑直接成立。从测试代码可知，由于 Sizeable 是由 type 直接构造，判断成立并进入 recursive_isinstance 函数。然而，在该函数内部并未发现调用 __instancecheck__ 的代码。recursive_isinstance 的判断逻辑大致如下：

def recursive_isinstance(inst, cls):
  return pyType_IsSubtype(inst, cls)

def pyType_IsSubtype(a, b):
  for mro in a.__mro__:
    if mro is b:
      return True
  return False

它是基于 __mro__（方法解析顺序）进行继承链遍历来判断的。回到 PyObject_IsInstance 函数继续向下查看：

if (PyTuple_Check(cls)) {
  ...
}

这是处理 isinstance(x, C) 中第二个参数为元组的情况，内部通过递归调用 PyObject_IsInstance(inst, item) 来处理。继续向下查看：

checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
if (checker != NULL) {
  res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
  ok = PyObject_IsTrue(res);
  return ok;
}

显然，这里才是获取并调用 __instancecheck__ 的关键位置。为了让检查流程执行到这里，定义的类必须显式指定 metaclass。接下来需要跟踪 _PyObject_LookupSpecial 函数的实现：

[typeobject.c]
PyObject *
_PyObject_LookupSpecial(PyObject *self, _Py_Identifier *attrid)
{
  PyObject *res;

  res = _PyType_LookupId(Py_TYPE(self), attrid);
  // 有回调的话处理回调
  // ...
  return res;
}

该函数获取的是 Py_TYPE(self)，这意味着必须在指定的 metaclass 中定义 __instancecheck__ 方法，才能生效。

总结

至此，总结成功重载 isinstance(x, C) 行为的必要条件：

1. x 对象不能是由 C 直接实例化的（即不能触发快速类型匹配）；
2. C 类必须显式指定 metaclass；
3. 指定的 metaclass 类中必须定义 __instancecheck__ 方法。

测试代码：

class MetaSizeable(type):
  def __instancecheck__(cls, instance):
    print("__instancecheck__ call")
    return hasattr(instance, "__len__")

class Sizeable(metaclass=MetaSizeable):
  pass

class B(object):
  pass

b = B()
print(isinstance(b, Sizeable)) # output: False
print(isinstance([], Sizeable)) # output: True

官方文档的描述可能较为陈旧。本次测试的环境是Python3.6。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。