collections.abc — Абстрактные базовые классы для контейнеров

Абстрактные базовые классы коллекций

Модуль collections предоставляет следующие ABC:

Примечания

1(1,2,3,4,5,6,7,8,9,10,11,12,13,14)

Эти ABC переопределяют object.__subclasshook__() для поддержки тестирования интерфейса путем проверки наличия необходимых методов и того, что они не установлены в значение None. Это работает только для простых интерфейсов. Более сложные интерфейсы требуют регистрации или прямого наследования.

2

Проверка isinstance(obj, Iterable) обнаруживает классы, зарегистрированные как Iterable или имеющие метод __iter__(), но не обнаруживает классы, которые итерируются с помощью метода __getitem__(). Единственный надёжный способ определить, является ли объект итерируемым, заключается в вызове iter(obj).

Классы абстрактного базового уровня Collections – подробные описания

class collections.abc.Container

ABC для классов, предоставляющих метод __contains__().

class collections.abc.Hashable

ABC для классов, предоставляющих метод __hash__().

class collections.abc.Sized

ABC для классов, предоставляющих метод __len__().

class collections.abc.Callable

ABC для классов, предоставляющих метод __call__().

class collections.abc.Iterable

ABC для классов, предоставляющих метод __iter__().

Проверка isinstance(obj, Iterable) обнаруживает классы, зарегистрированные как Iterable, или имеющие метод __iter__(), но не обнаруживает классы, которые итерируются с помощью метода __getitem__(). Единственный надёжный способ определить, является ли объект итерируемым, — вызвать iter(obj).

class collections.abc.Collection

ABC для классов контейнеров-коллекций, которые являются итерируемыми и имеют размер.

Введено в версии 3.6.

class collections.abc.Iterator

ABC для классов, предоставляющих методы __iter__() и __next__(). Смотрите также определение итератора.

class collections.abc.Reversible

ABC для итерируемых классов, которые также предоставляют метод __reversed__().

Введено в версии 3.6.

class collections.abc.Generator

ABC для классов-генераторов, реализующих протокол, определённый в PEP 342, который расширяет итераторы методами send(), throw() и close(). Смотрите также определение генератора.

Введено в версии 3.5.

class collections.abc.Sequence

class collections.abc.MutableSequence

class collections.abc.ByteString

ABC для неизменяемых и изменяемых последовательностей.

Примечание по реализации: некоторые методы-миксины, такие как __iter__(), __reversed__() и index(), делают повторные вызовы к базовому методу __getitem__(). Поэтому, если __getitem__() реализован с постоянной скоростью доступа, методы-миксины будут иметь линейную производительность. Однако, если базовый метод имеет линейную производительность (как в случае с связанным списком), миксины будут иметь квадратичную производительность и, вероятно, потребуют переопределения.

Изменено в версии 3.5: Метод index() получил поддержку аргументов stop и start.

class collections.abc.Set

class collections.abc.MutableSet

ABC для неизменяемых и изменяемых множеств.

class collections.abc.Mapping

class collections.abc.MutableMapping

ABC для неизменяемых и изменяемых отображений.

class collections.abc.MappingView

class collections.abc.ItemsView

class collections.abc.KeysView

class collections.abc.ValuesView

ABC для представлений отображений, элементов, ключей и значений.

class collections.abc.Awaitable

ABC для awaitable объектов, которые могут использоваться в выражениях await. Пользовательские реализации должны предоставлять метод __await__().

Объекты генераторов и экземпляры ABC Coroutine являются экземплярами этого ABC.

Примечание

В CPython, генераторы-корутины (генераторы, оформленные с помощью types.coroutine() или asyncio.coroutine()) являются awaitable, даже если у них нет метода __await__(). Использование isinstance(gencoro, Awaitable) для них вернёт False. Используйте inspect.isawaitable() для их обнаружения.

Введено в версии 3.5.

class collections.abc.Coroutine

ABC для совместимых с корутинами классов. Они реализуют следующие методы, определённые в Объектах корутин: send(), throw() и close(). Пользовательские реализации также должны реализовывать __await__(). Все экземпляры Coroutine также являются экземплярами Awaitable. Смотрите также определение корутины.

Примечание

В CPython, генераторы-корутины (генераторы, оформленные с помощью types.coroutine() или asyncio.coroutine()) являются awaitable, даже если у них нет метода __await__(). Использование isinstance(gencoro, Coroutine) для них вернёт False. Используйте inspect.isawaitable() для их обнаружения.

Введено в версии 3.5.

class collections.abc.AsyncIterable

ABC для классов, предоставляющих метод __aiter__. Смотрите также определение асинхронного итерируемого объекта.

Введено в версии 3.5.

class collections.abc.AsyncIterator

ABC для классов, предоставляющих методы __aiter__ и __anext__ . Смотрите также определение асинхронного итератора.

Введено в версии 3.5.

class collections.abc.AsyncGenerator

ABC для классов асинхронных генераторов, реализующих протокол, определённый в PEP 525 и PEP 492.

Введено в версии 3.6.

Примеры и рецепты

ABCs позволяют нам спрашивать классы или экземпляры, предоставляют ли они определённую функциональность, например:

size = None
if isinstance(myvar, collections.abc.Sized):
    size = len(myvar)

Несколько ABC также полезны в качестве миксинов, которые облегчают разработку классов, поддерживающих контейнерные API. Например, для написания класса, поддерживающего полный Set API, достаточно предоставить три основополагающих абстрактных метода: __contains__(), __iter__(), и __len__(). ABC предоставляет остальные методы, такие как __and__() и isdisjoint().

class ListBasedSet(collections.abc.Set):
    ''' Alternate set implementation favoring space over speed
        and not requiring the set elements to be hashable. '''
    def __init__(self, iterable):
        self.elements = lst = []
        for value in iterable:
            if value not in lst:
                lst.append(value)

    def __iter__(self):
        return iter(self.elements)

    def __contains__(self, value):
        return value in self.elements

    def __len__(self):
        return len(self.elements)

s1 = ListBasedSet('abcdef')
s2 = ListBasedSet('defghi')
overlap = s1 & s2            # The __and__() method is supported automatically

Примечания по использованию Set и MutableSet в качестве миксина:

1. Поскольку некоторые операции над множествами создают новые множества, стандартные методы миксина должны иметь возможность создавать новые экземпляры из итерируемого объекта. Предполагается, что конструктор класса имеет сигнатуру в виде ClassName(iterable). Это предположение вынесено в внутренний метод класса _from_iterable(), который вызывает cls(iterable), чтобы создать новое множество. Если миксин Set используется в классе с другой сигнатурой конструктора, вам нужно переопределить _from_iterable() с методом класса или обычным методом, который может создавать новые экземпляры из итерируемого аргумента.
2. Чтобы переопределить сравнения (вероятно, для повышения скорости, так как семантика фиксирована), переопределите __le__() и __ge__(), затем другие операции будут автоматически работать аналогичным образом.
3. Миксин Set предоставляет метод _hash() для вычисления значения хэша множества; однако, __hash__() не определен, так как не все множества являются хешируемыми или неизменяемыми. Чтобы добавить хешируемость множеству с помощью миксинов, наследуйтесь от Set() и Hashable(), а затем определите __hash__ = Set._hash.