minos.saga.definitions.saga

Classes

Saga	Saga class.

class Saga

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)

Parameters

• steps (Optional[list[minos.saga.definitions.steps.abc.SagaStep]]) –

• committed (bool) –

• commit (None) –

classmethod from_raw(raw, **kwargs)

Build a new Saga instance from raw.

Parameters

• raw (Union[dict[str, Any], Saga]) – The raw representation of the saga.

• kwargs – Additional named arguments.

Returns

A new Saga instance.

Return type

Saga

conditional_step(step=None)

Add a new conditional step.

Parameters

step (Optional[ConditionalSagaStep]) – The step to be added. If None is provided then a new one will be created.

Returns

A SagaStep instance.

Return type

ConditionalSagaStep

local_step(step=None, **kwargs)

Add a new local step.

Parameters

• step (Optional[Union[Callable[[SagaContext, ...], Union[SagaContext, None, Awaitable[Optional[SagaContext]]]], SagaOperation[Callable[[SagaContext, ...], Union[SagaContext, None, Awaitable[Optional[SagaContext]]]]], LocalSagaStep]]) – The step to be added. If None is provided then a new one will be created.

• kwargs – Additional named parameters.

Returns

A SagaStep instance.

Return type

LocalSagaStep

step(step=None, **kwargs)

Add a new remote step step.

Parameters

• step (Optional[Union[Callable[[SagaContext, ...], Union[SagaRequest, Awaitable[SagaRequest]]], SagaOperation[Callable[[SagaContext, ...], Union[SagaRequest, Awaitable[SagaRequest]]]], RemoteSagaStep]]) – The step to be added. If None is provided then a new one will be created.

• kwargs – Additional named parameters.

Returns

A SagaStep instance.

Return type

RemoteSagaStep

remote_step(step=None, **kwargs)

Add a new remote step step.

Parameters

• step (Optional[Union[Callable[[SagaContext, ...], Union[SagaRequest, Awaitable[SagaRequest]]], SagaOperation[Callable[[SagaContext, ...], Union[SagaRequest, Awaitable[SagaRequest]]]], RemoteSagaStep]]) – The step to be added. If None is provided then a new one will be created.

• kwargs – Additional named parameters.

Returns

A SagaStep instance.

Return type

RemoteSagaStep

property raw: dict[str, Any]

Generate a raw representation of the instance.

Returns

A dict instance.

commit(callback=None, **kwargs)

Commit the instance to be ready for execution.

Parameters

• callback (None) – Deprecated argument.

• kwargs – Additional named arguments.

Returns

A Saga instance.

Return type

Saga

validate()

Check if the saga is valid.

Returns

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

Return type

None