collections.abc
--- コレクションの抽象基底クラス¶
バージョン 3.3 で追加: 以前はこのモジュールは collections
モジュールの一部でした。
ソースコード: Lib/_collections_abc.py
このモジュールは、 抽象基底クラス を提供します。抽象基底クラスは、クラスが特定のインターフェースを提供しているか、例えばハッシュ可能であるかやマッピングであるかを判定します。
An issubclass()
or isinstance()
test for an interface works in one
of three ways.
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
In this example, class D
does not need to define
__contains__
, __iter__
, and __reversed__
because the
in-operator, the iteration
logic, and the reversed()
function automatically fall back to
using __getitem__
and __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__(next): ...
>>> issubclass(E, Iterable)
True
>>> isinstance(E(), Iterable)
True
Complex interfaces do not support this last technique because an
interface is more than just the presence of method names. Interfaces
specify semantics and relationships between methods that cannot be
inferred solely from the presence of specific method names. For
example, knowing that a class supplies __getitem__
, __len__
, and
__iter__
is insufficient for distinguishing a Sequence
from
a Mapping
.
バージョン 3.9 で追加: These abstract classes now support []
. See Generic Alias Type
and PEP 585.
コレクション抽象基底クラス¶
collections モジュールは以下の ABC (抽象基底クラス) を提供します:
ABC |
継承しているクラス |
抽象メソッド |
mixin メソッド |
---|---|---|---|
|
|||
|
|||
|
|||
|
|
||
|
|||
|
|
||
|
|||
|
|||
|
|||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|
||
|
|||
|
|
||
|
|
脚注
- 1(1,2,3,4,5,6,7,8,9,10,11,12,13,14)
These ABCs override
object.__subclasshook__()
to support testing an interface by verifying the required methods are present and have not been set toNone
. This only works for simple interfaces. More complex interfaces require registration or direct subclassing.- 2
Checking
isinstance(obj, Iterable)
detects classes that are registered asIterable
or that have an__iter__()
method, but it does not detect classes that iterate with the__getitem__()
method. The only reliable way to determine whether an object is iterable is to calliter(obj)
.
Collections Abstract Base Classes -- Detailed Descriptions¶
- class collections.abc.Container¶
__contains__()
メソッドを提供するクラスの ABC です。
- class collections.abc.Hashable¶
__hash__()
メソッドを提供するクラスの ABC です。
- class collections.abc.Sized¶
__len__()
メソッドを提供するクラスの ABC です。
- class collections.abc.Callable¶
__call__()
メソッドを提供するクラスの ABC です。
- class collections.abc.Iterable¶
__iter__()
メソッドを提供するクラスの ABC です。メソッド
isinstance(obj, Iterable)
で使用すると、Iterable
や__iter__()
メソッドを持っているクラスを検出できます。しかし、__getitem__()
メソッドで反復するクラスは検出しません。 オブジェクトが iterable であるかどうかを判別するにあたって、信頼できる唯一の方法はiter(obj)
を呼び出す方法です。
- class collections.abc.Collection¶
サイズ付きのイテラブルなコンテナクラスの ABC です。
バージョン 3.6 で追加.
- class collections.abc.Iterator¶
__iter__()
メソッドと__next__()
メソッドを提供するクラスの ABC です。 iterator の定義も参照してください。
- class collections.abc.Reversible¶
__reversed__()
メソッドを提供するイテラブルクラスの ABC です。バージョン 3.6 で追加.
- class collections.abc.Generator¶
PEP 342 で定義された、イテレータを
send()
,throw()
,close()
の各メソッドに拡張するプロトコルを実装する、ジェネレータクラスの ABC です。generator の定義も参照してください。バージョン 3.5 で追加.
- class collections.abc.Sequence¶
- class collections.abc.MutableSequence¶
- class collections.abc.ByteString¶
読み出し専用の シーケンス およびミュータブルな シーケンス の ABC です。
実装における注意:
__iter__()
,__reversed__()
,index()
など、一部の mixin メソッドは、下層の__getitem__()
メソッドを繰り返し呼び出します。その結果、__getitem__()
が定数のアクセス速度で実装されている場合、mixin メソッドは線形のパフォーマンスとなります。下層のメソッドが線形 (リンクされたリストの場合など) の場合、mixin は 2 乗のパフォーマンスとなるため、多くの場合上書きする必要があるでしょう。バージョン 3.5 で変更: index() メソッドは stop と start 引数をサポートしました。
- 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. Usingisinstance(gencoro, Awaitable)
for them will returnFalse
. Useinspect.isawaitable()
to detect them.バージョン 3.5 で追加.
- class collections.abc.Coroutine¶
コルーチンと互換性のあるクラスの ABC です。これらは、コルーチンオブジェクト で定義された
send()
,throw()
,close()
のメソッドを実装します。カスタムの実装は、__await__()
も実装しなければなりません。Coroutine
のすべてのインスタンスは、Awaitable
のインスタンスでもあります。coroutine の定義も参照してください。注釈
In CPython, generator-based coroutines (generators decorated with
types.coroutine()
) are awaitables, even though they do not have an__await__()
method. Usingisinstance(gencoro, Coroutine)
for them will returnFalse
. Useinspect.isawaitable()
to detect them.バージョン 3.5 で追加.
- class collections.abc.AsyncIterable¶
__aiter__
メソッドを提供するクラスの ABC です。asynchronous iterable の定義も参照してください。バージョン 3.5 で追加.
- class collections.abc.AsyncIterator¶
__aiter__
および__anext__
メソッドを提供するクラスの ABC です。asynchronous iterator の定義も参照してください。バージョン 3.5 で追加.
例とレシピ¶
ABCs allow us to ask classes or instances if they provide particular functionality, for example:
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 型として利用するときの注意点:
幾つかの set の操作は新しい set を作るので、デフォルトの mixin メソッドは iterable から新しいインスタンスを作成する方法を必要とします。クラスのコンストラクタは
ClassName(iterable)
の形のシグネチャを持つと仮定されます。内部の_from_iterable()
というクラスメソッドがcls(iterable)
を呼び出して新しい set を作る部分でこの仮定が使われています。コンストラクタのシグネチャが異なるクラスでSet
を使う場合は、 iterable 引数から新しいインスタンスを生成できるクラスメソッドあるいは仕様に沿ったメソッドで_from_iterable()
をオーバーライドする必要があります。(たぶん意味はそのままに速度を向上する目的で)比較をオーバーライドする場合、
__le__()
と__ge__()
だけを再定義すれば、その他の演算は自動的に追随します。Set
mixin型は set のハッシュ値を計算する_hash()
メソッドを提供しますが、すべての set が hashable や immutable とは限らないので、__hash__()
は提供しません。 mixin を使ってハッシュ可能な set を作る場合は、Set
とHashable
の両方を継承して、__hash__ = Set._hash
と定義してください。
参考
MutableSet
を使った例として OrderedSet recipe。