.. _l-methods:

Methods
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| method                                                                                           | class parent              | truncated documentation                                                                                               |
+==================================================================================================+===========================+=======================================================================================================================+
| :py:meth:`__call__ <mathenjeu.apps.staticapp.authmount.AuthMount.__call__>`                      | AuthMount                 | 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__>`                | AuthStaticFiles           | The ASGI entry point.                                                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.Activity.__getitem__>`                  | Activity                  | Returns the value associated to a field.                                                                              |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.ActivityGroup.__getitem__>`             | ActivityGroup             | Retrieves the question.                                                                                               |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.Base.__getitem__>`                      | Base                      | Returns the value associated to a field.                                                                              |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.Display.__getitem__>`                   | Display                   | Returns the value associated to a field.                                                                              |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.LanguageBase.__getitem__>`              | LanguageBase              | Returns the value associated to a field.                                                                              |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getitem__ <mathenjeu.activities.base_classes.Notion.__getitem__>`                    | Notion                    | Returns the value associated to a field.                                                                              |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.act_question.QuestionChoice.__init__>`                  | QuestionChoice            |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.Activity.__init__>`                        | Activity                  |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.ActivityGroup.__init__>`                   | ActivityGroup             |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.Base.__init__>`                            | Base                      |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.Display.__init__>`                         | Display                   |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.LanguageBase.__init__>`                    | LanguageBase              |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.activities.base_classes.Notion.__init__>`                          | Notion                    |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.apps.common.auth_app.AuthentificationAnswers.__init__>`            | AuthentificationAnswers   |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.apps.common.log_app.LogApp.__init__>`                              | LogApp                    |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.apps.display.html_display.DisplayQuestionChoiceHTML.__init__>`     | DisplayQuestionChoiceHTML | constructor                                                                                                           |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.apps.qcm.qcm_app.QCMApp.__init__>`                                 | QCMApp                    |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.apps.server.server_hypercorn.ServerHypercorn.__init__>`            | ServerHypercorn           |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.apps.staticapp.authmount.AuthMount.__init__>`                      | AuthMount                 |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mathenjeu.apps.staticapp.staticsite.StaticApp.__init__>`                     | StaticApp                 |                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__iter__ <mathenjeu.activities.base_classes.ActivityGroup.__iter__>`                   | ActivityGroup             | To iterate on activities.                                                                                             |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <mathenjeu.activities.base_classes.ActivityGroup.__len__>`                     | ActivityGroup             | Returns the number of activities.                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.Activity.__repr__>`                        | Activity                  | Usual                                                                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.ActivityGroup.__repr__>`                   | ActivityGroup             | Usual                                                                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.Base.__repr__>`                            | Base                      | Usual                                                                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.Display.__repr__>`                         | Display                   | Usual                                                                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.LanguageBase.__repr__>`                    | LanguageBase              | Usual                                                                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mathenjeu.activities.base_classes.Notion.__repr__>`                          | Notion                    | Usual                                                                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`answer <mathenjeu.apps.qcm.qcm_app.QCMApp.answer>`                                        | QCMApp                    | Captures an answer.                                                                                                   |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`authenticate <mathenjeu.apps.common.auth_app.AuthentificationAnswers.authenticate>`       | AuthentificationAnswers   | Authentification.                                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`authentify_user <mathenjeu.apps.common.auth_app.AuthentificationAnswers.authentify_user>` | AuthentificationAnswers   | Overwrites this method to allow or reject users.                                                                      |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`cleanup <mathenjeu.apps.qcm.qcm_app.QCMApp.cleanup>`                                      | QCMApp                    | Cleans up.                                                                                                            |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`cleanup <mathenjeu.apps.staticapp.staticsite.StaticApp.cleanup>`                          | StaticApp                 | Cleans up.                                                                                                            |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`event <mathenjeu.apps.qcm.qcm_app.QCMApp.event>`                                          | QCMApp                    | This route does not return anything interesting except a blank page, but it logs                                      |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`event <mathenjeu.apps.staticapp.staticsite.StaticApp.event>`                              | StaticApp                 | This route does not return anything interesting except a blank page, but it logs                                      |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`expected_answers <mathenjeu.activities.base_classes.ActivityGroup.expected_answers>`      | ActivityGroup             | Returns the expected answers aliases.                                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_app_session <mathenjeu.apps.staticapp.authmount.AuthMount.get_app_session>`           | AuthMount                 | Retrieves the :epkg:`starlette` application and the session.                                                          |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_app_session <mathenjeu.apps.staticapp.authmount.AuthStaticFiles.get_app_session>`     | AuthStaticFiles           | Retrieves the :epkg:`starlette` application and the session.                                                          |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_app_session <mathenjeu.apps.staticapp.authmount._CommonMethods.get_app_session>`      | _CommonMethods            | Retrieves the :epkg:`starlette` application and the session.                                                          |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_context <mathenjeu.apps.display.html_display.DisplayQuestionChoiceHTML.get_context>`  | DisplayQuestionChoiceHTML | Renders a question specified as QCM.                                                                                  |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_display_item <mathenjeu.activities.base_classes.ActivityGroup.get_display_item>`      | ActivityGroup             | Returns a displayable number.                                                                                         |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_next <mathenjeu.activities.base_classes.ActivityGroup.get_next>`                      | ActivityGroup             | Computes the next question or returns None if does not exist.                                                         |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_previous <mathenjeu.activities.base_classes.ActivityGroup.get_previous>`              | ActivityGroup             | Computes the previous question or returns None if does not exist.                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_session <mathenjeu.apps.common.auth_app.AuthentificationAnswers.get_session>`         | AuthentificationAnswers   | Retrieves the session.                                                                                                |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`hash_pwd <mathenjeu.apps.common.auth_app.AuthentificationAnswers.hash_pwd>`               | AuthentificationAnswers   | Hashes a password.                                                                                                    |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`is_allowed <mathenjeu.apps.common.auth_app.AuthentificationAnswers.is_allowed>`           | AuthentificationAnswers   | Checks that a user is allowed. Returns None if it is allowed, otherwise an page with an error message.                |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`lastpage <mathenjeu.apps.qcm.qcm_app.QCMApp.lastpage>`                                    | QCMApp                    | Defines the last page.                                                                                                |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`log_any <mathenjeu.apps.common.log_app.LogApp.log_any>`                                   | LogApp                    | Logs information.                                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`log_event <mathenjeu.apps.common.log_app.LogApp.log_event>`                               | LogApp                    | Logs information about events.                                                                                        |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`login <mathenjeu.apps.common.auth_app.AuthentificationAnswers.login>`                     | AuthentificationAnswers   | Login page. If paramater *returnto* is specified in the url, the user will go to this page after being logged.        |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`logout <mathenjeu.apps.common.auth_app.AuthentificationAnswers.logout>`                   | AuthentificationAnswers   | Logout page.                                                                                                          |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`main <mathenjeu.apps.qcm.qcm_app.QCMApp.main>`                                            | QCMApp                    | Defines the main page.                                                                                                |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`main <mathenjeu.apps.staticapp.staticsite.StaticApp.main>`                                | StaticApp                 | Defines the main page.                                                                                                |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`not_found <mathenjeu.apps.qcm.qcm_app.QCMApp.not_found>`                                  | QCMApp                    | Returns an :epkg:`HTTP 404` page.                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`not_found <mathenjeu.apps.staticapp.staticsite.StaticApp.not_found>`                      | StaticApp                 | Returns an :epkg:`HTTP 404` page.                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`on_error <mathenjeu.apps.qcm.qcm_app.QCMApp.on_error>`                                    | QCMApp                    | An example error.                                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`on_error <mathenjeu.apps.staticapp.staticsite.StaticApp.on_error>`                        | StaticApp                 | An example error.                                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`page_context <mathenjeu.apps.qcm.qcm_app.QCMApp.page_context>`                            | QCMApp                    | Returns the page context before applying any template.                                                                |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`page_context <mathenjeu.apps.staticapp.staticsite.StaticApp.page_context>`                | StaticApp                 | Returns the page context before applying any template.                                                                |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`qcm <mathenjeu.apps.qcm.qcm_app.QCMApp.qcm>`                                              | QCMApp                    | Defines the main page.                                                                                                |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`run <mathenjeu.apps.server.server_hypercorn.ServerHypercorn.run>`                         | ServerHypercorn           | Starts the server.                                                                                                    |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`save_session <mathenjeu.apps.common.auth_app.AuthentificationAnswers.save_session>`       | AuthentificationAnswers   | Saves the session to the response in a secure cookie.                                                                 |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`server_error <mathenjeu.apps.qcm.qcm_app.QCMApp.server_error>`                            | QCMApp                    | Returns an :epkg:`HTTP 500` page.                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`server_error <mathenjeu.apps.staticapp.staticsite.StaticApp.server_error>`                | StaticApp                 | Returns an :epkg:`HTTP 500` page.                                                                                     |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`startup <mathenjeu.apps.qcm.qcm_app.QCMApp.startup>`                                      | QCMApp                    | Startups.                                                                                                             |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`startup <mathenjeu.apps.staticapp.staticsite.StaticApp.startup>`                          | StaticApp                 | Startups.                                                                                                             |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.Activity.to_dict>`                             | Activity                  | Returns all values as a dictionary.                                                                                   |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.ActivityGroup.to_dict>`                        | ActivityGroup             | Returns all values as a dictionary.                                                                                   |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.Base.to_dict>`                                 | Base                      | Returns all values as a dictionary.                                                                                   |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.Display.to_dict>`                              | Display                   | Returns all values as a dictionary.                                                                                   |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.LanguageBase.to_dict>`                         | LanguageBase              | Returns all values as a dictionary.                                                                                   |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`to_dict <mathenjeu.activities.base_classes.Notion.to_dict>`                               | Notion                    | Returns all values as a dictionary.                                                                                   |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`unknown_game <mathenjeu.apps.qcm.qcm_app.QCMApp.unknown_game>`                            | QCMApp                    | Returns an answer for somebody looking to access the questions without being authentified.                            |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`unlogged_response <mathenjeu.apps.qcm.qcm_app.QCMApp.unlogged_response>`                  | QCMApp                    | Returns an answer for somebody looking to access the questions without being authentified.                            |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`unlogged_response <mathenjeu.apps.staticapp.staticsite.StaticApp.unlogged_response>`      | StaticApp                 | Returns an answer for somebody looking to access the questions without being authentified.                            |
+--------------------------------------------------------------------------------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------+