Python 多重繼承時metaclass conflict問題解決與原理探究

背景最近有一個需求需要自定義一個多繼承abc.ABC與django.contrib.admin.ModelAdmin兩個父類的抽象子類 , 方便不同模塊復用大部分代碼,同時強制必須實現所有抽象方法,沒想按想當然的寫法實現多繼承時,居然報錯metaclass conflict:
In [1]: import abcIn [2]: from django.contrib import adminIn [3]: class MyAdmin(abc.ABC, admin.ModelAdmin):...:pass...:---------------------------------------------------------------------------TypeErrorTraceback (most recent call last)<ipython-input-3-b159bc04ec1b> in <module>----> 1 class MyAdmin(abc.ABC, admin.ModelAdmin):2pass3TypeError: metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases一時之間疑惑滿滿,先是通過搜索快速找到了一個解決方案,但是卻并沒有弄明白問題的根本原因與解決方案的原理 , 最近終于有些時間可以深入探究一番,這里記錄一下 。PS: 本文所有討論均基于Python3,不考慮Python2的部分差異之處 。
什么是metaclass(元類)首先要弄清楚什么是metaclass,才可能明白metaclass conflict的真正含義 。
類比普通class與metaclass這里采用class(類)和instance(實例)的關系來類比解釋,如果要創建一個自定義class A,然后創建其實例,一般我們會這么寫:
In [1]: class A:...:def test(self):...:print('call test')In [2]: a = A()In [3]: print(a, type(a))<__main__.A object at 0x7f9f95414970> <class '__main__.A'>如上我們自定義了class A,并且生成了class A的實例對象a,print語句的輸出可以看出實例a的類型正是class A,此時如果我們進一步探究A的類型會發現:
【Python 多重繼承時metaclass conflict問題解決與原理探究】In [10]: print(type(A))<class 'type'>A類型是 class type 。我們會說a是class A的實例,那以此類推可以說class A是class type的實例 , 或者換一種說法:class A的實例是a,class type的實例是A ?,F在我們嘗試定義metaclass:在python中class不僅能創建實例對象,其本身也是一個對象,普通class創建實例普通對象 , metaclass(元類)則創建實例class對象 。PS: 嚴格來說metaclass本身不一定要是一個class,它可以是任意可以返回class的callable對象,這里我們不做深入探討 。
自定義與使用metaclass在python中應該怎么定義一個metaclass呢 , 其實type就是一個metaclass,type是所有class的默認metaclass,而且所有自定義的metaclass 最終也都會使用到type來執行最后創建class的工作 。事實上上面使用class A... 的語法定義類A時 , Python解釋器最終也是調用type來創建的class A,其等價于以下代碼:
In [23]: def fn(self):...:print('call test')...:In [24]: A = type('A', (object, ), dict(test=fn))type創建class的簽名如下:
type(name, bases, attrs)name: 要創建的class名稱bases: 要繼承的父類tuple(可以為空,但python3自定義class一般都默認繼承object)attrs: 包含class定義屬性名稱和值的dict絕大多數情況下我們并不需要用到metaclass,極少數需要動態創建/修改class的復雜場景比如Django的ORM才需要用到這一技術 。這里舉一個metaclass簡單使用示例,比如我們可以簡單創建一個給class統一加上其創建時間的metaclass , 以滿足需要時可以查看對應class首次創建時間的這個偽需求(僅為舉本例而提的需求_),如下AddCTimeMetaclass定義:
In [30]: from datetime import datetimeIn [31]: class AddCTimeMetaclass(type):...:def __new__(cls, name, bases, attrs):...:attrs['ctime'] = datetime.now()...:return super().__new__(cls, name, bases, attrs)...:In [32]: class B(metaclass=AddCTimeMetaclass):...:pass...:In [33]: B.ctimeOut[33]: datetime.datetime(2022, 10, 29, 1, 22, 46, 750176)在定義class B的時候,通過指定metaclass參數告訴解釋器創建class B時不使用默認的type而是使用自定義的元類AddCTimeMetaclass 。
metaclass confict(元類沖突)的清晰含義初步定義了metaclass并了解簡單使用之后,我們開始正式探究metaclass conflict,一個最簡單觸發metaclass conflict的例子如下:
In [42]: class M0(type):...:pass...:In [43]: class M1(type):...:pass...:In [44]: class A(metaclass=M0):...:pass...:In [45]: class B(metaclass=M1):...:pass...:In [46]: class C(A, B):...:pass...:---------------------------------------------------------------------------TypeErrorTraceback (most recent call last)<ipython-input-46-9900d594feda> in <module>----> 1 class C(A, B):2pass3TypeError: metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases如上M0與M1為自定義metaclass,分別作為A、B的metaclass,當class C試圖多繼承A、B時就會出問題,從字面意思理解:子類的metaclass必須是其所有基類metaclass的(非嚴格)子類,看起來普通class的多繼承和metaclass的多繼承之間發生了什么問題 。這段話具體怎么理解?我們已經知道A、B都分別具有自己的metaclass M0、M1 , 那么當C多繼承A、B的時候C的metaclass應該是M0還是M1呢?由于M0、M1兩者之間并沒有繼承關系,用哪個都不行,Python不知道怎么辦,只能告訴你出問題了 。

推薦閱讀