深度剖析isinstance的檢查機制

weapon發表於2019-02-16

起步

通過內建方法 isinstance(object, classinfo) 可以判斷一個物件是否是某個類的例項。但你是否想過關於鴨子協議的物件是如何進行判斷的呢？ 比如 list 類的父類是繼 object 類的，但通過 isinstance([], typing.Iterable) 返回的卻是真，難道 list 是可迭代的子類？學過Python的物件導向應該知道，list的基類是object的。

根據 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__ 沒有呼叫。 這是怎麼回事。可見文件描述並不清楚。打破砂鍋問到底的原則我從原始碼中觀察 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 直接構造的。從測試程式碼中得知判斷成立，進入 recursive_isinstance。但是這個函式裡面我卻沒找到有關 __instancecheck__ 的程式碼，recursive_isinstance 的判斷邏輯大致是:

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 。剩下就是跟蹤下 _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__ ，獲得該屬性後，通過 PyObject_CallFunctionObjArgs 呼叫，呼叫的內容才是使用者自定義的過載方法。

檢查機制總結

至此，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) ，讓使用者能自定義判斷結果，就需要滿足以下條件：

  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

參考閱讀

customizing-instance-and-subclass-checks

class.__mro__

相關文章