:py:mod:`leads.logger`
======================

.. py:module:: leads.logger

.. autodoc2-docstring:: leads.logger
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`Level <leads.logger.Level>`
     -
   * - :py:obj:`Logger <leads.logger.Logger>`
     - .. autodoc2-docstring:: leads.logger.Logger
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`_on_register_config <leads.logger._on_register_config>`
     - .. autodoc2-docstring:: leads.logger._on_register_config
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`L <leads.logger.L>`
     - .. autodoc2-docstring:: leads.logger.L
          :summary:

API
~~~

.. py:class:: Level()
   :canonical: leads.logger.Level

   Bases: :py:obj:`enum.IntEnum`

   .. py:attribute:: DEBUG
      :canonical: leads.logger.Level.DEBUG
      :type: int
      :value: 0

      .. autodoc2-docstring:: leads.logger.Level.DEBUG

   .. py:attribute:: INFO
      :canonical: leads.logger.Level.INFO
      :type: int
      :value: 1

      .. autodoc2-docstring:: leads.logger.Level.INFO

   .. py:attribute:: WARN
      :canonical: leads.logger.Level.WARN
      :type: int
      :value: 2

      .. autodoc2-docstring:: leads.logger.Level.WARN

   .. py:attribute:: ERROR
      :canonical: leads.logger.Level.ERROR
      :type: int
      :value: 3

      .. autodoc2-docstring:: leads.logger.Level.ERROR

.. py:class:: Logger()
   :canonical: leads.logger.Logger

   Bases: :py:obj:`object`

   .. autodoc2-docstring:: leads.logger.Logger

   .. rubric:: Initialization

   .. autodoc2-docstring:: leads.logger.Logger.__init__

   .. py:attribute:: REGULAR
      :canonical: leads.logger.Logger.REGULAR
      :type: int
      :value: 0

      .. autodoc2-docstring:: leads.logger.Logger.REGULAR

   .. py:attribute:: BOLD
      :canonical: leads.logger.Logger.BOLD
      :type: int
      :value: 1

      .. autodoc2-docstring:: leads.logger.Logger.BOLD

   .. py:attribute:: ITALIC
      :canonical: leads.logger.Logger.ITALIC
      :type: int
      :value: 3

      .. autodoc2-docstring:: leads.logger.Logger.ITALIC

   .. py:attribute:: UNDERLINED
      :canonical: leads.logger.Logger.UNDERLINED
      :type: int
      :value: 4

      .. autodoc2-docstring:: leads.logger.Logger.UNDERLINED

   .. py:attribute:: INVERSE
      :canonical: leads.logger.Logger.INVERSE
      :type: int
      :value: 7

      .. autodoc2-docstring:: leads.logger.Logger.INVERSE

   .. py:attribute:: BLACK
      :canonical: leads.logger.Logger.BLACK
      :type: int
      :value: 30

      .. autodoc2-docstring:: leads.logger.Logger.BLACK

   .. py:attribute:: RED
      :canonical: leads.logger.Logger.RED
      :type: int
      :value: 31

      .. autodoc2-docstring:: leads.logger.Logger.RED

   .. py:attribute:: GREEN
      :canonical: leads.logger.Logger.GREEN
      :type: int
      :value: 32

      .. autodoc2-docstring:: leads.logger.Logger.GREEN

   .. py:attribute:: YELLOW
      :canonical: leads.logger.Logger.YELLOW
      :type: int
      :value: 33

      .. autodoc2-docstring:: leads.logger.Logger.YELLOW

   .. py:attribute:: BLUE
      :canonical: leads.logger.Logger.BLUE
      :type: int
      :value: 34

      .. autodoc2-docstring:: leads.logger.Logger.BLUE

   .. py:attribute:: PURPLE
      :canonical: leads.logger.Logger.PURPLE
      :type: int
      :value: 35

      .. autodoc2-docstring:: leads.logger.Logger.PURPLE

   .. py:attribute:: CYAN
      :canonical: leads.logger.Logger.CYAN
      :type: int
      :value: 36

      .. autodoc2-docstring:: leads.logger.Logger.CYAN

   .. py:attribute:: WHITE
      :canonical: leads.logger.Logger.WHITE
      :type: int
      :value: 37

      .. autodoc2-docstring:: leads.logger.Logger.WHITE

   .. py:method:: history_messages() -> tuple[str, ...]
      :canonical: leads.logger.Logger.history_messages

      .. autodoc2-docstring:: leads.logger.Logger.history_messages

   .. py:method:: debug_level(debug_level: leads.logger.Level | None = None) -> leads.logger.Level | None
      :canonical: leads.logger.Logger.debug_level

      .. autodoc2-docstring:: leads.logger.Logger.debug_level

   .. py:method:: mark(msg: str, level: leads.logger.Level) -> str
      :canonical: leads.logger.Logger.mark
      :staticmethod:

      .. autodoc2-docstring:: leads.logger.Logger.mark

   .. py:method:: format(msg: str, font: int, color: int | None, background: int | None) -> str
      :canonical: leads.logger.Logger.format

      .. autodoc2-docstring:: leads.logger.Logger.format

   .. py:method:: print(msg: str, level: int) -> None
      :canonical: leads.logger.Logger.print

      .. autodoc2-docstring:: leads.logger.Logger.print

   .. py:method:: info(*msg: str, sep: str = ' ', end: str = '\n', f: tuple[int, int | None, int | None] = (REGULAR, None, None)) -> None
      :canonical: leads.logger.Logger.info

      .. autodoc2-docstring:: leads.logger.Logger.info

   .. py:method:: debug(*msg: str, sep: str = ' ', end: str = '\n', f: tuple[int, int | None, int | None] = (REGULAR, YELLOW, None)) -> None
      :canonical: leads.logger.Logger.debug

      .. autodoc2-docstring:: leads.logger.Logger.debug

   .. py:method:: warn(*msg: str, sep: str = ' ', end: str = '\n', f: tuple[int, int | None, int | None] = (REGULAR, RED, None)) -> None
      :canonical: leads.logger.Logger.warn

      .. autodoc2-docstring:: leads.logger.Logger.warn

   .. py:method:: error(*msg: str, sep: str = ' ', end: str = '\n', f: tuple[int, int | None, int | None] = (REGULAR, RED, None)) -> None
      :canonical: leads.logger.Logger.error

      .. autodoc2-docstring:: leads.logger.Logger.error

.. py:data:: L
   :canonical: leads.logger.L
   :type: leads.logger.Logger
   :value: 'Logger(...)'

   .. autodoc2-docstring:: leads.logger.L

.. py:function:: _on_register_config(chain: leads.types.OnRegister[leads.config.ConfigTemplate]) -> leads.types.OnRegister[leads.config.ConfigTemplate]
   :canonical: leads.logger._on_register_config

   .. autodoc2-docstring:: leads.logger._on_register_config
