collections.abc – 抽象基类详解(33)Python语言(必读进阶学习教程)(参考资料)

集合抽象基类

集合模块提供以下抽象基类：

class collections.abc.Container

class collections.abc.Hashable

class collections.abc.Sized

class collections.abc.Callable

分别提供方法__contains__()、 __hash__()、__len__()和的类的基础知识__call__()。

classcollections.abc.Iterable

提供了 __iter__() 方法的抽象基类。

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

classcollections.abc.Collection

集合了 Sized 和 Iterable 类的抽象基类。

版本3.6中的新功能。

classcollections.abc.Iterator

提供了 __iter__() 和 __next__() 方法的抽象基类。参见 iterator 的定义

classcollections.abc.Reversible

为可迭代类提供了 __reversed__() 方法的抽象基类。

版本3.6中的新功能。

classcollections.abc.Generator

生成器类，实现了 PEP 342 中定义的协议，继承并扩展了迭代器，提供了 send(), throw() 和 close() 方法。参见 generator 的定义。

版本3.5中的新功能。

classcollections.abc.Sequence

classcollections.abc.MutableSequence

classcollections.abc.ByteString

只读且可变的序列 sequences 的抽象基类。

实现注意事项：一些 mixin 方法，例如 __iter__()、__reversed__() 和 index()，会重复调用底层的 __getitem__() 方法。 因此，如果 __getitem__() 以恒定的访问速度实现，则 mixin 方法将具有线性性能； 然而，如果底层方法是线性的（就像链表一样），mixins 将具有二次性能并且可能需要被覆盖。

在 3.5 版更改： index() 方法添加了对停止和启动参数的支持。

classcollections.abc.Set

classcollections.abc.MutableSet

只读且可变的集合的抽象基类。

classcollections.abc.Mapping

classcollections.abc.MutableMapping

只读且可变的映射 mappings 的抽象基类。

classcollections.abc.MappingView

classcollections.abc.ItemsView

classcollections.abc.KeysView

classcollections.abc.ValuesView

映射及其键和值的视图 views 的抽象基类。

classcollections.abc.Awaitable

为可等待对象 awaitable 提供的类，可以被用于 await 表达式中。习惯上必须实现 __await__() 方法。

协程对象 Coroutine 和 Coroutine 抽象基类的实例都是这个抽象基类的实例。

注意

在 CPython 里，基于生成器的协程（使用 types.coroutine() 或 asyncio.coroutine() 包装的生成器）都是 可等待对象，即使他们不含有 __await__() 方法。使用 isinstance(gencoro, Awaitable) 来检测他们会返回 False。要使用 inspect.isawaitable() 来检测他们。

版本3.5中的新功能。

classcollections.abc.Coroutine

用于协程兼容类的ABC。这些实现以下方法，在定义协程对象： send()，throw()，和 close()。自定义实现也必须实现 __await__()。所有Coroutine实例也是实例 Awaitable。另见coroutine的定义。

注意

在 CPython 里，基于生成器的协程（使用 types.coroutine() 或 asyncio.coroutine() 包装的生成器）都是 可等待对象，即使他们不含有 __await__() 方法。使用 isinstance(gencoro, Coroutine) 来检测他们会返回 False。要使用 inspect.isawaitable() 来检测他们。

版本3.5中的新功能。

classcollections.abc.AsyncIterable

提供了 __aiter__ 方法的抽象基类。参见 asynchronous iterable 的定义。

版本3.5中的新功能。

classcollections.abc.AsyncIterator

提供了 __aiter__ 和 __anext__ 方法的抽象基类。参见 asynchronous iterator 的定义。

版本3.5中的新功能。

classcollections.abc.AsyncGenerator

为异步生成器类提供的抽象基类，这些类实现了定义在 PEP 525 和 PEP 492 里的协议。

版本3.6中的新功能。

这些抽象基类让我们可以确定类和示例拥有某些特定的函数，例如：

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

有些抽象基类也可以用作混入类（mixin），这可以更容易地开发支持容器 API 的类。例如，要写一个支持完整 Set API 的类，只需要提供下面这三个方法： __contains__(), __iter__() 和 __len__()。抽象基类会补充上其余的方法，比如 __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