text_lint.sequencers.bases.sequencer_base.SequencerBase

class text_lint.sequencers.bases.sequencer_base.SequencerBase(entities: List[TypeSequencerEntity])[source]

Bases: ABC, Generic[TypeSequencerEntity]

A base class for iterating over discrete entities.

__init__(entities: List[TypeSequencerEntity]) None[source]

Initialize OperatorBase instances.

Parameters:

entities (List[TypeSequencerEntity]) – The objects this sequencer iterates over.

__iter__() Iterator[TypeSequencerEntity][source]

Implement the iter operation for SequencerBase instances.

Returns:

The sequencer instance itself.

Return type:

Iterator[TypeSequencerEntity]

__len__() int[source]

Implement the len operator for SequencerBase instances.

Returns:

The number of entities in this instance.

Return type:

int

abstract __next__() TypeSequencerEntity[source]

Implement the next operation for SequencerBase instances.

Returns:

The next entity in the sequencer.

Return type:

TypeSequencerEntity

property current: TypeSequencerEntity

Current entity the sequencer is pointing to.

property last: TypeSequencerEntity

Last entity in the sequencer.

next() None[source]

Advance the sequencer to the next entity.