spinifex.logger
===============

.. py:module:: spinifex.logger

.. autoapi-nested-parse::

   Logging utilities for spinifex.



Attributes
----------

.. autoapisummary::

   spinifex.logger.ch
   spinifex.logger.formatter
   spinifex.logger.logger


Classes
-------

.. autoapisummary::

   spinifex.logger.TqdmToLogger


Functions
---------

.. autoapisummary::

   spinifex.logger.set_verbosity


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

.. py:class:: TqdmToLogger(logger: logging.Logger | None, level: int | None = None)

   Bases: :py:obj:`io.StringIO`


   Output stream for TQDM which will output to logger module instead of
   the StdOut.


   .. py:method:: flush() -> None

      Flush write buffers, if applicable.

      This is not implemented for read-only and non-blocking streams.



   .. py:method:: write(buf: str) -> int

      Write string to file.

      Returns the number of characters written, which is always equal to
      the length of the string.



   .. py:attribute:: buf
      :value: ''



   .. py:attribute:: level
      :value: None



   .. py:attribute:: logger
      :value: None



.. py:function:: set_verbosity(verbosity: int) -> None

   Set the logger verbosity.

   Parameters
   ----------
   verbosity : int
       Verbosity level


.. py:data:: ch

.. py:data:: formatter

.. py:data:: logger