Python 的 enum 模塊源碼分析

成員名不允許重複

這部分我的第一個想法是去控制__dict__中的 key 。但這樣的方式並不好,__dict__ 範圍大,它包含該類的所有屬性和方法。而不單單是枚舉的命名空間。我在源碼中發現 enum 使用另一個方法。通過 __prepare__ 魔術方法可以返回一個類字典實例,在該實例 使用__prepare__ 魔術方法自定義命名空間,在該空間內限定成員名不允許重複。

再看看 Enum 模塊的具體實現:

模塊中的_EnumDict 創建了_member_names 列表來存儲成員名,這是因爲不是所有的命名空間內的成員都是枚舉的成員。比如 __str__, __new__ 等魔術方法就不是了,所以這邊的 __setitem__ 需要做一些過濾:

模塊考慮的會更全面。

每個成員都有名稱屬性和值屬性

上述的代碼中,Color.red 取得的值是 1。而 eumu 模塊中,定義的枚舉類中,每個成員都是有名稱和屬性值的;並且細心的話還會發現 Color.red 是 Color 的示例。這樣的情況是如何來實現的呢。

還是用元類來完成,在元類的 __new__ 中實現,具體的思路是,先創建目標類,然後爲每個成員都創建一樣的類,再通過 setattr 的方式將後續的類作爲屬性添加到目標類中,僞代碼如下:

來看下一個可運行的demo:

enum 模塊在讓每個成員都有名稱和值的屬性的實現思路是一樣的(代碼我就不貼了)。EnumMeta.__new__ 是該模塊的重點,幾乎所有枚舉的特性都在這個函數實現。

當成員值相同時,第二個成員是第一個成員的別名

從這節開始就不再使用自己實現的類的說明了,而是通過拆解 enum 模塊的代碼來說明其實現了,從模塊的使用特性中可以知道,如果成員值相同,後者會是前者的一個別名:

從這可以知道,red和_red是同一對象。這又要怎麼實現呢?

元類會爲枚舉類創建_member_map_ 屬性來存儲成員名與成員的映射關係,如果發現創建的成員的值已經在映射關係中了,就會用映射表中的對象來取代:

從代碼上來看,即使是成員值相同,還是會先爲他們都創建對象,不過後創建的很快就會被垃圾回收掉了(我認爲這邊是有優化空間的)。通過與_member_map_ 映射表做對比,用以創建該成員值的成員取代後續,但兩者成員名都會在 _member_map_中,如例子中的red和_red 都在該字典,但他們指向的是同一個對象。

屬性_member_names_只會記錄第一個,這將會與枚舉的迭代有關。

可以通過成員值來獲取成員

枚舉類中的成員都是單例模式,元類創建的枚舉類中還維護了值到成員的映射關係 _value2member_map_:

然後在 Enum 的__new__返回該單例即可:

迭代的方式遍歷成員

枚舉類支持迭代的方式遍歷成員,按定義的順序,如果有值重複的成員,只獲取重複的第一個成員。對於重複的成員值只獲取第一個成員,正好屬性_member_names_只會記錄第一個:

總結

enum 模塊的核心特性的實現思路就是這樣,幾乎都是通過元類黑魔法來實現的。對於成員之間不能做比較大小但可以做等值比較。這反而不需要講,這其實繼承自 object 就是這樣的,不用額外做什麼就有的“特性”了。

總之,enum 模塊相對獨立,且代碼量不多,對於想知道元類編程可以閱讀一下,教科書式教學,還有單例模式等,值得一讀。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章