:py:mod:`ethos_penalps.utilities.logger_ethos_penalps`
======================================================

.. py:module:: ethos_penalps.utilities.logger_ethos_penalps


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

Classes
~~~~~~~

.. autoapisummary::

   ethos_penalps.utilities.logger_ethos_penalps.ContextFilter
   ethos_penalps.utilities.logger_ethos_penalps.PeNALPSLogger




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


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

   This is a filter which injects contextual information into the log.

   .. py:method:: filter(record)

      Determine if the specified record is to be logged.

      Returns True if the record should be logged, or False otherwise.
      If deemed appropriate, the record may be modified in-place.



.. py:class:: PeNALPSLogger


   .. py:attribute:: logger_name
      :value: 'ethos_penalps'

      

   .. py:attribute:: table_delimiter
      :value: 'DELIMITER'

      

   .. py:attribute:: prepend_loop_counter
      :value: True

      

   .. py:attribute:: has_been_called
      :type: bool
      :value: False

      

   .. py:attribute:: logger

      

   .. py:method:: initialize_logger()


   .. py:method:: get_logger_without_handler() -> logging.Logger


   .. py:method:: get_human_readable_logger() -> logging.Logger


   .. py:method:: get_logger_to_create_table() -> logging.Logger


   .. py:method:: read_log_to_data_frame() -> pandas.DataFrame