.. _f-baselogging:

module ``mlapp.base_logging``
=============================





.. inheritance-diagram:: lightmlrestapi.mlapp.base_logging


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

module ``lightmlrestapi.mlapp.base_logging``

Machine Learning Post request


:githublink:`%|py|5`




Classes
+++++++

+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| class                                                                | truncated documentation                                                                      |
+======================================================================+==============================================================================================+
| :class:`BaseLogging <lightmlrestapi.mlapp.base_logging.BaseLogging>` | Simplifies logging. Logging is encrypted with module :epkg:`pyjwt` if *secret* is specified. |
+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| function                                                                                | truncated documentation                                              |
+=========================================================================================+======================================================================+
| :func:`enumerate_parsed_logs <lightmlrestapi.mlapp.base_logging.enumerate_parsed_logs>` | Goes through a list of logged files, reads and decrypts the content. |
+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------+








Methods
+++++++

+----------------------------------------------------------------------------------------+------------------------------------------------------+
| method                                                                                 | truncated documentation                              |
+========================================================================================+======================================================+
| :py:meth:`__init__ <lightmlrestapi.mlapp.base_logging.BaseLogging.__init__>`           |                                                      |
+----------------------------------------------------------------------------------------+------------------------------------------------------+
| :py:meth:`_logerrorinfo <lightmlrestapi.mlapp.base_logging.BaseLogging._logerrorinfo>` | Logs any king of data into the logs.                 |
+----------------------------------------------------------------------------------------+------------------------------------------------------+
| :meth:`duration <lightmlrestapi.mlapp.base_logging.BaseLogging.duration>`              | Get the duration since :meth:`save_time` was called. |
+----------------------------------------------------------------------------------------+------------------------------------------------------+
| :meth:`error <lightmlrestapi.mlapp.base_logging.BaseLogging.error>`                    | Logs any king of data into the logs.                 |
+----------------------------------------------------------------------------------------+------------------------------------------------------+
| :meth:`info <lightmlrestapi.mlapp.base_logging.BaseLogging.info>`                      | Logs any king of data into the logs.                 |
+----------------------------------------------------------------------------------------+------------------------------------------------------+
| :meth:`save_time <lightmlrestapi.mlapp.base_logging.BaseLogging.save_time>`            | Saves the times to get a duration later.             |
+----------------------------------------------------------------------------------------+------------------------------------------------------+


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

.. automodule:: lightmlrestapi.mlapp.base_logging
    :members:
    :special-members: __init__
    :show-inheritance: