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

Коллекции абстрактных базовых классов¶

Модуль «Коллекции» предлагает следующее ABCs:

Сноски

Коллекции Абстрактных базовых классов - Подробные описания¶

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__(). Единственный надежный способ определить, является ли объект iterable, - это вызвать iter(obj).

class collections.abc.Collection¶

ABC для итерируемых контейнерных классов определенного размера.

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

class collections.abc.Iterator¶

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

class collections.abc.Reversible¶

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

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

class collections.abc.Generator¶

ABC для классов generator, которые реализуют протокол, определенный в PEP 342, который расширяет iterators с помощью методов send(), throw() и close().

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

class collections.abc.Sequence¶

class collections.abc.MutableSequence¶

class collections.abc.ByteString¶

Азбука только для чтения и изменяемая sequences.

Примечание по реализации: Некоторые из методов смешивания, такие как __iter__(), __reversed__() и index(), выполняют повторные вызовы базового метода __getitem__(). Следовательно, если __getitem__() реализован с постоянной скоростью доступа, методы mixin будут иметь линейную производительность; однако, если базовый метод является линейным (как это было бы со связанным списком), то mixins будут иметь квадратичную производительность и, вероятно, их потребуется переопределить.

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

class collections.abc.Set¶

class collections.abc.MutableSet¶

Азбука только для чтения и изменяемая sets.

class collections.abc.Mapping¶

class collections.abc.MutableMapping¶

Азбука только для чтения и изменяемая mappings.

class collections.abc.MappingView¶

class collections.abc.ItemsView¶

class collections.abc.KeysView¶

class collections.abc.ValuesView¶

Азбука для отображения, элементов, ключей и значений views.

class collections.abc.Awaitable¶

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

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

Примечание

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

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

class collections.abc.Coroutine¶

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

Примечание

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

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

class collections.abc.AsyncIterable¶

ABC для классов, которые предоставляют метод __aiter__. Смотрите также определение asynchronous iterable.

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

class collections.abc.AsyncIterator¶

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

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

class collections.abc.AsyncGenerator¶

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

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

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

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

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

Некоторые из азбук также полезны в качестве микшеров, которые упрощают разработку классов, поддерживающих контейнерные 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. Поскольку некоторые операции с наборами создают новые наборы, методы mixin по умолчанию должны иметь возможность создавать новые экземпляры из iterable. Предполагается, что конструктор класса имеет сигнатуру в виде ClassName(iterable). Это предположение учитывается во внутреннем classmethod, вызываемом _from_iterable(), который вызывает cls(iterable) для создания нового набора. Если Set mixin используется в классе с другой сигнатурой конструктора, вам нужно будет переопределить _from_iterable() с помощью classmethod или обычного метода, который может создавать новые экземпляры из повторяемого аргумента.

2. Чтобы переопределить сравнения (предположительно, для ускорения, поскольку семантика исправлена), переопределите __le__() и __ge__(), тогда другие операции автоматически последуют их примеру.

3. Set mixin предоставляет метод _hash() для вычисления хэш-значения для набора; однако метод __hash__() не определен, поскольку не все наборы являются hashable или неизменяемыми. Чтобы добавить возможность стирки с помощью миксеров, наследуйте как от Set(), так и от Hashable(), затем определите __hash__ = Set._hash.