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 не будет отображаться в их 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.

Сноски