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

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

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

Сноски

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

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

2

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

Классы абстрактного базиса коллекций — подробные описания

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 для классов контейнеров с размером и итераторами.

New in version 3.6.

class collections.abc.Iterator

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

class collections.abc.Reversible

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

New in version 3.6.

class collections.abc.Generator

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

New in version 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 для ожидаемых объектов, которые могут быть использованы в выражениях await. Пользовательские реализации должны предоставить метод __await__().

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

Примечание

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

New in version 3.5.

class collections.abc.Coroutine

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

Примечание

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

New in version 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.

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

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

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). Это предположение вынесено во внутренний classmethod с именем _from_iterable(), который вызывает cls(iterable) для создания нового множества. Если миксин Set используется в классе с другой сигнатурой конструктора, необходимо переопределить _from_iterable() с помощью метода-класса или обычного метода, способного создавать новые экземпляры из аргумента-итерируемой последовательности.
2. Для переопределения сравнений (вероятно, для повышения скорости, так как семантика фиксирована), переопределите __le__() и __ge__(), после чего другие операции будут автоматически переопределены.
3. Миксин Set предоставляет метод _hash() для вычисления хэш-значения для множества; однако, __hash__() не определён, потому что не все множества являются хешируемыми или неизменяемыми. Чтобы добавить хешируемость множества с помощью миксинов, унаследуйте как от Set(), так и от Hashable(), а затем определите __hash__ = Set._hash.