minos.saga.executions.steps.abc module¶

class minos.saga.executions.steps.abc.SagaStepExecution(definition, related_services=None, status=SagaStepStatus.Created, already_rollback=False)[source]¶

Bases: abc.ABC

Saga Step Execution class.

__init__(definition, related_services=None, status=SagaStepStatus.Created, already_rollback=False)[source]¶

abstract async execute(context, *args, **kwargs)[source]¶

Execution the step.

Parameters

context (minos.saga.context.SagaContext) – The execution context to be used during the execution.
args – Additional positional arguments.
kwargs – Additional named arguments.

Return type

minos.saga.context.SagaContext

Returns

The updated context.

static from_definition(step)[source]¶

Build a SagaStepExecution instance from the SagaStep definition.

Parameters: step (minos.saga.definitions.steps.abc.SagaStep) – The SagaStep definition.
Return type: minos.saga.executions.steps.abc.SagaStepExecution
Returns: A new SagaStepExecution.

classmethod from_raw(raw, **kwargs)[source]¶

Build a new instance from a raw representation.

Parameters

raw (typing.Union[dict[str, typing.Any], minos.saga.executions.steps.abc.SagaStepExecution]) – The raw representation of the instance.
kwargs – Additional named arguments.

Return type

minos.saga.executions.steps.abc.SagaStepExecution

Returns

A SagaStepExecution instance.

property raw: dict[str, typing.Any]¶

Compute a raw representation of the instance.

Return type: dict[str, typing.Any]
Returns: A dict instance.

abstract async rollback(context, *args, **kwargs)[source]¶

Revert the executed step.

Parameters

context (minos.saga.context.SagaContext) – Execution context.
args – Additional positional arguments.
kwargs – Additional named arguments.

Return type

minos.saga.context.SagaContext

Returns

The updated execution context.