ds_stoa.utils.logger._logger
============================

.. py:module:: ds_stoa.utils.logger._logger

.. autoapi-nested-parse::

   DS-Stoa Logger.



Classes
-------

.. autoapisummary::

   ds_stoa.utils.logger._logger.ContextFilter
   ds_stoa.utils.logger._logger.FolderNameFilter
   ds_stoa.utils.logger._logger.StoaLogger


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

.. py:class:: ContextFilter(prefix: Optional[str] = None)

   Bases: :py:obj:`logging.Filter`


   Context filter to add customized field in the logging
   record. This filter is used to add a prefix to the log.


   .. py:method:: filter(record) -> Literal[True]

      Add prefix to the log record.

      :param record: The log record.
      :return: True



.. py:class:: FolderNameFilter(name='')

   Bases: :py:obj:`logging.Filter`


   Filter instances are used to perform arbitrary filtering of LogRecords.

   Loggers and Handlers can optionally use Filter instances to filter
   records as desired. The base filter class only allows events which are
   below a certain point in the logger hierarchy. For example, a filter
   initialized with "A.B" will allow events logged by loggers "A.B",
   "A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB", "B.A.B" etc. If
   initialized with the empty string, all events are passed.


   .. py:method:: filter(record) -> Literal[True]

      Add the folder name to the log record.

      :param record: The log record.
      :return: True



.. py:class:: StoaLogger(log_level=logging.DEBUG)

   Setup logger for ds-stoa package.

   Usage:
   from ds_stoa.utils import LOGGER
   LOGGER.info("This is an info message.")
   LOGGER.warning("This is a warning message.")
   LOGGER.error("This is an error message.")
   LOGGER.debug("This is a debug message.")


   .. py:attribute:: LOGGER


   .. py:attribute:: FORMATER


   .. py:method:: setup_logger(prefix: str, with_file: bool = True) -> None

      Instantiates logger with a handler and a log message prefix.

      :param prefix: Prefix in log message.
      :param with_file: Indicates if logger should also write to file.
      :return: None



   .. py:method:: info(msg: str) -> None

      Log an info level message.

      :param msg: The message to log.
      :return: None



   .. py:method:: warning(msg: str) -> None

      Log a warning level message.

      :param msg: The message to log.
      :return: None



   .. py:method:: error(msg: str) -> None

      Log an error level message.

      :param msg: The message to log.
      :return: None



   .. py:method:: debug(msg: str) -> None

      Log a debug level message.

      :param msg: The message to log.
      :return: None



   .. py:method:: shutdown() -> None
      :staticmethod:


      Shutdown the logger by removing all handlers.
      :return: None



   .. py:method:: _setup_file_handler(log_file: str, prefix: str) -> logging.FileHandler

      Set up file handler for logger with logging prefix.

      :param log_file: The file to log to.
      :param prefix: The prefix for the log messages.
      :return: The file handler.



   .. py:method:: _setup_stream_handler(prefix: Optional[str] = None) -> logging.StreamHandler

      Sets up stream handler for logger with logging prefix.

      :param prefix: Prefix applied on every log to add context: Who!
      :return: The stream handler.