spines.parameters.decorators

Decorators for parameters module.

spines.parameters.decorators.finalize_post(func: Callable, store) → Callable[source]

Finalizes the store prior to executing the function

Parameters
  • func (callable) – The function to wrap.

  • store (ParameterStore) – The parameter store to finalize.

Returns

The wrapped function.

Return type

callable

Raises

MissingParameterException – If there’s a parameter missing from the required parameters in the given store.

spines.parameters.decorators.finalize_pre(func: Callable, store) → Callable[source]

Finalizes the store prior to executing the function

Parameters
  • func (callable) – The function to wrap.

  • store (ParameterStore) – The parameter store to finalize.

Returns

The wrapped function.

Return type

callable

Raises

MissingParameterException – If there’s a parameter missing from the required parameters in the given store.

spines.parameters.decorators.state_changed(func: Callable) → Callable[source]

Decorator indicating a function which changes the state

Parameters

func (callable) – The function to wrap.

Returns

The wrapped function.

Return type

callable