一文讀懂架構師都不知道的isinstance檢查機制
通過內建方法 isinstance(object, classinfo) 可以判斷一個對象是否是某個類的實例。但你是否想過關於鴨子協議的對象是如何進行判斷的呢？ 比如 list 類的父類是繼 object 類的，但通過 isinstance([], typing.Iterable) 返回的卻是真，難道 list 是可叠代的子類？
根據 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
這段話的意思是，當調用 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 沒有調用。 這是怎麽回事。可見文檔描述並不清楚。打破砂鍋問到底的原則我從源碼中觀察 isinstance 的檢測過程。
從源碼來看 isinstance 的檢測過程
這部分的內容可能比較難，如果讀者覺得閱讀有難度可以跳過，直接看結論。isinstance 的源碼在 abstract.c 文件中：
[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 ，這種快速的方式僅當 inst = cls() 匹配成功，並不會去優先檢查 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 直接構造的。從測試代碼中得知判斷成立，進入 recursiveisinstance。但是這個函數裏面我卻沒找到有關 instancecheck 的代碼，recursiveisinstance 的判斷邏輯大致是:
def recursive_isinstance(inst, cls): return pyType_IsSubtype(inst, cls) def pyType_IsSubtype(a, b): for mro in a.__class__.__mro__: if mro is b: return True return False
是從 mro 繼承順序來判斷的，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 。剩下就是跟蹤下 PyObjectLookupSpecial 就可以了：
[typeobject.c] PyObject * _PyObject_LookupSpecial(PyObject *self, _Py_Identifier *attrid) { PyObject *res; res = _PyType_LookupId(Py_TYPE(self), attrid); // 有回調的話處理回調 // ... return res; }
取的是 PyTYPE(self) ，也就是說指定的 metaclass 裏面需要定義 instancecheck ，獲得該屬性後，通過 PyObjectCallFunctionObjArgs 調用，調用的內容才是用戶自定義的重載方法。
檢查機制總結
至此，isinstance 的檢測過程基本清晰了，為了便於理解，也得益於python很強的自解釋能力，我用python代碼來簡化 isinstance 的過程:
def _isinstance(x, C): # 快速匹配 if type(x) is C: return True # 如果是由元類 type 直接構造的類 if type(C) is type: return C in x.__class__.__mro__ # 如果第二個參數是元組, 則遞歸調用 if type(C) is tuple: for item in C: r = _isinstance(x, item) if r: return r # 用戶自定義檢測規則 if hasattr(C, "__instancecheck__"): return C.__instancecheck__(x) # 默認行為 return C in x.__class__.__mro__
判斷的過程中有5個步驟，而用戶自定義的 instancecheck 則比較靠後，這個檢測過程主要還是以默認的行為來進行的，用戶行為並不優先。
重載 isinstance(x, C)
因此，要想重載 isinstance(x, C) ，讓用戶能自定義判斷結果，就需要滿足以下條件：
x 對象不能是由 C 直接實例化；
C 類指定 metaclass ；
指定的 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.0。
本文由馬哥教育Python學院提供支持。
一文讀懂架構師都不知道的isinstance檢查機制