歡迎光臨
每天分享高質量文章

一文讀懂架構師都不知道的isinstance檢查機制

來源:Python中文社區

ID:python-china

起步

通過內建方法 isinstance(object, classinfo) 可以判斷一個物件是否是某個類的實體。但你是否想過關於鴨子協議的物件是如何進行判斷的呢? 比如 list 類的父類是繼 object 類的,但通過 isinstance([], typing.Iterable) 傳回的卻是真,難道 list 是可迭代的子類?

根據 PEP 3119 的描述中得知實體的檢查是允許多載的:

  1. 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) ,傳回的結果便是實體檢測的結果,預設的判斷方式就沒有了。

這種方式有助於我們來檢查鴨子型別,我用代碼測了一下。

  1. class Sizeable(object):

  2.    def __instancecheck__(cls, instance):

  3.        print("__instancecheck__ call")

  4.        return hasattr(instance, "__len__")

  5. class B(object):

  6.    pass

  7. b = B()

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

只打印了 False,並且 instancecheck 沒有呼叫。 這是怎麼回事。可見文件描述並不清楚。打破砂鍋問到底的原則我從原始碼中觀察 isinstance 的檢測過程。

從原始碼來看 isinstance 的檢測過程

這部分的內容可能比較難,如果讀者覺得閱讀有難度可以跳過,直接看結論。isinstance 的原始碼在 abstract.c 檔案中:

  1. [abstract.c]

  2. int

  3. PyObject_IsInstance(PyObject *inst, PyObject *cls)

  4. {

  5.    _Py_IDENTIFIER(__instancecheck__);

  6.    PyObject *checker;

  7.    /* Quick test for an exact match */

  8.    if (Py_TYPE(inst) == (PyTypeObject *)cls)

  9.        return 1;

  10.    ....

  11. }

Py_TYPE(inst) == (PyTypeObject *)cls 這是一種快速匹配的方式,等價於 type(inst) is cls ,這種快速的方式僅當 inst = cls() 匹配成功,並不會去優先檢查 instancecheck ,所以文件中有誤。繼續向下看原始碼:

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

  2.    if (PyType_CheckExact(cls)) {

  3.        return recursive_isinstance(inst, cls);

  4.    }

展開宏 PyType_CheckExact :

  1. [object.h]

  2. #define PyType_CheckExact(op) (Py_TYPE(op) == &PyType_Type)

也就是說 cls 是由 type 直接構造出來的類,則判斷語言成立。除了類宣告里指定 metaclass 外基本都是由 type 直接構造的。從測試代碼中得知判斷成立,進入 recursiveisinstance。但是這個函式裡面我卻沒找到有關 instancecheck 的代碼,recursiveisinstance 的判斷邏輯大致是:

  1. def recursive_isinstance(inst, cls):

  2.    return pyType_IsSubtype(inst, cls)

  3. def pyType_IsSubtype(a, b):

  4.    for mro in a.__class__.__mro__:

  5.        if mro is b:

  6.            return True

  7.    return False

是從 mro 繼承順序來判斷的,mro 是一個元組,它表示類的繼承順序,這個元組的中類的順序也決定了屬性查找順序。回到 PyObject_IsInstance 函式往下看:

  1. if (PyTuple_Check(cls)) {

  2.    ...

  3. }

這是當 instance(x, C) 第二個引數是元組的情況,裡面的處理方式是遞迴呼叫 PyObject_IsInstance(inst, item) 。繼續往下看:

  1. checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);

  2. if (checker != NULL) {

  3.    res = PyObject_CallFunctionObjArgs(checker, inst, NULL);

  4.    ok = PyObject_IsTrue(res);

  5.    return ok;

  6. }

顯然,這邊才是獲得 instancecheck 的地方,為了讓檢查流程走到這裡,定義的類要指明 metaclass 。剩下就是跟蹤下 PyObjectLookupSpecial 就可以了:

  1. [typeobject.c]

  2. PyObject *

  3. _PyObject_LookupSpecial(PyObject *self, _Py_Identifier *attrid)

  4. {

  5.    PyObject *res;

  6.    res = _PyType_LookupId(Py_TYPE(self), attrid);

  7.    // 有回呼的話處理回呼

  8.    // ...

  9.    return res;

  10. }

取的是 PyTYPE(self) ,也就是說指定的 metaclass 裡面需要定義 instancecheck ,獲得該屬性後,通過 PyObjectCallFunctionObjArgs 呼叫,呼叫的內容才是用戶自定義的多載方法。

檢查機制總結

至此,isinstance 的檢測過程基本清晰了,為了便於理解,也得益於python很強的自解釋能力,我用python代碼來簡化 isinstance 的過程:

  1. def _isinstance(x, C):

  2.    # 快速匹配

  3.    if type(x) is C:

  4.        return True

  5.    # 如果是由元類 type 直接構造的類

  6.    if type(C) is type:

  7.        return C in x.__class__.__mro__

  8.    # 如果第二個引數是元組, 則遞迴呼叫

  9.    if type(C) is tuple:

  10.        for item in C:

  11.            r = _isinstance(x, item)

  12.            if r:

  13.                return r

  14.    # 用戶自定義檢測規則

  15.    if hasattr(C, "__instancecheck__"):

  16.        return C.__instancecheck__(x)

  17.    # 預設行為

  18.    return C in x.__class__.__mro__

判斷的過程中有5個步驟,而用戶自定義的 instancecheck 則比較靠後,這個檢測過程主要還是以預設的行為來進行的,用戶行為並不優先。

多載 isinstance(x, C)

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

x 物件不能是由 C 直接實體化; 

C 類指定 metaclass ; 

指定的 metaclass 類中定義了 instancecheck 。 

滿足這些條件後,比如對鴨子協議如何判斷就比較清楚了:

  1. class MetaSizeable(type):

  2.    def __instancecheck__(cls, instance):

  3.        print("__instancecheck__ call")

  4.        return hasattr(instance, "__len__")

  5. class Sizeable(metaclass=MetaSizeable):

  6.    pass

  7. class B(object):

  8.    pass

  9. b = B()

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

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

本次測試環境 Python3.6.0

作者:weapon,不會寫程式的浴室麥霸不是好的神經科醫生


     

《Python人工智慧和全棧開發》2018年07月23日即將在北京開課,120天衝擊Python年薪30萬,改變速約~~~~

*宣告:推送內容及圖片來源於網絡,部分內容會有所改動,版權歸原作者所有,如來源信息有誤或侵犯權益,請聯繫我們刪除或授權事宜。

- END -


更多Python好文請點擊【閱讀原文】哦

↓↓↓

赞(0)

分享創造快樂

© 2021 知識星球   网站地图