docarray.array.storage.base.seqlike module

class docarray.array.storage.base.seqlike.BaseSequenceLikeMixin(*args, **kwds)

Bases: MutableSequence[Document]

Implement sequence-like methods

insert(index, value, **kwargs)

Insert doc at index.

Parameters:

• 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)

Append doc to the end of the array.

Parameters:

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

clear()

Clear the data of DocumentArray

extend(values, **kwargs)

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

Return type:

None

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.

remove(value)

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

reverse()

S.reverse() – reverse IN PLACE