Python中的collections.abc的使用方法

在 Python 中，collections.abc 模块提供了许多抽象基类，这些基类定义了集合类型的接口。它们是用于实现自定义集合类型的基础类，也可以用于检查现有对象是否符合特定集合类型的行为。以下是 collections.abc 中每个常见基类的详细介绍和使用示例。

1. Iterable：判断是否可以迭代

Iterable 是一个抽象基类，表示对象是否可以被迭代（即支持 for 循环）。

• 用法：检查一个对象是否可迭代。
• 实现：一个对象如果实现了 __iter__ 方法，或实现了 __getitem__ 方法并抛出 IndexError，则它是可迭代的。

示例：

from collections.abc import Iterable

# 检查列表是否可迭代
print(isinstance([1, 2, 3], Iterable))  # True

# 检查整数是否可迭代
print(isinstance(123, Iterable))  # False

2. Mapping：表示映射类型（如字典）

Mapping 是一个抽象基类，表示一个对象是“映射类型”，即它是一个由键值对组成的数据结构。例如 Python 中的 dict。

• 用法：检查对象是否为映射类型。
• 实现：必须实现 __getitem__、__iter__ 和 __len__ 方法。

示例：

from collections.abc import Mapping

# 定义一个自定义映射类型
class MyDict(Mapping):
    def __init__(self, data):
        self.data = data
    
    def __getitem__(self, key):
        return self.data[key]
    
    def __iter__(self):
        return iter(self.data)
    
    def __len__(self):
        return len(self.data)

my_dict = MyDict({'a': 1, 'b': 2})
print(isinstance(my_dict, Mapping))  # True
print(my_dict['a'])  # 1

3. Sequence：表示序列类型（如列表、元组）

Sequence 是一个抽象基类，表示一个对象是“序列类型”，例如列表、元组等有顺序的容器。

• 用法：检查对象是否为序列类型。
• 实现：必须实现 __getitem__、__len__ 和 __contains__ 方法。

示例：

from collections.abc import Sequence

# 定义一个自定义序列类型
class MyList(Sequence):
    def __init__(self, items):
        self.items = items
    
    def __getitem__(self, index):
        return self.items[index]
    
    def __len__(self):
        return len(self.items)
    
    def __contains__(self, item):
        return item in self.items

my_list = MyList([1, 2, 3, 4])
print(isinstance(my_list, Sequence))  # True
print(my_list[2])  # 3
print(3 in my_list)  # True

4. Set：表示集合类型

Set 是一个抽象基类，表示一个对象是“集合类型”，即无序且元素唯一的数据结构。例如 Python 中的 set。

• 用法：检查对象是否为集合类型。
• 实现：必须实现 __contains__、__iter__ 和 __len__ 方法。

示例：

from collections.abc import Set

# 定义一个自定义集合类型
class MySet(Set):
    def __init__(self):
        self.data = set()
    
    def __contains__(self, item):
        return item in self.data
    
    def __iter__(self):
        return iter(self.data)
    
    def __len__(self):
        return len(self.data)
    
    def add(self, item):
        self.data.add(item)
    
    def discard(self, item):
        self.data.discard(item)

my_set = MySet()
my_set.add(1)
my_set.add(2)
print(isinstance(my_set, Set))  # True
print(1 in my_set)  # True

5. MappingView：视图对象（如字典的键、值、项视图）

MappingView 是一个抽象基类，用于表示映射类型的视图。字典的 keys()、values() 和 items() 方法返回的就是 MappingView 的实例。

• 用法：用于检查映射视图对象，如字典的键视图、值视图。
• 实现：这些视图通常是只读的。

示例：

from collections.abc import MappingView

d = {'a': 1, 'b': 2}
keys_view = d.keys()
print(isinstance(keys_view, MappingView))  # True

6. MutableMapping：可变映射类型（如字典）

MutableMapping 是一个抽象基类，表示“可变映射类型”，例如字典。

• 用法：检查对象是否为可变映射类型。
• 实现：除了实现 Mapping 的方法外，还需要实现 __setitem__ 和 __delitem__ 方法。

示例：

from collections.abc import MutableMapping

class MyMutableDict(MutableMapping):
    def __init__(self, data):
        self.data = data
    
    def __getitem__(self, key):
        return self.data[key]
    
    def __setitem__(self, key, value):
        self.data[key] = value
    
    def __delitem__(self, key):
        del self.data[key]
    
    def __iter__(self):
        return iter(self.data)
    
    def __len__(self):
        return len(self.data)

my_dict = MyMutableDict({'a': 1, 'b': 2})
my_dict['c'] = 3
del my_dict['a']
print(my_dict)  # {'b': 2, 'c': 3}

7. MutableSequence：可变序列类型（如列表）

MutableSequence 是一个抽象基类，表示“可变序列类型”，如列表。

• 用法：检查对象是否为可变序列类型。
• 实现：除了实现 Sequence 的方法外，还需要实现 __setitem__ 和 __delitem__ 方法。

示例：

from collections.abc import MutableSequence

class MyMutableList(MutableSequence):
    def __init__(self, items):
        self.items = items
    
    def __getitem__(self, index):
        return self.items[index]
    
    def __setitem__(self, index, value):
        self.items[index] = value
    
    def __delitem__(self, index):
        del self.items[index]
    
    def __len__(self):
        return len(self.items)
    
    def insert(self, index, value):
        self.items.insert(index, value)

my_list = MyMutableList([1, 2, 3])
my_list[1] = 5
del my_list[0]
print(my_list)  # [5, 3]

8. MutableSet：可变集合类型（如集合）

MutableSet 是一个抽象基类，表示“可变集合类型”，例如 Python 中的 set。

• 用法：检查对象是否为可变集合类型。
• 实现：除了实现 Set 的方法外，还需要实现 add 和 discard 方法。

示例：

from collections.abc import MutableSet

class MyMutableSet(MutableSet):
    def __init__(self):
        self.data = set()
    
    def __contains__(self, item):
        return item in self.data
    
    def __iter__(self):
        return iter(self.data)
    
    def __len__(self):
        return len(self.data)
    
    def add(self, item):
        self.data.add(item)
    
    def discard(self, item):
        self.data.discard(item)

my_set = MyMutableSet()
my_set.add(1)
my_set.add(2)
my_set.discard(1)
print(my_set)  # {2}

总结

• Iterable 用于检查对象是否可以迭代。
• Mapping 用于检查对象是否为映射类型（如字典）。
• Sequence 用于检查对象是否为序列类型（如列表、元组）。
• Set 用于检查对象是否为集合类型。
• MappingView 用于表示映射类型的视图（如字典的键、值、项视图）。
• MutableMapping 用于表示可变映射类型（如字典）。
• MutableSequence 用于表示可变序列类型（如列表）。
• MutableSet 用于表示可变集合类型（如集合）。

这些抽象基类帮助你创建和检查自定义的集合类型，并确保它们符合特定的行为规范。