minos.saga.definitions.steps.conditional module

class minos.saga.definitions.steps.conditional.ConditionalSagaStep(if_then=None, else_then=None, **kwargs)[source]

Bases: minos.saga.definitions.steps.abc.SagaStep

Conditional Saga Step class.

__init__(if_then=None, else_then=None, **kwargs)[source]
commit(*args, **kwargs)

Commit the current SagaStep on the Saga.

Parameters

  • args – Additional positional arguments.

  • kwargs – Additional named arguments.

Return type

Saga

Returns

A Saga instance.

conditional_step(*args, **kwargs)

Create a new conditional step in the Saga.

Parameters

  • args – Additional positional parameters.

  • kwargs – Additional named parameters.

Return type

ConditionalSagaStep

Returns

A new SagaStep instance.

else_then(saga)[source]

Set the ElseThenAlternative with the given saga.

Parameters

saga (Saga) – The saga to be executed if not any condition is met.

Return type

ConditionalSagaStep

Returns

This method returns the same instance that is called.

classmethod from_raw(raw, **kwargs)

Build a new instance from raw.

Parameters
Return type

minos.saga.definitions.steps.abc.SagaStep

Returns

A SagaStep instance.

if_then(condition, saga)[source]

Add a new IfThenAlternative based on a condition and a saga.

Parameters

  • condition (Callable[[SagaContext], Union[bool, Awaitable[bool]]]) – The condition that must be satisfied to execute the alternative.

  • saga (Saga) – The saga to be executed if the condition is satisfied.

Return type

ConditionalSagaStep

Returns

This method returns the same instance that is called.

local_step(*args, **kwargs)

Create a new local step in the Saga.

Parameters

  • args – Additional positional parameters.

  • kwargs – Additional named parameters.

Return type

LocalSagaStep

Returns

A new SagaStep instance.

property raw: dict[str, typing.Any]

Get the raw representation of the step.

Return type

dict[str, typing.Any]

Returns

A dict instance.

remote_step(*args, **kwargs)

Create a new remote step in the Saga.

Parameters

  • args – Additional positional parameters.

  • kwargs – Additional named parameters.

Return type

RemoteSagaStep

Returns

A new SagaStep instance.

step(*args, **kwargs)

Create a new step in the Saga.

Parameters

  • args – Additional positional parameters.

  • kwargs – Additional named parameters.

Return type

minos.saga.definitions.steps.abc.SagaStep

Returns

A new SagaStep instance.

validate()[source]

Check if the step is valid.

Return type

None

Returns

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

class minos.saga.definitions.steps.conditional.ElseThenAlternative(saga)[source]

Bases: object

Else Then Alternative class.

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

Build a new instance from a raw representation.

Parameters
Return type

minos.saga.definitions.steps.conditional.ElseThenAlternative

Returns

A new ElseThenAlternative instance.

property raw: dict[str, typing.Any]

Get the raw representation of the alternative.

Return type

dict[str, typing.Any]

Returns

A dict value.

validate()[source]

Check if the alternative is valid.

Return type

None

Returns

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

class minos.saga.definitions.steps.conditional.IfThenAlternative(condition, saga)[source]

Bases: object

If Then Alternative class.

__init__(condition, saga)[source]
classmethod from_raw(raw, **kwargs)[source]

Build a new instance from a raw representation.

Parameters
Return type

minos.saga.definitions.steps.conditional.IfThenAlternative

Returns

A new IfThenAlternative instance.

property raw: dict[str, typing.Any]

Get the raw representation of the alternative.

Return type

dict[str, typing.Any]

Returns

A dict value.

validate()[source]

Check if the alternative is valid.

Return type

None

Returns

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