:py:mod:`adi_py.logger`
===============================

.. py:module:: adi_py.logger

.. autoapi-nested-parse::

   
   This module contains the **ADILogger** class which provides a python-like
   logging API facade around the dsproc logging methods.





Classes
~~~~~~~

.. autoapisummary::

   adi_py.logger.ADILogger
   adi_py.logger.LogLevel





.. py:class:: ADILogger

   
   This class provides python-like logging API facade around the dsproc
   logging methods.





   .. rst-class:: section-separator

   Class Methods

   .. autoapisummary::
      :nosignatures:

       adi_py.logger.ADILogger.debug
       adi_py.logger.ADILogger.error
       adi_py.logger.ADILogger.exception
       adi_py.logger.ADILogger.info
       adi_py.logger.ADILogger.warning


   .. rst-class:: section-separator

   Method Descriptions

   .. py:method:: debug(message, debug_level=1)
       :staticmethod:


   .. py:method:: error(message)
       :staticmethod:


   .. py:method:: exception(message)
       :staticmethod:

       
       Use this method to log the stack trace of any raised exception to the process's
       ADI log file.

       :param - message: str
                         An optional additional message to log, in addition to the stack trace.




   .. py:method:: info(message)
       :staticmethod:


   .. py:method:: warning(message)
       :staticmethod:




.. py:class:: LogLevel

   Bases: :py:obj:`enum.Enum`

   Generic enumeration.

   Derive from this class to define new enumerations.



   .. py:attribute:: DEBUG
      :annotation: = debug

      

   .. py:attribute:: ERROR
      :annotation: = error

      

   .. py:attribute:: INFO
      :annotation: = info

      

   .. py:attribute:: WARNING
      :annotation: = warning

      



   .. autoapisummary::
      :nosignatures: