nmk.logs
========

.. py:module:: nmk.logs


Attributes
----------

.. autoapisummary::

   nmk.logs.LOG_FORMAT
   nmk.logs.LOG_FORMAT_DEBUG
   nmk.logs.NmkLogger


Classes
-------

.. autoapisummary::

   nmk.logs.NmkLogWrapper


Functions
---------

.. autoapisummary::

   nmk.logs.logging_initial_setup
   nmk.logs.logging_finalize_setup


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

.. py:data:: LOG_FORMAT
   :value: '%(asctime)s (%(levelname).1s) %(prefix)s%(name)s %(message)s'


   Displayed logs format


.. py:data:: LOG_FORMAT_DEBUG
   :value: '%(asctime)s.%(msecs)03d (%(levelname).1s) %(prefix)s%(name)s %(message)s -...


   File logs format


.. py:class:: NmkLogWrapper(logger: logging.Logger)

   Wrapped logger, handling logs with emojis!

   :param logger: logger instance to be wrapped


   .. py:method:: log(level: int, emoji: str, line: str)

      Log provided message string + emoji, on required level

      :param level: log level
      :param emoji: emoji code or format string
      :param line: message string to be logged



   .. py:method:: info(emoji: str, line: str)

      Log provided message string + emoji, on INFO level

      :param emoji: emoji code or format string
      :param line: message string to be logged



   .. py:method:: debug(line: str)

      Log provided message string (with default emoji), on DEBUG level

      :param line: message string to be logged



   .. py:method:: error(line: str)

      Log provided message string (with default emoji), on ERROR level

      :param line: message string to be logged



   .. py:method:: warning(line: str)

      Log provided message string (with default emoji), on WARNING level

      :param line: message string to be logged



.. py:data:: NmkLogger

   Root logger instance


.. py:function:: logging_initial_setup(args: argparse.Namespace) -> Union[logging.handlers.MemoryHandler, None]

   Logging setup for nmk

   :param args: parsed args from the command line
   :return: memory handler used for logging, or None if no logs are enabled


.. py:function:: logging_finalize_setup(log_file_str: str, model_paths_keywords: dict[str, str], memory_handler: Union[logging.handlers.MemoryHandler, None])

   Finalize logs setup, once nmk project folder has been setup

   :param log_file_str: log file path pattern (from command line args)
   :param model_paths_keywords: keywords to be used in the log file path pattern (computed from nmk model)
   :param memory_handler: memory handler used for logging, or None if no logs are enabled