Added logger and improved service provider

src/sh_edraft/logging/base/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+"""
+sh_edraft.logging.base 
+~~~~~~~~~~~~~~~~~~~
+
+
+
+:copyright: (c) 2020 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'sh_edraft.logging.base'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2020 sh-edraft.de'
+__version__ = '2020.12.0.1'
+
+from collections import namedtuple
+
+# imports:
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major=2020, minor=12, micro=0.1)

src/sh_edraft/logging/base/logger_base.py

@@ -0,0 +1,31 @@
+from abc import abstractmethod
+
+from sh_edraft.service.base import ServiceBase
+
+
+class LoggerBase(ServiceBase):
+
+    @abstractmethod
+    def __init__(self):
+        ServiceBase.__init__(self)
+
+    @abstractmethod
+    def header(self, string: str): pass
+
+    @abstractmethod
+    def trace(self, name: str, message: str): pass
+
+    @abstractmethod
+    def debug(self, name: str, message: str): pass
+
+    @abstractmethod
+    def info(self, name: str, message: str): pass
+
+    @abstractmethod
+    def warn(self, name: str, message: str): pass
+
+    @abstractmethod
+    def error(self, name: str, message: str, ex: Exception = None): pass
+
+    @abstractmethod
+    def fatal(self, name: str, message: str, ex: Exception = None): pass

src/sh_edraft/logging/logger.py

@@ -0,0 +1,171 @@
+import datetime
+import os
+import traceback
+from string import Template
+from typing import Optional
+
+from termcolor import colored
+
+from sh_edraft.configuration.application_host import ApplicationHost
+from sh_edraft.logging.base.logger_base import LoggerBase
+from sh_edraft.logging.model.log_level import LoggingLevel
+from sh_edraft.logging.model.log_settings import LoggingSettings
+from sh_edraft.time.model.time_format_settings import TimeFormatSettings
+from sh_edraft.utils.console import Console
+
+
+class Logger(LoggerBase):
+
+    def __init__(self):
+        LoggerBase.__init__(self)
+
+        self._log_settings: Optional[LoggingSettings] = None
+        self._time_format_settings: Optional[TimeFormatSettings] = None
+        self._app_host: Optional[ApplicationHost] = None
+
+        self._log: Optional[str] = None
+        self._path: Optional[str] = None
+        self._level: Optional[LoggingLevel] = None
+        self._console: Optional[LoggingLevel] = None
+
+    def init(self, args: tuple):
+        self._log_settings = args[0]
+        self._time_format_settings = args[1]
+        self._app_host = args[2]
+
+        self._log = Template(self._log_settings.filename).substitute(
+            date_time_now=self._app_host.date_time_now.strftime(self._time_format_settings.date_time_format),
+            start_time=self._app_host.start_time.strftime(self._time_format_settings.date_time_log_format)
+        )
+        self._path = self._log_settings.path
+        self._level = self._log_settings.level
+        self._console = self._log_settings.console
+
+    def _get_datetime_now(self) -> str:
+        try:
+            return datetime.datetime.now().strftime(self._time_format_settings.date_time_format)
+        except Exception as e:
+            self.error(__name__, 'Cannot get time', ex=e)
+
+    def _get_date(self) -> str:
+        try:
+            return datetime.datetime.now().strftime(self._time_format_settings.date_format)
+        except Exception as e:
+            self.error(__name__, 'Cannot get date', ex=e)
+
+    def create(self) -> None:
+        """ path """
+        try:
+            # check if log file path exists
+            if not os.path.exists(self._path):
+                os.mkdir(self._path)
+        except Exception as e:
+            self.fatal(__name__, 'Cannot create log dir', ex=e)
+
+        """ create new log file """
+        try:
+            # open log file, create if not exists
+            path = f'{self._path}{self._log}'
+            f = open(path, "w+")
+            Console.write_line(f'[{__name__}]: Using log file: {path}')
+            f.close()
+        except Exception as e:
+            self.fatal(__name__, 'Cannot open log file', ex=e)
+
+    def _append_log(self, string):
+        try:
+            # open log file and append always
+            with open(self._path + self._log, "a+", encoding="utf-8") as f:
+                f.write(string + '\n')
+                f.close()
+        except Exception as e:
+            self.error(__name__, f'Cannot append log file, message: {string}', ex=e)
+
+    def _get_string(self, name: str, level: LoggingLevel, message: str) -> str:
+        log_level = level.name
+        return f'<{self._get_datetime_now()}> [ {log_level} ] [ {name} ]: {message}'
+
+    def header(self, string: str):
+        # append log and print message
+        self._append_log(string)
+        Console.write_line(string, 'white')
+
+    def trace(self, name: str, message: str):
+        output = self._get_string(name, LoggingLevel.TRACE, message)
+
+        # check if message can be written to log
+        if self._level.value >= LoggingLevel.TRACE.value:
+            self._append_log(output)
+
+        # check if message can be shown in console
+        if self._console.value >= LoggingLevel.TRACE.value:
+            Console.write_line(output, 'green')
+
+    def debug(self, name: str, message: str):
+        output = self._get_string(name, LoggingLevel.DEBUG, message)
+
+        # check if message can be written to log
+        if self._level.value >= LoggingLevel.DEBUG.value:
+            self._append_log(output)
+
+        # check if message can be shown in console
+        if self._console.value >= LoggingLevel.DEBUG.value:
+            Console.write_line(output, 'green')
+
+    def info(self, name: str, message: str):
+        output = self._get_string(name, LoggingLevel.INFO, message)
+
+        # check if message can be written to log
+        if self._level.value >= LoggingLevel.INFO.value:
+            self._append_log(output)
+
+        # check if message can be shown in console
+        if self._console.value >= LoggingLevel.INFO.value:
+            Console.write_line(output, 'green')
+
+    def warn(self, name: str, message: str):
+        output = self._get_string(name, LoggingLevel.WARN, message)
+
+        # check if message can be written to log
+        if self._level.value >= LoggingLevel.WARN.value:
+            self._append_log(output)
+
+        # check if message can be shown in console
+        if self._console.value >= LoggingLevel.WARN.value:
+            Console.write_line(output, 'yellow')
+
+    def error(self, name: str, message: str, ex: Exception = None):
+        output = ''
+        if ex is not None:
+            tb = traceback.format_exc()
+            self.error(name, message)
+            output = self._get_string(name, LoggingLevel.ERROR, f'{ex} -> {tb}')
+        else:
+            output = self._get_string(name, LoggingLevel.ERROR, message)
+
+        # check if message can be written to log
+        if self._level.value >= LoggingLevel.ERROR.value:
+            self._append_log(output)
+
+        # check if message can be shown in console
+        if self._console.value >= LoggingLevel.ERROR.value:
+            Console.write_line(output, 'red')
+
+    def fatal(self, name: str, message: str, ex: Exception = None):
+        output = ''
+        if ex is not None:
+            tb = traceback.format_exc()
+            self.error(name, message)
+            output = self._get_string(name, LoggingLevel.ERROR, f'{ex} -> {tb}')
+        else:
+            output = self._get_string(name, LoggingLevel.ERROR, message)
+
+        # check if message can be written to log
+        if self._level.value >= LoggingLevel.FATAL.value:
+            self._append_log(output)
+
+        # check if message can be shown in console
+        if self._console.value >= LoggingLevel.FATAL.value:
+            Console.write_line(output, 'red')
+
+        exit()

src/sh_edraft/logging/model/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+"""
+sh_edraft.logging.model 
+~~~~~~~~~~~~~~~~~~~
+
+
+
+:copyright: (c) 2020 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'sh_edraft.logging.model'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2020 sh-edraft.de'
+__version__ = '2020.12.0.1'
+
+from collections import namedtuple
+
+# imports:
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major=2020, minor=12, micro=0.1)

src/sh_edraft/logging/model/log_level.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class LoggingLevel(Enum):
+
+    OFF = 0         # Nothing
+    FATAL = 1       # Error that cause exit
+    ERROR = 2       # Non fatal error
+    WARN = 3        # Error that can later be fatal
+    INFO = 4        # Normal information's
+    DEBUG = 5       # Detailed app state
+    TRACE = 6       # Detailed app information's

src/sh_edraft/logging/model/log_settings.py

@@ -0,0 +1,60 @@
+import traceback
+from typing import Optional
+
+from sh_edraft.configuration.model.configuration_model_base import ConfigurationModelBase
+from sh_edraft.logging.model.log_settings_name import LogSettingsName
+from sh_edraft.utils.console import Console
+from sh_edraft.logging.model.log_level import LoggingLevel
+
+
+class LoggingSettings(ConfigurationModelBase):
+
+    def __init__(self):
+        ConfigurationModelBase.__init__(self)
+
+        self._path: Optional[str] = None
+        self._filename: Optional[str] = None
+        self._console: Optional[LoggingLevel] = None
+        self._level: Optional[LoggingLevel] = None
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @path.setter
+    def path(self, path: str) -> None:
+        self._path = path
+
+    @property
+    def filename(self) -> str:
+        return self._filename
+
+    @filename.setter
+    def filename(self, filename: str) -> None:
+        self._filename = filename
+
+    @property
+    def console(self) -> LoggingLevel:
+        return self._console
+
+    @console.setter
+    def console(self, console: LoggingLevel) -> None:
+        self._console = console
+
+    @property
+    def level(self) -> LoggingLevel:
+        return self._level
+
+    @level.setter
+    def level(self, level: LoggingLevel) -> None:
+        self._level = level
+
+    def from_dict(self, settings: dict):
+        try:
+            self._path = settings[LogSettingsName.path.value]
+            self._filename = settings[LogSettingsName.filename.value]
+            self._console = LoggingLevel[settings[LogSettingsName.console_level.value]]
+            self._level = LoggingLevel[settings[LogSettingsName.file_level.value]]
+        except Exception as e:
+            Console.write_line(f'[ ERROR ] [ {__name__} ]: Reading error in {LogSettingsName.log.value} settings', 'red')
+            Console.write_line(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}', 'red')

src/sh_edraft/logging/model/log_settings_name.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class LogSettingsName(Enum):
+
+    log = 'Log'
+    path = 'Path'
+    filename = 'Filename'
+    console_level = 'ConsoleLogLevel'
+    file_level = 'FileLogLevel'