0x00 为什么需要 abc 模块

abc 模块为调用者和具体实现类（而不是抽象类）之间提供更高级别的语义化约定。你使用类 A 之前，类 A 就给你保证它有 b 方法和 c 属性，不需要你在使用的时候通过 getattr 来判断，这个就是约定（contract）。

上面说的那句话是什么意思其实我也不是很懂，我理解它其实就类似于静态语言中的接口，子类必须实现抽象基类中的所有抽象方法和属性。而 abc 模块就帮你完成了这些事情。

详情请查看 PEP 3119

0x01 abc.ABCMeta 对象介绍

ABCMeta 是一个元类（metaclass），用来定义 Abstract Base Classes (ABCs)

ABCMeta 可以被继承，可以作为一个 Mixin Class。

可以注册不相关的具体类和 ABCs，作为虚拟类，他和他的子类会被认为是注册的 ABC 的子类（使用内置的 issubclass 函数来判断），但是注册的 ABC 不会出现在他们的 MRO（Method Resolution Order）中，注册 ABC 的方法也不能被调用。

通过 ABCMeta 元类创建的类具有以下方法：

register(subclass)

• 注册一个子类，作为这个 ABC 的虚拟子类
• 注意：虚拟子类与 C++ 中的虚拟子类概念不是一回事

from abc import ABCMeta

class MyABC:
    __metaclass__ = ABCMeta

MyABC.register(tuple)

assert issubclass(tuple, MyABC)
assert isinstance((), MyABC)

__subclasshook__(subclass)

• 必须是一个类方法。
• 检测 subclass 是不是这个 ABC 的子类。
• 这个方法被 __subclasscheck__ 调用，意思就是说可以通过这个类自定义 issubclass 的行为，不需要给每个需要注册虚拟子类的类调用 register() 方法（类似于 MyABC.register(tuple)）。
• 这个方法必须返回 True，False 或者 NotImplemented。True 表示 subclass 是 ABC 的子类，False 反之，如果是 NotImplemented，那就继续执行接下来的常规流程。

给个例子解释下功能用法：

• ABC 类 MyIterable 定义了标准的可迭代对象方法（__iter__()）作为抽象方法。这里给出的实现仍然可以在子类调用。get_iterator() 方法也是 MyIterable 的一部分，但是它不是抽象方法，所以它没有强制要求被非抽象子类重写（overridden）。
• 这里定义的 __subclasshook__ 方法表示，在传入的类型 C 的 MRO 中的所有类型的 __dict__ 中，如果有 __iter__ 方法，就返回 True（意思就是 C 是 MyIterable 的子类）
• 将 Foo 类注册为 MyIterable 的虚拟子类，这样的话，即使 Foo 没有定义 __iter__ 方法，它也会被认为是 MyIterable 的子类

class Foo(object):
    def __getitem__(self, index):
        ...
    def __len__(self):
        ...
    def get_iterator(self):
        return iter(self)

class MyIterable:
    __metaclass__ = ABCMeta

    @abstractmethod
    def __iter__(self):
        while False:
            yield None

    def get_iterator(self):
        return self.__iter__()

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

MyIterable.register(Foo)

0x02 abc 模块装饰器介绍

abc.abstractmethod(function)

• 这个装饰器用来表示一个抽象方法
• 使用这个装饰器时，必须要求它所属的类的元类是 ABCMeta 或其子类
• 元类是 ABCMeta 或其子类的类，它的所有抽象方法和属性必须被重写（overridden），否则无法初始化
• 子类内可以通过 super() 方法来调用抽象方法的实现
• 动态给一个类添加抽象方法，或者修改一个方法为抽象方法都是不可以的
• abc.abstractmethod 方法只能使用在正常继承方式下的子类，不能使用在虚拟子类（使用 register 方法注册的）中
• 注意：不像 JAVA 或者其他语言的抽象方法，Python 的抽象方法可以有自己的实现。这个实现可以被子类重写的方法通过 super() 方法调用，这个一般在多继承中很有用

abc.abstractproperty([fget[, fset[, fdel[, doc]]]])

• 内置 property 类的子类，表示一个抽象属性
• 使用这个装饰器时，必须要求它所属的类的元类是 ABCMeta 或其子类
• 元类是 ABCMeta 或其子类的类，它的所有抽象方法和属性必须被重写（overridden），否则无法初始化
• 子类内可以通过 super() 方法来调用抽象方法的实现

# 只读属性
class C:
    __metaclass__ = ABCMeta
    @abstractproperty
    def my_abstract_property(self):
        ...
# 读写属性
class C:
    __metaclass__ = ABCMeta
    def getx(self): ...
    def setx(self, value): ...
    x = abstractproperty(getx, setx)

参考：

📌 abc — Abstract Base Classes

📌 PEP 3119

📌 Why use Abstract Base Classes in Python?