.. _f-handlersml:

module ``handlersml``
=====================





.. inheritance-diagram:: lightmlboard.handlersml


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

module ``lightmlboard.handlersml``

Defines handlers for a Tornado application.


:githublink:`%|py|5`




Classes
+++++++

+----------------------------------------------------------------------------+-------------------------------------------------------+
| class                                                                      | truncated documentation                               |
+============================================================================+=======================================================+
| :class:`_BaseRequestHandler <lightmlboard.handlersml._BaseRequestHandler>` | Base handler. Returns the user.                       |
+----------------------------------------------------------------------------+-------------------------------------------------------+
| :class:`_TemplateHandler <lightmlboard.handlersml._TemplateHandler>`       | Defines the main page handler.                        |
+----------------------------------------------------------------------------+-------------------------------------------------------+
| :class:`CompetitionHandler <lightmlboard.handlersml.CompetitionHandler>`   | Handlers for the page on competitions.                |
+----------------------------------------------------------------------------+-------------------------------------------------------+
| :class:`LoginHandler <lightmlboard.handlersml.LoginHandler>`               | Login Handler.                                        |
+----------------------------------------------------------------------------+-------------------------------------------------------+
| :class:`LogoutHandler <lightmlboard.handlersml.LogoutHandler>`             | Logout Handler.                                       |
+----------------------------------------------------------------------------+-------------------------------------------------------+
| :class:`MainHandler <lightmlboard.handlersml.MainHandler>`                 | Handlers for the main page.                           |
+----------------------------------------------------------------------------+-------------------------------------------------------+
| :class:`SubmitForm <lightmlboard.handlersml.SubmitForm>`                   | Handlers for the form to upload dataset.              |
+----------------------------------------------------------------------------+-------------------------------------------------------+
| :class:`UploadData <lightmlboard.handlersml.UploadData>`                   | Upload data. Handlers for the form to upload dataset. |
+----------------------------------------------------------------------------+-------------------------------------------------------+






Properties
++++++++++

+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| property                                                                        | truncated documentation                                                                                              |
+=================================================================================+======================================================================================================================+
| :meth:`cookies <lightmlboard.handlersml.CompetitionHandler.cookies>`            | An alias for `self.request.cookies <.httputil.HTTPServerRequest.cookies>`.                                           |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`cookies <lightmlboard.handlersml.LoginHandler.cookies>`                  | An alias for `self.request.cookies <.httputil.HTTPServerRequest.cookies>`.                                           |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`cookies <lightmlboard.handlersml.LogoutHandler.cookies>`                 | An alias for `self.request.cookies <.httputil.HTTPServerRequest.cookies>`.                                           |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`cookies <lightmlboard.handlersml.MainHandler.cookies>`                   | An alias for `self.request.cookies <.httputil.HTTPServerRequest.cookies>`.                                           |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`cookies <lightmlboard.handlersml.SubmitForm.cookies>`                    | An alias for `self.request.cookies <.httputil.HTTPServerRequest.cookies>`.                                           |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`cookies <lightmlboard.handlersml.UploadData.cookies>`                    | An alias for `self.request.cookies <.httputil.HTTPServerRequest.cookies>`.                                           |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`cookies <lightmlboard.handlersml._BaseRequestHandler.cookies>`           | An alias for `self.request.cookies <.httputil.HTTPServerRequest.cookies>`.                                           |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`cookies <lightmlboard.handlersml._TemplateHandler.cookies>`              | An alias for `self.request.cookies <.httputil.HTTPServerRequest.cookies>`.                                           |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`current_user <lightmlboard.handlersml.CompetitionHandler.current_user>`  | The authenticated user for this request. This is set in one of two ways:                                             |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`current_user <lightmlboard.handlersml.LoginHandler.current_user>`        | The authenticated user for this request. This is set in one of two ways:                                             |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`current_user <lightmlboard.handlersml.LogoutHandler.current_user>`       | The authenticated user for this request. This is set in one of two ways:                                             |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`current_user <lightmlboard.handlersml.MainHandler.current_user>`         | The authenticated user for this request. This is set in one of two ways:                                             |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`current_user <lightmlboard.handlersml.SubmitForm.current_user>`          | The authenticated user for this request. This is set in one of two ways:                                             |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`current_user <lightmlboard.handlersml.UploadData.current_user>`          | The authenticated user for this request. This is set in one of two ways:                                             |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`current_user <lightmlboard.handlersml._BaseRequestHandler.current_user>` | The authenticated user for this request. This is set in one of two ways:                                             |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`current_user <lightmlboard.handlersml._TemplateHandler.current_user>`    | The authenticated user for this request. This is set in one of two ways:                                             |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`locale <lightmlboard.handlersml.CompetitionHandler.locale>`              | The locale for the current session. Determined by either `get_user_locale`, which you can override to set ...        |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`locale <lightmlboard.handlersml.LoginHandler.locale>`                    | The locale for the current session. Determined by either `get_user_locale`, which you can override to set ...        |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`locale <lightmlboard.handlersml.LogoutHandler.locale>`                   | The locale for the current session. Determined by either `get_user_locale`, which you can override to set ...        |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`locale <lightmlboard.handlersml.MainHandler.locale>`                     | The locale for the current session. Determined by either `get_user_locale`, which you can override to set ...        |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`locale <lightmlboard.handlersml.SubmitForm.locale>`                      | The locale for the current session. Determined by either `get_user_locale`, which you can override to set ...        |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`locale <lightmlboard.handlersml.UploadData.locale>`                      | The locale for the current session. Determined by either `get_user_locale`, which you can override to set ...        |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`locale <lightmlboard.handlersml._BaseRequestHandler.locale>`             | The locale for the current session. Determined by either `get_user_locale`, which you can override to set ...        |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`locale <lightmlboard.handlersml._TemplateHandler.locale>`                | The locale for the current session. Determined by either `get_user_locale`, which you can override to set ...        |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`settings <lightmlboard.handlersml.CompetitionHandler.settings>`          | An alias for `self.application.settings <Application.settings>`.                                                     |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`settings <lightmlboard.handlersml.LoginHandler.settings>`                | An alias for `self.application.settings <Application.settings>`.                                                     |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`settings <lightmlboard.handlersml.LogoutHandler.settings>`               | An alias for `self.application.settings <Application.settings>`.                                                     |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`settings <lightmlboard.handlersml.MainHandler.settings>`                 | An alias for `self.application.settings <Application.settings>`.                                                     |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`settings <lightmlboard.handlersml.SubmitForm.settings>`                  | An alias for `self.application.settings <Application.settings>`.                                                     |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`settings <lightmlboard.handlersml.UploadData.settings>`                  | An alias for `self.application.settings <Application.settings>`.                                                     |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`settings <lightmlboard.handlersml._BaseRequestHandler.settings>`         | An alias for `self.application.settings <Application.settings>`.                                                     |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`settings <lightmlboard.handlersml._TemplateHandler.settings>`            | An alias for `self.application.settings <Application.settings>`.                                                     |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`xsrf_token <lightmlboard.handlersml.CompetitionHandler.xsrf_token>`      | The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' ... |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`xsrf_token <lightmlboard.handlersml.LoginHandler.xsrf_token>`            | The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' ... |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`xsrf_token <lightmlboard.handlersml.LogoutHandler.xsrf_token>`           | The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' ... |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`xsrf_token <lightmlboard.handlersml.MainHandler.xsrf_token>`             | The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' ... |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`xsrf_token <lightmlboard.handlersml.SubmitForm.xsrf_token>`              | The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' ... |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`xsrf_token <lightmlboard.handlersml.UploadData.xsrf_token>`              | The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' ... |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`xsrf_token <lightmlboard.handlersml._BaseRequestHandler.xsrf_token>`     | The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' ... |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`xsrf_token <lightmlboard.handlersml._TemplateHandler.xsrf_token>`        | The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' ... |
+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+




Static Methods
++++++++++++++

+----------------------------------------------------------+-------------------------+
| staticmethod                                             | truncated documentation |
+==========================================================+=========================+
| :meth:`get <lightmlboard.handlersml.LoginHandler.get>`   | Page.                   |
+----------------------------------------------------------+-------------------------+
| :meth:`post <lightmlboard.handlersml.LoginHandler.post>` | post                    |
+----------------------------------------------------------+-------------------------+
| :meth:`post <lightmlboard.handlersml.UploadData.post>`   | post                    |
+----------------------------------------------------------+-------------------------+




Methods
+++++++

+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| method                                                                                  | truncated documentation                                                                        |
+=========================================================================================+================================================================================================+
| :py:meth:`__init__ <lightmlboard.handlersml.CompetitionHandler.__init__>`               | Constructor.                                                                                   |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <lightmlboard.handlersml.LoginHandler.__init__>`                     | Expected additional parameters:                                                                |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <lightmlboard.handlersml.LogoutHandler.__init__>`                    | Expected additional parameters:                                                                |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <lightmlboard.handlersml.MainHandler.__init__>`                      | Constructor.                                                                                   |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <lightmlboard.handlersml.SubmitForm.__init__>`                       | Constructor.                                                                                   |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <lightmlboard.handlersml.UploadData.__init__>`                       | Constructor.                                                                                   |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <lightmlboard.handlersml._BaseRequestHandler.__init__>`              | Constructor. See `web.py <https://github.com/tornadoweb/tornado/blob/master/tornado/web.py>`_. |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <lightmlboard.handlersml._TemplateHandler.__init__>`                 | Constructor. See `web.py <https://github.com/tornadoweb/tornado/blob/master/tornado/web.py>`_. |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`_process_kwargs <lightmlboard.handlersml.CompetitionHandler._process_kwargs>` | Separates attributes templates / tornado.                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`_process_kwargs <lightmlboard.handlersml.LoginHandler._process_kwargs>`       | Separates attributes templates / tornado.                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`_process_kwargs <lightmlboard.handlersml.LogoutHandler._process_kwargs>`      | Separates attributes templates / tornado.                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`_process_kwargs <lightmlboard.handlersml.MainHandler._process_kwargs>`        | Separates attributes templates / tornado.                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`_process_kwargs <lightmlboard.handlersml.SubmitForm._process_kwargs>`         | Separates attributes templates / tornado.                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`_process_kwargs <lightmlboard.handlersml.UploadData._process_kwargs>`         | Separates attributes templates / tornado.                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :py:meth:`_process_kwargs <lightmlboard.handlersml._TemplateHandler._process_kwargs>`   | Separates attributes templates / tornado.                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get <lightmlboard.handlersml.CompetitionHandler.get>`                            | Returns the content page.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get <lightmlboard.handlersml.LogoutHandler.get>`                                 | Page.                                                                                          |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get <lightmlboard.handlersml.MainHandler.get>`                                   | Returns the content page.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get <lightmlboard.handlersml.SubmitForm.get>`                                    | Returns the content page.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get <lightmlboard.handlersml.UploadData.get>`                                    | Returns the content page.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get <lightmlboard.handlersml._TemplateHandler.get>`                              | Returns the content page.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get_current_user <lightmlboard.handlersml.CompetitionHandler.get_current_user>`  | Returns the current user.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get_current_user <lightmlboard.handlersml.LoginHandler.get_current_user>`        | Returns the current user.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get_current_user <lightmlboard.handlersml.LogoutHandler.get_current_user>`       | Returns the current user.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get_current_user <lightmlboard.handlersml.MainHandler.get_current_user>`         | Returns the current user.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get_current_user <lightmlboard.handlersml.SubmitForm.get_current_user>`          | Returns the current user.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get_current_user <lightmlboard.handlersml.UploadData.get_current_user>`          | Returns the current user.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get_current_user <lightmlboard.handlersml._BaseRequestHandler.get_current_user>` | Returns the current user.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`get_current_user <lightmlboard.handlersml._TemplateHandler.get_current_user>`    | Returns the current user.                                                                      |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`info <lightmlboard.handlersml.CompetitionHandler.info>`                          | Log information.                                                                               |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`info <lightmlboard.handlersml.LoginHandler.info>`                                | Log information.                                                                               |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`info <lightmlboard.handlersml.LogoutHandler.info>`                               | Log information.                                                                               |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`info <lightmlboard.handlersml.MainHandler.info>`                                 | Log information.                                                                               |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`info <lightmlboard.handlersml.SubmitForm.info>`                                  | Log information.                                                                               |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`info <lightmlboard.handlersml.UploadData.info>`                                  | Log information.                                                                               |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`info <lightmlboard.handlersml._BaseRequestHandler.info>`                         | Log information.                                                                               |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`info <lightmlboard.handlersml._TemplateHandler.info>`                            | Log information.                                                                               |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :meth:`set_current_user <lightmlboard.handlersml.LoginHandler.set_current_user>`        | Sets the current user or clear the cookie if None.                                             |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+


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

.. automodule:: lightmlboard.handlersml
    :members:
    :special-members: __init__
    :show-inheritance: