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

build/lib/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
+                )

build/lib/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/__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/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

ka_uts_com/data/log.main.tenant.yml

@@ -0,0 +1,86 @@
+version: 1
+
+disable_existing_loggers: False
+
+# root:
+#     level: DEBUG
+#     handlers:
+#         - debug_console
+#         - debug_file
+
+loggers:
+
+    # main logger
+    main:
+        # level: NOTSET
+        level: DEBUG
+        handlers:
+            - main_debug_console
+            - main_debug_file
+            - main_info_file
+            - main_error_file
+
+handlers:
+
+    main_debug_console:
+        class: 'logging.StreamHandler'
+        level: DEBUG
+        formatter: main_debug
+        stream: 'ext://sys.stderr'
+
+#   main_info_rotating_file_handler:
+#       class: 'logging.handlers.RotatingFileHandler'
+#       level: INFO
+#       formatter: info
+#       filename: 'info.rotating.log'
+#       mode: 'a'
+#       maxBytes: 1048576  # 1MB
+#       backupCount: 10
+#       encoding: utf8
+
+    main_debug_file:
+        class: 'logging.FileHandler'
+        level: DEBUG
+        formatter: main_error
+        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/debs/debs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    main_info_file:
+        class: 'logging.FileHandler'
+        level: INFO
+        formatter: main_info
+        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/logs/logs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    main_error_file:
+        class: 'logging.FileHandler'
+        level: ERROR
+        formatter: main_error
+        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/errs/errs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    main_critical_mail:
+        class: 'logging.handlers.SMTPHandler'
+        level: CRITICAL
+        formatter: main_critical
+        mailhost : localhost
+        fromaddr: 'monitoring@domain.com'
+        toaddrs:
+            - 'dev@domain.com'
+            - 'qa@domain.com'
+        subject: 'Critical error with application name'
+
+
+formatters:
+
+    main_info:
+        format: '%(asctime)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)s'
+    main_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'
+    main_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'
+    main_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'

ka_uts_com/data/log.person.yml

@@ -0,0 +1,86 @@
+version: 1
+
+disable_existing_loggers: False
+
+# root:
+#     level: DEBUG
+#     handlers:
+#         - debug_console
+#         - debug_file
+
+loggers:
+
+    # main logger
+    main:
+        # level: NOTSET
+        level: DEBUG
+        handlers:
+            - main_debug_console
+            - main_debug_file
+            - main_info_file
+            - main_error_file
+
+handlers:
+
+    main_debug_console:
+        class: 'logging.StreamHandler'
+        level: DEBUG
+        formatter: main_debug
+        stream: 'ext://sys.stderr'
+
+#   main_info_rotating_file_handler:
+#       class: 'logging.handlers.RotatingFileHandler'
+#       level: INFO
+#       formatter: info
+#       filename: 'info.rotating.log'
+#       mode: 'a'
+#       maxBytes: 1048576  # 1MB
+#       backupCount: 10
+#       encoding: utf8
+
+    main_debug_file:
+        class: 'logging.FileHandler'
+        level: DEBUG
+        formatter: main_error
+        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/debs/debs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    main_info_file:
+        class: 'logging.FileHandler'
+        level: INFO
+        formatter: main_info
+        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/logs/logs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    main_error_file:
+        class: 'logging.FileHandler'
+        level: ERROR
+        formatter: main_error
+        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/errs/errs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    main_critical_mail:
+        class: 'logging.handlers.SMTPHandler'
+        level: CRITICAL
+        formatter: main_critical
+        mailhost : localhost
+        fromaddr: 'monitoring@domain.com'
+        toaddrs:
+            - 'dev@domain.com'
+            - 'qa@domain.com'
+        subject: 'Critical error with application name'
+
+
+formatters:
+
+    main_info:
+        format: '%(asctime)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)s'
+    main_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'
+    main_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'
+    main_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'

ka_uts_com/data/log.yml

@@ -0,0 +1,93 @@
+version: 1
+
+disable_existing_loggers: False
+
+root:
+    level: DEBUG
+    handlers:
+        - debug_console
+        - debug_file
+
+loggers:
+
+    # main logger
+    main:
+        level: 'NOTSET'
+        handlers:
+            - debug_console
+            - debug_file
+            - info_file
+            - error_file
+
+    # person logger
+    person:
+        level: NOTSET
+        handlers:
+            - debug_console
+            - debug_file
+            - info_file
+            - error_file
+
+handlers:
+
+    debug_console:
+        class: 'logging.StreamHandler'
+        level: DEBUG
+        formatter: debug
+        stream: 'ext://sys.stderr'
+
+    debug_file:
+        class: 'logging.FileHandler'
+        level: DEBUG
+        formatter: error
+        filename: 'debug.log'
+        mode: 'a'
+
+#   info_rotating_file_handler:
+#       class: 'logging.handlers.RotatingFileHandler'
+#       level: INFO
+#       formatter: info
+#       filename: 'info.rotating.log'
+#       mode: 'a'
+#       maxBytes: 1048576  # 1MB
+#       backupCount: 10
+#       encoding: utf8
+
+    info_file:
+        class: 'logging.FileHandler'
+        level: INFO
+        formatter: info
+        filename: 'info.log'
+        mode: 'a'
+
+    error_file:
+        class: 'logging.FileHandler'
+        level: ERROR
+        formatter: error
+        filename: 'error.log'
+        mode: 'a'
+
+    critical_mail:
+        class: 'logging.handlers.SMTPHandler'
+        level: CRITICAL
+        formatter: critical
+        mailhost : localhost
+        fromaddr: 'monitoring@domain.com'
+        toaddrs:
+            - 'dev@domain.com'
+            - 'qa@domain.com'
+        subject: 'Critical error with application name'
+
+formatters:
+
+    info:
+        format: '%(asctime)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)s'
+    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'
+    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'
+    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'