Pythonのcollections.abcで学ぶコンテナの抽象基底クラス

Pythonには、コンテナ型のための抽象基底クラス（Abstract Base Classes: ABC）が標準ライブラリとして用意されています。これらは collections.abc モジュールにまとめられており、Container、Hashable、Generator、Set、MutableSet、Awaitable など、さまざまな抽象基底クラスが定義されています。

collections.abcモジュールのインポート

このモジュールを使用するには、まず次のようにインポートします。

import collections.abc

抽象基底クラスの活用例

抽象基底クラスは、独自のコンテナクラスを開発する際に非常に役立ちます。たとえば、セット（集合）としての完全な機能を持つコンテナを作成したい場合、Set 抽象基底クラスを継承するだけで実現できます。

このとき、自作クラス側で実装が必要なメソッドは主に次の3つです。

• __contains__()：指定した要素が含まれているかを判定する
• __iter__()：イテレータを返す
• __len__()：要素数を返す

これらの特殊メソッドさえ用意すれば、& 演算子による積集合の計算など、Set クラスが提供する豊富な演算機能をそのまま利用できるようになります。

サンプルコード

以下は、リストを内部に持つ独自のセットクラス ListSet を、collections.abc.Set を継承して実装した例です。

import collections.abc

class ListSet(collections.abc.Set):
    def __init__(self, iterable):
        self.elements = lst = list()
        for element in iterable:
            if element not in lst:
                lst.append(element)

    def __iter__(self):
        return iter(self.elements)

    def __contains__(self, value):
        return value in self.elements

    def __len__(self):
        return len(self.elements)


set1 = ListSet('ABCDEF')
set2 = ListSet('DEFGHI')
intersect = set1 & set2

intersect_iter = iter(intersect)

try:
    while True:
        print(next(intersect_iter))
except StopIteration:
    pass

実行結果

このコードでは、'ABCDEF' と 'DEFGHI' の共通要素（積集合）を求め、順番に出力しています。

D
E
F

ポイント解説

• ListSet は重複しないようにリストへ要素を追加することで、セットの性質を実現しています。
• set1 & set2 のような演算子による操作は、Set 抽象基底クラスが提供するミックスインメソッドによって自動的に使えるようになります。
• イテレーションは next() を使って手動で進めており、要素が尽きた時点で発生する StopIteration を捕捉してループを終了させています。

このように抽象基底クラスを継承すると、最小限のメソッド実装だけで、Python標準のセットと同等の振る舞いを持つ独自コンテナを簡潔に構築できます。