ka-uts-com 1.0.0.240823__py3-none-any.whl → 2.0.0.250407__py3-none-any.whl

ka_uts_com/com.py

@@ -1,222 +1,121 @@
 # coding=utf-8
+from typing import Any
 
+import os
+import time
 import calendar
+import importlib.resources as resources
 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_Any = Any
-T_Arr = List[Any]
-T_Bool = bool
-T_Dic = Dict[Any, Any]
-
-TN_Arr = None | T_Arr
-TN_Bool = None | bool
-TN_Dic = None | T_Dic
-TN_DT = None | datetime
+from ka_uts_com.utils.aoeqstmt import AoEqStmt
+from ka_uts_com.utils.pacmod import PacMod
+from ka_uts_com.base.app_ import App_
+from ka_uts_com.base.cfg_ import Cfg_
+from ka_uts_com.base.exit_ import Exit_
+from ka_uts_com.base.log_ import Log_
+
+TyAny = Any
+TyDateTime = datetime
+TyTimeStamp = int
+TyArr = list[Any]
+TyBool = bool
+TyDic = dict[Any, Any]
+TyLogger = Logger
+
+TnAny = None | Any
+TnArr = None | TyArr
+TnDic = None | TyDic
+TnTimeStamp = None | TyTimeStamp
+TnDateTime = None | TyDateTime
+TnStr = None | str
 
 
-class LogStandard:
-    """Standard Logging
+class Com:
+    """Communication Class
     """
     sw_init: bool = False
-    cfg: T_Dic = {}
-    log: Logger = logging.getLogger('dummy_logger')
-    logfile: str = 'log.standard.yml'
+    dir_dat: TnStr = None
+    tenant: TnStr = None
+    log_type: TnStr = None
+    cmd: TnStr = None
+    d_com_pacmod: TyDic = {}
+    d_app_pacmod: TyDic = {}
+    path_bin = None
+    path_log_cfg = None
 
-    @staticmethod
-    def read(pacmod: T_Dic, filename: str) -> Any:
-        """Read log file path with jinja2
-        """
-        # path: str = Pacmod.Path.Log.sh_cfg(filename=filename)
-        path: str = Pacmod.sh_path_cfg_log(filename=filename)
-        tenant: str = pacmod['tenant']
-        package: str = pacmod['package']
-        module: str = pacmod['module']
-        pid = Com.pid
-        ts: TN_DT = Com.ts_start
-        cfg = Jinja2.read(
-            path, tenant=tenant,
-            package=package, module=module,
-            pid=pid, ts=ts)
-        return cfg
+    pid = None
 
-    @classmethod
-    def set_level(cls, sw_debug: bool) -> None:
-        """Set static variable log level in log configuration handlers
-        """
-        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
+    ts: TnTimeStamp
+    ts_start: TnDateTime = None
+    ts_end: TnDateTime = None
+    ts_etime: TnDateTime = None
+    d_timer: TyDic = {}
 
-    @classmethod
-    def init(
-            cls, **kwargs) -> None:
-        cls.sw_init = True
-        cls.cfg = cls.read(Com.pacmod_curr, cls.logfile)
-        sw_debug: Any = kwargs.get('sw_debug')
-        cls.set_level(sw_debug)
-        logging.config.dictConfig(cls.cfg)
-        cls.log = logging.getLogger('main')
+    cfg: TnDic = None
+    Log = logging.getLogger('dummy_logger')
+    App: Any = None
+    Exit: Any = None
 
     @classmethod
-    def sh(cls, **kwargs) -> Any:
+    def init(cls, app_cls, kwargs: TyDic):
+        """ set log and application (module) configuration
+        """
         if cls.sw_init:
-            return cls.log
-        cls.init(**kwargs)
-        return cls.log
-
-
-class LogPersonal:
-    """Personal Logging
-    """
-    sw_init: bool = False
-    cfg: T_Dic = {}
-    logfile = 'log.person.yml'
-    log: Logger = logging.getLogger('dummy_logger')
+            return
+        cls.sw_init = True
+        cls.dir_dat = kwargs.get('dir_dat', '/data')
+        cls.tenant = kwargs.get('tenant')
+        cls.log_type = kwargs.get('log_type', 'std')
+        cls.cmd = kwargs.get('cmd')
+        cls.d_com_pacmod = PacMod.sh_d_pacmod(cls)
+        cls.d_app_pacmod = PacMod.sh_d_pacmod(app_cls)
+
+        cls.ts = calendar.timegm(time.gmtime())
+        cls.pid = os.getpid()
 
-    @classmethod
-    def read(cls, pacmod: T_Dic, person: Any, filename: str) -> Any:
-        path: str = Pacmod.sh_path_cfg_log(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)
+        # print(f"Com.init cls.tenanat = {cls.tenant}")
+        # print(f"Com.init cls.cmd = {cls.cmd}")
+        # print(f"Com.init kwargs = {kwargs}")
 
-    @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
+        cls.set_path_bin()
+        cls.set_path_log_cfg()
 
-    @classmethod
-    def init(cls, pacmod: T_Dic, person: str, sw_debug: bool) -> None:
-        cls.cfg = cls.read(pacmod, person, cls.logfile)
-        cls.set_level(person, sw_debug)
-        logging.config.dictConfig(cls.cfg)
-        cls.log = logging.getLogger(person)
+        cls.Log = Log_.sh(cls, **kwargs)
+        cls.cfg = Cfg_.sh(cls, **kwargs)
+        cls.App = App_.sh(cls, **kwargs)
+        cls.Exit = Exit_.sh(**kwargs)
 
     @classmethod
-    def sh(cls, **kwargs) -> Any:
-        if cls.sw_init:
-            return cls.log
-        cls.init(**kwargs)
-        return cls.log
-
+    def sh_kwargs(cls, app_cls, d_parms, *args) -> TyDic:
+        _kwargs: TyDic = AoEqStmt.sh_d_eq(*args, d_parms=d_parms)
+        cls.init(app_cls, _kwargs)
+        _kwargs['com'] = cls
+        return _kwargs
 
-class Cfg:
-    """Configuration Class
-    """
     @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
+    def set_path_bin(cls):
+        """ show directory
         """
-        _dic: TN_Dic = Yaml.read(Pacmod.sh_path_cfg_yaml(pacmod))
-        return _dic
-
-
-class Mgo:
-    """Mongo DB Class
-    """
-    client = None
-
-
-class App:
-    """Aplication Class
-    """
-    sw_init: T_Bool = False
-    httpmod: T_Any = None
-    sw_replace_keys: TN_Bool = None
-    keys: TN_Arr = None
-    reqs: T_Dic = {}
-    app: T_Dic = {}
-
-    @classmethod
-    def init(cls, **kwargs) -> Any:
-        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))
-                cls.keys = Yaml.read(Pacmod.sh_path_keys_yaml(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
-
-    @classmethod
-    def sh(cls, **kwargs) -> Any:
-        if cls.sw_init:
-            return cls
-        cls.init(**kwargs)
-        return cls
-
-
-class Exit:
-    """Exit Class
-    """
-    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 = None
-    Log: Logger = logging.getLogger('dummy_logger')
-    App = None
-    Exit = Exit
+        package = cls.d_app_pacmod['package']
+        path = resources.files(package).joinpath("bin")
+        if path.is_file():
+            cls.path_bin = path
+        # raise ModuleNotFoundError
 
     @classmethod
-    def init(cls, **kwargs):
-        """ set log and application (module) configuration
+    def set_path_log_cfg(cls):
+        """ show directory
         """
-        if cls.sw_init:
+        package = cls.d_app_pacmod['package']
+        path = resources.files(package).joinpath(f"data/log.{cls.log_type}.yml")
+        if path.is_file():
+            cls.path_log_cfg = path
             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)
-        log_type = kwargs.get('log_type', 'standard')
-        if log_type == 'standard':
-            cls.Log = LogStandard.sh(**kwargs)
-        else:
-            cls.Log = LogPersonal.sh(**kwargs)
-        cls.App = App.sh(**kwargs)
+        package = cls.d_com_pacmod['package']
+        path = resources.files(package).joinpath(f"data/log.{cls.log_type}.yml")
+        if path.is_file():
+            cls.path_log_cfg = path
+        # raise ModuleNotFoundError

ka_uts_com/data/log.std.yml

@@ -0,0 +1,107 @@
+version: 1
+
+disable_existing_loggers: False
+
+# root:
+#     level: DEBUG
+#     handlers:
+#         - debug_console
+#         - debug_file
+
+loggers:
+
+    # standard logger
+    std:
+        # level: NOTSET
+        level: DEBUG
+        handlers:
+            - std_debug_console
+            - std_error_file
+            - std_warning_file
+            - std_debug_file
+            - std_info_file
+            - std_log_file
+
+handlers:
+
+    std_debug_console:
+        class: 'logging.StreamHandler'
+        level: DEBUG
+        formatter: std_debug
+        stream: 'ext://sys.stderr'
+
+#   std_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
+
+    std_error_file:
+        class: 'logging.FileHandler'
+        level: ERROR
+        formatter: std_error
+        filename: '{{dir_run_errs}}/errs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    std_warning_file:
+        class: 'logging.FileHandler'
+        level: WARNING
+        formatter: std_warning
+        filename: '{{dir_run_wrns}}/wrns_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    std_debug_file:
+        class: 'logging.FileHandler'
+        level: DEBUG
+        formatter: std_debug
+        filename: '{{dir_run_debs}}/debs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    std_info_file:
+        class: 'logging.FileHandler'
+        level: INFO
+        formatter: std_info
+        filename: '{{dir_run_infs}}/infs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    std_log_file:
+        class: 'logging.FileHandler'
+        level: INFO
+        formatter: std_log
+        filename: '{{dir_run_logs}}/logs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    std_critical_mail:
+        class: 'logging.handlers.SMTPHandler'
+        level: CRITICAL
+        formatter: std_critical
+        mailhost : localhost
+        fromaddr: 'monitoring@domain.com'
+        toaddrs:
+            - 'dev@domain.com'
+            - 'qa@domain.com'
+        subject: 'Critical error with application name'
+
+
+formatters:
+
+    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_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)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)s'
+    std_log:
+        format: '%(asctime)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)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'

ka_uts_com/data/{log.standard.yml → log.usr.yml}

@@ -1,5 +1,4 @@
 version: 1
-
 disable_existing_loggers: False
 
 # root:
@@ -10,25 +9,27 @@ disable_existing_loggers: False
 
 loggers:
 
-    # main logger
-    main:
+    # user logger
+    usr:
         # level: NOTSET
         level: DEBUG
         handlers:
-            - main_debug_console
-            - main_debug_file
-            - main_info_file
-            - main_error_file
+            - usr_debug_console
+            - usr_error_file
+            - usr_warning_file
+            - usr_debug_file
+            - usr_info_file
+            - usr_log_file
 
 handlers:
 
-    main_debug_console:
+    usr_debug_console:
         class: 'logging.StreamHandler'
         level: DEBUG
-        formatter: main_debug
+        formatter: usr_debug
         stream: 'ext://sys.stderr'
 
-#   main_info_rotating_file_handler:
+#   person_info_rotating_file_handler:
 #       class: 'logging.handlers.RotatingFileHandler'
 #       level: INFO
 #       formatter: info
@@ -38,31 +39,45 @@ handlers:
 #       backupCount: 10
 #       encoding: utf8
 
-    main_debug_file:
+    usr_error_file:
+        class: 'logging.FileHandler'
+        level: ERROR
+        formatter: usr_error
+        filename: '{{dir_run_errs}}/errs_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    usr_warning_file:
+        class: 'logging.FileHandler'
+        level: ERROR
+        formatter: usr_warning
+        filename: '{{dir_run_wrns}}/wrns_{{pid}}_{{ts}}.log'
+        mode: 'a'
+
+    usr_debug_file:
         class: 'logging.FileHandler'
         level: DEBUG
-        formatter: main_error
-        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/debs/debs_{{pid}}_{{ts}}.log'
+        formatter: usr_debug
+        filename: '{{dir_run_debs}}/debs_{{pid}}_{{ts}}.log'
         mode: 'a'
 
-    main_info_file:
+    usr_info_file:
         class: 'logging.FileHandler'
         level: INFO
-        formatter: main_info
-        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/logs/logs_{{pid}}_{{ts}}.log'
+        formatter: usr_info
+        filename: '{{dir_run_infs}}/infs_{{pid}}_{{ts}}.log'
         mode: 'a'
 
-    main_error_file:
+    usr_log_file:
         class: 'logging.FileHandler'
-        level: ERROR
-        formatter: main_error
-        filename: '/data/{{tenant}}/RUN/{{package}}/{{module}}/errs/errs_{{pid}}_{{ts}}.log'
+        level: INFO
+        formatter: usr_log
+        filename: '{{dir_run_logs}}/logs_{{pid}}_{{ts}}.log'
         mode: 'a'
 
-    main_critical_mail:
+    usr_critical_mail:
         class: 'logging.handlers.SMTPHandler'
         level: CRITICAL
-        formatter: main_critical
+        formatter: usr_critical
         mailhost : localhost
         fromaddr: 'monitoring@domain.com'
         toaddrs:
@@ -73,14 +88,19 @@ handlers:
 
 formatters:
 
-    main_info:
-        format: '%(asctime)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)s'
-    main_debug:
+    usr_errs:
         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:
+    usr_wrns:
         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:
+    usr_debs:
+        format: '%(asctime)-15s %(levelname)s-%(name)s-%(process)d::%(module)s.%(funcName)s|%(lineno)s:: %(message)s'
+        datefmt: '%Y-%m-%d %H:%M:%S'
+    usr_infs:
+        format: '%(asctime)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)s'
+    usr_logs:
+        format: '%(asctime)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)s'
+    usr_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/decorators/dec.py

@@ -0,0 +1,13 @@
+"""
+Decorators
+"""
+# coding=utf-8
+from ka_uts_com.timer import Timer
+
+
+def timer(fnc):
+    def wrapper(*args, **kwargs):
+        Timer.start(fnc)
+        fnc(*args, **kwargs)
+        Timer.end(fnc)
+    return wrapper

ka_uts_com/fnc.py

@@ -1,37 +1,42 @@
 # coding=utf-8
+from collections.abc import Callable
+from typing import Any
 
-from typing import Any, Callable, Dict
+TyArr = list[Any]
+TyCallable = Callable[..., Any]
+TyDic = dict[Any, Any]
+TyArrDic = TyArr | TyDic
+TyDoC = dict[str, TyCallable]
+TyMsg = str
 
-T_Dic = Dict[Any, Any]
-T_DicStr2Callable = Dict[str, Callable]
-
-TN_Str = None | str
-TN_Callable = None | Callable
+TnStr = None | str
+TnDoC = None | TyDoC
+TnCallable = None | TyCallable
 
 
 class Fnc:
-    """ Manage Functions
+    """
+    Functions
     """
     @staticmethod
-    def sh(d_key2fnc: T_DicStr2Callable, key: TN_Str) -> Callable:
-        if not key:
-            msg = f"key {key} is None or empty string"
-            raise Exception(msg)
-        _fnc: TN_Callable = d_key2fnc.get(key)
-        if not _fnc:
-            msg = f"key {key} is not defined in function table {d_key2fnc}"
-            raise Exception(msg)
-        else:
-            return _fnc
+    def identity(obj: Any) -> Any:
+        return obj
 
     @staticmethod
-    def ex(d_key2fnc: T_DicStr2Callable, key: TN_Str, kwargs: T_Dic) -> None:
+    def sh(doc: TnDoC, key: TnStr) -> TyCallable:
+        if not doc:
+            msg = f"function table: {doc} is not defined"
+            raise Exception(msg)
         if not key:
-            msg = f"key {key} is None or empty string"
+            msg = f"key: {key} is not defined"
             raise Exception(msg)
-        _fnc: TN_Callable = d_key2fnc.get(key)
-        if not _fnc:
-            msg = f"key {key} is not defined in function table {d_key2fnc}"
+        fnc: TnCallable = doc.get(key)
+        if not fnc:
+            msg = f"key: {key} is not defined in function table: {doc}"
             raise Exception(msg)
-        else:
-            _fnc(kwargs)
+        return fnc
+
+    @classmethod
+    def ex(cls, doc: TnDoC, key: TnStr, args_kwargs: TyArrDic) -> Any:
+        fnc: TyCallable = cls.sh(doc, key)
+        return fnc(args_kwargs)

ka_uts_com/ioc/jinja2_.py

@@ -0,0 +1,42 @@
+# coding=utf-8
+# from collections.abc import Callable
+from typing import Any
+
+import os
+import yaml
+import jinja2
+# import logging
+# import logging.config
+from logging import Logger
+
+TyAny = Any
+TyDic = dict[Any, Any]
+TyLogger = Logger
+
+TnDic = None | TyDic
+
+
+class Jinja2_:
+
+    """ Manage Object to Json file affilitation
+    """
+    @staticmethod
+    def read_template(path: str) -> Any:
+        directory, file = os.path.split(path)
+        env = jinja2.Environment(loader=jinja2.FileSystemLoader(directory))
+        return env.get_template(file)
+
+    @classmethod
+    def read(cls, path: str, log: TyLogger, **kwargs) -> Any:
+        try:
+            # read jinja template from file
+            template = cls.read_template(path)
+            # render template as yaml string
+            template_rendered = template.render(kwargs)
+            # load yaml string into object
+            obj: Any = yaml.safe_load(template_rendered)
+            return obj
+        except IOError as exc:
+            log.error(exc, exc_info=True)
+            # log.error(f"No such file or directory: {path}")
+            raise