collections.abc —- 容器的抽象基类

3.3 新版功能: 该模块曾是 collections 模块的组成部分。

成都创新互联公司于2013年开始，先为栖霞等服务建站，栖霞等地企业，进行企业商务咨询服务。为栖霞企业网站制作PC+手机+微官网三网同步一站式服务解决您的所有建站问题。

源代码： Lib/_collections_abc.py

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

一个接口的 issubclass() 或 isinstance() 测试采用以下三种方式之一。

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__(next): ...
 
 
 
 

 
 
 
 

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

复杂的接口不支持最后这种技术手段因为接口并不只是作为方法名称存在。 接口指明了方法之间的语义和关系，这些是无法根据特定方法名称的存在推断出来的。 例如，知道一个类提供了 __getitem__, __len__ 和 __iter__ 并不足以区分 Sequence 和 Mapping。

3.9 新版功能: 这些抽象类现在都支持 []。 参见 GenericAlias 类型 和 PEP 585。

容器抽象基类

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

附注

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

这些 ABC 重载了 object.__subclasshook__() 以便支持通过验证所需的方法是否存在并且没有被设为 None 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或直接子类化。

2

检查 isinstance(obj, Iterable) 是否侦测到被注册为 Iterable 或者具有 __iter__() 方法的类，但它不能侦测到使用 __getitem__() 方法进行迭代的类。 确定一个对象是否为 iterable 的唯一可靠方式是调用 iter(obj)。

多项集抽象基类 — 详细描述

class collections.abc.Container

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

class collections.abc.Hashable

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

class collections.abc.Sized

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

class collections.abc.Callable

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

class collections.abc.Iterable

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

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

class collections.abc.Collection

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

3.6 新版功能.

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

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

实现笔记：一些混入（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

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

class collections.abc.MappingView

class collections.abc.ItemsView

class collections.abc.KeysView

class collections.abc.ValuesView

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

class collections.abc.Awaitable

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

协程 对象和 Coroutine ABC 的实例都是这个 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.

3.5 新版功能.

class collections.abc.Coroutine

用于协程兼容类的抽象基类。实现了如下定义在 协程对象: 里的方法： 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. Using isinstance(gencoro, Coroutine) for them will return False. Use inspect.isawaitable() to detect them.

3.5 新版功能.

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 里的协议。

3.6 新版功能.

例子和配方

ABC 允许我们询问类或实例是否提供特定的功能，例如:

 
 
 
 

  
  
  
  
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
 
 
 
 

当把 Set 和 MutableSet 用作混入类时需注意：

1. 由于某些集合操作会创建新集合，默认的混入方法需要一种从可迭代对象里创建新实例的方式。 假定类构造器具有 ClassName(iterable) 形式的签名。 这样它将执行一个名为 _from_iterable() 的内部类方法，该方法会调用 cls(iterable) 来产生一个新集合。 如果 Set 混入类在具有不同构造器签名的类中被使用，你将需要通过类方法或常规方法来重载 _from_iterable()，以便基于可迭代对象参数来构造新的实例。

2. 重载比较符时时（想必是为了速度，因为其语义都是固定的），只需要重定义 __le__() 和 __ge__() 函数，然后其他的操作会自动跟进。

3. 混入集合类 Set 提供了一个 _hash() 方法为集合计算哈希值，然而， __hash__() 函数却没有被定义，因为并不是所有集合都是可哈希并且不可变的。为了使用混入类为集合添加哈希能力，可以同时继承 Set() 和 Hashable() 类，然后定义 __hash__ = Set._hash。

参见

• OrderedSet recipe 是基于 MutableSet 构建的一个示例。

• 对于抽象基类，参见 abc 模块和 PEP 3119。

网页名称：创新互联Python教程：collections.abc—-容器的抽象基类
文章路径：http://www.shufengxianlan.com/qtweb/news21/293821.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联