collections.abc —容器的抽象 Base Class

版本 3.3 中的新增Function：以前，此模块是collections模块的一部分。

源代码： Lib/_collections_abc.py

此模块提供抽象 Base Class，可用于测试类是否提供了特定的接口；例如，它是否可散列还是 Map。

集合抽象 Base Class

收款模块提供以下ABCs：

ABC Inherits from Abstract Methods Mixin Methods
Container __contains__
Hashable __hash__
Iterable __iter__
Iterator Iterable __next__ __iter__
Reversible Iterable __reversed__
Generator Iterator send , throw close , __iter__ , __next__
Sized __len__
Callable __call__
Collection 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，reverse，extend，pop，remove和__iadd__
ByteString Sequence __getitem__ , __len__ 继承的Sequence个方法
Set Collection __contains__ , __iter__ , __len__ __le__，__lt__，__eq__，__ne__，__gt__，__ge__，__and__，__or__，__sub__，__xor__和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 __len__
ItemsView MappingView, Set __contains__ , __iter__
KeysView MappingView, Set __contains__ , __iter__
ValuesView MappingView, Collection __contains__ , __iter__
Awaitable __await__
Coroutine Awaitable send , throw close
AsyncIterable __aiter__
AsyncIterator AsyncIterable __anext__ __aiter__
AsyncGenerator AsyncIterator asend , athrow aclose , __aiter__ , __anext__

检查isinstance(obj, Iterable)会检测已注册为Iterable或具有iter()方法的类，但不会检测到使用getitem()方法进行迭代的类。确定对象是否为iterable的唯一可靠方法是调用iter(obj)。

3.6 版的新Function。

3.6 版的新Function。

3.5 版中的新Function。

实施注意事项：某些 mixin 方法(例如iter()，reversed()和index())反复调用基础getitem()方法。因此，如果以恒定的访问速度实现getitem()，则 mixin 方法将具有线性性能；但是，如果基础方法是线性的(如链表那样)，则混合将具有二次性能，并且可能需要重写。

在版本 3.5 中进行了更改：index()方法添加了对* stop 和 start *参数的支持。

Coroutine对象和Coroutine ABC 的实例都是此 ABC 的所有实例。

Note

在 CPython 中，即使没有await()方法，基于生成器的协程(以types.coroutine()或asyncio.coroutine()装饰的生成器)也是* waitables *。对他们使用isinstance(gencoro, Awaitable)将返回False。使用inspect.isawaitable()来检测它们。

3.5 版中的新Function。

Note

在 CPython 中，即使没有await()方法，基于生成器的协程(以types.coroutine()或asyncio.coroutine()装饰的生成器)也是* waitables *。对他们使用isinstance(gencoro, Coroutine)将返回False。使用inspect.isawaitable()来检测它们。

3.5 版中的新Function。

3.5 版中的新Function。

3.5 版中的新Function。

3.6 版的新Function。

这些 ABC 允许我们询问类或实例是否提供特定Function，例如：

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

几种 ABC 可用作混合器，使开发支持容器 API 的类更加容易。例如，要编写一个支持完整的Set API 的类，只需提供三个底层抽象方法：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用作混合的注意事项：

See also

首页