user.forms.login
================

.. py:module:: user.forms.login


Classes
-------

.. autoapisummary::

   user.forms.login.LoginData
   user.forms.login.LoginForm


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

.. py:class:: LoginData

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: username
      :type:  str


   .. py:attribute:: password
      :type:  str


   .. py:attribute:: second_factor
      :type:  str | None


   .. py:attribute:: skip_providers
      :type:  NotRequired[bool]


.. py:class:: LoginForm(formdata: webob.multidict.MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: collections.abc.Mapping[str, collections.abc.Sequence[Any]] | None = None, **kwargs: Any)

   Bases: :py:obj:`onegov.form.Form`


   A generic login form for onegov.user 


   .. py:attribute:: username


   .. py:attribute:: password


   .. py:attribute:: yubikey


   .. py:property:: login_data
      :type: LoginData


      Returns the data required to be passed to the
      :class:`onegov.user.auth.Auth` methods.