mafw.models.loop_payloads

Loop payload dataclasses for parallel processors.

Added in version v2.1.0.

Classes

`LoopItem`(i_item, n_item, payload)	Container for a loop item and its position.
`LoopResult`(i_item, n_item, looping_status, ...)	Container for a loop result and its status.

class mafw.models.loop_payloads.LoopItem(i_item: int, n_item: int, payload: Any)[source]

Bases: object

Container for a loop item and its position.

i_item: int: Index of the item within the loop.

n_item: int: Total number of items in the loop.

payload: Any: The item payload.

class mafw.models.loop_payloads.LoopResult(i_item: int, n_item: int, looping_status: LoopingStatus, payload: Any, duration: float)[source]

Bases: object

Container for a loop result and its status.

duration: float: Wall clock duration of the item processing.

i_item: int: Index of the item within the loop.

looping_status: LoopingStatus: Looping status produced while processing the item.

n_item: int: Total number of items in the loop.

payload: Any: Optional result payload returned by the processor.