Metadata-Version: 2.4
Name: ka_uts_log
Version: 4.0.2.250519
Summary: Logging Utilities
Author-email: Bernd Stroehle <bernd.stroehle@gmail.com>
Maintainer-email: Bernd Stroehle <bernd.stroehle@gmail.com>
License-Expression: GPL-3.0-only WITH Classpath-exception-2.0 OR BSD-3-Clause
Project-URL: Source Code, https://github.com/bs291048/ka_uts_log/tree/master
Project-URL: Homepage, https://kosakya.de/
Project-URL: Documentation, https://ka-com.readthedocs.io/en/latest
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Natural Language :: English
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: ka_uts_uts>=4.0.2.250519
Requires-Dist: psutil>=7.0.0
Dynamic: license-file

##########
ka_uts_log
##########

Overview
********

.. start short_desc

**Log Management**

.. end short_desc

Installation
************

.. start installation

The package ``ka_uts_log`` can be installed from PyPI or Anaconda.

To install with ``pip``:

.. code-block:: shell

	$ python -m pip install ka_uts_log

To install with ``conda``:

.. code-block:: shell

	$ conda install -c conda-forge ka_uts_log

.. end installation

Package logging
***************

c.f.: **Appendix: Package Logging**

Package files
*************

Classification
==============

The Package ``ka_uts_log`` consist of the following file types (c.f.: **Appendix**):

#. **Special files:** (c.f.: **Appendix:** *Special python package files*)

#. **Dunder modules:** (c.f.: **Appendix:** *Special python package modules*)

#. **Modules**

   #. *log.py*

#. **Special Sub-directories:** (c.f.: **Appendix:** *Special python package Sub-directories*)

   #. **cfg**

      a. *__init__.py*
      #. *log.std.yml*
      #. *log.usr.yml*

Special Sub-directory: cfg
**************************

Overview
========

  .. Special-Sub-directory-cfg-Files-label:
  .. table:: *Special Sub directory cfg: Files*

   +-----------+-----------------------------------------+
   |Name       |Description                              |
   +===========+=========================================+
   |log.std.yml|Yaml definition file for standard logging|
   +-----------+-----------------------------------------+
   |log.usr.yml|Yaml definition file for user logging    |
   +-----------+-----------------------------------------+

Modules
*******

The Package ``ka_uts_log`` contains the following modules.

  .. ka_uts_log-Modules-label:
  .. table:: *ka_uts_log Modules*

   +------+-------------------------+
   |Name  |Decription               |
   +======+=========================+
   |log.py|Logging management module|
   +------+-------------------------+

ka_uts_log Module: log.py
=========================

The Module ``log.py`` contains the following static classes.

log.py Classes
---------------

  .. log.py-classes-label:
  .. table:: *log.py classes*

   +------+--------------------------------------------+
   |Name  |Description                                 |
   +======+============================================+
   |LogEq |Management of Log Equate message, generated |
   |      |from a key-, value-pair.                    |
   +------+--------------------------------------------+
   |LogDic|Management of Log Equate messages, generated|
   |      |from the key-, value-pairs of a dictionary. |
   +------+--------------------------------------------+
   |Log   |Management of Log messages                  |
   +------+--------------------------------------------+

log.py Class: Log
-----------------

The static Class ``Log`` contains the subsequent display- and management-methods.

Log Display Methods
^^^^^^^^^^^^^^^^^^^

  .. Log-Display-Methods-label:
  .. table:: *Log Display Methods*

   +--------+---------------------------------------------+
   |Name    |Description                                  |
   +========+=============================================+
   |debug   |Log debug message to debug destination.      |
   +--------+---------------------------------------------+
   |info    |Log info message to info destination.        |
   +--------+---------------------------------------------+
   |warning |Log warnning message to warning destination. |
   +--------+---------------------------------------------+
   |error   |Log error message to error destination.      |
   +--------+---------------------------------------------+
   |critcial|Log critical message to critical destination.|
   +--------+---------------------------------------------+

Log Management Methods
^^^^^^^^^^^^^^^^^^^^^^

  .. Log-Managment-Methods-label:
  .. table:: *Log Management Methods*

   +---------------+------------------------------------+
   |Name           |Description                         |
   +===============+====================================+
   |init           |initialise current class.           |
   +---------------+------------------------------------+
   |sh_calendar_ts |Show timestamp or datetime.         |
   +---------------+------------------------------------+
   |sh_dir_run     |Show run directory.                 |
   +---------------+------------------------------------+
   |sh_d_dir_run   |Show dictionary of run directories. |
   +---------------+------------------------------------+
   |sh_d_log_cfg   |Show log configuration directory.   |
   +---------------+------------------------------------+
   |sh_path_log_cfg|Show path of log configuration file.|
   +---------------+------------------------------------+
   |sh             |initialise and show current class.  |
   +---------------+------------------------------------+

Log Management Method: init
^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
Parameter
"""""""""

  .. Log-method-init-Parameter-label:
  .. table:: *Log method init: Parameter*

   +---------+-----+-----------------+
   |Name     |Type |Description      |
   +=========+=====+=================+
   |cls      |class|current class    |
   +---------+-----+-----------------+
   |\**kwargs|TyAny|keyword arguments|
   +---------+-----+-----------------+


log.py Class: LogEq
-------------------

The static Class ``LogEq`` of Module log.py contains the subsequent methods

LogEq Methods
^^^^^^^^^^^^^

  .. LogEq Methods-label:
  .. table:: *LogEq Methods*

   +--------+---------------------------------------------------------------------------+
   |Name    |Description                                                                |
   +========+===========================================================================+
   |debug   |Log generated equate message "<key> = <value>" to the debug destination.   |
   +--------+---------------------------------------------------------------------------+
   |info    |Log generated equate message "<key> = <value>" to the info destination.    |
   +--------+---------------------------------------------------------------------------+
   |warning |Log generated equate message "<key> = <value>" to the warning destination. |
   +--------+---------------------------------------------------------------------------+
   |error   |Log generated equate message "<key> = <value>" to the error destination.   |
   +--------+---------------------------------------------------------------------------+
   |critcial|Log generated equate message "<key> = <value>" to the critical destination.|
   +--------+---------------------------------------------------------------------------+

All Methods use the following Parameter:

LogEq Methods Parameter
^^^^^^^^^^^^^^^^^^^^^^^

  .. LogEq- Methods-parameter-label:
  .. table:: *LogEq Methods parameter*

   +-----+-----+-------------+
   |Name |Type |Description  |
   +=====+=====+=============+
   |cls  |class|current class|
   +-----+-----+-------------+
   |key  |TyAny|Key          |
   +-----+-----+-------------+
   |value|TyAny|Value        |
   +-----+-----+-------------+

log.py Class: LogDic
--------------------

The static Class ``LogDic`` of Module log.py contains the subsequent methods

LogDic Methods
^^^^^^^^^^^^^^

  .. LogDic-Methods-label:
  .. table:: *LogDic Methods*

   +--------+-------------------------------------------------------------------------------------+
   |Name    |Description                                                                          |
   +========+=====================================================================================+
   |debug   |Log generated equate messages for all dictionary entries to the debug destination.   |
   +--------+-------------------------------------------------------------------------------------+
   |info    |Log generated equate messages for all dictionary entries to the info destination.    |
   +--------+-------------------------------------------------------------------------------------+
   |warning |Log generated equate messages for all dictionary entries to the warning destination. |
   +--------+-------------------------------------------------------------------------------------+
   |error   |Log generated equate messages for all dictionary entries to the error destination.   |
   +--------+-------------------------------------------------------------------------------------+
   |critical|Log generated equate messages for all dictionary entries to the critical destination.|
   +--------+-------------------------------------------------------------------------------------+

All LogDic Methods use the following Parameters:

LogDic Methods Parameter
^^^^^^^^^^^^^^^^^^^^^^^^

  .. LogDic-Methods-Parameter-label:
  .. table:: *LogDic Methods Parameter*

   +----+-----+-------------+
   |Name|Type |Description  |
   +====+=====+=============+
   |cls |class|current class|
   +----+-----+-------------+
   |dic |TyDic|Dictionary   |
   +----+-----+-------------+

Appendix
********

Package Logging
===============

Description
-----------

The Standard or user specifig logging is carried out by the log.py module of the logging
package ka_uts_log using the configuration files **ka_std_log.yml** or **ka_usr_log.yml**
in the configuration directory **cfg** of the logging package **ka_uts_log**.
The Logging configuration of the logging package could be overriden by yaml files with
the same names in the configuration directory **cfg** of the application packages.

Log message types
-----------------

Logging defines log file path names for the following log message types: .

#. *debug*
#. *info*
#. *warning*
#. *error*
#. *critical*

Application parameter for logging
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  .. Application-parameter-used-in-log-naming-label:
  .. table:: *Application parameter used in log naming*

   +-----------------+--------------------------+-----------------+------------+
   |Name             |Decription                |Values           |Example     |
   |                 |                          +-----------------+            |
   |                 |                          |Value|Type       |            |
   +=================+==========================+=====+===========+============+
   |dir_dat          |Application data directory|     |Path       |/otev/data  |
   +-----------------+--------------------------+-----+-----------+------------+
   |tenant           |Application tenant name   |     |str        |UMH         |
   +-----------------+--------------------------+-----+-----------+------------+
   |package          |Application package name  |     |str        |otev_xls_srr|
   +-----------------+--------------------------+-----+-----------+------------+
   |cmd              |Application command       |     |str        |evupreg     |
   +-----------------+--------------------------+-----+-----------+------------+
   |pid              |Process ID                |     |str        |evupreg     |
   +-----------------+--------------------------+-----+-----------+------------+
   |log_ts_type      |Timestamp type used in    |ts   |Timestamp  |ts          |
   |                 |loggin files              +-----+-----------+------------+
   |                 |                          |dt   |Datetime   |            |
   +-----------------+--------------------------+-----+-----------+------------+
   |log_sw_single_dir|Enable single log         |True |Bool       |True        |
   |                 |directory or multiple     +-----+-----------+            |
   |                 |log directories           |False|Bool       |            |
   +-----------------+--------------------------+-----+-----------+------------+
   |log_sw_pid       |Enable display of pid     |True |Bool       |True        |
   |                 |in log file name          +-----+-----------+            |
   |                 |                          |False|Bool       |            |
   +-----------------+--------------------------+-----+-----------+------------+

Log type and Log directories
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Single or multiple Application log directories can be used for each message type:

  .. Log-types-and-Log-directories-label:
  .. table:: *Log types and directoriesg*

   +--------------+---------------+
   |Log type      |Log directory  |
   +--------+-----+--------+------+
   |long    |short|multiple|single|
   +========+=====+========+======+
   |debug   |dbqs |dbqs    |logs  |
   +--------+-----+--------+------+
   |info    |infs |infs    |logs  |
   +--------+-----+--------+------+
   |warning |wrns |wrns    |logs  |
   +--------+-----+--------+------+
   |error   |errs |errs    |logs  |
   +--------+-----+--------+------+
   |critical|crts |crts    |logs  |
   +--------+-----+--------+------+

Log files naming
^^^^^^^^^^^^^^^^

Conventions
"""""""""""

  .. Naming-conventions-for-logging-file-paths-label:
  .. table:: *Naming conventions for logging file paths*

   +--------+-------------------------------------------------------+-------------------------+
   |Type    |Directory                                              |File                     |
   +========+=======================================================+=========================+
   |debug   |/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+
   |info    |/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+
   |warning |/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+
   |error   |/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+
   |critical|/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+

Examples (with log_ts_type = 'ts')
""""""""""""""""""""""""""""""""""

The examples use the following parameter values.

#. dir_dat = '/data/otev'
#. tenant = 'UMH'
#. package = 'otev_srr'
#. cmd = 'evupreg'
#. log_sw_single_dir = True
#. log_sw_pid = True
#. log_ts_type = 'ts'

  .. Naming-examples-for-logging-file-paths-label:
  .. table:: *Naming examples for logging file paths*

   +--------+----------------------------------------+------------------------+
   |Type    |Directory                               |File                    |
   +========+========================================+========================+
   |debug   |/data/otev/umh/RUN/otev_srr/evupreg/logs|debs_1737118199_9470.log|
   +--------+----------------------------------------+------------------------+
   |info    |/data/otev/umh/RUN/otev_srr/evupreg/logs|infs_1737118199_9470.log|
   +--------+----------------------------------------+------------------------+
   |warning |/data/otev/umh/RUN/otev_srr/evupreg/logs|wrns_1737118199_9470.log|
   +--------+----------------------------------------+------------------------+
   |error   |/data/otev/umh/RUN/otev_srr/evupreg/logs|errs_1737118199_9470.log|
   +--------+----------------------------------------+------------------------+
   |critical|/data/otev/umh/RUN/otev_srr/evupreg/logs|crts_1737118199_9470.log|
   +--------+----------------------------------------+------------------------+

Python Terminology
==================

Python package
--------------

Overview
^^^^^^^^

  .. Python package-label:
  .. table:: *Python package*

   +-----------+-----------------------------------------------------------------+
   |Name       |Definition                                                       |
   +===========+==========+======================================================+
   |Python     |Python packages are directories that contains the special module |
   |package    |``__init__.py`` and other modules, packages files or directories.|
   +-----------+-----------------------------------------------------------------+
   |Python     |Python sub-packages are python packages which are contained in   |
   |sub-package|another pyhon package.                                           |
   +-----------+-----------------------------------------------------------------+

Python package sub-directories
------------------------------

Overview
^^^^^^^^

  .. Python package sub-direcories-label:
  .. table:: *Python package sub-directories*

   +---------------------+----------------------------------------+
   |Name                 |Definition                              |
   +=====================+========================================+
   |Python               |directory contained in a python package.|
   |package sub-directory|                                        |
   +---------------------+----------------------------------------+
   |Special python       |Python package sub-directories with a   |
   |package sub-directory|special meaning like data or cfg.       |
   +---------------------+----------------------------------------+

Special python package sub-directories
--------------------------------------

Overview
^^^^^^^^

  .. Special-python-package-sub-directories-label:
  .. table:: *Special python sun-directories*

   +----+------------------------------------------+
   |Name|Description                               |
   +====+==========================================+
   |data|Directory for package data files.         |
   +----+------------------------------------------+
   |cfg |Directory for package configuration files.|
   +----+------------------------------------------+

Python package files
--------------------

Overview
^^^^^^^^

  .. Python-package-files-label:
  .. table:: *Python package files*

   +--------------+---------------------------------------------------------+
   |Name          |Definition                                               |
   +==============+==========+==============================================+
   |Python        |File within a python package.                            |
   |package file  |                                                         |
   +--------------+---------------------------------------------------------+
   |Special python|Python package file which are not modules and used as    |
   |package file  |python marker files like ``__init__.py``.                |
   +--------------+---------------------------------------------------------+
   |Python        |File with suffix ``.py`` which could be empty or contain |
   |package module|python code; Other modules can be imported into a module.|
   +--------------+---------------------------------------------------------+
   |Special python|Python package module with special name and functionality|
   |package module|like ``main.py`` or ``__init__.py``.                     |
   +--------------+---------------------------------------------------------+

Special python package files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Overview
°°°°°°°°

  .. Special-python-package-files-label:
  .. table:: *Special python package files*

   +--------+--------+---------------------------------------------------------------+
   |Name    |Type    |Description                                                    |
   +========+========+===============================================================+
   |py.typed|Type    |The ``py.typed`` file is a marker file used in Python packages |
   |        |checking|to indicate that the package supports type checking. This is a |
   |        |marker  |part of the PEP 561 standard, which provides a standardized way|
   |        |file    |to package and distribute type information in Python.          |
   +--------+--------+---------------------------------------------------------------+

Special python package modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Overview
°°°°°°°°

  .. Special-Python-package-modules-label:
  .. table:: *Special Python package modules*

   +--------------+-----------+-----------------------------------------------------------------+
   |Name          |Type       |Description                                                      |
   +==============+===========+=================================================================+
   |__init__.py   |Package    |The dunder (double underscore) module ``__init__.py`` is used to |
   |              |directory  |execute initialisation code or mark the directory it contains as |
   |              |marker     |a package. The Module enforces explicit imports and thus clear   |
   |              |file       |namespace use and call them with the dot notation.               |
   +--------------+-----------+-----------------------------------------------------------------+
   |__main__.py   |entry point|The dunder module ``__main__.py`` serves as an entry point for   |
   |              |for the    |the package. The module is executed when the package is called by|
   |              |package    |the interpreter with the command **python -m <package name>**.   |
   +--------------+-----------+-----------------------------------------------------------------+
   |__version__.py|Version    |The dunder module ``__version__.py`` consist of assignment       |
   |              |file       |statements used in Versioning.                                   |
   +--------------+-----------+-----------------------------------------------------------------+

Python elements
---------------

Overview
°°°°°°°°

  .. Python elements-label:
  .. table:: *Python elements*

   +-------------------+---------------------------------------------+
   |Name               |Definition                                   |
   +===================+=============================================+
   |Python method      |Function defined in a python module.         |
   +-------------------+---------------------------------------------+
   |Special            |Python method with special name and          |
   |python method      |functionality like ``init``.                 |
   +-------------------+---------------------------------------------+
   |Python class       |Python classes are defined in python modules.|
   +-------------------+---------------------------------------------+
   |Python class method|Python method defined in a python class.     |
   +-------------------+---------------------------------------------+
   |Special            |Python class method with special name and    |
   |Python class method|functionality like ``init``.                 |
   +-------------------+---------------------------------------------+

Special python methods
^^^^^^^^^^^^^^^^^^^^^^

Overview
°°°°°°°°

  .. Special-python-methods-label:
  .. table:: *Special python methods*

   +--------+------------+----------------------------------------------------------+
   |Name    |Type        |Description                                               |
   +========+============+==========================================================+
   |__init__|class object|The special method ``__init__`` is called when an instance|
   |        |constructor |(object) of a class is created; instance attributes can be|
   |        |method      |defined and initalized in the method.                     |
   +--------+------------+----------------------------------------------------------+

Table of Contents
=================

.. contents:: **Table of Content**
