# `collections.abc` --- コンテナの抽象基底クラス

Added in version 3.3: 以前はこのモジュールは `collections` モジュールの一部でした。

ソースコード: Lib/_collections_abc.py

このモジュールは、 抽象基底クラス を提供します。抽象基底クラスは、クラスが特定のインターフェースを提供しているか、例えば ハッシュ可能 であるかや マッピング であるかを判定します。

`issubclass()` や `isinstance()` を使ったインターフェースに対するテストは、以下の3つのいずれかの方法で動作します。

1. A newly written class can inherit directly from one of the abstract base classes. The class must supply the required abstract methods. The remaining mixin methods come from inheritance and can be overridden if desired. Other methods may be added as needed:

       class C(Sequence):                      # Direct inheritance
           def __init__(self): ...             # Extra method not required by the ABC
           def __getitem__(self, index):  ...  # Required abstract method
           def __len__(self):  ...             # Required abstract method
           def count(self, value): ...         # Optionally override a mixin method

       >>> issubclass(C, Sequence)
       True
       >>> isinstance(C(), Sequence)
       True

2. Existing classes and built-in classes can be registered as "virtual subclasses" of the ABCs. Those classes should define the full API including all of the abstract methods and all of the mixin methods. This lets users rely on `issubclass()` or `isinstance()` tests to determine whether the full interface is supported. The exception to this rule is for methods that are automatically inferred from the rest of the API:

       class D:                                 # No inheritance
           def __init__(self): ...              # Extra method not required by the ABC
           def __getitem__(self, index):  ...   # Abstract method
           def __len__(self):  ...              # Abstract method
           def count(self, value): ...          # Mixin method
           def index(self, value): ...          # Mixin method

       Sequence.register(D)                     # Register instead of inherit

       >>> issubclass(D, Sequence)
       True
       >>> isinstance(D(), Sequence)
       True

   この例では、クラス `D` は `__contains__`, `__iter__`, `__reversed__` を定義する必要がありません。なぜなら in 演算子, the 反復 ロジック, および `reversed()` 関数は自動的に `__getitem__` と `__len__` を使うようにフォールバックするからです。

3. Some simple interfaces are directly recognizable by the presence of the required methods (unless those methods have been set to `None`):

       class E:
           def __iter__(self): ...
           def __next__(self): ...

       >>> issubclass(E, Iterable)
       True
       >>> isinstance(E(), Iterable)
       True

   複雑なインターフェースは、単に特定のメソッドが存在すること以上の定義を持つため、3番目のテクニックをサポートしていません。それらのインターフェースはメソッドの意味やメソッド間の関係まで指定するので、特定のメソッド名の存在からだけではインターフェースの推測ができません。たとえば、あるクラスが `__getitem__`, `__len__`, および `__iter__` を提供するというだけでは、 `Sequence` と `Mapping` を区別するには不十分です。

Added in version 3.9: これらの抽象クラスは `[]` をサポートするようになりました。 ジェネリックエイリアス型 および PEP 585 を参照してください。

## コレクション抽象基底クラス

collections モジュールは以下の ABC (抽象基底クラス) を提供します:

ABC | 継承しているクラス | 抽象メソッド | mixin メソッド
--- | --- | --- | ---
`Container` [1] |  | `__contains__` |
`Hashable` [1] |  | `__hash__` |
`Iterable` [1] [2] |  | `__iter__` |
`Iterator` [1] | `Iterable` | `__next__` | `__iter__`
`Reversible` [1] | `Iterable` | `__reversed__` |
`Generator` [1] | `Iterator` | `send`, `throw` | `close`, `__iter__`, `__next__`
`Sized` [1] |  | `__len__` |
`Callable` [1] |  | `__call__` |
`Collection` [1] | `Sized`, `Iterable`, `Container` | `__contains__`, `__iter__`, `__len__` |
`Sequence` | `Reversible`, `Collection` | `__getitem__`, `__len__` | `__contains__`, `__iter__`, `__reversed__`, `index`, `count`
`MutableSequence` | `Sequence` | `__getitem__`, `__setitem__`, `__delitem__`, `__len__`, `insert` | `Sequence` から継承したメソッドと、 `append`, `clear`, `reverse`, `extend`, `pop`, `remove`, `__iadd__`
`ByteString` | `Sequence` | `__getitem__`, `__len__` | `Sequence` から継承したメソッド
`Set` | `Collection` | `__contains__`, `__iter__`, `__len__` | `__le__`, `__lt__`, `__eq__`, `__ne__`, `__gt__`, `__ge__`, `__and__`, `__or__`, `__sub__`, `__rsub__`, `__xor__`, `__rxor__` and `isdisjoint`
`MutableSet` | `Set` | `__contains__`, `__iter__`, `__len__`, `add`, `discard` | `Set` から継承したメソッドと、 `clear`, `pop`, `remove`, `__ior__`, `__iand__`, `__ixor__`, `__isub__`
`Mapping` | `Collection` | `__getitem__`, `__iter__`, `__len__` | `__contains__`, `keys`, `items`, `values`, `get`, `__eq__`, `__ne__`
`MutableMapping` | `Mapping` | `__getitem__`, `__setitem__`, `__delitem__`, `__iter__`, `__len__` | `Mapping` から継承したメソッドと、 `pop`, `popitem`, `clear`, `update`, `setdefault`
`MappingView` | `Sized` |  | `__init__`, `__len__` and `__repr__`
`ItemsView` | `MappingView`, `Set` |  | `__contains__`, `__iter__`
`KeysView` | `MappingView`, `Set` |  | `__contains__`, `__iter__`
`ValuesView` | `MappingView`, `Collection` |  | `__contains__`, `__iter__`
`Awaitable` [1] |  | `__await__` |
`Coroutine` [1] | `Awaitable` | `send`, `throw` | `close`
`AsyncIterable` [1] |  | `__aiter__` |
`AsyncIterator` [1] | `AsyncIterable` | `__anext__` | `__aiter__`
`AsyncGenerator` [1] | `AsyncIterator` | `asend`, `athrow` | `aclose`, `__aiter__`, `__anext__`
`Buffer` [1] |  | `__buffer__` |

脚注

[1] (1,2,3,4,5,6,7,8,9,10,11,12,13,14,15)

これらの抽象基底クラスは `__subclasshook__()` をオーバーライドして、必要なメソッドが存在し、かつ `None` に指定されていないことを確かめることによってインターフェースをテストすることをサポートします。このテストは単純なインターフェースに対してのみ有効に働きます。より複雑なインターフェースは基底クラスへの登録や直接派生することが必要になります。

[2]

`isinstance(obj, Iterable)` によるチェックは `Iterable` として登録されたクラスや `__iter__()` メソッドを持つクラスを検出しますが、 `__getitem__()` メソッドにより反復処理を行うクラスは検出しません。オブジェクトがイテラブル (iterable) かどうかを確認する唯一の信頼できる方法は `iter(obj)` を呼び出すことです。

## コレクションの抽象基底クラス -- 詳細な説明

class collections.abc.Container

  `__contains__()` メソッドを提供するクラスの ABC です。

class collections.abc.Hashable

  `__hash__()` メソッドを提供するクラスの ABC です。

class collections.abc.Sized

  `__len__()` メソッドを提供するクラスの ABC です。

class collections.abc.Callable

  `__call__()` メソッドを提供するクラスの ABC です。

  `Callable` を型アノテーションで使う方法の詳細は、 呼び出し可能オブジェクトのアノテーション を参照してください。

class collections.abc.Iterable

  `__iter__()` メソッドを提供するクラスの ABC です。

  `isinstance(obj, Iterable)` によるチェックは `Iterable` として登録されたクラスや `__iter__()` メソッドを持つクラスを検出しますが、 `__getitem__()` メソッドにより反復処理を行うクラスは検出しません。オブジェクトがイテラブル (iterable) かどうかを確認する唯一の信頼できる方法は `iter(obj)` を呼び出すことです。

class collections.abc.Collection

  サイズ付きのイテラブルなコンテナクラスの ABC です。

  Added in version 3.6.

class collections.abc.Iterator

  `__iter__()` メソッドと `__next__()` メソッドを提供するクラスの ABC です。 iterator の定義も参照してください。

class collections.abc.Reversible

  `__reversed__()` メソッドを提供するイテラブルクラスの ABC です。

  Added in version 3.6.

class collections.abc.Generator

  PEP 342 で定義された、イテレータ を `send()`, `throw()`, `close()` の各メソッドに拡張するプロトコルを実装する、ジェネレータ クラスの ABC です。

  `Generator` を型アノテーションで使う方法の詳細は、 Annotating generators and coroutines を参照してください。

  Added in version 3.5.

class collections.abc.Sequence
class collections.abc.MutableSequence
class collections.abc.ByteString

  読み出し専用の シーケンス およびミュータブルな シーケンス の ABC です。

  Implementation note: Some of the mixin methods, such as `__iter__()`, `__reversed__()`, and `index()` make repeated calls to the underlying `__getitem__()` method. Consequently, if `__getitem__()` is implemented with constant access speed, the mixin methods will have linear performance; however, if the underlying method is linear (as it would be with a linked list), the mixins will have quadratic performance and will likely need to be overridden.

  index(value, start=0, stop=None)

    Return first index of value.

    Raises `ValueError` if the value is not present.

    Supporting the start and stop arguments is optional, but recommended.

    バージョン 3.5 で変更: The `index()` method gained support for the stop and start arguments.

  バージョン 3.12 で非推奨、バージョン 3.17 で削除予定: The `ByteString` ABC has been deprecated.

  Use `isinstance(obj, collections.abc.Buffer)` to test if `obj` implements the buffer protocol at runtime. For use in type annotations, either use `Buffer` or a union that explicitly specifies the types your code supports (e.g., `bytes | bytearray | memoryview`).

  `ByteString` was originally intended to be an abstract class that would serve as a supertype of both `bytes` and `bytearray`. However, since the ABC never had any methods, knowing that an object was an instance of `ByteString` never actually told you anything useful about the object. Other common buffer types such as `memoryview` were also never understood as subtypes of `ByteString` (either at runtime or by static type checkers).

  See PEP 688 for more details.

class collections.abc.Set
class collections.abc.MutableSet

  読み出し専用でミュータブルな 集合 の ABC です。

class collections.abc.Mapping
class collections.abc.MutableMapping

  読み出し専用の マッピング およびミュータブルな マッピング の ABC です。

class collections.abc.MappingView
class collections.abc.ItemsView
class collections.abc.KeysView
class collections.abc.ValuesView

  マッピング、要素、キー、値の ビュー の ABC です。

class collections.abc.Awaitable

  `await` で使用できる awaitable オブジェクトの ABC です。カスタムの実装は、`__await__()` メソッドを提供しなければなりません。

  `Coroutine` ABC の Coroutine オブジェクトとインスタンスは、すべてこの ABC のインスタンスです。

  注釈

  In CPython, generator-based coroutines (generators decorated with `@types.coroutine`) are awaitables, even though they do not have an `__await__()` method. Using `isinstance(gencoro, Awaitable)` for them will return `False`. Use `inspect.isawaitable()` to detect them.

  Added in version 3.5.

class collections.abc.Coroutine

  コルーチン と互換性のあるクラスの ABC です。これらは、コルーチンオブジェクト で定義された `send()`, `throw()`, `close()` のメソッドを実装します。カスタムの実装は、`__await__()` も実装しなければなりません。`Coroutine` のすべてのインスタンスは、 `Awaitable` のインスタンスでもあります。

  注釈

  In CPython, generator-based coroutines (generators decorated with `@types.coroutine`) are awaitables, even though they do not have an `__await__()` method. Using `isinstance(gencoro, Coroutine)` for them will return `False`. Use `inspect.isawaitable()` to detect them.

  `Coroutine` を型アノテーションで使う方法の詳細は、 Annotating generators and coroutines を参照してください。型パラメータの意味と順序は `Generator` と同様です。

  Added in version 3.5.

class collections.abc.AsyncIterable

  `__aiter__` メソッドを提供するクラスの ABC です。asynchronous iterable の定義も参照してください。

  Added in version 3.5.

class collections.abc.AsyncIterator

  `__aiter__` および `__anext__` メソッドを提供するクラスの ABC です。asynchronous iterator の定義も参照してください。

  Added in version 3.5.

class collections.abc.AsyncGenerator

  PEP 525 と PEP 492 に定義されているプロトコルを実装した 非同期ジェネレータ クラスの ABC です。

  `AsyncGenerator` を型アノテーションで使う方法の詳細は、 Annotating generators and coroutines を参照してください。

  Added in version 3.6.

class collections.abc.Buffer

  buffer protocol を実装する `__buffer__()` メソッドを提供するクラスのABCです。PEP 688 を参照してください。

  Added in version 3.12.

## 例とレシピ

抽象基底クラスは、クラスやインスタンスが特定の機能を提供しているかどうかを調べることを可能にします。例えば:

    size = None
    if isinstance(myvar, collections.abc.Sized):
        size = len(myvar)

幾つかの ABC はコンテナ型 API を提供するクラスを開発するのを助ける mixin 型としても使えます。例えば、 `Set` API を提供するクラスを作る場合、3つの基本になる抽象メソッド `__contains__()`, `__iter__()`, `__len__()` だけが必要です。ABC が残りの `__and__()` や `isdisjoint()` といったメソッドを提供します:

    class ListBasedSet(collections.abc.Set):
        ''' Alternate set implementation favoring space over speed
            and not requiring the set elements to be hashable. '''
        def __init__(self, iterable):
            self.elements = lst = []
            for value in iterable:
                if value not in lst:
                    lst.append(value)

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

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

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

    s1 = ListBasedSet('abcdef')
    s2 = ListBasedSet('defghi')
    overlap = s1 & s2            # The __and__() method is supported automatically

`Set` と `MutableSet` を mixin 型として利用するときの注意点:

1. 幾つかの set の操作は新しい set を作るので、デフォルトの mixin メソッドは イテラブル から新しいインスタンスを作成する方法を必要とします。クラスのコンストラクタは `ClassName(iterable)` の形のシグネチャを持つと仮定されます。内部の `_from_iterable()` という `classmethod` が `cls(iterable)` を呼び出して新しい set を作る部分でこの仮定が使われています。コンストラクタのシグネチャが異なるクラスで `Set` を使う場合は、 iterable 引数から新しいインスタンスを生成できるクラスメソッドあるいは仕様に沿ったメソッドで `_from_iterable()` をオーバーライドする必要があります。

2. (たぶん意味はそのままに速度を向上する目的で)比較をオーバーライドする場合、 `__le__()` と `__ge__()` だけを再定義すれば、その他の演算は自動的に追随します。

3. The `Set` mixin provides a `_hash()` method to compute a hash value for the set; however, `__hash__()` is not defined because not all sets are hashable or immutable. To add set hashability using mixins, inherit from both `Set` and `Hashable`, then define `__hash__ = Set._hash`.

参考

- `MutableSet` を使った例として OrderedSet recipe。

- ABCs についての詳細は、 `abc` モジュールと PEP 3119 を参照してください。