abc — Абстрактные базовые классы

Исходный код: Lib/abc.py

Этот модуль предоставляет инфраструктуру для определения абстрактных базовых классов (ABC) в Python, как описано в PEP 3119; см. PEP, чтобы понять, почему это было добавлено в Python. (См. также PEP 3141 и numbers модуль, касающийся иерархии типов чисел на основе ABC.)

Модуль collections содержит некоторые конкретные классы, производные от ABC; эти классы, конечно, могут быть дополнительно производными. Кроме того, подмодуль collections.abc содержит некоторые ABC, которые могут использоваться для проверки, предоставляет ли класс или экземпляр определенный интерфейс, например, является ли он хешируемым или является ли он отображением.

Этот модуль предоставляет метакласс ABCMeta для определения ABC и вспомогательный класс ABC для альтернативного определения ABC через наследование:

class abc.ABC

Вспомогательный класс, у которого ABCMeta является метаклассом. С помощью этого класса абстрактный базовый класс можно создать, просто унаследовав от ABC, избегая иногда запутанного использования метаклассов, например:

from abc import ABC

class MyABC(ABC):
    pass

Обратите внимание, что тип ABC по-прежнему является ABCMeta, поэтому наследование от ABC требует обычных мер предосторожности в отношении использования метаклассов, так как множественное наследование может привести к конфликтам метаклассов. Также можно определить абстрактный базовый класс, передав ключевое слово metaclass и используя ABCMeta напрямую, например:

from abc import ABCMeta

class MyABC(metaclass=ABCMeta):
    pass

Доступно начиная с версии 3.4.

class abc.ABCMeta

Метакласс для определения абстрактных базовых классов (ABC).

Используйте этот метакласс для создания ABC. ABC можно наследовать напрямую, а затем он будет действовать как класс-микшин. Вы также можете регистрировать несвязанные конкретные классы (даже встроенные классы) и несвязанные ABC как «виртуальные подклассы» — эти подклассы и их потомки будут рассматриваться как подклассы регистрирующего ABC функцией встроенной issubclass(), но регистрирующий ABC не будет отображаться в их порядке разрешения методов (Method Resolution Order) и реализации методов, определенные регистрирующим ABC, не будут вызываемыми (даже через super()). 1

Классы, созданные с метаклассом ABCMeta, имеют следующий метод:

register(subclass)

Зарегистрировать подкласс как «виртуальный подкласс» этого ABC. Например:

from abc import ABC

class MyABC(ABC):
    pass

MyABC.register(tuple)

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

Изменено в версии 3.3: Возвращает зарегистрированный подкласс, чтобы разрешить использование в качестве декоратора класса.

Изменено в версии 3.4: Чтобы обнаружить вызовы register(), вы можете использовать функцию get_cache_token().

Вы также можете переопределить этот метод в абстрактном базовом классе:

__subclasshook__(subclass)

(Должен быть определен как метод класса.)

Проверить, считается ли подкласс подклассом этого ABC. Это означает, что вы можете настроить поведение issubclass далее без необходимости вызова register() для каждого класса, который вы хотите считать подклассом ABC. (Этот метод класса вызывается из метода __subclasscheck__() ABC.)

Этот метод должен вернуть True, False или NotImplemented. Если он возвращает True, подкласс считается подклассом этого ABC. Если он возвращает False, подкласс не считается подклассом этого ABC, даже если он обычно таковым является. Если он возвращает NotImplemented, проверка подкласса продолжается обычным механизмом.

Для демонстрации этих концепций посмотрите этот пример определения 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 определяет стандартный метод итерации __iter__() как абстрактный метод. Реализация, приведенная здесь, по-прежнему может вызываться из подклассов. Метод get_iterator() также является частью абстрактного базового класса MyIterable, но его не обязательно переопределять в неабстрактных производных классах.

Метод класса __subclasshook__(), определенный здесь, говорит, что любой класс, у которого есть метод __iter__() в его __dict__ (или в одном из его базовых классов, доступных через список __mro__), также считается MyIterable.

Наконец, последняя строка делает Foo виртуальным подклассом MyIterable, хотя он не определяет метод __iter__() (он использует протокол итерации старого стиля, определенный в терминах __len__() и __getitem__()). Обратите внимание, что это не сделает get_iterator доступным в качестве метода Foo, поэтому он предоставляется отдельно.

Модуль abc также предоставляет следующий декоратор:

@abc.abstractmethod

Декоратор, указывающий абстрактные методы.

Использование этого декоратора требует, чтобы метакласс класса был ABCMeta или был от него производным. Класс, имеющий метакласс, производный от ABCMeta, не может быть создан в экземпляр, если все его абстрактные методы и свойства не переопределены. Абстрактные методы можно вызывать, используя любые стандартные механизмы вызова «super». abstractmethod() может быть использован для объявления абстрактных методов для свойств и описателей.

Динамическое добавление абстрактных методов в класс или попытка изменить статус абстракции метода или класса после его создания не поддерживаются. abstractmethod() влияет только на подклассы, полученные с использованием обычного наследования; «виртуальные подклассы», зарегистрированные с помощью метода ABC register() не затрагиваются.

Когда abstractmethod() применяется в сочетании с другими описателями методов, он должен применяться как самый внутренний декоратор, как показано в следующих примерах использования:

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

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

Для правильного взаимодействия с механизмом абстрактного базового класса описатель должен идентифицировать себя как абстрактный, используя __isabstractmethod__. В общем, этот атрибут должен быть True, если какие-либо из методов, используемых для построения описателя, являются абстрактными. Например, встроенный в Python property делает то же самое, что и:

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

Примечание

В отличие от абстрактных методов Java, эти абстрактные методы могут иметь реализацию. Эту реализацию можно вызвать через механизм super() из класса, который её переопределяет. Это может быть полезно в качестве конечной точки вызова super в рамках, использующих кооперативное множественное наследование.

Модуль abc также поддерживает следующие декораторы устаревшего типа:

@abc.abstractclassmethod

Новое в версии 3.2.

Устарело начиная с версии 3.3: Теперь можно использовать classmethod с abstractmethod(), что делает этот декоратор избыточным.

Подкласс встроенного classmethod(), указывающий на абстрактный метод класса. В противном случае он похож на abstractmethod().

Этот специальный случай устарел, так как декоратор classmethod() теперь корректно определяется как абстрактный при применении к абстрактному методу:

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

@abc.abstractstaticmethod

Новое в версии 3.2.

Устарело начиная с версии 3.3: Теперь можно использовать staticmethod с abstractmethod(), что делает этот декоратор избыточным.

Подкласс встроенного staticmethod(), указывающий на абстрактный статический метод. В противном случае он похож на abstractmethod().

Этот специальный случай устарел, так как декоратор staticmethod() теперь корректно определяется как абстрактный при применении к абстрактному методу:

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

@abc.abstractproperty

Устарело начиная с версии 3.3: Теперь можно использовать property, property.getter(), property.setter() и property.deleter() с abstractmethod(), что делает этот декоратор избыточным.

Подкласс встроенного property(), указывающий на абстрактное свойство.

Этот специальный случай устарел, так как декоратор property() теперь корректно определяется как абстрактный при применении к абстрактному методу:

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

В приведенном выше примере определено только для чтения свойство; вы также можете определить абстрактное свойство для чтения и записи, соответствующим образом отметив один или несколько базовых методов как абстрактные:

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

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

Если только некоторые компоненты являются абстрактными, только эти компоненты нужно обновить, чтобы создать конкретное свойство в подклассе:

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

Модуль abc также предоставляет следующие функции:

abc.get_cache_token()

Возвращает текущий токен кэша абстрактного базового класса.

Токен — это непрозрачный объект (поддерживающий проверку на равенство), определяющий текущую версию кэша абстрактного базового класса для виртуальных подклассов. Токен изменяется при каждом вызове ABCMeta.register() для любого ABC.

Новое в версии 3.4.

Примечания

1

Программисты C++ должны отметить, что концепция виртуального базового класса в Python не такая же, как в C++.