:py:mod:`km3flux.logger`
========================

.. py:module:: km3flux.logger

.. autoapi-nested-parse::

   
   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   km3flux.logger.supports_color
   km3flux.logger.colored
   km3flux.logger.hash_coloured_escapes
   km3flux.logger.isnotebook
   km3flux.logger.get_logger
   km3flux.logger.set_level



Attributes
~~~~~~~~~~

.. autoapisummary::

   km3flux.logger.loggers
   km3flux.logger.ATTRIBUTES
   km3flux.logger.ATTRIBUTES_RE
   km3flux.logger.HIGHLIGHTS
   km3flux.logger.HIGHLIGHTS_RE
   km3flux.logger.COLORS
   km3flux.logger.COLORS_RE
   km3flux.logger.RESET
   km3flux.logger.RESET_RE
   km3flux.logger.log


.. py:data:: loggers
   

   
















   ..
       !! processed by numpydoc !!

.. py:data:: ATTRIBUTES
   

   
















   ..
       !! processed by numpydoc !!

.. py:data:: ATTRIBUTES_RE
   

   
















   ..
       !! processed by numpydoc !!

.. py:data:: HIGHLIGHTS
   

   
















   ..
       !! processed by numpydoc !!

.. py:data:: HIGHLIGHTS_RE
   

   
















   ..
       !! processed by numpydoc !!

.. py:data:: COLORS
   

   
















   ..
       !! processed by numpydoc !!

.. py:data:: COLORS_RE
   

   
















   ..
       !! processed by numpydoc !!

.. py:data:: RESET
   :annotation: = \033[0m

   
















   ..
       !! processed by numpydoc !!

.. py:data:: RESET_RE
   :annotation: = \033\[0m

   
















   ..
       !! processed by numpydoc !!

.. py:function:: supports_color()

   
   Checks if the terminal supports color.
















   ..
       !! processed by numpydoc !!

.. py:function:: colored(text, color=None, on_color=None, attrs=None, ansi_code=None)

   
   Colorize text, while stripping nested ANSI color sequences.

   Author:  Konstantin Lepa <konstantin.lepa@gmail.com> / termcolor

   Available text colors:
       red, green, yellow, blue, magenta, cyan, white.
   Available text highlights:
       on_red, on_green, on_yellow, on_blue, on_magenta, on_cyan, on_white.
   Available attributes:
       bold, dark, underline, blink, reverse, concealed.
   Example:
       colored('Hello, World!', 'red', 'on_grey', ['blue', 'blink'])
       colored('Hello, World!', 'green')















   ..
       !! processed by numpydoc !!

.. py:function:: hash_coloured_escapes(text)

   
   Return the ANSI hash colour prefix and suffix for a given text
















   ..
       !! processed by numpydoc !!

.. py:function:: isnotebook()

   
   Check if running within a Jupyter notebook
















   ..
       !! processed by numpydoc !!

.. py:function:: get_logger(name, filename=None, stream_loglevel='INFO', file_loglevel='DEBUG')

   
   Helper function to get a logger
















   ..
       !! processed by numpydoc !!

.. py:function:: set_level(log_or_name, level)

   
   Set the log level for given logger
















   ..
       !! processed by numpydoc !!

.. py:data:: log
   

   
















   ..
       !! processed by numpydoc !!