onboarding.models.assistant
===========================

.. py:module:: onboarding.models.assistant


Attributes
----------

.. autoapisummary::

   onboarding.models.assistant._T


Classes
-------

.. autoapisummary::

   onboarding.models.assistant.Assistant
   onboarding.models.assistant.Step
   onboarding.models.assistant.DefaultAssistant


Module Contents
---------------

.. py:data:: _T

.. py:class:: Assistant(app: onegov.onboarding.app.OnboardingApp, current_step_number: int = 1)

   Describes an assistant guiding a user through onboarding. 


   .. py:attribute:: app


   .. py:attribute:: steps


   .. py:attribute:: current_step_number
      :value: 1



   .. py:property:: current_step
      :type: Step



   .. py:property:: progress
      :type: tuple[int, int]



   .. py:property:: is_first_step
      :type: bool



   .. py:property:: is_last_step
      :type: bool



   .. py:method:: for_next_step() -> Self


   .. py:method:: for_prev_step() -> Self


   .. py:method:: for_first_step() -> Self


   .. py:method:: step(form: None = None) -> collections.abc.Callable[[_ViewF], _ViewF]
                  step(form: type[_FormT]) -> collections.abc.Callable[[_FormView[_FormT, _T]], _FormView[_FormT, _T]]
      :classmethod:



.. py:class:: Step(view_handler: collections.abc.Callable[[onegov.core.request.CoreRequest], Any], order: float, form: None)
              Step(view_handler: collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.form.Form], Any], order: float, form: onegov.form.Form)

   Describes a step in an assistant. 


   .. py:attribute:: view_handler


   .. py:attribute:: order


   .. py:attribute:: form


   .. py:method:: __lt__(other: Step) -> bool


   .. py:method:: handle_view(request: onegov.core.request.CoreRequest, form: onegov.form.Form | None) -> Any


.. py:class:: DefaultAssistant(assistant: Assistant)

   .. py:attribute:: assistant