Skip to main content

run

Run a form with the given runnables or a single widget. This is the main entry point for executing forms. It supports two modes: 1. Running a list of runnables as a multi-step form 2. Running a single widget to get its value

Signature

def run(
runnables: Union[List[Runnable], Widget],
state: Dict = None,
hide_steps: bool = False
) -> typing.Union[abstra_internals.entities.forms.form_state.State, NoneType, object]

Parameters

NameDescriptionTypeDefault
runnables (required)Either a list of form steps or a single widget.Union[List[Runnable], Widget]None
stateInitial state values for the form.DictNone
hide_stepsWhether to hide steps navigation in the UI. Union[State, None, object]: - For a list of runnables: the final State object - For a single InputWidget: the widget's value - For other single widgets: NoneboolFalse

Return Value

typing.Union[abstra_internals.entities.forms.form_state.State, NoneType, object]