avl._core.sequence module

class avl._core.sequence.Sequence(*args: Any, **kwargs: Any)[source]
__init__(name, parent_sequence: Sequence) → None[source]

Initializes the Sequence with a name and parent sequence.

Parameters:

  • name (str) – Name of the sequence.

  • parent_sequence (Sequence) – Parent sequence, if any.

set_priority(priority: int) → None[source]

Sets the priority of the sequence.

Parameters:

priority (int) – The priority to be set.

get_priority() → int[source]

Gets the priority of the sequence.

Returns:

The priority of the sequence.

Return type:

int

async start_item(item: SequenceItem, priority: int | None = None, sequencer: Sequencer | None = None) → None[source]

Starts an item in the sequence.

Parameters:

  • item (SequenceItem) – The item to be started.

  • priority (int) – The priority of the item (optional).

  • sequencer (Sequencer) – The sequencer to be used (optional).

async finish_item(item: SequenceItem) → None[source]

Finishes an item in the sequence.

Parameters:

item (SequenceItem) – The item to be finished.

async pre_start() → None[source]

Pre-start hook for the sequence.

async post_start() → None[source]

Post-start hook for the sequence.

async start() → None[source]

Starts the sequence.

async pre_body() → None[source]

Pre-body hook for the sequence.

async post_body() → None[source]

Post-body hook for the sequence.

async body() → None[source]

Body of the sequence.

pre_do(item: SequenceItem) → None[source]

Pre-do hook for an item.

Parameters:

item – The item to be processed.

mid_do(item: SequenceItem) → None[source]

Mid-do hook for an item.

Parameters:

item – The item to be processed.

post_do(item: SequenceItem) → None[source]

Post-do hook for an item.

Parameters:

item – The item to be processed.