pyrcf.core.logging
==================

.. py:module:: pyrcf.core.logging


Attributes
----------

.. autoapisummary::

   pyrcf.core.logging.throttled_logging


Classes
-------

.. autoapisummary::

   pyrcf.core.logging.ThrottledLogger


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

.. py:class:: ThrottledLogger(name: str, rate: float, level: int | str = logging.INFO)

   Bases: :py:obj:`logging.Logger`


   Log data intermittently at specified frequency.


   .. py:attribute:: _handler


   .. py:attribute:: __period


   .. py:attribute:: __next_tick


   .. py:method:: log(level, msg, *args, **kwargs)

      Log 'msg % args' with the integer severity 'level'.

      To pass exception information, use the keyword argument exc_info with
      a true value, e.g.

      logger.log(level, "We have a %s", "mysterious problem", exc_info=True)



.. py:data:: throttled_logging

   Log data intermittently once every t seconds. Allows use directly as function call using
   `throttled_logging.<logtype>("message", delay_time_in_sec)`