onboarding.models.assistant

Attributes

Classes

`Assistant`	Describes an assistant guiding a user through onboarding.
`Step`	Describes a step in an assistant.
`DefaultAssistant`

Module Contents

onboarding.models.assistant._T[source]

class onboarding.models.assistant.Assistant(app: onegov.onboarding.app.OnboardingApp, current_step_number: int = 1)[source]

Describes an assistant guiding a user through onboarding.

app[source]

methods[source]

steps[source]

current_step_number[source]

property current_step: Step[source]

property progress: tuple[int, int][source]

property is_first_step: bool[source]

property is_last_step: bool[source]

for_next_step() → Self[source]

for_prev_step() → Self[source]

for_first_step() → Self[source]

classmethod step(form: None = None) → Callable[[_ViewF], _ViewF][source]
classmethod step(form: type[_FormT]) → Callable[[_FormView[_FormT, _T]], _FormView[_FormT, _T]]

class onboarding.models.assistant.Step(view_handler: Callable[[CoreRequest], Any], order: float, form: None)[source]

class onboarding.models.assistant.Step(view_handler: Callable[[CoreRequest, Form], Any], order: float, form: onegov.form.Form)

Describes a step in an assistant.

view_handler[source]

order[source]

form[source]

__lt__(other: Step) → bool[source]

handle_view(request: onegov.core.request.CoreRequest, form: Form | None) → Any[source]

class onboarding.models.assistant.DefaultAssistant(assistant: Assistant)[source]

assistant[source]