Merge pull request #1 from clagiordano/feature/log-levels

Log levels enum

Author: clagiordano

clagiordano/python3_logger/AbstractLogger.py

@@ -6,49 +6,49 @@ class AbstractLogger(ABC):
     and their mandatory methods
     """
     @abstractmethod
-    def emergency(self, message):
+    def emergency(self, message) -> None:
         """
         It logs an emergency message
         """
 
     @abstractmethod
-    def alert(self, message):
+    def alert(self, message) -> None:
         """
         It logs an alert message
         """
 
     @abstractmethod
-    def critical(self, message):
+    def critical(self, message) -> None:
         """
         It logs a critical message
         """
 
     @abstractmethod
-    def error(self, message):
+    def error(self, message) -> None:
         """
         It logs an error message
         """
 
     @abstractmethod
-    def warning(self, message):
+    def warning(self, message) -> None:
         """
         It logs a warning message
         """
 
     @abstractmethod
-    def notice(self, message):
+    def notice(self, message) -> None:
         """
         It logs a notice message
         """
 
     @abstractmethod
-    def info(self, message):
+    def info(self, message) -> None:
         """
         It logs an info message
         """
 
     @abstractmethod
-    def debug(self, message):
+    def debug(self, message) -> None:
         """
         It logs a debug message
         """

clagiordano/python3_logger/CLILogger.py

@@ -1,57 +1,60 @@
 import re
 from clagiordano.python3_logger.AbstractLogger import AbstractLogger
+from clagiordano.python3_logger.LogLevels import LogLevels
 
 class CLILogger(AbstractLogger):
     """
     Command Line logger with optional colors
     """
     __ansi = True
-    __EMERGENCY = '\033[1;41mEMERGENCY\033[0m'
-    __ALERT     = '\033[41mALERT\033[0m'
-    __CRITICAL  = '\033[1;31mCRITICAL\033[0m'
-    __ERROR     = '\033[31mERROR\033[0m'
-    __WARNING   = '\033[1;33mWARNING\033[0m'
-    __NOTICE    = '\033[33mNOTICE\033[0m'
-    __INFO      = '\033[1;32mINFO\033[0m'
-    __DEBUG     = '\033[1;30mDEBUG\033[0m'
+    __EMERGENCY = f'\033[1;41m{LogLevels.EMERGENCY.name:>10}\033[0m'
+    __ALERT     = f'\033[41m{LogLevels.ALERT.name:>10}\033[0m'
+    __CRITICAL  = f'\033[1;31m{LogLevels.CRITICAL.name:>10}\033[0m'
+    __ERROR     = f'\033[31m{LogLevels.ERROR.name:>10}\033[0m'
+    __WARNING   = f'\033[1;33m{LogLevels.WARNING.name:>10}\033[0m'
+    __NOTICE    = f'\033[33m{LogLevels.NOTICE.name:>10}\033[0m'
+    __INFO      = f'\033[1;32m{LogLevels.INFO.name:>10}\033[0m'
+    __DEBUG     = f'\033[1;30m{LogLevels.DEBUG.name:>10}\033[0m'
 
-    def __format(self, badge, message):
+    def __format(self, badge, message) -> str:
+        """
+        Formats and returns an output string
+        """
         output = f"[{badge}]: {message}"
-
         if self.__ansi is False:
             ansi_escape = re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')
             output = ansi_escape.sub('', output)
 
         return output
 
-    def set_ansi(self, value):
+    def set_ansi(self, value) -> None:
         """
         Enable or disable ANSI color usage, possible values True or False
         """
         self.__ansi = bool(value)
 
-    def emergency(self, message):
+    def emergency(self, message) -> None:
         """
         It outputs an emergency message and exits
         """
         print(self.__format(self.__EMERGENCY, message))
         raise SystemExit(8)
 
-    def alert(self, message):
+    def alert(self, message) -> None:
         """
         It outputs an alert message and exits
         """
         print(self.__format(self.__ALERT, message))
         raise SystemExit(7)
 
-    def critical(self, message):
+    def critical(self, message) -> None:
         """
         It outputs a critical message and exits
         """
         print(self.__format(self.__CRITICAL, message))
         raise SystemExit(6)
 
-    def error(self, message):
+    def error(self, message) -> None:
         """
         It outputs an error message
         """
@@ -63,19 +66,19 @@ def warning(self, message):
         """
         print(self.__format(self.__WARNING, message))
 
-    def notice(self, message):
+    def notice(self, message) -> None:
         """
         It outputs a notice message
         """
         print(self.__format(self.__NOTICE, message))
 
-    def info(self, message):
+    def info(self, message) -> None:
         """
         It outputs a info message
         """
         print(self.__format(self.__INFO, message))
 
-    def debug(self, message):
+    def debug(self, message) -> None:
         """
         It outputs a debug message
         """

clagiordano/python3_logger/LogLevels.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+class LogLevels(Enum):
+    """
+    Log levels definition
+    """
+    EMERGENCY = 0
+    ALERT     = 1
+    CRITICAL  = 2
+    ERROR     = 3
+    WARNING   = 4
+    NOTICE    = 5
+    INFO      = 6
+    DEBUG     = 7

clagiordano/python3_logger/__init__.py

@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = '1.1.0'

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "clagiordano.python3-logger"
-version = "1.0.2"
+version = "1.1.0"
 description = "Library for logging facility"
 authors = ["Claudio Giordano <claudio.giordano@autistici.org>"]
 license = "LGPL-3.0-or-later"

tests/test_CLILogger.py

@@ -12,7 +12,7 @@ def test_version(self):
         """
         version
         """
-        assert __version__ == '0.1.0'
+        assert __version__ == '1.1.0'
 
     def test_ansi_emergency(self):
         """

tests/test_LogLevels.py

@@ -0,0 +1,18 @@
+import pytest
+from clagiordano.python3_logger.LogLevels import LogLevels
+
+@pytest.mark.parametrize("level,expected_value", [
+    ('EMERGENCY', 0),
+    ('ALERT', 1),
+    ('CRITICAL', 2),
+    ('ERROR', 3),
+    ('WARNING', 4),
+    ('NOTICE', 5),
+    ('INFO', 6),
+    ('DEBUG', 7)
+])
+def test_log_levels(level, expected_value):
+    """
+    Tests log levels
+    """
+    assert LogLevels[level].value == expected_value