ut-prc 1.0.0.20250730
Process and Thread Management Utilities
Requires Python: >=3.10

######
ut_prc
######

********
Overview
********

.. start short_desc

**Utilities for Process and Thread Management**

.. end short_desc

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

.. start installation

The package ``ut_prc`` can be installed from PyPI.

To install with ``pip``:

.. code-block:: shell

	$ python -m pip install ut_prc

.. end installation

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

(c.f.: **Appendix**: `Package Logging`)

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

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

The Files of Package ``ut_obj`` could be classified into the follwing file types (c.f.: **Appendix**: `Python Terminology`):


#. **Special files**

   a. *py.typed*

#. **Special modules**

   a. *__init__.py*
   #. *__version__.py*

#. **Modules**

   a. *prc.py*

*******
Modules
*******

The Package ``ut_prc`` contains the subsequent modules.

  .. Modules-of-package-ut_prc-label:
  .. table:: Modules of package ut_prc*

   +---------------------------------------------+
   |Module                                       |
   +--------+------------------------------------+
   |Name    |Description                         |
   +========+====================================+
   |prc.py  |Management of "array of arrays".    |
   +--------+------------------------------------+

  .. processing-module-with-classes-label:
  .. table:: *Processing Module with classes*

   +-----------------------------------+----------------------------------------------+
   |Module                             |Static Classes                                |
   +-------------------+---------------+----+-----------------------------------------+
   |Name               |Type           |Name|Description                              |
   +===================+===============+====+=========================================+
   |prc                |Task runner    |Ra  |Process Task decorated by the ray remote |
   |                   |for iterator   |    |decorator for all iterator items.        |
   |                   |               +----+-----------------------------------------+
   |                   |               |Co  |Process Task using concurrent futures    |
   |                   |               |    |with process- or thread-pool.            |
   |                   |               +----+-----------------------------------------+
   |                   |               |Mp  |Process Tasks using multiprocessing with |
   |                   |               |    |process- or thread-pool                  |
   |                   |               +----+-----------------------------------------+
   |                   |               |Sp  |Process Task sequentially for all        |
   |                   |               |    |iterator items.                          |
   |                   |               +----+-----------------------------------------+
   |                   |               |Prc |Create iterator for path-templates       |
   |                   |               |    |optionally modified by transformer       |
   |                   |               |    |functions (if defined).                  |
   |                   |               |    +-----------------------------------------+
   |                   |               |    |Process Tasks by selecting the run-,     |
   |                   |               |    |process- or thread-function of one of the|
   |                   |               |    |Processing classes Ra, Co, Mp, Sp with   |
   |                   |               |    |the run_method using the function table  |
   |                   |               |    |of run methods: d_run_method_2_fnc.      |
   +-------------------+---------------+----+-----------------------------------------+

  .. special-modules-without-classes-label:
  .. table:: *Special-Modules without classes*

   +-----------+----------------+------------------------------------------------+
   |Module     |Type            |Statements                                      |
   +===========+================+================================================+
   |__init__   |Package         |Module with no Statements; the module is used to|
   |           |directory       |mark the directory it contains as a package. A  | 
   |           |marker          |dummy Module enforces explicit imports and thus |
   |           |                |clear namespace use and call them with the dot  |
   |           |                |dot notation                                    |
   +-----------+----------------+------------------------------------------------+
   |__version__|Version         |Assignment Statements for Version System        |
   |           |                |Variables                                       |
   +-----------+----------------+------------------------------------------------+

Processing Modul: prc_by_dir
============================

The Modul ``prc_by_dir`` contains the subsequent static classes with static variables and methods

  .. Static-classes-of_module-prc_by_dir-label:
  .. table:: *Classes of module prc_by_dir*

   +---------------------------------------------+
   |Static Classes                               |
   +-----+---------------------------------------+
   |Name |Description                            |
   +=====+=======================================+
   |Ra   |Execute tasks using Ray                |
   +-----+---------------------------------------+
   |Co   |Execute tasks using Concurrent futures |
   +-----+---------------------------------------+
   |Mp   |Execute tasks using multiprocessing    |
   +-----+---------------------------------------+
   |Sp   |Execute tasks using single processing  |
   +-----+---------------------------------------+
   |Prc  |Run tasks with selected method         |
   +-----+---------------------------------------+

static Class: Ra
----------------

static Methods
^^^^^^^^^^^^^^

  .. ra-static-methods-of-prc-label:
  .. table:: *Ra static Methods of prc*

   +-----------------------------------------+-----------------------------------+
   |Static Method                            |Parameter\: P / Return Value\: RV  |
   +-------+---------------------------------+------+-----+----+-----------------+
   |Name   |Description                      |Name  |Type |P/RV|Description      |
   +=======+=================================+======+=====+====+=================+
   |process|Run tasks in parallel by         |cls   |class|P   |current class    |
   |       |executing the task decorated with+------+-----+----+-----------------+
   |       |with the ray remote decorator for|kwargs|T_Dic|P   |keyword arguments|
   |       |every iterator item              +------+-----+----+-----------------+
   |       |                                 |      |None |RV  |no return value  |
   +-------+---------------------------------+------+-----+----+-----------------+

static Class: Co
----------------

static Methods
^^^^^^^^^^^^^^

  .. co-static-methods-of-prc-label:
  .. table:: *Co static Methods of prc*

   +-----------------------------------------+-----------------------------------+
   |Static Method                            |Parameter\: P / Return Value\: RV  |
   +-------+---------------------------------+------+-----+----+-----------------+
   |Name   |Description                      |Name  |Type |P/RV|Description      |
   +=======+=================================+======+=====+====+=================+
   |process|Run tasks in parallel by applying|cls   |class|P   |current class    |
   |       |the map method of the concurrent +------+-----+----+-----------------+
   |       |futures process pool executor to |kwargs|T_Dic|P   |keyword arguments|
   |       |the task and the iterator.       +------+-----+----+-----------------+
   |       |                                 |      |None |RV  |no return value  |
   +-------+---------------------------------+------+-----+----+-----------------+
   |thread |Run tasks in parallel by applying|cls   |class|P   |current class    |
   |       |the map method of the concurrent +------+-----+----+-----------------+
   |       |futures thread pool executor to  |kwargs|T_Dic|P   |keyword arguments|
   |       |the task and the iterator.       +------+-----+----+-----------------+
   |       |                                 |      |None |RV  |no return value  |
   +-------+---------------------------------+------+-----+----+-----------------+

static Class: Mp
----------------

static Methods
^^^^^^^^^^^^^^

  .. mp-static-methods-of-prc_label:
  .. table:: *Mp static Methods of prc*

   +-----------------------------------------+-----------------------------------+
   |Static Method                            |Parameter\: P / Return Value\: RV  |
   +-------+---------------------------------+------+-----+----+-----------------+
   |Name   |Description                      |Name  |Type |P/RV|Description      |
   +=======+=================================+======+=====+====+=================+
   |process|Run tasks in parallel by applying|cls   |class|P   |current class    |
   |       |the map method of the            +------+-----+----+-----------------+
   |       |multiprocessing process pool to  |kwargs|T_Dic|P   |keyword arguments|
   |       |the task and the iterator.       +------+-----+----+-----------------+
   |       |                                 |      |None |RV  |no return value  |
   +-------+---------------------------------+------+-----+----+-----------------+
   |thread |Run tasks in parallel by applying|cls   |class|P   |current class    |
   |       |the map method of the            +------+-----+----+-----------------+
   |       |multiprocessing thread pool to   |kwargs|T_Dic|P   |keyword arguments|
   |       |the task and the iterator.       +------+-----+----+-----------------+
   |       |                                 |      |None |RV  |no return value  |
   +-------+---------------------------------+------+-----+----+-----------------+

static Class: Sp
----------------

static Methods
^^^^^^^^^^^^^^

  .. sp-static-methods-of-prc-label:
  .. table:: *Sp static Methods of prc*

   +-----------------------------------------+-----------------------------------+
   |Static Method                            |Parameter\: P / Return Value\: RV  |
   +-------+---------------------------------+------+-----+----+-----------------+
   |Name   |Description                      |Name  |Type |P/RV|Description      |
   +=======+=================================+======+=====+====+=================+
   |run    |Run tasks sequentially for all   |cls   |class|P   |current class    |
   |       |items of the iterator            +------+-----+----+-----------------+
   |       |                                 |kwargs|T_Dic|P   |keyword arguments|
   |       |                                 +------+-----+----+-----------------+
   |       |                                 |      |None |RV  |no return value  |
   +-------+---------------------------------+------+-----+----+-----------------+

static Class: Prc
-----------------

static Variables
^^^^^^^^^^^^^^^^

  .. prc-static-variables-of-prc-label:
  .. table:: *Prc static Variables of prc*


   +-----------------------------------------------------------+
   |Static Variable                                            |
   +------------------+------+---------------------------------+
   |Name              |Type  |Description                      |
   +========+=========+======+=================================+
   |d_run_method_2_fnc|T_Dic |Dictionary to translate run      |
   |                  |      |methods into run functions       |
   +------------------+------+---------------------------------+

static Methods
^^^^^^^^^^^^^^

  .. prc-static-methods-of-prc-label:
  .. table:: *Prc static Methods of prc*

   +-------------------------------------+-----------------------------------+
   |Static Method                        |Parameter\: P / Return Value\: RV  |
   +-----+-------------------------------+------+-----+----+-----------------+
   |Name |Description                    |Name  |Type |P/RV|Description      |
   +=====+===============================+======+=====+====+=================+
   |do   |Select executer with run method|cls   |class|P   |current class    |
   |     |and run method function table. |      |     |    |                 |
   |     +-------------------------------+------+-----+----+-----------------+
   |     |Create iterator using the Task |kwargs|T_Dic|P   |keyword arguments|
   |     |function: yield_dl_template.   |      |     |    |                 |
   |     +-------------------------------+------+-----+----+-----------------+
   |     |Run the Task function: task    |      |None |RV  |no return value  |
   |     |with the executor.             |      |     |    |                 |
   +-----+-------------------------------+------+-----+----+-----------------+

Special Modul: __version__
==========================

The Modul ``__version__`` contains no classes, but assignment statements for
system variables used by versioning.

  .. modul-__version__-system-variables:
  .. table:: *__version_ System Variables*

   +---------------+-----------------------------------------+
   |System Variable|Example                                  |
   +===============+=========================================+
   |__title__      |'ut_prc'                                 |
   +---------------+-----------------------------------------+
   |__description__|'Processing Utilities.'                  |
   +---------------+-----------------------------------------+
   |__url__        |'https://ka-com.readthedocs.io/en/latest'|
   +---------------+-----------------------------------------+
   |__version___   |'1.0.0.24.08.24'                         |
   +---------------+-----------------------------------------+
   |__build__      |0x022200                                 |
   +---------------+-----------------------------------------+
   |__author_email_|'Bernd Stroehle'                         |
   +---------------+-----------------------------------------+
   |__license__    |'Apache-2.0'                             |
   +---------------+-----------------------------------------+
   |__copyright__  |'Copyright 2024 Bernd Stroehle           |
   +---------------+-----------------------------------------+
   |__cake__       |u'\u2728 \U0001f370 \u2728'              |
   +---------------+-----------------------------------------+

Module Data
===========

   +-------------------+---------------------+
   |System Variable    |Description          |
   +===================+=====================+
   |log.main.tenant.yml|'ut_prc'             |
   |__copyright__      |'Copyright 2023 bs29'|
   +-------------------+---------------------+
        
########
Appendix
########

***************
Package Logging
***************

Description
===========

Logging use the module **log.py** of the logging package **ut_log**.
The module supports two Logging types:

#. **Standard Logging** (std) or 
#. **User Logging** (usr).

The Logging type can be defined by one of the values 'std' or 'usr' of the parameter log_type; 'std' is the default.
The different Logging types are configured by one of the following configuration files:

#. **log.std.yml** or 
#. **log.usr.yml** 
  
The configuration files can be stored in different configuration directories (ordered by increased priority):

#. <package directory of the log package **ut_log**>/**cfg**,
#. <package directory of the application package **ui_eviq_srr**>/**cfg**,
#. <application directory of the application **eviq**>/**cfg**,

The active configuration file is the configuration file in the directory with the highest priority.

Examples
========
  
Site-packages-path = **/appl/eviq/.pyenv/versions/3.11.12/lib/python3.11/site-packages**
Log-package = **ut_log**
Application-package = **ui_eviq_srr**
Application-home-path = **/appl/eviq**
  
.. Examples-of-log-configuration-files-label:
.. table:: **Examples of log configuration-files**

   +-----------------------------------------------------------------------------------+
   |Log Configuration                                                                  |
   +----+-------------------+----------------------------------------------+-----------+
   |Type|Directory Type     |Directory                                     |File       |
   +====+===================+==============================================+===========+
   |std |Log package        |<Site-packages-path>/<Log-package>/cfg        |log.std.yml|
   |    +-------------------+----------------------------------------------+           |
   |    |Application package|<Site-packages-path>/<application-package>/cfg|           |
   |    +-------------------+----------------------------------------------+           |
   |    |Application        |<application-home-path>/cfg                   |           |
   +----+-------------------+----------------------------------------------+-----------+
   |usr |Log package        |<site-packages-path>/ut_log/cfg               |log.usr.yml|
   |    +-------------------+----------------------------------------------+           |
   |    |Application package|<site-packages-path>/ui_eviq_srr/cfg          |           |
   |    +-------------------+----------------------------------------------+           |
   |    |Application        |<application-path>/cfg                        |           |
   +----+-------------------+----------------------------------------------+-----------+

Log message types
=================

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

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

Log types 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  |
   +--------+-----+--------+------+

Application parameter for logging
---------------------------------

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

   +-----------------+--------------+-----+------------------+-------+-----------+
   |Name             |Decription    |Value|Description       |Default|Example    |
   +=================+==============+=====+==================+=======+===========+
   |appl_data        |data directory|     |                  |       |/data/eviq |
   +-----------------+--------------+-----+------------------+-------+-----------+
   |tenant           |tenant name   |UMH  |                  |       |UMH        |
   +-----------------+--------------+-----+------------------+-------+-----------+
   |package          |package name  |     |                  |       |ui_eviq_srr|
   +-----------------+--------------+-----+------------------+-------+-----------+
   |cmd              |command       |     |                  |       |evupreg    |
   +-----------------+--------------+-----+------------------+-------+-----------+
   |log_type         |Logging Type  |std: |Standard logging  |std    |std        |
   |                 |              +-----+------------------+       |           |
   |                 |              |usr: |User Logging      |       |           |
   +-----------------+--------------+-----+------------------+-------+-----------+
   |log_ts_type      |Logging       |ts:  |Sec since 1.1.1970|ts     |ts         |
   |                 |timestamp     +-----+------------------+       |           |
   |                 |type          |dt:  |Datetime          |       |           |
   +-----------------+--------------+-----+------------------+-------+-----------+
   |log_sw_single_dir|Use single log|True |use single dir.   |True   |True       |
   |                 |directory     +-----+------------------+       |           |
   |                 |              |False|use muliple dir.  |       |           |
   +-----------------+--------------+-----+------------------+-------+-----------+

Log files naming
----------------

Naming Conventions (table format)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

   +--------+----------------------------------------------+-------------------+
   |Type    |Directory                                     |File               |
   +========+==============================================+===================+
   |debug   |/<appl_data>/<tenant>/RUN/<package>/<cmd>/debs|debs_<ts>_<pid>.log|
   +--------+----------------------------------------------+-------------------+
   |critical|/<appl_data>/<tenant>/RUN/<package>/<cmd>/logs|crts_<ts>_<pid>.log|
   +--------+----------------------------------------------+-------------------+
   |error   |/<appl_data>/<tenant>/RUN/<package>/<cmd>/logs|errs_<ts>_<pid>.log|
   +--------+----------------------------------------------+-------------------+
   |info    |/<appl_data>/<tenant>/RUN/<package>/<cmd>/logs|infs_<ts>_<pid>.log|
   +--------+----------------------------------------------+-------------------+
   |warning |/<appl_data>/<tenant>/RUN/<package>/<cmd>/logs|rnsg_<ts>_<pid>.log|
   +--------+----------------------------------------------+-------------------+

Naming Conventions (tree format)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

 <appl_data>   Application data folder
 │
 └── <tenant>  Application tenant folder
     │
     └── RUN  Applications RUN folder for Application log files
         │
         └── <package>  RUN folder of Application package: <package>
             │
             └── <cmd>  RUN folder of Application command <cmd>
                 │
                 ├── debs  Application command debug messages folder
                 │   │
                 │   └── debs_<ts>_<pid>.log  debug messages for
                 │                            run of command <cmd>
                 │                            with pid <pid> at <ts>
                 │
                 └── logs  Application command log messages folder
                     │
                     ├── crts_<ts>_<pid>.log  critical messages for
                     │                        run of command <cmd>
                     │                        with pid <pid> at <ts>
                     ├── errs_<ts>_<pid>.log  error messages for
                     │                        run of command <cmd>
                     │                        with pid <pid> at <ts>
                     ├── infs_<ts>_<pid>.log  info messages for
                     │                        run of command <cmd>
                     │                        with pid <pid> at <ts>
                     └── wrns_<ts>_<pid>.log  warning messages for
                                              run of command <cmd>
                                              with pid <pid> at <ts>

Naming Examples (table format)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

   +--------+--------------------------------------------+--------------------------+
   |Type    |Directory                                   |File                      |
   +========+============================================+==========================+
   |debug   |/appl/eviq/UMH/RUN/ui_eviq_srr/evdomap/debs/|debs_1750096540_354710.log|
   +--------+--------------------------------------------+--------------------------+
   |critical|/appl/eviq/UMH/RUN/ui_eviq_srr/evdomap/logs/|crts_1749971151_240257.log|
   +--------+                                            +--------------------------+
   |error   |                                            |errs_1749971151_240257.log|
   +--------+                                            +--------------------------+
   |info    |                                            |infs_1750096540_354710.log|
   +--------+                                            +--------------------------+
   |warning |                                            |wrns_1749971151_240257.log|
   +--------+--------------------------------------------+--------------------------+

Naming Examples (tree format)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: text

  /data/eviq/UMH/RUN/ui_eviq_srr/evdomap  Run folder of
  │                                       of function evdomap
  │                                       of package ui_eviq_srr
  │                                       for teanant UMH
  │                                       of application eviq
  │
  ├── debs  debug folder of Application function: evdomap
  │   │
  │   └── debs_1748609414_314062.log  debug messages for run 
  │                                   of function evdomap     
  │                                   using pid: 314062 at: 1748609414
  │
  └── logs  log folder of Application function: evdomap
      │
      ├── errs_1748609414_314062.log  error messages for run
      │                               of function evdomap     
      │                               with pid: 314062 at: 1748609414
      ├── infs_1748609414_314062.log  info messages for run
      │                               of function evdomap     
      │                               with pid: 314062 at: 1748609414
      └── wrns_1748609414_314062.log  warning messages for run
                                      of function evdomap     
                                      with pid: 314062 at: 1748609414

Configuration files
===================

log.std.yml (jinja2 yml file)
-----------------------------

Content
^^^^^^^

.. log.std.yml-label:
.. code-block:: jinja

 version: 1

 disable_existing_loggers: False

 loggers:

     # standard logger
     std:
         # level: NOTSET
         level: DEBUG
         handlers:
             - std_debug_console
             - std_debug_file
             - std_info_file
             - std_warning_file
             - std_error_file
             - std_critical_file

 handlers:
 
     std_debug_console:
         class: 'logging.StreamHandler'
         level: DEBUG
         formatter: std_debug
         stream: 'ext://sys.stderr'

     std_debug_file:
         class: 'logging.FileHandler'
         level: DEBUG
         formatter: std_debug
         filename: '{{dir_run_debs}}/debs_{{ts}}_{{pid}}.log'
         mode: 'a'
         delay: true

     std_info_file:
         class: 'logging.FileHandler'
         level: INFO
         formatter: std_info
         filename: '{{dir_run_infs}}/infs_{{ts}}_{{pid}}.log'
         mode: 'a'
         delay: true

     std_warning_file:
         class: 'logging.FileHandler'
         level: WARNING
         formatter: std_warning
         filename: '{{dir_run_wrns}}/wrns_{{ts}}_{{pid}}.log'
         mode: 'a'
         delay: true

     std_error_file:
         class: 'logging.FileHandler'
         level: ERROR
         formatter: std_error
         filename: '{{dir_run_errs}}/errs_{{ts}}_{{pid}}.log'
         mode: 'a'
         delay: true
 
     std_critical_file:
         class: 'logging.FileHandler'
         level: CRITICAL
         formatter: std_critical
         filename: '{{dir_run_crts}}/crts_{{ts}}_{{pid}}.log'
         mode: 'a'
         delay: true

     std_critical_mail:
         class: 'logging.handlers.SMTPHandler'
         level: CRITICAL
         formatter: std_critical_mail
         mailhost : localhost
         fromaddr: 'monitoring@domain.com'
         toaddrs:
             - 'dev@domain.com'
             - 'qa@domain.com'
         subject: 'Critical error with application name'
 
 formatters:

     std_debug:
         format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
         datefmt: '%Y-%m-%d %H:%M:%S'
     std_info:
         format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
         datefmt: '%Y-%m-%d %H:%M:%S'
     std_warning:
         format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
         datefmt: '%Y-%m-%d %H:%M:%S'
     std_error:
         format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
         datefmt: '%Y-%m-%d %H:%M:%S'
     std_critical:
         format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
         datefmt: '%Y-%m-%d %H:%M:%S'
     std_critical_mail:
         format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
         datefmt: '%Y-%m-%d %H:%M:%S'

Jinja2-variables
^^^^^^^^^^^^^^^^

.. log.std.yml-Jinja2-variables-label:
.. table:: *log.std.yml Jinja2 variables*

   +------------+-----------------------------+-------------------------------------------+
   |Name        |Definition                   |Example                                    |
   +============+=============================+===========================================+
   |dir_run_debs|debug run directory          |/data/eviq/UMH/RUN/ui_eviq_srr/evupreg/debs|
   +------------+-----------------------------+-------------------------------------------+
   |dir_run_infs|info run directory           |/data/eviq/UMH/RUN/ui_eviq_srr/evupreg/logs|
   +------------+-----------------------------+                                           |
   |dir_run_wrns|warning run directory        |                                           |
   +------------+-----------------------------+                                           |
   |dir_run_errs|error run directory          |                                           |
   +------------+-----------------------------+                                           |
   |dir_run_crts|critical error run directory |                                           |
   +------------+-----------------------------+-------------------------------------------+
   |ts          |Timestamp since 1970 in [sec]|1749483509                                 |
   |            |if log_ts_type == 'ts'       |                                           |
   |            +-----------------------------+-------------------------------------------+
   |            |Datetime in timezone Europe/ |20250609 17:38:29 GMT+0200                 |
   |            |Berlin if log_ts_type == 'dt'|                                           |
   +------------+-----------------------------+-------------------------------------------+
   |pid         |Process ID                   |79133                                      |
   +------------+-----------------------------+-------------------------------------------+

***************
Python Glossary
***************

.. _python-modules:

Python Modules
==============

Overview
--------

  .. Python-Modules-label:
  .. table:: *Python Modules*

   +--------------+---------------------------------------------------------+
   |Name          |Definition                                               |
   +==============+==========+==============================================+
   |Python modules|Files with suffix ``.py``; they could be empty or contain|
   |              |python code; other modules can be imported into a module.|
   +--------------+---------------------------------------------------------+
   |special Python|Modules like ``__init__.py`` or ``main.py`` with special |
   |modules       |names and functionality.                                 |
   +--------------+---------------------------------------------------------+

.. _python-functions:

Python Function
===============

Overview
--------

  .. Python-Function-label:
  .. table:: *Python Function*

   +---------------+---------------------------------------------------------+
   |Name           |Definition                                               |
   +===============+==========+==============================================+
   |Python function|Files with suffix ``.py``; they could be empty or contain|
   |               |python code; other modules can be imported into a module.|
   +---------------+---------------------------------------------------------+
   |special Python |Modules like ``__init__.py`` or ``main.py`` with special |
   |modules        |names and functionality.                                 |
   +---------------+---------------------------------------------------------+

.. _python-packages:

Python Packages
===============

Overview
--------

  .. Python Packages-Overview-label:
  .. table:: *Python Packages Overview*

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

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

  .. Special-python-package-sub-directory-Examples-label:
  .. table:: *Special python package sub-directories*

   +-------+------------------------------------------+
   |Name   |Description                               |
   +=======+==========================================+
   |bin    |Directory for package scripts.            |
   +-------+------------------------------------------+
   |cfg    |Directory for package configuration files.|
   +-------+------------------------------------------+
   |data   |Directory for package data files.         |
   +-------+------------------------------------------+
   |service|Directory for systemd service scripts.    |
   +-------+------------------------------------------+

.. _python-files:

Python Files
============

Overview
--------

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

   +--------------+---------------------------------------------------------+
   |Name          |Definition                                               |
   +==============+==========+==============================================+
   |Python modules|Files with suffix ``.py``; they could be empty or contain|
   |              |python code; other modules can be imported into a module.|
   +--------------+---------------------------------------------------------+
   |Python package|Files within a python package.                           |
   |files         |                                                         |
   +--------------+---------------------------------------------------------+
   |Python dunder |Python modules which are named with leading and trailing |
   |modules       |double underscores.                                      |
   +--------------+---------------------------------------------------------+
   |special       |Files which are not modules and used as python marker    |
   |Python files  |files like ``py.typed``.                                 |
   +--------------+---------------------------------------------------------+
   |special Python|Modules like ``__init__.py`` or ``main.py`` with special |
   |modules       |names and functionality.                                 |
   +--------------+---------------------------------------------------------+

.. _python-special-files:

Python Special Files
--------------------

  .. Python-special-files-label:
  .. table:: *Python special 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   |
   |        |file    |way to package and distribute type information in Python.     |
   +--------+--------+--------------------------------------------------------------+

.. _python-special-modules:

Python Special Modules
----------------------

  .. Python-special-modules-label:
  .. table:: *Python special 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   |
   |              |marker     |as a package. The Module enforces explicit imports and thus     |
   |              |file       |clear namespace use and call them with the dot notation.        |
   +--------------+-----------+----------------------------------------------------------------+
   |__main__.py   |entry point|The dunder module ``__main__.py`` serves as package entry point |
   |              |for the    |point. The module is executed when the package is called by the |
   |              |package    |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 classes
==============

Overview
--------

  .. Python-classes-overview-label:
  .. table:: *Python classes overview*

   +-------------------+---------------------------------------------------+
   |Name               |Description                                        |
   +===================+===================================================+
   |Python class       |A class is a container to group related methods and|
   |                   |variables together, even if no objects are created.|
   |                   |This helps in or