epicsarchiver_mgmt.logging
==========================

.. py:module:: epicsarchiver_mgmt.logging

.. autoapi-nested-parse::

   Sets up logging for the application.



Attributes
----------

.. autoapisummary::

   epicsarchiver_mgmt.logging.HOME_LOG
   epicsarchiver_mgmt.logging.HOME_LOG_LOCATION
   epicsarchiver_mgmt.logging.LOG
   epicsarchiver_mgmt.logging.formatter
   epicsarchiver_mgmt.logging.timed_rotating_file_handler
   epicsarchiver_mgmt.logging.root
   epicsarchiver_mgmt.logging.rich_handler


Functions
---------

.. autoapisummary::

   epicsarchiver_mgmt.logging.log_location
   epicsarchiver_mgmt.logging.setup_file_handler


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

.. py:data:: HOME_LOG

.. py:data:: HOME_LOG_LOCATION

.. py:data:: LOG
   :type:  logging.Logger

.. py:function:: log_location(command_path: str) -> pathlib.Path

   Get the location of the log file.

   :param command_path: The full path of the command.
   :type command_path: str

   :returns: The location of the log file.
   :rtype: Path


.. py:function:: setup_file_handler(command_path: str) -> logging.Handler

   Set up file logging for the command.

   :param command_path: The full path of the command.
   :type command_path: str

   :returns: The file handler for the command.
   :rtype: logging.Handler


.. py:data:: formatter

.. py:data:: timed_rotating_file_handler

.. py:data:: root

.. py:data:: rich_handler