minos.saga.definitions.saga module

class minos.saga.definitions.saga.Saga(*args, steps=None, committed=False, commit=None, **kwargs)[source]

Bases: object

Saga class.

The purpose of this class is to define a sequence of operations among microservices.

__init__(*args, steps=None, committed=False, commit=None, **kwargs)[source]
commit(callback=None, **kwargs)[source]

Commit the instance to be ready for execution.

Parameters

  • callback (None) – Deprecated argument.

  • kwargs – Additional named arguments.

Return type

minos.saga.definitions.saga.Saga

Returns

A Saga instance.

conditional_step(step=None)[source]

Add a new conditional step.

Parameters

step (typing.Optional[minos.saga.definitions.steps.conditional.ConditionalSagaStep]) – The step to be added. If None is provided then a new one will be created.

Return type

minos.saga.definitions.steps.conditional.ConditionalSagaStep

Returns

A SagaStep instance.

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

Build a new Saga instance from raw.

Parameters
Return type

minos.saga.definitions.saga.Saga

Returns

A new Saga instance.

local_step(step=None, **kwargs)[source]

Add a new local step.

Parameters
Return type

minos.saga.definitions.steps.local.LocalSagaStep

Returns

A SagaStep instance.

property raw: dict[str, typing.Any]

Generate a raw representation of the instance.

Return type

dict[str, typing.Any]

Returns

A dict instance.

remote_step(step=None, **kwargs)[source]

Add a new remote step step.

Parameters
Return type

minos.saga.definitions.steps.remote.RemoteSagaStep

Returns

A SagaStep instance.

step(step=None, **kwargs)[source]

Add a new remote step step.

Parameters
Return type

minos.saga.definitions.steps.remote.RemoteSagaStep

Returns

A SagaStep instance.

validate()[source]

Check if the saga is valid.

Return type

None

Returns

This method does not return anything, but raises an exception if the saga is not valid.