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

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

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

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

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

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

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

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