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, MRO), а реализации методов, определённые регистрирующим 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() может использоваться для объявления абстрактных методов для свойств и описателей.

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

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

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)

Для правильного взаимодействия с механизмом абстрактного базового класса описатель должен определить себя как абстрактный с помощью __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, arg):
        ...

@abc.abstractstaticmethod

Добавлена в версии 3.2.

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

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

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

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

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

abc.update_abstractmethods(cls)

Функция для перерасчета статуса абстракции абстрактного класса. Эту функцию следует вызывать, если методы абстрактного класса были реализованы или изменены после их создания. Обычно эту функцию следует вызывать изнутри декоратора класса.

Возвращает cls, чтобы разрешить использование в качестве декоратора класса.

Если cls не является экземпляром ABCMeta, ничего не делает.

Примечание

Эта функция предполагает, что суперклассы cls уже обновлены. Она не обновляет подклассы.

Добавлена в версии 3.10.

Сноски