`collections.abc.md`

182 строк · 21.2 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/library/collections.abc.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 8.4. [`collections.abc`](https://python-all.ru/3.5/library/collections.abc.html#module-collections.abc) – Абстрактные базовые классы для контейнеров89Новинка версии 3.3: Ранее этот модуль был частью модуля [`collections`](https://python-all.ru/3.5/library/collections.html#module-collections).1011**Исходный код:** [Lib/\_collections\_abc.py](https://python-all.ru/src/3.5/Lib/_collections_abc.py)1213---1415Этот модуль предоставляет [абстрактные базовые классы](https://python-all.ru/3.5/glossary.html#term-abstract-base-class), которые можно использовать для проверки, реализует ли класс определённый интерфейс; например, является ли он хешируемым или отображением.1617## 8.4.1. Абстрактные базовые классы коллекций1819Модуль collections предоставляет следующие [абстрактные базовые классы](https://python-all.ru/3.5/glossary.html#term-abstract-base-class):2021| ABC | Наследует от | Абстрактные методы | Методы-примеси |22| --- | --- | --- | --- |23| [`Container`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Container) |  | `__contains__` |  |24| [`Hashable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Hashable) |  | `__hash__` |  |25| [`Iterable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Iterable) |  | `__iter__` |  |26| [`Iterator`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Iterator) | [`Iterable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Iterable) | `__next__` | `__iter__` |27| [`Generator`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Generator) | [`Iterator`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Iterator) | `send`, `throw` | `close`, `__iter__`, `__next__` |28| [`Sized`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sized) |  | `__len__` |  |29| [`Callable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Callable) |  | `__call__` |  |30| [`Sequence`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sequence) | [`Sized`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sized), [`Iterable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Iterable), [`Container`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Container) | `__getitem__`, `__len__` | `__contains__`, `__iter__`, `__reversed__`, `index` и `count` |31| [`MutableSequence`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MutableSequence) | [`Sequence`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sequence) | `__getitem__`, `__setitem__`, `__delitem__`, `__len__`, `insert` | Наследуемые методы [`Sequence`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sequence) и `append`, `reverse`, `extend`, `pop`, `remove` и `__iadd__` |32| [`ByteString`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.ByteString) | [`Sequence`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sequence) | `__getitem__`, `__len__` | Унаследованные методы [`Sequence`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sequence) |33| [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) | [`Sized`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sized), [`Iterable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Iterable), [`Container`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Container) | `__contains__`, `__iter__`, `__len__` | `__le__`, `__lt__`, `__eq__`, `__ne__`, `__gt__`, `__ge__`, `__and__`, `__or__`, `__sub__`, `__xor__` и `isdisjoint` |34| [`MutableSet`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MutableSet) | [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) | `__contains__`, `__iter__`, `__len__`, `add`, `discard` | Унаследованные методы [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) и `clear`, `pop`, `remove`, `__ior__`, `__iand__`, `__ixor__` и `__isub__` |35| [`Mapping`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Mapping) | [`Sized`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sized), [`Iterable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Iterable), [`Container`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Container) | `__getitem__`, `__iter__`, `__len__` | `__contains__`, `keys`, `items`, `values`, `get`, `__eq__` и `__ne__` |36| [`MutableMapping`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MutableMapping) | [`Mapping`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Mapping) | `__getitem__`, `__setitem__`, `__delitem__`, `__iter__`, `__len__` | Унаследованные методы [`Mapping`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Mapping) и `pop`, `popitem`, `clear`, `update`, и `setdefault` |37| [`MappingView`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MappingView) | [`Sized`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Sized) |  | `__len__` |38| [`ItemsView`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.ItemsView) | [`MappingView`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MappingView), [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) |  | `__contains__`, `__iter__` |39| [`KeysView`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.KeysView) | [`MappingView`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MappingView), [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) |  | `__contains__`, `__iter__` |40| [`ValuesView`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.ValuesView) | [`MappingView`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MappingView) |  | `__contains__`, `__iter__` |41| [`Awaitable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Awaitable) |  | `__await__` |  |42| [`Coroutine`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Coroutine) | [`Awaitable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Awaitable) | `send`, `throw` | `close` |43| [`AsyncIterable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.AsyncIterable) |  | `__aiter__` |  |44| [`AsyncIterator`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.AsyncIterator) | [`AsyncIterable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.AsyncIterable) | `__anext__` | `__aiter__` |4546#### `class collections.abc.Container`4748#### `class collections.abc.Hashable`4950#### `class collections.abc.Sized`5152#### `class collections.abc.Callable`5354ABC для классов, которые предоставляют соответственно методы [`__contains__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__contains__), [`__hash__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__hash__), [`__len__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__len__) и [`__call__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__call__).5556#### `class collections.abc.Iterable`5758ABC для классов, которые предоставляют метод [`__iter__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__iter__). См. также определение [итерируемого объекта](https://python-all.ru/3.5/glossary.html#term-iterable).5960#### `class collections.abc.Iterator`6162ABC для классов, которые предоставляют методы [`__iter__()`](https://python-all.ru/3.5/library/stdtypes.html#iterator.__iter__) и [`__next__()`](https://python-all.ru/3.5/library/stdtypes.html#iterator.__next__). См. также определение [итератора](https://python-all.ru/3.5/glossary.html#term-iterator).6364#### `class collections.abc.Generator`6566ABC для классов-генераторов, реализующих протокол, определённый в [**PEP 342**](https://python-all.ru/3.5/library/collections.abc.html), который расширяет итераторы методами [`send()`](https://python-all.ru/3.5/reference/expressions.html#generator.send), [`throw()`](https://python-all.ru/3.5/reference/expressions.html#generator.throw) и [`close()`](https://python-all.ru/3.5/reference/expressions.html#generator.close). См. также определение [генератора](https://python-all.ru/3.5/glossary.html#term-generator).6768Новое в версии 3.5.6970#### `class collections.abc.Sequence`7172#### `class collections.abc.MutableSequence`7374#### `class collections.abc.ByteString`7576ABC для неизменяемых и изменяемых [последовательностей](https://python-all.ru/3.5/glossary.html#term-sequence).7778Примечание к реализации: некоторые методы-примеси, такие как [`__iter__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__iter__), [`__reversed__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__reversed__) и `index()`, многократно вызывают базовый метод [`__getitem__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__getitem__). Следовательно, если метод [`__getitem__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__getitem__) реализован с постоянной скоростью доступа, методы-примеси будут иметь линейную производительность; однако, если базовый метод является линейным (как в случае со связным списком), производительность примесей станет квадратичной, и их, скорее всего, придётся переопределить.7980Изменено в версии 3.5: Метод index() получил поддержку *stop* и *start* аргументов.8182#### `class collections.abc.Set`8384#### `class collections.abc.MutableSet`8586ABC для наборов только для чтения и изменяемых наборов.8788#### `class collections.abc.Mapping`8990#### `class collections.abc.MutableMapping`9192ABC для неизменяемых и изменяемых [отображений](https://python-all.ru/3.5/glossary.html#term-mapping).9394#### `class collections.abc.MappingView`9596#### `class collections.abc.ItemsView`9798#### `class collections.abc.KeysView`99100#### `class collections.abc.ValuesView`101102ABC для [представлений](https://python-all.ru/3.5/glossary.html#term-dictionary-view) отображений, элементов, ключей и значений.103104#### `class collections.abc.Awaitable`105106ABC для [ожидаемых](https://python-all.ru/3.5/glossary.html#term-awaitable) объектов, которые могут использоваться в выражениях [`await`](https://python-all.ru/3.5/reference/expressions.html#await). Пользовательские реализации должны предоставлять метод [`__await__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__await__) .107108Объекты [Coroutine](https://python-all.ru/3.5/glossary.html#term-coroutine) и экземпляры ABC [`Coroutine`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Coroutine) являются экземплярами этого ABC.109110> **Примечание**111>112> В CPython корутины на основе генераторов (генераторы, декорированные [`types.coroutine()`](https://python-all.ru/3.5/library/types.html#types.coroutine) или [`asyncio.coroutine()`](https://python-all.ru/3.5/library/asyncio-task.html#asyncio.coroutine)) являются *ожидаемыми объектами*, даже если у них нет метода [`__await__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__await__). Использование `isinstance(gencoro, Awaitable)` для них вернёт `False`. Используйте [`inspect.isawaitable()`](https://python-all.ru/3.5/library/inspect.html#inspect.isawaitable) для их обнаружения.113114Новое в версии 3.5.115116#### `class collections.abc.Coroutine`117118ABC для классов, совместимых с корутинами. Они реализуют следующие методы, определённые в [Объектах корутин](https://python-all.ru/3.5/reference/datamodel.html#coroutine-objects): [`send()`](https://python-all.ru/3.5/reference/datamodel.html#coroutine.send), [`throw()`](https://python-all.ru/3.5/reference/datamodel.html#coroutine.throw) и [`close()`](https://python-all.ru/3.5/reference/datamodel.html#coroutine.close). Пользовательские реализации также должны реализовывать [`__await__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__await__). Все экземпляры [`Coroutine`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Coroutine) также являются экземплярами [`Awaitable`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Awaitable). См. также определение [корутины](https://python-all.ru/3.5/glossary.html#term-coroutine).119120> **Примечание**121>122> В CPython корутины на основе генераторов (генераторы, декорированные [`types.coroutine()`](https://python-all.ru/3.5/library/types.html#types.coroutine) или [`asyncio.coroutine()`](https://python-all.ru/3.5/library/asyncio-task.html#asyncio.coroutine)) являются *ожидаемыми объектами*, даже если у них нет метода [`__await__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__await__). Использование `isinstance(gencoro, Coroutine)` для них вернёт `False`. Используйте [`inspect.isawaitable()`](https://python-all.ru/3.5/library/inspect.html#inspect.isawaitable) для их обнаружения.123124Новое в версии 3.5.125126#### `class collections.abc.AsyncIterable`127128ABC для классов, предоставляющих метод `__aiter__`. См. также определение [асинхронного итерируемого](https://python-all.ru/3.5/glossary.html#term-asynchronous-iterable).129130Новое в версии 3.5.131132#### `class collections.abc.AsyncIterator`133134ABC для классов, предоставляющих методы `__aiter__` и `__anext__`. См. также определение [асинхронного итератора](https://python-all.ru/3.5/glossary.html#term-asynchronous-iterator).135136Новое в версии 3.5.137138Эти ABC позволяют проверять, предоставляют ли классы или их экземпляры определённую функциональность, например:139140```python141size = None142if isinstance(myvar, collections.abc.Sized):143    size = len(myvar)144```145146Некоторые из ABC также полезны в качестве примесей (mixins), упрощающих разработку классов, поддерживающих API контейнеров. Например, чтобы написать класс, поддерживающий полный API [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set), достаточно предоставить три основных абстрактных метода: [`__contains__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__contains__), [`__iter__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__iter__) и [`__len__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__len__). ABC предоставляет остальные методы, такие как [`__and__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__and__) и `isdisjoint()`:147148```python149class ListBasedSet(collections.abc.Set):150    ''' Альтернативная реализация множества, ориентированная на экономию памяти, а не на скорость151        и не требующая, чтобы элементы множества были хэшируемыми. '''152    def __init__(self, iterable):153        self.elements = lst = []154        for value in iterable:155            if value not in lst:156                lst.append(value)157158    def __iter__(self):159        return iter(self.elements)160161    def __contains__(self, value):162        return value in self.elements163164    def __len__(self):165        return len(self.elements)166167s1 = ListBasedSet('abcdef')168s2 = ListBasedSet('defghi')169overlap = s1 & s2            # Метод __and__() поддерживается автоматически170```171172Замечания по использованию [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) и [`MutableSet`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MutableSet) в качестве примеси:1731741. Поскольку некоторые операции над множествами создают новые множества, методам примесей по умолчанию нужен способ создавать новые экземпляры из итерируемого объекта. Предполагается, что конструктор класса имеет сигнатуру вида `ClassName(iterable)`. Это допущение вынесено во внутренний метод класса `_from_iterable()`, который вызывает `cls(iterable)` для создания нового множества. Если примесь [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) используется в классе с другой сигнатурой конструктора, потребуется переопределить `_from_iterable()` методом класса, который умеет создавать новые экземпляры из итерируемого аргумента.1752. Чтобы переопределить сравнения (предположительно для скорости, так как семантика фиксирована), переопределите [`__le__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__le__) и [`__ge__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__ge__), тогда остальные операции будут автоматически им следовать.1763. Миксин [`Set`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) предоставляет метод `_hash()` для вычисления хеша множества; однако [`__hash__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__hash__) не определён, так как не все множества хешируемы или неизменяемы. Чтобы добавить хешируемость множества с помощью миксинов, унаследуйте от обоих [`Set()`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Set) и [`Hashable()`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.Hashable), а затем определите `__hash__ = Set._hash`.177178> **См. также**179>180> - [Рецепт OrderedSet](https://python-all.ru/3.5/library/collections.abc.html) для примера, построенного на [`MutableSet`](https://python-all.ru/3.5/library/collections.abc.html#collections.abc.MutableSet).181> - Для получения дополнительной информации об ABC см. модуль [`abc`](https://python-all.ru/3.5/library/abc.html#module-abc) и .182