:py:mod:`acquire.acquire.log`
=============================

.. py:module:: acquire.acquire.log




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

Classes
~~~~~~~

.. autoapisummary::

   acquire.acquire.log.DelayedFileHandler



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   acquire.acquire.log.setup_logging
   acquire.acquire.log.reconfigure_log_file
   acquire.acquire.log.new_file_handler
   acquire.acquire.log.get_file_handler



Attributes
~~~~~~~~~~

.. autoapisummary::

   acquire.acquire.log.log
   acquire.acquire.log.STREAM_FORMATTER
   acquire.acquire.log.FILE_FORMATTER


.. py:data:: log

.. py:data:: STREAM_FORMATTER

.. py:data:: FILE_FORMATTER

.. py:class:: DelayedFileHandler(filename: str, *args, **kwargs)

   Bases: :py:obj:`logging.FileHandler`


   A handler class which writes formatted logging records to disk files.


   .. py:attribute:: opened
      :value: False



   .. py:method:: set_filename(filename: str) -> None


   .. py:method:: set_stream(stream: BinaryIO) -> None


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


   .. py:method:: emit(record: logging.LogRecord) -> None

      Emit a record.

      If the stream was not opened because 'delay' was specified in the
      constructor, open it before calling the superclass's emit.

      If stream is not open, current mode is 'w' and `_closed=True`, record
      will not be emitted (see Issue #42378).



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

      Closes the stream.



.. py:function:: setup_logging(logger: logging.Logger, path: str, verbosity: int, delay: bool = False) -> None

.. py:function:: reconfigure_log_file(logger: logging.Logger, path: str, delay: bool = False) -> None

.. py:function:: new_file_handler(path: str, delay: bool = False) -> DelayedFileHandler | logging.FileHandler

.. py:function:: get_file_handler(logger: logging.Logger) -> logging.FileHandler | None