`abc` --- 抽象基類?

源代碼： Lib/abc.py

該模塊提供了在 Python 中定義抽象基類 (ABC) 的組件，在 PEP 3119 中已有概述。查看 PEP 文檔了解為什么需要在 Python 中增加這個(gè)模塊。（也可查看 PEP 3141 以及 numbers 模塊了解基于 ABC 的數(shù)字類型繼承關(guān)系。）

collections 模塊中有一些派生自 ABC 的具體類；當(dāng)然這些類還可以進(jìn)一步被派生。此外，collections.abc 子模塊中有一些 ABC 可被用于測試一個(gè)類或?qū)嵗欠裉峁┨囟ǖ慕涌?，例如它是否可哈?；蛩欠駷橛成涞取?/p>

該模塊提供了一個(gè)元類 ABCMeta，可以用來定義抽象類，另外還提供一個(gè)工具類 ABC，可以用它以繼承的方式定義抽象基類。

class abc.ABC?

一個(gè)使用 ABCMeta 作為元類的工具類。抽象基類可以通過從 ABC 派生來簡單地創(chuàng)建，這就避免了在某些情況下會(huì)令人混淆的元類用法，例如：

from abc import ABC

class MyABC(ABC):
    pass

注意 ABC 的類型仍然是 ABCMeta，因此繼承 ABC 仍然需要關(guān)注元類使用中的注意事項(xiàng)，比如可能會(huì)導(dǎo)致元類沖突的多重繼承。當(dāng)然你也可以直接使用 ABCMeta 作為元類來定義抽象基類，例如：

from abc import ABCMeta

class MyABC(metaclass=ABCMeta):
    pass

3.4 新版功能.

class abc.ABCMeta?

用于定義抽象基類（ABC）的元類。

使用該元類以創(chuàng)建抽象基類。抽象基類可以像 mix-in 類一樣直接被子類繼承。你也可以將不相關(guān)的具體類（包括內(nèi)建類）和抽象基類注冊(cè)為“抽象子類” —— 這些類以及它們的子類會(huì)被內(nèi)建函數(shù) issubclass() 識(shí)別為對(duì)應(yīng)的抽象基類的子類，但是該抽象基類不會(huì)出現(xiàn)在其 MRO（Method Resolution Order，方法解析順序）中，抽象基類中實(shí)現(xiàn)的方法也不可調(diào)用（即使通過 super() 調(diào)用也不行）。1

使用 ABCMeta 作為元類創(chuàng)建的類含有如下方法：

register(subclass)?

將“子類”注冊(cè)為該抽象基類的“抽象子類”，例如：

from abc import ABC

class MyABC(ABC):
    pass

MyABC.register(tuple)

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

在 3.3 版更改: 返回注冊(cè)的子類，使其能夠作為類裝飾器。

在 3.4 版更改: 你可以使用 get_cache_token() 函數(shù)來檢測對(duì) register() 的調(diào)用。

你也可以在虛基類中重載這個(gè)方法。

__subclasshook__(subclass)?

（必須定義為類方法。）

檢查 subclass 是否是該抽象基類的子類。也就是說對(duì)于那些你希望定義為該抽象基類的子類的類，你不用對(duì)每個(gè)類都調(diào)用 register() 方法了，而是可以直接自定義 issubclass 的行為。（這個(gè)類方法是在抽象基類的 __subclasscheck__() 方法中調(diào)用的。）

該方法必須返回 True, False 或是 NotImplemented。如果返回 True，subclass 就會(huì)被認(rèn)為是這個(gè)抽象基類的子類。如果返回 False，無論正常情況是否應(yīng)該認(rèn)為是其子類，統(tǒng)一視為不是。如果返回 NotImplemented，子類檢查會(huì)按照正常機(jī)制繼續(xù)執(zhí)行。

為了對(duì)這些概念做一演示，請(qǐng)看以下定義 ABC 的示例：

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

class MyIterable(ABC):

    @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)

ABC MyIterable 定義了標(biāo)準(zhǔn)的迭代方法 __iter__() 作為一個(gè)抽象方法。這里給出的實(shí)現(xiàn)仍可在子類中被調(diào)用。get_iterator() 方法也是 MyIterable 抽象基類的一部分，但它并非必須被非抽象派生類所重載。

這里定義的 __subclasshook__() 類方法指明了任何在其 __dict__ (或在其通過 __mro__ 列表訪問的基類) 中具有 __iter__() 方法的類也都會(huì)被視為 MyIterable。

最后，末尾行使得 Foo 成為 MyIterable 的一個(gè)虛子類，即使它沒有定義 __iter__() 方法（它使用了以 __len__() 和 __getitem__() 術(shù)語定義的舊式可迭代對(duì)象協(xié)議）。請(qǐng)注意這將不會(huì)使 get_iterator 成為 Foo 的一個(gè)可用方法，它是被另外提供的。

此外，abc 模塊還提供了這些裝飾器：

@abc.abstractmethod?

用于聲明抽象方法的裝飾器。

使用此裝飾器要求類的元類是 ABCMeta 或是從該類派生。一個(gè)具有派生自 ABCMeta 的元類的類不可以被實(shí)例化，除非它全部的抽象方法和特征屬性均已被重載。抽象方法可通過任何普通的“super”調(diào)用機(jī)制來調(diào)用。 abstractmethod() 可被用于聲明特性屬性和描述器的抽象方法。

動(dòng)態(tài)地添加抽象方法到一個(gè)類，或嘗試在方法或類被創(chuàng)建后修改其抽象狀態(tài)等操作僅在使用 update_abstractmethods() 函數(shù)時(shí)受到支持。 abstractmethod() 只會(huì)影響使用常規(guī)繼承所派生的子類；通過 ABC 的 register() 方法注冊(cè)的“虛子類”不會(huì)受到影響。

當(dāng) abstractmethod() 與其他方法描述符配合應(yīng)用時(shí)，它應(yīng)當(dāng)被應(yīng)用為最內(nèi)層的裝飾器，如以下用法示例所示:

class C(ABC):
    @abstractmethod
    def my_abstract_method(self, arg1):
        ...
    @classmethod
    @abstractmethod
    def my_abstract_classmethod(cls, arg2):
        ...
    @staticmethod
    @abstractmethod
    def my_abstract_staticmethod(arg3):
        ...

    @property
    @abstractmethod
    def my_abstract_property(self):
        ...
    @my_abstract_property.setter
    @abstractmethod
    def my_abstract_property(self, val):
        ...

    @abstractmethod
    def _get_x(self):
        ...
    @abstractmethod
    def _set_x(self, val):
        ...
    x = property(_get_x, _set_x)

為了能正確地與抽象基類機(jī)制實(shí)現(xiàn)互操作，描述符必須使用 __isabstractmethod__ 將自身標(biāo)識(shí)為抽象的。通常，如果被用于組成描述符的任何方法都是抽象的則此屬性應(yīng)當(dāng)為 True。例如，Python 的內(nèi)置 property 所做的就等價(jià)于:

class Descriptor:
    ...
    @property
    def __isabstractmethod__(self):
        return any(getattr(f, '__isabstractmethod__', False) for
                   f in (self._fget, self._fset, self._fdel))

備注

不同于 Java 抽象方法，這些抽象方法可能具有一個(gè)實(shí)現(xiàn)。這個(gè)實(shí)現(xiàn)可在重載它的類上通過 super() 機(jī)制來調(diào)用。這在使用協(xié)作多重繼承的框架中可以被用作超調(diào)用的一個(gè)端點(diǎn)。

abc 模塊還支持下列舊式裝飾器:

@abc.abstractclassmethod?

3.2 新版功能.

3.3 版后已移除: 現(xiàn)在可以讓 classmethod 配合 abstractmethod() 使用，使得此裝飾器變得冗余。

內(nèi)置 classmethod() 的子類，指明一個(gè)抽象類方法。在其他方面它都類似于 abstractmethod()。

這個(gè)特例已被棄用，因?yàn)楝F(xiàn)在當(dāng) classmethod() 裝飾器應(yīng)用于抽象方法時(shí)它會(huì)被正確地標(biāo)識(shí)為抽象的:

class C(ABC):
    @classmethod
    @abstractmethod
    def my_abstract_classmethod(cls, arg):
        ...

@abc.abstractstaticmethod?

3.2 新版功能.

3.3 版后已移除: 現(xiàn)在可以讓 staticmethod 配合 abstractmethod() 使用，使得此裝飾器變得冗余。

內(nèi)置 staticmethod() 的子類，指明一個(gè)抽象靜態(tài)方法。在其他方面它都類似于 abstractmethod()。

這個(gè)特例已被棄用，因?yàn)楝F(xiàn)在當(dāng) staticmethod() 裝飾器應(yīng)用于抽象方法時(shí)它會(huì)被正確地標(biāo)識(shí)為抽象的:

class C(ABC):
    @staticmethod
    @abstractmethod
    def my_abstract_staticmethod(arg):
        ...

@abc.abstractproperty?

3.3 版后已移除: 現(xiàn)在可以讓 property, property.getter(), property.setter() 和 property.deleter() 配合 abstractmethod() 使用，使得此裝飾器變得冗余。

內(nèi)置 property() 的子類，指明一個(gè)抽象特性屬性。

這個(gè)特例已被棄用，因?yàn)楝F(xiàn)在當(dāng) property() 裝飾器應(yīng)用于抽象方法時(shí)它會(huì)被正確地標(biāo)識(shí)為抽象的:

class C(ABC):
    @property
    @abstractmethod
    def my_abstract_property(self):
        ...

上面的例子定義了一個(gè)只讀特征屬性；你也可以通過適當(dāng)?shù)貙⒁粋€(gè)或多個(gè)下層方法標(biāo)記為抽象的來定義可讀寫的抽象特征屬性:

class C(ABC):
    @property
    def x(self):
        ...

    @x.setter
    @abstractmethod
    def x(self, val):
        ...

如果只有某些組件是抽象的，則只需更新那些組件即可在子類中創(chuàng)建具體的特征屬性:

class D(C):
    @C.x.setter
    def x(self, val):
        ...

abc 模塊還提供了這些函數(shù)：

abc.get_cache_token()?

返回當(dāng)前抽象基類的緩存令牌

此令牌是一個(gè)不透明對(duì)象（支持相等性測試），用于為虛子類標(biāo)識(shí)抽象基類緩存的當(dāng)前版本。此令牌會(huì)在任何 ABC 上每次調(diào)用 ABCMeta.register() 時(shí)發(fā)生更改。

3.4 新版功能.

abc.update_abstractmethods(cls)?

重新計(jì)算一個(gè)抽象類的抽象狀態(tài)的函數(shù)。如果一個(gè)類的抽象方法在類被創(chuàng)建后被實(shí)現(xiàn)或被修改則應(yīng)當(dāng)調(diào)用此函數(shù)。通常，此函數(shù)應(yīng)當(dāng)在一個(gè)類裝飾器內(nèi)部被調(diào)用。

返回 cls，使其能夠用作類裝飾器。

如果 cls 不是 ABCMeta 的子類，則不做任何操作。

備注

此函數(shù)會(huì)假定 cls 的上級(jí)類已經(jīng)被更新。它不會(huì)更新任何子類。

3.10 新版功能.

備注

1: C++ 程序員需要注意：Python 中虛基類的概念和 C++ 中的并不相同。

`abc` --- 抽象基類?

上一個(gè)主題

下一個(gè)主題

當(dāng)前頁面

abc --- 抽象基類?

`abc` --- 抽象基類?