为什么 collections.MutableSet 不赋予更新方法？

Question

当实现一个像集合一样工作的类时，可以从collections.MutableSet 继承，如果你实现了新类所需的方法，它将赋予新类多个 mixin 方法。 （换句话说，集合的某些方法可以用其他方法来实现。为了让您免于无聊，collections.MutableSet 和朋友只包含这些实现。）

The docs 说抽象方法是：

__contains__、__iter__、__len__、add、discard

混合方法是

继承Set方法和clear、pop、remove、__ior__、__iand__、__ixor__和__isub__

（而且，要明确的是，update 不是“继承的Set 方法的一部分，Set 的混合方法是：

__le__、__lt__、__eq__、__ne__、__gt__、__ge__、__and__、__or__、__sub__、isdisjoint和@p98 >

不过，Set 指的是不可变集合，自然不会有update。）

为什么update 不在这些方法之列？ 我发现set 包含此方法，但collections.Set 没有，这令人惊讶——甚至不直观。例如，它会导致以下情况：

In [12]: my_set
Out[12]: <ms.MySet at 0x7f947819a5d0>

In [13]: s
Out[13]: set()

In [14]: isinstance(my_set, collections.MutableSet)
Out[14]: True

In [15]: isinstance(s, collections.MutableSet)
Out[15]: True

In [16]: s.update
Out[16]: <function update>

In [17]: my_set.update
---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
<ipython-input-17-9ed968a9eb18> in <module>()
----> 1 my_set.update

AttributeError: 'MySet' object has no attribute 'update'

也许奇怪的是MutableMapping 确实提供了一个update 方法，而MutableSet 没有。 AFAICT，source code 没有提到任何原因。

Answer 1

更新：

Raymond Hettinger 本人回复the bug report you raised，如下所述，Set Abstract Base Class 使用操作符，而不是命名方法。

---

原始回复：

Raymond Hettinger 基于MutableSet 抽象基类编写了a recipe for an OrderedSet，（参见底部的代码块。）但他没有使用更新方法。相反，他使用更新方法调用的|= 运算符。我不知道您的错误报告是否会引起注意，因为它可能会破坏仅期望当前实现的预先存在的代码。

但是，您可以编写一个抽象基类，它确实期望方法包含更多您坚持要实现的方法：

import abc
import collections

class MyMutableSet(collections.MutableSet):
    @abc.abstractmethod
    def update(self, other):
        raise NotImplementedError

MyMutableSet.register(set)

然后以下工作：

>>> isinstance(set('abc'), MyMutableSet)
True

如果我们尝试子类化我们的新抽象基类（参见下面的配方）而不是MutableSet：

>>> s = OrderedSet()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: Can't instantiate abstract class OrderedSet with abstract methods update

所以我们看到，如果我们要求用户子类化我们自定义的抽象基类，我们可以通过这种方式要求 update 方法。

这确实突出了一个事实，即如果您想测试例如，您应该小心只期望您正在使用的抽象基类实现的方法，并且不要假设您在内置函数中拥有所有方法（在这个案例，set)。 set 注册为 MutableSet 的子类，而不是相反。

在 ABC 中实现更新

如果你想在抽象基类中实现更新，因为它需要__ior__：

def update(self, other): 
    self |= other

不应该破坏预先存在的代码来执行此操作。但如果你要这样做，你也可以实现所有其他方法。

---

雷蒙德的食谱，适合我们的目的：

import collections

# class OrderedSet(collections.MutableSet):
class OrderedSet(MyMutableSet):
    def __init__(self, iterable=None):
        self.end = end = [] 
        end += [None, end, end]         # sentinel node for doubly linked list
        self.map = {}                   # key --> [key, prev, next]
        if iterable is not None:
            self |= iterable
    def __len__(self):
        return len(self.map)
    def __contains__(self, key):
        return key in self.map
    def add(self, key):
        if key not in self.map:
            end = self.end
            curr = end[1]
            curr[2] = end[1] = self.map[key] = [key, curr, end]
    def discard(self, key):
        if key in self.map:        
            key, prev, next = self.map.pop(key)
            prev[2] = next
            next[1] = prev
    def __iter__(self):
        end = self.end
        curr = end[2]
        while curr is not end:
            yield curr[0]
            curr = curr[2]
    def __reversed__(self):
        end = self.end
        curr = end[1]
        while curr is not end:
            yield curr[0]
            curr = curr[1]
    def pop(self, last=True):
        if not self:
            raise KeyError('set is empty')
        key = self.end[1][0] if last else self.end[2][0]
        self.discard(key)
        return key
    def __repr__(self):
        if not self:
            return '%s()' % (self.__class__.__name__,)
        return '%s(%r)' % (self.__class__.__name__, list(self))
    def __eq__(self, other):
        if isinstance(other, OrderedSet):
            return len(self) == len(other) and list(self) == list(other)
        return set(self) == set(other)


if __name__ == '__main__':
    s = OrderedSet('abracadaba')
    t = OrderedSet('simsalabim')
    print(s | t)
    print(s & t)
    print(s - t)

Answer 2

MutableSet 的 API 由 Guido van Rossum 设计。他的提议在PEP 3119's section on for Sets 中阐明。他没有详细说明，而是指出：

"这个类还定义了具体的算子来计算并集， 交点，对称和非对称差，分别 __or__、__and__、__xor__ 和 __sub__"

...

“这也是 支持就地变异操作 |=、&=、^=、-=。这些是 其右操作数可以是任意 Iterable 的具体方法， 除了 &=，它的右操作数必须是一个容器。这个 ABC 确实 不提供内置具体集合中存在的命名方法 执行（几乎）相同操作的类型。”

这里没有错误或疏忽；相反，对于您是否喜欢 Guido 的设计存在意见。

Python 之禅对此有话要说：

• 应该有一种——最好只有一种——明显的方法。
• 虽然这种方式一开始可能并不明显，除非您是荷兰人。

也就是说，抽象基类被设计为易于扩展。使用update = Set.__ior__ 将您自己的update() 方法添加到您的具体类是微不足道的。