ka-uts-com 2023.6.0__tar.gz

ka_uts_com-2023.6.0/LICENSE.txt

@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2022 Kosakya, GmbH. All rights reserved.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more detail.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Person:           		Role:           Email:
+# Bernd Stroehle                Author          bernd.stroehle@kosakya.de
+#                               Maintainer

ka_uts_com-2023.6.0/MANIFEST.in

@@ -0,0 +1,15 @@
+include MANIFEST.in
+include LICENSE.txt
+include README.rst
+include setup.cfg
+include requirements.txt
+
+recursive-include * *.txt
+recursive-include * *.in
+recursive-include * *.md
+recursive-exclude * __pycache__
+recursive-exclude * *.pyc
+recursive-exclude * *.pyo
+recursive-exclude * *.orig
+
+prune __pycache__*

ka_uts_com-2023.6.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.1
+Name: ka_uts_com
+Version: 2023.6.0
+Summary: Communication Class Utilities
+Author-email: Bernd Stroehle <bernd.stroehle@bs29.com>
+Maintainer-email: Bernd Stroehle <bernd.stroehle@bs29.com>
+Project-URL: Source Code, https://github.com/bs29/ka_uts_com/tree/master
+Project-URL: Homepage, https://kosakya.de/
+Project-URL: Documentation, https://ka-com.readthedocs.io/en/latest
+Project-URL: Apache-2.0 License, https://apache.org/licenses/LICENSE-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+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: Jinja2>=3.1.4
+Requires-Dist: PyYAML>=6.0.2
+Requires-Dist: setuptools>=70.1.1
+
+##########
+ka_uts_com
+##########
+
+Overview
+========
+
+.. start short_desc
+
+**Communication Utilities**
+
+.. end short_desc
+
+Installation
+============
+.. start installation
+
+``ka_uts_com`` can be installed from PyPI or Anaconda.
+
+To install with ``pip``:
+
+.. code-block:: shell
+
+	$ python -m pip install ka_uts_com
+
+To install with ``conda``:
+
+.. code-block:: shell
+
+	$ conda install -c conda-forge ka_uts_com
+
+.. end installation
+
+This requires that the ``readme`` extra is installed:
+
+.. code-block:: bash
+
+	$ python -m pip install ka_uts_com[readme]
+
+Configuration
+=============
+
+The Configuration of general or tenant specific Package logging is defined in Yaml Configuration Files in the data directory <Package Name>/data of the Package.
+
+.. _configuration-file-label:
+.. list-table:: *Configuration Files*
+   :widths: auto
+   :header-rows: 1
+
+   * - Logging Type
+     - Configuration File
+     - Description
+   * - general
+     - log.yml
+     - the Python Logger compatible general Configuration file is used to
+       define tenant independend logging
+   * - tenant
+     - log.main.tenant.yml
+     - the Python Logger compatible tenant Configuration file is used to
+       define tenant dependend logging
+
+Modules
+=======
+``ka_uts_com`` contains the following modules.
+
+------------
+Base Modules
+------------
+
+  .. base-modules-label:
+  .. table:: *Base Modules*
+
+   +------+---------------------------------------------------+
+   |Module|Description                                        |
+   +======+===================================================+
+   |com   |The com module contains the the Base Communication |
+   |      |class Com and the Utility Classes:                 |
+   |      +---------------------------------------------------+
+   |      |**Base Communication Class**                       |
+   |      +----------+----------------------------------------+
+   |      |**Class** |**Description**                         |
+   |      +----------+----------------------------------------+
+   |      |*Com*     | Base Communication Setup               |
+   |      +----------+----------------------------------------+
+   |      |**Utility Classes**                                |
+   |      +----------+----------------------------------------+
+   |      |**Class** |**Description**                         |
+   |      +----------+----------------------------------------+
+   |      |*Standard*|Standard Log Configuration              |
+   |      +----------+----------------------------------------+
+   |      |*Person*  |Person based Log Configuration          |
+   |      +----------+----------------------------------------+
+   |      |*Cfg*     |Configuration Management                |
+   |      +----------+----------------------------------------+
+   |      |*Mgo*     |Mongo Db Configuration Management       |
+   |      +----------+----------------------------------------+
+   |      |*App*     |Setup Application Management            |
+   |      +----------+----------------------------------------+
+   |      |*Exit*    |Setup Exit Handling                     |
+   +------+----------+----------------------------------------+
+
+---------------
+Utility Modules
+---------------
+
+  .. _utility-modules-label:
+
+  .. table:: *Utility Modules*
+
+   +------+-----------------------------------------------------+
+   |Module|Description                                          |
+   +======+=====================================================+
+   |pacmod|The pacmod module contains the Pacmod Class with     |
+   |      |the following Components (Functions and sub classes) |
+   |      +-------------+---------------------------------------+
+   |      |**Function** |**Description**                        |
+   |      +-------------+---------------------------------------+
+   |      |sh           |show pacmod dictionary entries         |
+   |      +-------------+---------------------------------------+
+   |      |**Sub-class**|**Description**                        |
+   |      +-------------+---------------------------------------+
+   |      |Yaml         |I/O for yaml files                     |
+   |      +-------------+---------------------------------------+
+   |      |Json         |I/O for Json files                     |
+   +------+-------------+---------------------------------------+
+   |ioc   |The ioc module contains I/O Classes for the following|
+   |      |file types: yaml, json                               |
+   +------+-----------------------------------------------------+
+
+  .. _utility-modules-function-label:
+
+  .. table:: *Utility Module Functions*
+
+   +-------+---------------------------------+
+   |Fnction|Description                      |
+   +=======+=================================+
+   |sh     |pacmod dictionary                |
+   +-------+---------------------------------+
+
+  .. _utility-modules-classes-label:
+
+  .. table:: *Utility Module Classes*
+
+   +-----+-----------------------------------------------+
+   |Class|Description                                    |
+   +-----+-----------------------------------------------+
+   |Yaml |I/O for yaml files                             |
+   +-----+-----------------------------------------------+
+   |Json |I/O for json files                             |
+   +-----+-----------------------------------------------+
+
+---------------
+Special Modules
+---------------
+
+  .. special-modules-label:
+
+  .. table:: *Special Modules*
+
+   +-----------+---------------------------------------------+
+   |Module     |Description                                  |
+   +===========+=============================================+
+   |__init__   |dummy Module: contains no Statements         |
+   +-----------+---------------------------------------------+
+   |__version__|contains Assignment Statements for Version   |
+   |           |System Variables                             |
+   +-----------+-------------------+-------------------------+
+
+  .. System-Variables-of-Module-__version__:
+
+  .. table:: *System Variables of Module __version__*
+
+   +---------------+-----------------------------------------+
+   |System Variable|Example                                  |
+   +===============+=========================================+
+   |__title__      |'ka_uts_com'                             |
+   +---------------+-----------------------------------------+
+   |__description__|'Communication Area Utilities.'          |
+   +---------------+-----------------------------------------+
+   |__url__        |'https://ka-com.readthedocs.io/en/latest'|
+   +---------------+-----------------------------------------+
+   |__version___   |'2023.2.2'                               |
+   +---------------+-----------------------------------------+
+   |__build__      |0x022200                                 |
+   +---------------+-----------------------------------------+
+   |__author_email_|'Bernd Stroehle'                         |
+   +---------------+-----------------------------------------+
+   |__license__    |'Apache-2.0'                             |
+   +---------------+-----------------------------------------+
+   |__copyright__  |'Copyright 2023 bs29'                    |
+   +---------------+-----------------------------------------+
+   |__cake__       |u'\u2728 \U0001f370 \u2728'              |
+   +---------------+-----------------------------------------+
+
+Appendix
+========
+
+.. contents:: **Table of Content**

ka_uts_com-2023.6.0/README.rst

@@ -0,0 +1,198 @@
+##########
+ka_uts_com
+##########
+
+Overview
+========
+
+.. start short_desc
+
+**Communication Utilities**
+
+.. end short_desc
+
+Installation
+============
+.. start installation
+
+``ka_uts_com`` can be installed from PyPI or Anaconda.
+
+To install with ``pip``:
+
+.. code-block:: shell
+
+	$ python -m pip install ka_uts_com
+
+To install with ``conda``:
+
+.. code-block:: shell
+
+	$ conda install -c conda-forge ka_uts_com
+
+.. end installation
+
+This requires that the ``readme`` extra is installed:
+
+.. code-block:: bash
+
+	$ python -m pip install ka_uts_com[readme]
+
+Configuration
+=============
+
+The Configuration of general or tenant specific Package logging is defined in Yaml Configuration Files in the data directory <Package Name>/data of the Package.
+
+.. _configuration-file-label:
+.. list-table:: *Configuration Files*
+   :widths: auto
+   :header-rows: 1
+
+   * - Logging Type
+     - Configuration File
+     - Description
+   * - general
+     - log.yml
+     - the Python Logger compatible general Configuration file is used to
+       define tenant independend logging
+   * - tenant
+     - log.main.tenant.yml
+     - the Python Logger compatible tenant Configuration file is used to
+       define tenant dependend logging
+
+Modules
+=======
+``ka_uts_com`` contains the following modules.
+
+------------
+Base Modules
+------------
+
+  .. base-modules-label:
+  .. table:: *Base Modules*
+
+   +------+---------------------------------------------------+
+   |Module|Description                                        |
+   +======+===================================================+
+   |com   |The com module contains the the Base Communication |
+   |      |class Com and the Utility Classes:                 |
+   |      +---------------------------------------------------+
+   |      |**Base Communication Class**                       |
+   |      +----------+----------------------------------------+
+   |      |**Class** |**Description**                         |
+   |      +----------+----------------------------------------+
+   |      |*Com*     | Base Communication Setup               |
+   |      +----------+----------------------------------------+
+   |      |**Utility Classes**                                |
+   |      +----------+----------------------------------------+
+   |      |**Class** |**Description**                         |
+   |      +----------+----------------------------------------+
+   |      |*Standard*|Standard Log Configuration              |
+   |      +----------+----------------------------------------+
+   |      |*Person*  |Person based Log Configuration          |
+   |      +----------+----------------------------------------+
+   |      |*Cfg*     |Configuration Management                |
+   |      +----------+----------------------------------------+
+   |      |*Mgo*     |Mongo Db Configuration Management       |
+   |      +----------+----------------------------------------+
+   |      |*App*     |Setup Application Management            |
+   |      +----------+----------------------------------------+
+   |      |*Exit*    |Setup Exit Handling                     |
+   +------+----------+----------------------------------------+
+
+---------------
+Utility Modules
+---------------
+
+  .. _utility-modules-label:
+
+  .. table:: *Utility Modules*
+
+   +------+-----------------------------------------------------+
+   |Module|Description                                          |
+   +======+=====================================================+
+   |pacmod|The pacmod module contains the Pacmod Class with     |
+   |      |the following Components (Functions and sub classes) |
+   |      +-------------+---------------------------------------+
+   |      |**Function** |**Description**                        |
+   |      +-------------+---------------------------------------+
+   |      |sh           |show pacmod dictionary entries         |
+   |      +-------------+---------------------------------------+
+   |      |**Sub-class**|**Description**                        |
+   |      +-------------+---------------------------------------+
+   |      |Yaml         |I/O for yaml files                     |
+   |      +-------------+---------------------------------------+
+   |      |Json         |I/O for Json files                     |
+   +------+-------------+---------------------------------------+
+   |ioc   |The ioc module contains I/O Classes for the following|
+   |      |file types: yaml, json                               |
+   +------+-----------------------------------------------------+
+
+  .. _utility-modules-function-label:
+
+  .. table:: *Utility Module Functions*
+
+   +-------+---------------------------------+
+   |Fnction|Description                      |
+   +=======+=================================+
+   |sh     |pacmod dictionary                |
+   +-------+---------------------------------+
+
+  .. _utility-modules-classes-label:
+
+  .. table:: *Utility Module Classes*
+
+   +-----+-----------------------------------------------+
+   |Class|Description                                    |
+   +-----+-----------------------------------------------+
+   |Yaml |I/O for yaml files                             |
+   +-----+-----------------------------------------------+
+   |Json |I/O for json files                             |
+   +-----+-----------------------------------------------+
+
+---------------
+Special Modules
+---------------
+
+  .. special-modules-label:
+
+  .. table:: *Special Modules*
+
+   +-----------+---------------------------------------------+
+   |Module     |Description                                  |
+   +===========+=============================================+
+   |__init__   |dummy Module: contains no Statements         |
+   +-----------+---------------------------------------------+
+   |__version__|contains Assignment Statements for Version   |
+   |           |System Variables                             |
+   +-----------+-------------------+-------------------------+
+
+  .. System-Variables-of-Module-__version__:
+
+  .. table:: *System Variables of Module __version__*
+
+   +---------------+-----------------------------------------+
+   |System Variable|Example                                  |
+   +===============+=========================================+
+   |__title__      |'ka_uts_com'                             |
+   +---------------+-----------------------------------------+
+   |__description__|'Communication Area Utilities.'          |
+   +---------------+-----------------------------------------+
+   |__url__        |'https://ka-com.readthedocs.io/en/latest'|
+   +---------------+-----------------------------------------+
+   |__version___   |'2023.2.2'                               |
+   +---------------+-----------------------------------------+
+   |__build__      |0x022200                                 |
+   +---------------+-----------------------------------------+
+   |__author_email_|'Bernd Stroehle'                         |
+   +---------------+-----------------------------------------+
+   |__license__    |'Apache-2.0'                             |
+   +---------------+-----------------------------------------+
+   |__copyright__  |'Copyright 2023 bs29'                    |
+   +---------------+-----------------------------------------+
+   |__cake__       |u'\u2728 \U0001f370 \u2728'              |
+   +---------------+-----------------------------------------+
+
+Appendix
+========
+
+.. contents:: **Table of Content**

ka_uts_com-2023.6.0/classifiers.txt

@@ -0,0 +1,7 @@
+Development Status :: 5 - Production/Stable
+Intended Audience :: Developers
+License :: OSI Approved :: Apache Software License
+Operating System :: OS Independent
+Programming Language :: Python :: 3.10
+Natural Language :: English
+Topic :: Software Development :: Libraries :: Python Modules

ka_uts_com-2023.6.0/ka_uts_com/__version__.py

@@ -0,0 +1,10 @@
+__title__ = 'ka_uts_com'
+__description__ = 'Communication Area Utilities.'
+__url__ = 'https://ka-ut-com.readthedocs.io/en/latest'
+__version__ = '2023.6.0'
+__build__ = 0x022200
+__author__ = 'Bernd Stroehle'
+__author_email__ = 'bernd.stroehle@bs29.com'
+__license__ = 'Apache-2.0'
+__copyright__ = 'Copyright 2023 bs29'
+__cake__ = u'\u2728 \U0001f370 \u2728'

ka_uts_com-2023.6.0/ka_uts_com/com.py

@@ -0,0 +1,196 @@
+# coding=utf-8
+
+import calendar
+import logging
+import logging.config
+from logging import Logger
+
+import os
+import time
+from datetime import datetime
+
+from ka_uts_com.ioc import Yaml
+from ka_uts_com.ioc import Jinja2
+from ka_uts_com.pacmod import Pacmod
+
+from typing import Any, Callable, List, Dict
+
+T_Arr = List[Any]
+T_Dic = Dict[Any, Any]
+
+TN_Arr = None | T_Arr
+TN_Dic = None | T_Dic
+
+
+class StandardLog:
+
+    sw_init: bool = False
+    cfg: T_Dic = {}
+    log: Logger = logging.getLogger('dummy_logger')
+
+    @staticmethod
+    def read(pacmod: T_Dic, filename: str) -> Any:
+        path: str = Pacmod.Path.Log.sh_cfg(filename=filename)
+        tenant: str = pacmod['tenant']
+        package: str = pacmod['package']
+        module: str = pacmod['module']
+        pid = Com.pid
+        ts: None | datetime = Com.ts_start
+        log_main = Jinja2.read(
+            path, tenant=tenant, package=package, module=module,
+            pid=pid, ts=ts)
+        return log_main
+
+    @classmethod
+    def set_level(cls, sw_debug: bool) -> None:
+        if sw_debug:
+            level = logging.DEBUG
+        else:
+            level = logging.INFO
+        cls.cfg['handlers']['main_debug_console']['level'] = level
+        cls.cfg['handlers']['main_debug_file']['level'] = level
+
+    @classmethod
+    def init(
+            cls, **kwargs) -> None:
+        sw_debug: Any = kwargs.get('sw_debug')
+        if cls.sw_init:
+            return
+        cls.sw_init = True
+        cls.cfg = cls.read(Com.pacmod_curr, 'log.main.tenant.yml')
+        cls.set_level(sw_debug)
+        logging.config.dictConfig(cls.cfg)
+        cls.log = logging.getLogger('main')
+        return cls.log
+
+
+class PersonLog:
+
+    sw_init: bool = False
+    cfg: T_Dic = {}
+    log: Logger = logging.getLogger('dummy_logger')
+
+    @classmethod
+    def read(
+            cls, pacmod: T_Dic, person: Any, filename: str) -> Any:
+        path: str = Pacmod.Path.Log.sh_cfg(filename=filename)
+        package: str = pacmod['package']
+        module: str = pacmod['module']
+        return Jinja2.read(
+            path, package=package, module=module, person=person,
+            pid=Com.pid, ts=Com.ts_start)
+
+    @classmethod
+    def set_level(cls, person: str, sw_debug: bool) -> None:
+        if sw_debug:
+            level = logging.DEBUG
+        else:
+            level = logging.INFO
+        cls.cfg['handlers'][f'{person}_debug_console']['level'] = level
+        cls.cfg['handlers'][f'{person}_debug_file']['level'] = level
+
+    @classmethod
+    def init(cls, pacmod: T_Dic, person: str, sw_debug: bool) -> None:
+        cls.cfg = cls.read(pacmod, person, 'log.person.yml')
+        cls.set_level(person, sw_debug)
+        logging.config.dictConfig(cls.cfg)
+        cls.log = logging.getLogger(person)
+        return cls.log
+
+
+class Cfg:
+
+    @classmethod
+    def init(cls, pacmod: T_Dic) -> TN_Dic:
+        """ the package data directory has to contain a __init__.py
+            file otherwise the objects notation {package}.data to
+            locate the package data directory is invalid
+        """
+        _dic: TN_Dic = Yaml.read(Pacmod.Cfg.sh_path(pacmod))
+        return _dic
+
+
+class Mgo:
+
+    client = None
+
+
+class App:
+
+    sw_init: bool = False
+    httpmod = None
+    sw_replace_keys: None | bool = None
+    keys: TN_Arr = None
+    reqs: T_Dic = {}
+    app: T_Dic = {}
+
+    @classmethod
+    def init(
+            cls, **kwargs) -> Any:
+        if cls.sw_init:
+            return cls
+        cls.sw_init = True
+
+        cls.httpmod = kwargs.get('httpmod')
+        cls.sw_replace_keys = kwargs.get('sw_replace_keys', False)
+
+        try:
+            if cls.sw_replace_keys:
+                pacmod = kwargs.get('pacmod_curr')
+                cls.keys = Yaml.read(Pacmod.Pmd.sh_path_keys(pacmod))
+        except Exception as e:
+            if Com.Log is not None:
+                fnc_error: Callable = Com.Log.error
+                fnc_error(e, exc_info=True)
+            raise
+        return cls
+
+
+class Exit:
+
+    sw_critical: bool = False
+    sw_stop: bool = False
+    sw_interactive: bool = False
+
+
+class Com:
+    """Communication Class
+    """
+
+    sw_init: bool = False
+    cfg: TN_Dic = None
+    pid = None
+    pacmod_curr: T_Dic = {}
+
+    ts_start: None | datetime = None
+    ts_end: None | datetime = None
+    ts_etime: None | datetime = None
+    d_timer: Dict = {}
+
+    Log: Logger = logging.getLogger('dummy_logger')
+    App = None
+    Exit = Exit
+
+    @classmethod
+    def init(cls, **kwargs):
+        """ set log and application (module) configuration
+        """
+        if cls.sw_init:
+            return
+        cls.sw_init = True
+
+        cls.pacmod_curr = kwargs.get('pacmod_curr')
+        cls.ts_start = calendar.timegm(time.gmtime())
+        cls.pid = os.getpid()
+
+        cls.cfg = Cfg.init(cls.pacmod_curr)
+        cls.Log = StandardLog.init(**kwargs)
+        cls.App = App.init(**kwargs)
+
+    # @classmethod
+    # def terminate(cls):
+    #     """ set log and application (module) configuration
+    #     """
+    #     cls.Log = StandardLog.log
+    #     cls.ts_end = calendar.timegm(time.gmtime())
+    #     cls.ts_etime = cls.ts_end - cls.ts_start