:py:mod:`secop_ophyd.logs`
==========================

.. py:module:: secop_ophyd.logs

.. autodoc2-docstring:: secop_ophyd.logs
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`setup_logging <secop_ophyd.logs.setup_logging>`
     - .. autodoc2-docstring:: secop_ophyd.logs.setup_logging
          :summary:
   * - :py:obj:`get_logger <secop_ophyd.logs.get_logger>`
     - .. autodoc2-docstring:: secop_ophyd.logs.get_logger
          :summary:

Data
~~~~

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

   * - :py:obj:`DEFAULT_LOG_LEVEL <secop_ophyd.logs.DEFAULT_LOG_LEVEL>`
     - .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_LOG_LEVEL
          :summary:
   * - :py:obj:`DEFAULT_LOG_FORMAT <secop_ophyd.logs.DEFAULT_LOG_FORMAT>`
     - .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_LOG_FORMAT
          :summary:
   * - :py:obj:`DEFAULT_LOG_DIR <secop_ophyd.logs.DEFAULT_LOG_DIR>`
     - .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_LOG_DIR
          :summary:
   * - :py:obj:`DEFAULT_LOG_FILENAME <secop_ophyd.logs.DEFAULT_LOG_FILENAME>`
     - .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_LOG_FILENAME
          :summary:
   * - :py:obj:`DEFAULT_ROTATION_WHEN <secop_ophyd.logs.DEFAULT_ROTATION_WHEN>`
     - .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_ROTATION_WHEN
          :summary:
   * - :py:obj:`DEFAULT_ROTATION_INTERVAL <secop_ophyd.logs.DEFAULT_ROTATION_INTERVAL>`
     - .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_ROTATION_INTERVAL
          :summary:
   * - :py:obj:`DEFAULT_BACKUP_COUNT <secop_ophyd.logs.DEFAULT_BACKUP_COUNT>`
     - .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_BACKUP_COUNT
          :summary:
   * - :py:obj:`LOG_LEVELS <secop_ophyd.logs.LOG_LEVELS>`
     - .. autodoc2-docstring:: secop_ophyd.logs.LOG_LEVELS
          :summary:
   * - :py:obj:`log_file_handlers <secop_ophyd.logs.log_file_handlers>`
     - .. autodoc2-docstring:: secop_ophyd.logs.log_file_handlers
          :summary:
   * - :py:obj:`console_handler <secop_ophyd.logs.console_handler>`
     - .. autodoc2-docstring:: secop_ophyd.logs.console_handler
          :summary:

API
~~~

.. py:data:: DEFAULT_LOG_LEVEL
   :canonical: secop_ophyd.logs.DEFAULT_LOG_LEVEL
   :value: None

   .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_LOG_LEVEL

.. py:data:: DEFAULT_LOG_FORMAT
   :canonical: secop_ophyd.logs.DEFAULT_LOG_FORMAT
   :value: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'

   .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_LOG_FORMAT

.. py:data:: DEFAULT_LOG_DIR
   :canonical: secop_ophyd.logs.DEFAULT_LOG_DIR
   :value: '.secop-ophyd'

   .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_LOG_DIR

.. py:data:: DEFAULT_LOG_FILENAME
   :canonical: secop_ophyd.logs.DEFAULT_LOG_FILENAME
   :value: 'secop-ophyd.log'

   .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_LOG_FILENAME

.. py:data:: DEFAULT_ROTATION_WHEN
   :canonical: secop_ophyd.logs.DEFAULT_ROTATION_WHEN
   :value: 'H'

   .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_ROTATION_WHEN

.. py:data:: DEFAULT_ROTATION_INTERVAL
   :canonical: secop_ophyd.logs.DEFAULT_ROTATION_INTERVAL
   :value: 1

   .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_ROTATION_INTERVAL

.. py:data:: DEFAULT_BACKUP_COUNT
   :canonical: secop_ophyd.logs.DEFAULT_BACKUP_COUNT
   :value: 48

   .. autodoc2-docstring:: secop_ophyd.logs.DEFAULT_BACKUP_COUNT

.. py:data:: LOG_LEVELS
   :canonical: secop_ophyd.logs.LOG_LEVELS
   :value: None

   .. autodoc2-docstring:: secop_ophyd.logs.LOG_LEVELS

.. py:data:: log_file_handlers
   :canonical: secop_ophyd.logs.log_file_handlers
   :type: typing.Dict[str, logging.handlers.TimedRotatingFileHandler]
   :value: None

   .. autodoc2-docstring:: secop_ophyd.logs.log_file_handlers

.. py:data:: console_handler
   :canonical: secop_ophyd.logs.console_handler
   :type: logging.StreamHandler | None
   :value: None

   .. autodoc2-docstring:: secop_ophyd.logs.console_handler

.. py:function:: setup_logging(name: str = 'secop_ophyd', level: int = DEFAULT_LOG_LEVEL, log_dir: typing.Optional[str] = None) -> logging.Logger
   :canonical: secop_ophyd.logs.setup_logging

   .. autodoc2-docstring:: secop_ophyd.logs.setup_logging

.. py:function:: get_logger(name: str) -> logging.Logger
   :canonical: secop_ophyd.logs.get_logger

   .. autodoc2-docstring:: secop_ophyd.logs.get_logger