淺談Python中重載isinstance繼承關係的問題

這篇文章主要介紹了關於淺談Python中重載isinstance繼承關係的問題，有著一定的參考價值，現在分享給大家，有需要的朋友可以參考一下

判斷繼承關係

通過內建方法 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):  passb = B()print(isinstance(b, Sizeable)) # output:False

只列印了 False，並且 __instancecheck__ 沒有調用。 這是怎麼回事。

沒有啟動並執行 __instancecheck__

可見文檔寫得並不清楚，為了找出問題，我們從 isinstance 源碼開始進行跟蹤。

[abstract.c]intPyObject_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 外基本都是由 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)) {  ...}

這是當 instance(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):  passclass B(object):  passb = B()print(isinstance(b, Sizeable)) # output: Falseprint(isinstance([], Sizeable)) # output: True

文檔可能有點老舊了。本次測試的環境是Python3.6。