.. _f-authmount:

module ``apps.staticapp.authmount``
===================================





.. inheritance-diagram:: mathenjeu.apps.staticapp.authmount


Short summary
+++++++++++++

module ``mathenjeu.apps.staticapp.authmount``

Custom Router to check for authentification.


:githublink:`%|py|5`




Classes
+++++++

+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| class                                                                         | truncated documentation                                                                                                   |
+===============================================================================+===========================================================================================================================+
| :class:`_CommonMethods <mathenjeu.apps.staticapp.authmount._CommonMethods>`   |                                                                                                                           |
+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :class:`AuthMount <mathenjeu.apps.staticapp.authmount.AuthMount>`             | The router checks for authentification by looking for a cookie which contains an alias. This alias can only be set if ... |
+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :class:`AuthStaticFiles <mathenjeu.apps.staticapp.authmount.AuthStaticFiles>` | Overloads *StaticFiles* to check authentification.                                                                        |
+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+----------------------------------------------------------------------+-------------------------+
| property                                                             | truncated documentation |
+======================================================================+=========================+
| :meth:`routes <mathenjeu.apps.staticapp.authmount.AuthMount.routes>` |                         |
+----------------------------------------------------------------------+-------------------------+






Methods
+++++++

+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| method                                                                                       | truncated documentation                                                                                               |
+==============================================================================================+=======================================================================================================================+
| :py:meth:`__call__ <mathenjeu.apps.staticapp.authmount.AuthMount.__call__>`                  | Checks the user is authenticated, falls back in the previous behavior, otherwise redirect to the authentification ... |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__call__ <mathenjeu.apps.staticapp.authmount.AuthStaticFiles.__call__>`            | The ASGI entry point.                                                                                                 |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.apps.staticapp.authmount.AuthMount.__init__>`                  |                                                                                                                       |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_app_session <mathenjeu.apps.staticapp.authmount.AuthMount.get_app_session>`       | Retrieves the :epkg:`starlette` application and the session.                                                          |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_app_session <mathenjeu.apps.staticapp.authmount.AuthStaticFiles.get_app_session>` | Retrieves the :epkg:`starlette` application and the session.                                                          |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_app_session <mathenjeu.apps.staticapp.authmount._CommonMethods.get_app_session>`  | Retrieves the :epkg:`starlette` application and the session.                                                          |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: mathenjeu.apps.staticapp.authmount
    :members:
    :special-members: __init__
    :show-inheritance: