class*args, **kwds)[source]#

Bases: MutableSequence[Document]

Implement sequence-like methods

insert(index, value, **kwargs)[source]#

Insert doc at index.

  • index (int) – Position of the insertion.

  • value (Document) – The doc needs to be inserted.

  • kwargs – Additional Arguments that are passed to the Document Store. This has no effect for in-memory DocumentArray.

append(value, **kwargs)[source]#

Append doc to the end of the array.


value (Document) – The doc needs to be appended.


Clear the data of DocumentArray

extend(values, **kwargs)[source]#

S.extend(iterable) – extend sequence by appending elements from the iterable

Return type:


count(value) integer -- return number of occurrences of value#
index(value[, start[, stop]]) integer -- return first index of value.#

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

pop([index]) item -- remove and return item at index (default last).#

Raise IndexError if list is empty or index is out of range.


S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.


S.reverse() – reverse IN PLACE