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

2022-11-01 14:03:22

背景

最近有一個需求需要自定義一個多繼承abc.ABC與django.contrib.admin.ModelAdmin兩個父類別的抽象子類，方便不同模組複用大部分程式碼，同時強制必須實現所有抽象方法，沒想按想當然的寫法實現多繼承時，居然報錯metaclass conflict：

In [1]: import abc
In [2]: from django.contrib import admin
In [3]: class MyAdmin(abc.ABC, admin.ModelAdmin):
   ...:     pass
   ...:
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-3-b159bc04ec1b> in <module>
----> 1 class MyAdmin(abc.ABC, admin.ModelAdmin):
      2     pass
      3
TypeError: 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的型別會發現:

In [10]: print(type(A))
<class 'type'>

A型別是 class type。
我們會說a是class A的範例，那以此類推可以說class A是class type的範例，或者換一種說法：class A的範例是a，class type的範例是A。
現在我們嘗試定義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 datetime
In [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.ctime
Out[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
    ...:
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-46-9900d594feda> in <module>
----> 1 class C(A, B):
      2     pass
      3

TypeError: 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不知道怎麼辦，只能告訴你出問題了。

解決方案

那理想情況下C的metaclass到底應該是什麼呢？理想情況應該如下所示：

M0     M1
 :    / :
 :   /  :
 A  M2  B
    :  /
    : /
     C

即採用多繼承了M0、M1的M2作為C的metaclass，這也是解決這個問題的最終方案，具體程式碼如下：

In [58]: class M2(M0, M1):
    ...:     pass
    ...:
In [59]: class C(A, B, metaclass=M2):
    ...:     pass
    ...:

如上我們通過手動定義M2，並手動明確指定class C的metaclass為M2，如此解決metaclass conflict問題。
這時再回到開頭碰到的多繼承abc.ABC與admin.ModelAdmin時遇到的問題就很容易理解了：因為abc.ABC有自己的metaclass abc.ABCMeta，同時modelAdmin也有自己的metaclass django.forms.widgets.MediaDefiningClass，並且這兩者之間沒有繼承關係，因而 class MyAdmin(abc.ABC, admin.ModelAdmin) 多繼承時直譯器無法推斷出滿足條件的metaclass，自然也就報錯了，解決辦法和上面的方案一樣，定義一個兩者metaclass的子類並將其指定為MyAdmin的metaclass即可，程式碼如下：

In [112]: print(type(abc.ABC), type(admin.ModelAdmin))
<class 'abc.ABCMeta'> <class 'django.forms.widgets.MediaDefiningClass'>
In [113]: class MyMeta(type(abc.ABC), type(admin.ModelAdmin)):
     ...:     pass
     ...:
In [114]: class MyAdmin(abc.ABC, admin.ModelAdmin, metaclass=MyMeta):
     ...:     pass
     ...:
In [115]: print(type(MyAdmin))
<class '__main__.MyMeta'>