python standard library collections.abc

发表于 | 更新于 | 分类于 | 阅读次数：
本文字数： 5.5k | 阅读时长 ≈ 5 分钟

python 标准库 之 collections.abc

每日一词: wrong

adj. 不道德的, 不正当的, 不义的

不确实的, 不正确的, 错误的

不合要求的, 不适合的, 并非合意的

有故障, 有毛病

adv. 方式或方向错误地; 错误地; 结果错误地

n. 罪过, 过失, 罪恶

不义的行为, 不公正的事

时 态: wronged, wronging, wrongs
名 词: wronger
副 词: wrongly
名 词: wrongness

词语：

confound right and wrong

混淆是非，黑白不分

get one wrong

误会某人；误会

right or wrong
adv. 不管如何

something wrong with

…出了毛病；…有问题；…不对头

python 标准库学习之 抽象基类 collection.abc

众所周知,python3中所有类默认继承自object类,意味着父类中所有的方法,子类都继承了。

我个人理解,抽象基类是无法被实例化的,只能子类实现

参考文档

源代码： Lib/_collections_abc.py

该模块定义了一些 抽象基类，它们可用于判断一个具体类是否具有某一特定的接口；例如，这个类是否可哈希，或其是否为映射类。

模块里方法一览,摘自源码

1
2
3
4
5
6
7
8
9
10
__all__ = ["Awaitable", "Coroutine",
           "AsyncIterable", "AsyncIterator", "AsyncGenerator",
           "Hashable", "Iterable", "Iterator", "Generator", "Reversible",
           "Sized", "Container", "Callable", "Collection",
           "Set", "MutableSet",
           "Mapping", "MutableMapping",
           "MappingView", "KeysView", "ItemsView", "ValuesView",
           "Sequence", "MutableSequence",
           "ByteString",
           ]

容器抽象基类

这个容器模块提供了以下 ABCs:

抽象基类 继承自 抽象方法 Mixin 方法
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, and 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__, 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__, and __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__

类

  • class collections.abc.Container

  • class collections.abc.Hashable

  • class collections.abc.Sized

  • class collections.abc.Callable

    分别提供了 __contains__(), __hash__(), __len__() 和 __call__() 方法的抽象基类。

  • class collections.abc.Iterable

    提供了 __iter__() 方法的抽象基类。使用 isinstance(obj, Iterable) 可以检测一个类是否已经注册到了 Iterable 或者实现了 __iter__() 函数，但是无法检测这个类是否能够使用 __getitem__() 方法进行迭代。检测一个对象是否是 iterable 的唯一可信赖的方法是调用 iter(obj)。

  • class collections.abc.Collection

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

  • class collections.abc.Iterator

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

  • class collections.abc.Reversible

    为可迭代类提供了 __reversed__() 方法的抽象基类。3.6 新版功能.

  • class collections.abc.Generator

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

  • class collections.abc.Sequence

  • class collections.abc.MutableSequence

  • class collections.abc.ByteString

    只读且可变的序列 sequences 的抽象基类。实现笔记：一些混入（Maxin）方法比如 __iter__(), __reversed__() 和 index() 会重复调用底层的 __getitem__() 方法。因此，如果实现的 __getitem__() 是常数级访问速度，那么相应的混入方法会有一个线性的表现；然而，如果底层方法是线性实现（例如链表），那么混入方法将会是平方级的表现，这也许就需要被重构了。在 3.5 版更改: index() 方法支持 stop 和 start 参数。

  • class collections.abc.Set

  • class collections.abc.MutableSet

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

  • class collections.abc.Mapping

  • class collections.abc.MutableMapping

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

  • class collections.abc.MappingView

  • class collections.abc.ItemsView

  • class collections.abc.KeysView

  • class collections.abc.ValuesView

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

  • class collections.abc.Awaitable

    为可等待对象 awaitable 提供的类，可以被用于 await 表达式中。习惯上必须实现 __await__() 方法。协程对象 Coroutine 和 Coroutine 抽象基类的实例都是这个抽象基类的实例。

  • class collections.abc.Coroutine

    用于协程兼容类的抽象基类。实现了如下定义在 协程对象: 里的方法： send()，throw() 和 close()。通常的实现里还需要实现 __await__() 方法。所有的 Coroutine 实例都必须是 Awaitable 实例。参见 coroutine 的定义。注解 在 CPython 里，基于生成器的协程（使用 types.coroutine() 或 asyncio.coroutine() 包装的生成器）都是 可等待对象，即使他们不含有 __await__() 方法。使用 isinstance(gencoro, Coroutine) 来检测他们会返回 False。要使用 inspect.isawaitable() 来检测他们。

  • class collections.abc.AsyncIterable

    提供了 __aiter__ 方法的抽象基类。参见 asynchronous iterable 的定义。3.5 新版功能.

  • class collections.abc.AsyncIterator

    提供了 __aiter__ 和 __anext__ 方法的抽象基类。参见 asynchronous iterator 的定义。3.5 新版功能.

  • class collections.abc.AsyncGenerator

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

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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 用作混入类时需注意：

  1. 由于某些集合操作会创建新集合，默认的混入方法需要一种从可迭代对象里创建新实例的方法。假如其类构造函数签名形如 ClassName(iterable) ，则其会调用一个内部的类方法 _from_iterable()，其中调用了 cls(iterable) 来生成一个新集合。如果这个 Set 混入类在类中被使用，但其构造函数的签名却是不同的形式，那么你就需要重载 _from_iterable() 方法，将其编写成一个类方法，并且它能够从可迭代对象参数中构造一个新实例。
  2. 重载比较符时时（想必是为了速度，因为其语义都是固定的），只需要重定义 __le__() 和 __ge__() 函数，然后其他的操作会自动跟进。
  3. 混入集合类 Set 提供了一个 _hash() 方法为集合计算哈希值，然而， __hash__() 函数却没有被定义，因为并不是所有集合都是可哈希并且不可变的。为了使用混入类为集合添加哈希能力，可以同时继承 Set() 和 Hashable() 类，然后定义 __hash__ = Set._hash。

总结

我看了官方文档的描述,一头雾水。下面就我个人理解谈谈这个模块。

abc模块应用的场景

1. 判定某个对象的类型

2. 强制子类实现某些父类方法

坚持原创技术分享，您的支持将鼓励我继续创作！
0%