ka-uts-com 2023.6.0__py3-none-any.whl

ka_uts_com/ioc.py

@@ -0,0 +1,55 @@
+# coding=utf-8
+
+import jinja2
+import os
+import yaml
+
+from typing import Any, Dict
+
+T_Dic = Dict[Any, Any]
+
+TN_Any = None | Any
+
+
+class Yaml:
+
+    """ Manage Object to Yaml file affilitation
+    """
+    @staticmethod
+    def load_with_safeloader(string: str) -> None | Any:
+        return yaml.load(string, Loader=yaml.SafeLoader)
+
+    @staticmethod
+    def read(path: str) -> TN_Any:
+        with open(path) as fd:
+            # The Loader parameter handles the conversion from YAML
+            # scalar values to Python object format
+            return yaml.load(fd, Loader=yaml.SafeLoader)
+        return None
+
+
+class Jinja2:
+    """ Manage Object to Json file affilitation
+    """
+    @staticmethod
+    def read_template(
+            path: str) -> Any:
+        dir, file = os.path.split(path)
+        env = jinja2.Environment(loader=jinja2.FileSystemLoader(dir))
+        return env.get_template(file)
+
+    @classmethod
+    def read(
+            cls, path: str, **kwargs):
+        try:
+            # read jinja template from file
+            template = cls.read_template(path)
+
+            # render template as yaml string
+            template_rendered = template.render(**kwargs)
+
+            # parse yaml string as dictionary
+            dic = Yaml.load_with_safeloader(template_rendered)
+            return dic
+        except Exception:
+            raise

ka_uts_com/log.py

@@ -0,0 +1,82 @@
+from ka_uts_com.com import Com
+
+from typing import Any, Callable
+
+
+# class Eq:
+#     """ Manage Equate Class
+#     """
+#     @staticmethod
+#     def sh(key: Any, value: Any) -> str:
+#         """ Show Key, Value as Equate
+#         """
+#         return f"{key} = {value}"
+
+
+class Log:
+    """Logging Class
+    """
+
+    class Eq:
+
+        @staticmethod
+        def sh(key: Any, value: Any) -> str:
+            """ Show Key, Value as Equate
+            """
+            return f"{key} = {value}"
+
+        @classmethod
+        def debug(cls, key: Any, value: Any) -> None:
+            Log.debug(cls.sh(key, value), stacklevel=3)
+
+        @classmethod
+        def error(cls, key: Any, value: Any) -> None:
+            Log.error(cls.sh(key, value), stacklevel=3)
+
+        @classmethod
+        def info(cls, key: Any, value: Any) -> None:
+            Log.info(cls.sh(key, value), stacklevel=3)
+
+        @classmethod
+        def warning(cls, key: Any, value: Any) -> None:
+            Log.warning(cls.sh(key, value), stacklevel=3)
+
+    @staticmethod
+    def debug(*args, **kwargs) -> None:
+        if kwargs is None:
+            kwargs = {}
+        kwargs['stacklevel'] = kwargs.get('stacklevel', 2)
+        fnc_debug: Callable = Com.Log.debug
+        fnc_debug(*args, **kwargs)
+
+    @staticmethod
+    def error(*args, **kwargs) -> None:
+        if kwargs is None:
+            kwargs = {}
+        kwargs['stacklevel'] = kwargs.get('stacklevel', 2)
+        fnc_error: Callable = Com.Log.error
+        fnc_error(*args, **kwargs)
+
+    @staticmethod
+    def info(*args, **kwargs) -> None:
+        if kwargs is None:
+            kwargs = {}
+        kwargs['stacklevel'] = kwargs.get('stacklevel', 2)
+        fnc_info: Callable = Com.Log.info
+        fnc_info(*args, **kwargs)
+
+    @staticmethod
+    def warning(*args, **kwargs) -> None:
+        if kwargs is None:
+            kwargs = {}
+        kwargs['stacklevel'] = kwargs.get('stacklevel', 2)
+        fnc_warning: Callable = Com.Log.warning
+        fnc_warning(*args, **kwargs)
+
+    # @staticmethod
+    # def finished(*args, **kwargs) -> None:
+    #     msg_finished: str = Com.cfg.profs.msgs.finished
+    #     Com.Log.info(msg_finished)
+    #     msg_etime: str = Com.cfg.profs.msgs.etime
+    #     msg_etime = msg_etime.format(etime=Com.ts_etime)
+    #     Com.Log.info(msg_profile)

ka_uts_com/pacmod.py

@@ -0,0 +1,129 @@
+# coding=utf-8
+
+from os import path as os_path
+import pkg_resources
+
+from typing import Any, Dict, List
+
+T_Arr = List[Any]
+T_Dic = Dict[Any, Any]
+
+TN_Dic = None | T_Dic
+
+
+class Pacmod:
+    """ Package Module Management
+    """
+    def sh(root_cls, tenant: Any) -> T_Dic:
+        """ Show Pacmod Dictionary
+        """
+        a_pacmod: T_Arr = root_cls.__module__.split(".")
+        package = a_pacmod[0]
+        module = a_pacmod[1]
+        d_pacmod: T_Dic = {}
+        d_pacmod['tenant'] = tenant
+        d_pacmod['package'] = package
+        d_pacmod['module'] = module
+        return d_pacmod
+
+    class Cfg:
+        """ Configuration Sub Class of Package Module Class
+        """
+        @staticmethod
+        def sh_path(pacmod: T_Dic) -> str:
+            """ show directory
+            """
+            package = pacmod['package']
+            module = pacmod['module']
+
+            dir: str = f"{package}.data"
+
+            # print(f"dir = {dir}")
+            # print(f"package = {package}")
+            # print(f"module = {module}")
+
+            path = pkg_resources.resource_filename(dir, f"{module}.yml")
+            return path
+
+    class Pmd:
+        """ Package Sub Class of Package Module Class
+        """
+        @staticmethod
+        def sh_path_keys(
+                pacmod: Any, filename: str = 'keys.yml') -> str:
+            """ show directory
+            """
+            package = pacmod['package']
+            dir = f"{package}.data"
+            path = pkg_resources.resource_filename(dir, filename)
+            return path
+
+    class Path:
+
+        # class Data:
+        #     class Dir:
+        #         """ Data Directory Sub Class
+        #         """
+        #         @staticmethod
+        #         def sh(pacmod: Dict, type: str) -> str:
+        #             """ show Data File Path
+        #             """
+        #             package = pacmod['package']
+        #             module = pacmod['module']
+        #             return f"/data/{package}/{module}/{type}"
+
+        @staticmethod
+        def sh_data_package_module_type(pacmod: Dict, type_: str) -> str:
+            """ show Data File Path
+            """
+            package = pacmod['package']
+            module = pacmod['module']
+            return f"/data/{package}/{module}/{type_}"
+
+        @classmethod
+        def sh(
+                cls, pacmod: T_Dic, type_: str, suffix: str,
+                pid: Any, ts: Any, **kwargs) -> str:
+            """ show type specific path
+            """
+            filename = kwargs.get('filename')
+            if filename is not None:
+                filename_ = filename
+            else:
+                filename_ = type_
+
+            sw_run_pid_ts = kwargs.get('sw_run_pid_ts', True)
+            if sw_run_pid_ts is None:
+                sw_run_pid_ts = True
+
+            # _dir: str = cls.Data.Dir.sh(pacmod, type)
+            _dir: str = cls.sh_data_package_module_type(pacmod, type_)
+            if sw_run_pid_ts:
+                # pid = str(Com.pid)
+                # ts = str(Com.ts_start)
+                file_path = os_path.join(
+                    _dir, f"{filename_}_{pid}_{ts}.{suffix}")
+            else:
+                file_path = os_path.join(_dir, f"{filename_}.{suffix}")
+            return file_path
+
+        @classmethod
+        def sh_pattern(
+                cls, pacmod: Dict, type_: str, suffix: str, **kwargs) -> str:
+            """ show type specific path
+            """
+            filename = kwargs.get('filename')
+            _dir: str = cls.sh_data_package_module_type(pacmod, type_)
+            return os_path.join(_dir, f"{filename}*.{suffix}")
+
+        class Log:
+
+            @staticmethod
+            def sh_cfg(pacmod: TN_Dic = None, filename: str = 'log.yml'):
+                """ show directory
+                """
+                if pacmod is None:
+                    pacmod = {'package': 'ka_uts_com', 'module': 'com'}
+                return pkg_resources.resource_filename(
+                    f"{pacmod['package']}.data", filename
+                )

ka_uts_com/timer.py

@@ -0,0 +1,72 @@
+# coding=utf-8
+
+from datetime import datetime
+
+from ka_uts_com.com import Com
+from ka_uts_com.log import Log
+
+from typing import Any, List
+
+T_Any = Any
+T_Arr = List[Any]
+T_Str = str
+
+TN_Any = None | T_Any
+TN_Str = None | T_Str
+
+
+class Timestamp:
+
+    @staticmethod
+    def sh_elapse_time_sec(
+            end: Any, start: TN_Any) -> TN_Any:
+        if start is None:
+            return None
+        return end.timestamp()-start.timestamp()
+
+
+class Timer:
+    """ Timer Management
+    """
+    @staticmethod
+    def sh_task_id(
+            class_id: Any, parms: TN_Any, separator: T_Str) -> T_Str:
+        """ start Timer
+        """
+        package = Com.pacmod_curr['package']
+        module = Com.pacmod_curr['module']
+        if isinstance(class_id, str):
+            class_name = class_id
+        else:
+            class_name = class_id.__qualname__
+        if not parms:
+            parms = ""
+        else:
+            parms = f" {parms}"
+        arr: T_Arr = []
+        for item in [package, module, class_name, parms]:
+            if not item:
+                continue
+            arr.append(item)
+        return separator.join(arr)
+
+    @classmethod
+    def start(
+            cls, class_id: T_Any,
+            parms: TN_Any = None, separator: T_Str = ".") -> None:
+        """ start Timer
+        """
+        task_id = cls.sh_task_id(class_id, parms, separator)
+        Com.d_timer[task_id] = datetime.now()
+
+    @classmethod
+    def end(cls, class_id: T_Any,
+            parms: TN_Any = None, separator: T_Str = ".") -> None:
+        """ end Timer
+        """
+        task_id = cls.sh_task_id(class_id, parms, separator)
+        start = Com.d_timer.get(task_id)
+        end = datetime.now()
+        elapse_time_sec = Timestamp.sh_elapse_time_sec(end, start)
+        msg = f"{task_id} elapse time [sec] = {elapse_time_sec}"
+        Log.info(msg, stacklevel=2)

ka_uts_com-2023.6.0.dist-info/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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,29 @@
+build/lib/ka_uts_com/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/ka_uts_com/__version__.py,sha256=NxBIn-b5y0KE4X5hwQdyncFk1EgYcAISVNmrd1Ginzg,355
+build/lib/ka_uts_com/com.py,sha256=ptOJeE13oFd0rIKjHKS-XbYaPMI3-kenVOOX4yl1xd4,5136
+build/lib/ka_uts_com/ioc.py,sha256=p5ODR3JtMQb2IPzI5wo343X_of5ORJjD839vnN_F6dM,1360
+build/lib/ka_uts_com/log.py,sha256=WD_rz7EGp-Tcwtxr06lFya0cnacxwpVWpMcf5Dm2Pvw,2327
+build/lib/ka_uts_com/pacmod.py,sha256=TAu1wYnGprxngj18NEQPToZq716h1iqf2SqLJJpW6Io,4038
+build/lib/ka_uts_com/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/ka_uts_com/timer.py,sha256=IViB3YAGH_ZwHJ7LxkDdiCMTbfju7gT5fUYWWlYFB4o,1869
+build/lib/ka_uts_com/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/ka_uts_com/data/log.main.tenant.yml,sha256=ONqKV6nOGQS1ZYLFGH64_jf8fyMk60lZqnd5GK5j-qs,2423
+build/lib/ka_uts_com/data/log.person.yml,sha256=ONqKV6nOGQS1ZYLFGH64_jf8fyMk60lZqnd5GK5j-qs,2423
+build/lib/ka_uts_com/data/log.yml,sha256=hCBsy34Nb3cHObRtMcjB2GtRLFqh-pzr3vuC1xB8PWY,2281
+ka_uts_com/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ka_uts_com/__version__.py,sha256=NxBIn-b5y0KE4X5hwQdyncFk1EgYcAISVNmrd1Ginzg,355
+ka_uts_com/com.py,sha256=ptOJeE13oFd0rIKjHKS-XbYaPMI3-kenVOOX4yl1xd4,5136
+ka_uts_com/ioc.py,sha256=p5ODR3JtMQb2IPzI5wo343X_of5ORJjD839vnN_F6dM,1360
+ka_uts_com/log.py,sha256=WD_rz7EGp-Tcwtxr06lFya0cnacxwpVWpMcf5Dm2Pvw,2327
+ka_uts_com/pacmod.py,sha256=TAu1wYnGprxngj18NEQPToZq716h1iqf2SqLJJpW6Io,4038
+ka_uts_com/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ka_uts_com/timer.py,sha256=IViB3YAGH_ZwHJ7LxkDdiCMTbfju7gT5fUYWWlYFB4o,1869
+ka_uts_com/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ka_uts_com/data/log.main.tenant.yml,sha256=ONqKV6nOGQS1ZYLFGH64_jf8fyMk60lZqnd5GK5j-qs,2423
+ka_uts_com/data/log.person.yml,sha256=ONqKV6nOGQS1ZYLFGH64_jf8fyMk60lZqnd5GK5j-qs,2423
+ka_uts_com/data/log.yml,sha256=hCBsy34Nb3cHObRtMcjB2GtRLFqh-pzr3vuC1xB8PWY,2281
+ka_uts_com-2023.6.0.dist-info/LICENSE.txt,sha256=1NG3lZzl4JyP_dVIoFfHr-ycMHJMLY1j6sjzjxBzqXo,858
+ka_uts_com-2023.6.0.dist-info/METADATA,sha256=cy3XL3KxDi2E-sjpMNOFLgQmljqniP8ezyWkpO-DHhM,8450
+ka_uts_com-2023.6.0.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
+ka_uts_com-2023.6.0.dist-info/top_level.txt,sha256=CviWgXDn1mYmGlBxZ3G7sMNqv9KOOwYzbDpZsu5RYv4,27
+ka_uts_com-2023.6.0.dist-info/RECORD,,

ka_uts_com-2023.6.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (72.2.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ka_uts_com-2023.6.0.dist-info/top_level.txt

@@ -0,0 +1,4 @@
+build
+dist
+docs
+ka_uts_com