为什么在 Python 中使用抽象基类？

Question

因为我习惯了 Python 中鸭子类型的旧方式，所以我无法理解 ABC（抽象基类）的必要性。 帮助很好地介绍了如何使用它们。

我试图阅读 PEP 中的基本原理，但它超出了我的理解范围。如果我正在寻找可变序列容器，我会检查 __setitem__，或更可能尝试使用它（EAFP)。我还没有遇到过现实生活中使用 数字模块，它确实使用了 ABC，但这是我所理解的最接近的。

有人可以向我解释一下原理吗？

Answer 1

@Oddthinking 的答案并没有错，但我认为它忽略了 Python 在鸭子打字世界中拥有 ABC 的真实、实用原因。

抽象方法很简洁，但在我看来，它们并没有真正满足鸭子类型尚未涵盖的任何用例。抽象基类的真正力量在于它们允许您自定义的方式isinstance 和 issubclass 的行为。 （__subclasshook__ 基本上是一个基于 Python __instancecheck__ 和 __subclasscheck__ 挂钩。）调整内置构造以处理自定义类型是 Python 哲学的重要组成部分。

Python 的源代码堪称典范。 这里是collections.Container 在标准库中定义（在撰写本文时）：

class Container(metaclass=ABCMeta):
    __slots__ = ()

    @abstractmethod
    def __contains__(self, x):
        return False

    @classmethod
    def __subclasshook__(cls, C):
        if cls is Container:
            if any("__contains__" in B.__dict__ for B in C.__mro__):
                return True
        return NotImplemented

__subclasshook__ 的定义表示任何具有 __contains__ 属性的类都被视为 Container 的子类，即使它不直接子类化它。所以我可以这样写：

class ContainAllTheThings(object):
    def __contains__(self, item):
        return True

>>> issubclass(ContainAllTheThings, collections.Container)
True
>>> isinstance(ContainAllTheThings(), collections.Container)
True

换句话说，如果你实现了正确的接口，你就是一个子类！ ABC 提供了一种在 Python 中定义接口的正式方法，同时忠于鸭子的精神 -打字。此外，它的工作方式遵循开闭原则。

Python 的对象模型表面上看起来与更“传统”的 OO 系统（我指的是 Java*）相似——我们有类、对象、方法——但是当你触及表面时，你会发现更丰富和更丰富的东西。更灵活。同样，Java 开发人员可能会认识到 Python 的抽象基类概念，但实际上它们的目的却截然不同。

有时我发现自己编写了可以作用于单个项目或项目集合的多态函数，并且我发现 isinstance(x, collections.Iterable) 比 hasattr(x) 更具可读性、 '__iter__') 或等效的 try... except 块。 （如果您不了解 Python，那么这三者中哪一个能让代码的意图最清晰？）

也就是说，我发现我很少需要编写自己的 ABC，并且通常通过重构来发现对 ABC 的需求。如果我看到一个多态函数进行大量属性检查，或者许多函数进行相同的属性检查，那么这种气味表明存在等待提取的 ABC。

_{*不涉及Java是否是“传统”OO系统的争论...}

---

附录：即使抽象基类可以覆盖isinstance的行为和issubclass，它仍然没有进入MRO。这对于客户端来说是一个潜在的陷阱：并非每个 isinstance(x, MyABC) == True 的对象都具有在 MyABC 上定义的方法。

class MyABC(metaclass=abc.ABCMeta):
    def abc_method(self):
        pass
    @classmethod
    def __subclasshook__(cls, C):
        return True

class C(object):
    pass

# typical client code
c = C()
if isinstance(c, MyABC):  # will be true
    c.abc_method()  # raises AttributeError

不幸的是，这是“不要这样做”的陷阱之一（Python 的陷阱相对较少！）：避免使用 __subclasshook__ 和非抽象方法定义 ABC。此外，您应该使 __subclasshook__ 的定义与 ABC 定义的抽象方法集一致。

Answer 2

简短版本的

ABC 在客户端和实现的类之间提供了更高级别的语义契约。

长版本

类和它的调用者之间有一个契约。该类承​​诺做某些事情并具有某些属性。

合同有不同的级别。

在非常低的级别，契约可能包括方法的名称或其参数的数量。

在静态类型语言中，该约定实际上由编译器强制执行。在 Python 中，您可以使用 EAFP 或键入 introspection 来确认未知数对象满足此预期合同。

但合同中还有更高级别的语义承诺。

例如，如果有一个 __str__() 方法，则期望返回对象的字符串表示形式。它可以删除对象的所有内容，提交事务并从打印机中吐出一张空白页......但对于它应该做什么有一个共同的理解，如Python手册中所述。

这是一种特殊情况，手册中描述了语义契约。 print() 方法应该做什么？应该将对象写入打印机还是将一行写入屏幕，还是其他什么？这取决于 - 您需要阅读评论以了解此处的完整合同。一段简单地检查 print() 方法是否存在的客户端代码已经确认了合同的一部分 - 可以进行方法调用，但并没有就该方法的更高级别语义达成一致。称呼。

定义抽象基类 (ABC) 是在类实现者和调用者之间产生契约的一种方法。它不仅仅是方法名称的列表，而是对这些方法应该做什么的共同理解。如果您继承了此 ABC，则您承诺遵循注释中描述的所有规则，包括 print() 方法的语义。

Python 的鸭子类型在灵活性方面比静态类型有很多优势，但它并不能解决所有问题。 ABC 提供了介于 Python 的自由形式和静态类型语言的束缚与规范之间的中间解决方案。

Answer 3

ABC 的一个方便的功能是，如果您没有实现所有必要的方法（和属性），您会在实例化时收到错误，而不是 AttributeError，可能会在很久以后，当您实际尝试使用缺少的方法时。

from abc import ABCMeta, abstractmethod

# python2
class Base(object):
    __metaclass__ = ABCMeta

    @abstractmethod
    def foo(self):
        pass

    @abstractmethod
    def bar(self):
        pass

# python3
class Base(object, metaclass=ABCMeta):
    @abstractmethod
    def foo(self):
        pass

    @abstractmethod
    def bar(self):
        pass

class Concrete(Base):
    def foo(self):
        pass

    # We forget to declare `bar`


c = Concrete()
# TypeError: "Can't instantiate abstract class Concrete with abstract methods bar"

示例来自 https://dbader.org/blog/abstract-base-classes-in -python

编辑：包含 python3 语法，感谢@PandasRocks

Answer 4

它将使得确定一个对象是否支持给定协议变得更加容易，而无需检查协议中所有方法的存在，也不会因不支持而触发深入“敌方”领域的异常。

Answer 5

抽象方法确保您在父类中调用的任何方法也必须出现在子类中。以下是调用和使用抽象的常规方式。
程序是用python3编写的，

正常调用方式：

class Parent:
    def method_one(self):
        raise NotImplemented()

    def method_two(self):
        raise NotImplementedError()

class Son(Parent):
   def method_one(self):
       return 'method_one() is called'

c = Son()
c.method_one()

<块引用>

“method_one() 被调用”

c.method_two()

<块引用>

未实现错误

使用抽象方法：

from abc import ABCMeta, abstractmethod

class Parent(metaclass=ABCMeta):
    @abstractmethod
    def method_one(self):
        raise NotImplementedError()
    @abstractmethod
    def method_two(self):
        raise NotImplementedError()

class Son(Parent):
    def method_one(self):
        return 'method_one() is called'

c = Son()

<块引用>

类型错误：无法使用抽象方法 method_two 实例化抽象类 Son。

由于 method_two 没有在子类中调用，我们得到了错误。正确的实现如下：

from abc import ABCMeta, abstractmethod

class Parent(metaclass=ABCMeta):
    @abstractmethod
    def method_one(self):
        raise NotImplementedError()
    @abstractmethod
    def method_two(self):
        raise NotImplementedError()

class Son(Parent):
    def method_one(self):
        return 'method_one() is called'
    def method_two(self):
        return 'method_two() is called'

c = Son()
c.method_one()

<块引用>

“method_one() 被调用”

Answer 6

ABC 能够创建设计模式和框架。请参阅 Brandon Rhodes 的 pycon 演讲：

Python 设计模式 1

Python 本身内的协议（更不用说迭代器、装饰器和槽（它们本身实现 FlyWeight 模式））都是可能的，因为 ABC 的（尽管在 CPython 中实现为虚拟方法/类）。

Brandon 提到，鸭子类型确实使 Python 中的某些模式变得微不足道，但许多其他模式继续出现并在 Python 中有用，例如适配器。

简而言之，ABC 使您能够编写可扩展且可重用的代码。根据 GoF：

1. 对接口进行编程，而不是实现（继承破坏了封装；对接口进行编程会促进松散耦合/控制反转/“好莱坞原则：不要打电话给我们” ，我们会给您打电话”）

2. 优先考虑对象组合而不是类继承（委派工作）

3. 封装变化的概念（开闭原则使类对扩展开放，但对修改封闭）

此外，随着Python静态类型检查器的出现（例如mypy ），对于函数接受作为参数或返回的每个对象，可以使用 ABC 作为类型而不是 Union[...]。想象一下，每次您的代码库支持新对象时，都必须更新类型而不是实现？这很快就会变得无法维护（无法扩展）。