minos.saga.executions.saga module

class minos.saga.executions.saga.SagaExecution(definition, uuid, context, status=SagaStatus.Created, steps=None, paused_step=None, already_rollback=False, user=None, *args, **kwargs)[source]

Bases: object

Saga Execution class.

__init__(definition, uuid, context, status=SagaStatus.Created, steps=None, paused_step=None, already_rollback=False, user=None, *args, **kwargs)[source]
async commit(*args, **kwargs)[source]

Commit the execution transactions.

Parameters

  • args – Additional positional arguments.

  • kwargs – Additional named arguments.

Return type

None

Returns

This method does not return anything.

async execute(response=None, *args, autocommit=True, **kwargs)[source]

Execute the Saga definition.

Parameters

  • response (typing.Optional[minos.saga.messages.SagaResponse]) – An optional SagaResponse to be consumed by the immediately next executed step.

  • args – Additional positional arguments.

  • autocommit (bool) – If True the commit process is performed automatically, otherwise must be performed manually.

  • kwargs – Additional named arguments.

Return type

minos.saga.context.SagaContext

Returns

A ``SagaContext instance.

classmethod from_definition(definition, context=None, uuid=None, *args, **kwargs)[source]

Build a new instance from a Saga object.

Parameters

  • definition (minos.saga.definitions.saga.Saga) – The definition of the saga.

  • context (typing.Optional[minos.saga.context.SagaContext]) – Initial saga execution context. If not provided, then a new empty context is created.

  • uuid (typing.Optional[uuid.UUID]) – The identifier of the execution. If None is provided, then a new one will be generated.

  • args – Additional positional arguments.

  • kwargs – Additional named arguments.

Return type

minos.saga.executions.saga.SagaExecution

Returns

A new SagaExecution instance.

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

Build a new instance from a raw representation.

Parameters
Return type

minos.saga.executions.saga.SagaExecution

Returns

A SagaExecution instance.

classmethod from_saga(definition, context=None, *args, **kwargs)[source]

Build a new instance from a Saga object.

Parameters
Return type

minos.saga.executions.saga.SagaExecution

Returns

A new SagaExecution instance.

property raw: dict[str, typing.Any]

Compute a raw representation of the instance.

Return type

dict[str, typing.Any]

Returns

A dict instance.

async reject(*args, **kwargs)[source]

Reject the execution transactions.

Parameters

  • args – Additional positional arguments.

  • kwargs – Additional named arguments.

Return type

None

Returns

This method does not return anything.

async rollback(*args, autoreject=True, **kwargs)[source]

Revert the executed operation with a compensatory operation.

Parameters

  • args – Additional positional arguments.

  • autoreject (bool) – If True the commit process is performed automatically, otherwise must be performed manually.

  • kwargs – Additional named arguments.

Return type

None

Returns

The updated execution context.