:py:mod:`bhepop2.utils`
=======================

.. py:module:: bhepop2.utils

.. autoapi-nested-parse::

   Utility classes, functions and constants.



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

Classes
~~~~~~~

.. autoapisummary::

   bhepop2.utils.Bhepop2Logger



Functions
~~~~~~~~~

.. autoapisummary::

   bhepop2.utils.log
   bhepop2.utils._get_logger



Attributes
~~~~~~~~~~

.. autoapisummary::

   bhepop2.utils.logger_level
   bhepop2.utils.logger_name


.. py:exception:: PopulationValidationError


   Bases: :py:obj:`Exception`

   Raised when a population fails validation.


.. py:exception:: SourceValidationError


   Bases: :py:obj:`Exception`

   Raised when an enrichment source fails validation.


.. py:data:: logger_level

   

.. py:data:: logger_name
   :value: 'bhepop2_logger'

   

.. py:class:: Bhepop2Logger(default_log_level=lg.DEBUG)


   Logging helper class for Bhepop2.

   See logging library for more information.

   .. py:method:: log(message: str, level: int = None)

      Log a message using the package logger.

      :param message: message to be logged
      :param level: logging level



.. py:function:: log(message, level)

   Log a message using the logging library.

   :param message: message to log
   :param level: logging level


.. py:function:: _get_logger()

   Create a logger or return the current one if already instantiated.

   :return: logging.logger