從源碼來看isinstance的檢測過程

起步

通過內(nèi)建方法 isinstance(object, classinfo) 可以判斷一個(gè)對象是否是某個(gè)類的實(shí)例。但你是否想過關(guān)于鴨子協(xié)議的對象是如何進(jìn)行判斷的呢？ 比如 list 類的父類是繼 object 類的，但通過 isinstance([], typing.Iterable) 返回的卻是真，難道 list 是可迭代的子類？

根據(jù) PEP 3119 的描述中得知實(shí)例的檢查是允許重載的：

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, andif so, calls C.__instancecheck__(x) instead of its normal implementation.

這段話的意思是，當(dāng)調(diào)用 isinstance(x, C) 進(jìn)行檢測時(shí)，會優(yōu)先檢查是否存在 C.instancecheck，如果存在則調(diào)用 C.instancecheck(x) ，返回的結(jié)果便是實(shí)例檢測的結(jié)果，默認(rèn)的判斷方式就沒有了。

這種方式有助于我們來檢查鴨子類型，我用代碼測了一下。

classSizeable(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沒有調(diào)用。 這是怎么回事。可見文檔描述并不清楚。打破砂鍋問到底的原則我從源碼中觀察 isinstance 的檢測過程。

從源碼來看 isinstance 的檢測過程

這部分的內(nèi)容可能比較難，如果讀者覺得閱讀有難度可以跳過，直接看結(jié)論。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)

return1;

....

}

Py_TYPE(inst) == (PyTypeObject *)cls 這是一種快速匹配的方式，等價(jià)于 type(inst) is cls ，這種快速的方式僅當(dāng) inst = cls() 匹配成功，并不會去優(yōu)先檢查instancecheck，所以文檔中有誤。繼續(xù)向下看源碼：

/* We know what type's __instancecheck__ does. */

if (PyType_CheckExact(cls)) {

return recursive_isinstance(inst, cls);

}

展開宏 PyType_CheckExact :

[object.h]

#definePyType_CheckExact(op) (Py_TYPE(op) == &PyType_Type)

也就是說 cls 是由 type 直接構(gòu)造出來的類，則判斷語言成立。除了類聲明里指定 metaclass 外基本都是由 type 直接構(gòu)造的。從測試代碼中得知判斷成立，進(jìn)入 recursiveisinstance。但是這個(gè)函數(shù)里面我卻沒找到有關(guān)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:

returnTrue

returnFalse

是從mro繼承順序來判斷的，mro是一個(gè)元組，它表示類的繼承順序，這個(gè)元組的中類的順序也決定了屬性查找順序?；氐?PyObject_IsInstance 函數(shù)往下看：

if (PyTuple_Check(cls)) {

...

}

這是當(dāng) instance(x, C) 第二個(gè)參數(shù)是元組的情況，里面的處理方式是遞歸調(diào)用 PyObject_IsInstance(inst, item) 。繼續(xù)往下看：

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);

// 有回調(diào)的話處理回調(diào)

// ...

return res;

}

取的是 PyTYPE(self) ，也就是說指定的 metaclass 里面需要定義instancecheck，獲得該屬性后，通過 PyObjectCallFunctionObjArgs 調(diào)用，調(diào)用的內(nèi)容才是用戶自定義的重載方法。

檢查機(jī)制總結(jié)

至此，isinstance 的檢測過程基本清晰了，為了便于理解，也得益于python很強(qiáng)的自解釋能力，我用python代碼來簡化 isinstance 的過程:

def _isinstance(x, C):

# 快速匹配

if type(x) is C:

returnTrue

# 如果是由元類 type 直接構(gòu)造的類

if type(C) is type:

return C in x.__class__.__mro__

# 如果第二個(gè)參數(shù)是元組, 則遞歸調(diào)用

if type(C) is tuple:

for item in C:

r = _isinstance(x, item)

if r:

return r

# 用戶自定義檢測規(guī)則

if hasattr(C, "__instancecheck__"):

return C.__instancecheck__(x)

# 默認(rèn)行為

return C in x.__class__.__mro__

判斷的過程中有5個(gè)步驟，而用戶自定義的instancecheck則比較靠后，這個(gè)檢測過程主要還是以默認(rèn)的行為來進(jìn)行的，用戶行為并不優(yōu)先。

重載 isinstance(x, C)

因此，要想重載 isinstance(x, C) ，讓用戶能自定義判斷結(jié)果，就需要滿足以下條件：

x 對象不能是由 C 直接實(shí)例化；

C 類指定 metaclass ；

指定的 metaclass 類中定義了instancecheck。

滿足這些條件后，比如對鴨子協(xié)議如何判斷就比較清楚了：

classMetaSizeable(type):

def __instancecheck__(cls, instance):

print("__instancecheck__ call")

return hasattr(instance, "__len__")

classSizeable(metaclass=MetaSizeable):

pass

class B(object):

pass

b = B()

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

print(isinstance([], Sizeable)) # output: True

本次測試環(huán)境 Python3.6.0