timor.utilities.logging
=======================

.. py:module:: timor.utilities.logging


Attributes
----------

.. autoapisummary::

   timor.utilities.logging.CRITICAL
   timor.utilities.logging.DEBUG
   timor.utilities.logging.ERROR
   timor.utilities.logging.INFO
   timor.utilities.logging.NOTSET
   timor.utilities.logging.VERBOSE_DEBUG
   timor.utilities.logging.WARNING


Functions
---------

.. autoapisummary::

   timor.utilities.logging.basicConfig
   timor.utilities.logging.critical
   timor.utilities.logging.debug
   timor.utilities.logging.error
   timor.utilities.logging.flush
   timor.utilities.logging.getEffectiveLevel
   timor.utilities.logging.getLogger
   timor.utilities.logging.info
   timor.utilities.logging.setLevel
   timor.utilities.logging.verbose_debug
   timor.utilities.logging.warn
   timor.utilities.logging.warning


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

.. py:data:: CRITICAL
   :value: 50


.. py:data:: DEBUG
   :value: 10


.. py:data:: ERROR
   :value: 40


.. py:data:: INFO
   :value: 20


.. py:data:: NOTSET
   :value: 0


.. py:data:: VERBOSE_DEBUG
   :value: 5


.. py:data:: WARNING
   :value: 30


.. py:function:: basicConfig(filename = None, filemode = 'w', output_format = '%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s', datefmt = '%Y-%m-%d %H:%M:%S', level = INFO)

   Set logging configurations for the runtime environment

   :param filename: Name to store logs to
   :param filemode: Mode (append ('a'), overwrite ('w'), ...)
   :param output_format: Format string for log
   :param datefmt: Specify time in logs
   :param level: Logging level for the logger (use logging.DEBUG, WARN, ...)


.. py:function:: critical(msg, *args, **kwargs)

   Log a message with severity 'CRITICAL'.


.. py:function:: debug(msg, *args, **kwargs)

   Log a message with severity 'DEBUG'.


.. py:function:: error(msg, *args, **kwargs)

   Log a message with severity 'ERROR'.


.. py:function:: flush()

   Tell logger to empty output buffers.


.. py:function:: getEffectiveLevel()

   Return the level the logger is set at.


.. py:function:: getLogger()

   Get the custom logger.


.. py:function:: info(msg, *args, **kwargs)

   Log a message with severity 'INFO'.


.. py:function:: setLevel(level)

   Set the logger level.


.. py:function:: verbose_debug(msg, *args, **kwargs)

   Log a message with severity 'VERBOSE_DEBUG', i.e., very low.


.. py:function:: warn(msg, *args, **kwargs)

   Deprecated name for warning.


.. py:function:: warning(msg, *args, **kwargs)

   Log a message with severity 'WARNING'.