nessai.utils.logging
====================

.. py:module:: nessai.utils.logging

.. autoapi-nested-parse::

   Utilities related to logging.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   nessai.utils.logging.configure_logger
   nessai.utils.logging.setup_logger


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

.. py:function:: configure_logger(output=None, label='nessai', log_level='INFO', filehandler_kwargs=None, include_logger_name=False, stream=None)

   
   Configure the logger.

   Based on the implementation in Bilby:
   https://github.com/bilby-dev/bilby/blob/main/bilby/core/utils/log.py

   .. versionchanged:: 0.14.0
       Renamed :code:`setup_logger` to :code:`configure_logger`.

   .. versionadded:: 0.14.0
       Added :code:`include_logger_name` argument.

   :Parameters:

       **output** : str, optional
           Path of to output directory.

       **label** : str, optional
           Label for this instance of the logger.

       **log_level** : {'ERROR', 'WARNING', 'INFO', 'DEBUG'}, optional
           Level of logging passed to logger.

       **filehandler_kwargs** : dict, optional
           Keyword arguments for configuring the FileHandler. See logging
           documentation for details.

       **include_logger_name** : bool, optional
           If true, include the logger name in the log output. If false, only
           the name will be replaced with 'nessai'.

       **stream** : str, file-object, optional
           Stream passes to :code:`logging.StreamHandler` to set the stream. See
           logging documentation for more details.



   :Returns:

       :obj:`logging.Logger`
           Instance of the Logger class.











   ..
       !! processed by numpydoc !!

.. py:function:: setup_logger(*args, **kwargs)

   
   Wrapper for configure_logger to maintain backwards compatibility.

   .. deprecated:: 0.14.0
       Use :func:`configure_logger` instead.















   ..
       !! processed by numpydoc !!