Документация Python неофициальный перевод

abc.md

143 строк · 11.5 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/2.6/library/abc.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 27.7. `abc` – Абстрактные базовые классы89Новое в версии 2.6.1011Этот модуль предоставляет инфраструктуру для определения [*абстрактного базового класса*](https://python-all.ru/2.6/glossary.html#term-abstract-base-class) (ABC) в Python, как описано в [**PEP 3119**](https://python-all.ru/2.6/library/abc.html); см. этот PEP, чтобы узнать, почему это было добавлено в Python. (См. также [**PEP 3141**](https://python-all.ru/2.6/library/abc.html) и модуль [`numbers`](https://python-all.ru/2.6/library/numbers.html#module-numbers), касающийся иерархии типов для чисел на основе ABC.)1213Модуль [`collections`](https://python-all.ru/2.6/library/collections.html#module-collections) содержит несколько конкретных классов, которые наследуются от ABC; их, конечно, можно наследовать далее. Кроме того, модуль [`collections`](https://python-all.ru/2.6/library/collections.html#module-collections) содержит несколько ABC, которые можно использовать для проверки, предоставляет ли класс или экземпляр определённый интерфейс, например, является ли он хешируемым или отображением.1415Этот модуль предоставляет следующий класс:1617#### `class abc.ABCMeta`1819Метакласс для определения абстрактных базовых классов (ABC).2021Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as “virtual subclasses” – these and their descendants will be considered subclasses of the registering ABC by the built-in [`issubclass()`](https://python-all.ru/2.6/library/functions.html#issubclass) function, but the registering ABC won’t show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via [`super()`](https://python-all.ru/2.6/library/functions.html#super)). [\[1\]](https://python-all.ru/2.6/library/abc.html#id2)2223Классы, созданные с метаклассом [`ABCMeta`](https://python-all.ru/2.6/library/abc.html#abc.ABCMeta), имеют следующий метод:2425#### `register(subclass)`2627Регистрирует *подкласс* как «виртуальный подкласс» этого ABC. Например:2829```python30from abc import ABCMeta3132class MyABC:33    __metaclass__ = ABCMeta3435MyABC.register(tuple)3637assert issubclass(tuple, MyABC)38assert isinstance((), MyABC)39```4041Также можно переопределить этот метод в абстрактном базовом классе:4243#### `__subclasshook__(subclass)`4445(Должен быть определён как метод класса.)4647Проверяет, считается ли *subclass* подклассом этого ABC. Это означает, что можно дополнительно настроить поведение `issubclass` без необходимости вызывать [`register()`](https://python-all.ru/2.6/library/abc.html#abc.ABCMeta.register) для каждого класса, который требуется считать подклассом ABC. (Этот метод класса вызывается из метода `__subclasscheck__()` ABC.)4849Этот метод должен возвращать `True`, `False` или `NotImplemented`. Если он возвращает `True`, то *subclass* считается подклассом этого ABC. Если он возвращает `False`, то *subclass* не считается подклассом этого ABC, даже если бы обычно им являлся. Если он возвращает `NotImplemented`, проверка на подкласс продолжается обычным механизмом.5051Для демонстрации этих концепций посмотрите на следующий пример определения ABC:5253```python54class Foo(object):55    def __getitem__(self, index):56        ...57    def __len__(self):58        ...59    def get_iterator(self):60        return iter(self)6162class MyIterable:63    __metaclass__ = ABCMeta6465    @abstractmethod66    def __iter__(self):67        while False:68            yield None6970    def get_iterator(self):71        return self.__iter__()7273    @classmethod74    def __subclasshook__(cls, C):75        if cls is MyIterable:76            if any("__iter__" in B.__dict__ for B in C.__mro__):77                return True78        return NotImplemented7980MyIterable.register(Foo)81```8283ABC `MyIterable` определяет стандартный метод итерации, [`__iter__()`](https://python-all.ru/2.6/reference/datamodel.html#object.__iter__), как абстрактный метод. Реализацию, приведённую здесь, можно по-прежнему вызывать из подклассов. Метод `get_iterator()` также является частью абстрактного базового класса `MyIterable`, но его не обязательно переопределять в неабстрактных производных классах.8485Метод класса [`__subclasshook__()`](https://python-all.ru/2.6/library/abc.html#abc.ABCMeta.__subclasshook__), определённый здесь, говорит, что любой класс, имеющий метод [`__iter__()`](https://python-all.ru/2.6/reference/datamodel.html#object.__iter__) в своём `__dict__` (или в атрибуте \_\_dict\_\_ одного из своих базовых классов, доступ к которому осуществляется через список `__mro__`), также считается `MyIterable`.8687Наконец, последняя строка делает `Foo` виртуальным подклассом `MyIterable`, даже если он не определяет метод [`__iter__()`](https://python-all.ru/2.6/reference/datamodel.html#object.__iter__) (он использует старый протокол итерации, основанный на [`__len__()`](https://python-all.ru/2.6/reference/datamodel.html#object.__len__) и [`__getitem__()`](https://python-all.ru/2.6/reference/datamodel.html#object.__getitem__)). Обратите внимание, что это не сделает `get_iterator` доступным как метод `Foo`, поэтому он предоставляется отдельно.8889Он также предоставляет следующие декораторы:9091#### `abc.abstractmethod(function)`9293Декоратор, указывающий на абстрактные методы.9495Использование этого декоратора требует, чтобы метакласс класса был [`ABCMeta`](https://python-all.ru/2.6/library/abc.html#abc.ABCMeta) или был производным от него. Класс, метакласс которого является производным от [`ABCMeta`](https://python-all.ru/2.6/library/abc.html#abc.ABCMeta), не может быть инстанциирован, если не переопределены все его абстрактные методы и свойства. Абстрактные методы можно вызывать с помощью любого из обычных механизмов вызова через 'super'.9697Динамическое добавление абстрактных методов в класс или попытка изменить статус абстрактности метода или класса после его создания не поддерживаются. [`abstractmethod()`](https://python-all.ru/2.6/library/abc.html#abc.abstractmethod) влияет только на подклассы, производные с помощью обычного наследования; «виртуальные подклассы», зарегистрированные методом ABC `register()`, не затрагиваются.9899Использование:100101```python102class C:103    __metaclass__ = ABCMeta104    @abstractmethod105    def my_abstract_method(self, ...):106        ...107```108109> **Примечание**110>111> В отличие от абстрактных методов Java, эти абстрактные методы могут иметь реализацию. Эту реализацию можно вызвать через механизм [`super()`](https://python-all.ru/2.6/library/functions.html#super) из класса, который его переопределяет. Это может быть полезно как конечная точка для вызова super во фреймворке, использующем кооперативное множественное наследование.112113#### `abc.abstractproperty([fget[, fset[, fdel[, doc]]]])`114115Подкласс встроенной функции [`property()`](https://python-all.ru/2.6/library/functions.html#property), обозначающий абстрактное свойство.116117Использование этой функции требует, чтобы метакласс класса был [`ABCMeta`](https://python-all.ru/2.6/library/abc.html#abc.ABCMeta) или был производным от него. Класс, метакласс которого является производным от [`ABCMeta`](https://python-all.ru/2.6/library/abc.html#abc.ABCMeta), не может быть инстанциирован, если не переопределены все его абстрактные методы и свойства. Абстрактные свойства можно вызывать с помощью любого из обычных механизмов вызова через 'super'.118119Использование:120121```python122class C:123    __metaclass__ = ABCMeta124    @abstractproperty125    def my_abstract_property(self):126        ...127```128129Это определяет свойство только для чтения; можно также определить абстрактное свойство чтения-записи, используя «длинную» форму объявления свойства:130131```python132class C:133    __metaclass__ = ABCMeta134    def getx(self): ...135    def setx(self, value): ...136    x = abstractproperty(getx, setx)137```138139Сноски140141| [\[1\]](https://python-all.ru/2.6/library/abc.html#id1) | Программистам на C++ следует отметить, что концепция виртуального базового класса в Python отличается от C++. |142| --- | --- |143