Changed logging config to be received by separate parameters for simplicity, removed option to receive configuration as a dict, added .vscode to gitignore

Author: Liad Noam

.gitignore

@@ -134,3 +134,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# VSCode
+.vscode/

.vscode/settings.json

@@ -22,7 +22,7 @@ WEATHER_API_KEY = os.getenv('WEATHER_API_KEY')
 ICAL_VERSION = '2.0'
 PRODUCT_ID = '-//Our product id//'
 
-# email
+# EMAIL
 email_conf = ConnectionConfig(
     MAIL_USERNAME=os.getenv("MAIL_USERNAME") or "user",
     MAIL_PASSWORD=os.getenv("MAIL_PASSWORD") or "password",
@@ -35,15 +35,12 @@ email_conf = ConnectionConfig(
 )
 
 # LOGGER
-LOGGER = {
-    "logger": {
-        "path": "./var/log",
-        "filename": "calendar.log",
-        "level": "error",
-        "rotation": "20 days",
-        "retention": "1 month",
-        "format": ("<level>{level: <8}</level> <green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green>"
-                   " - <cyan>{name}</cyan>:<cyan>{function}</cyan>"
-                   " - <level>{message}</level>")
-    }
-}
+LOG_PATH = "./var/log"
+LOG_FILENAME = "calendar.log"
+LOG_LEVEL = "error"
+LOG_ROTATION_INTERVAL = "20 days"
+LOG_RETENTION_INTERVAL = "1 month"
+LOG_FORMAT = ("<level>{level: <8}</level>"
+              " <green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green>"
+              " - <cyan>{name}</cyan>:<cyan>{function}</cyan>"
+              " - <level>{message}</level>")

app/config.py.example

@@ -1,6 +1,4 @@
-import json
 import sys
-from typing import Union, Dict
 
 from pathlib import Path
 from loguru import logger, _Logger as Logger
@@ -13,34 +11,38 @@ class LoggerConfigError(Exception):
 class LoggerCustomizer:
 
     @classmethod
-    def make_logger(cls, config_file_or_dict: Union[Path, Dict],
-                    logger_name: str) -> Logger:
-        """Creates a loguru logger from given configuration path or dict.
+    def make_logger(cls, log_path: Path,
+                    log_filename: str,
+                    log_level: str,
+                    log_rotation_interval: str,
+                    log_retention_interval: str,
+                    log_format: str) -> Logger:
+        """Creates a logger from given configurations
 
         Args:
-            config_file_or_dict (Union[Path, Dict]): Path to logger
-            configuration file or dictionary of configuration
-            logger_name (str): Logger instance created from configuration
+            log_path (Path): Path where the log file is located
+            log_filename (str):
+
+            log_level (str): The level we want to start logging from
+            log_rotation_interval (str): Every how long the logs
+                would be rotated
+            log_retention_interval (str): Amount of time in words defining
+                how long the log will be kept
+            log_format (str): The logging format
 
         Raises:
             LoggerConfigError: Error raised when the configuration is invalid
 
         Returns:
             Logger: Loguru logger instance
         """
-
-        config = cls.load_logging_config(config_file_or_dict)
         try:
-            logging_config = config.get(logger_name)
-            logs_path = logging_config.get('path')
-            log_file_path = logging_config.get('filename')
-
             logger = cls.customize_logging(
-                file_path=Path(logs_path) / Path(log_file_path),
-                level=logging_config.get('level'),
-                retention=logging_config.get('retention'),
-                rotation=logging_config.get('rotation'),
-                format=logging_config.get('format')
+                file_path=Path(log_path) / Path(log_filename),
+                level=log_level,
+                retention=log_retention_interval,
+                rotation=log_rotation_interval,
+                format=log_format
             )
         except (TypeError, ValueError) as err:
             raise LoggerConfigError(
@@ -90,21 +92,3 @@ def customize_logging(cls,
         )
 
         return logger
-
-    @classmethod
-    def load_logging_config(cls, config: Union[Path, Dict]) -> Dict:
-        """Loads logging configuration from file or dict
-
-        Args:
-            config (Union[Path, Dict]): Path to logging configuration file
-
-        Returns:
-            Dict: Configuration parsed as dictionary
-        """
-        if isinstance(config, Path):
-            with open(config) as config_file:
-                used_config = json.load(config_file)
-        else:
-            used_config = config
-
-        return used_config

app/internal/logger_customizer.py

@@ -6,9 +6,7 @@
 from app.dependencies import (
     MEDIA_PATH, STATIC_PATH, templates)
 from app.routers import agenda, event, profile, email, invitation
-
 from app.internal.logger_customizer import LoggerCustomizer
-
 from app import config
 
 models.Base.metadata.create_all(bind=engine)
@@ -18,7 +16,12 @@
 app.mount("/media", StaticFiles(directory=MEDIA_PATH), name="media")
 
 # Configure logger
-logger = LoggerCustomizer.make_logger(config.LOGGER, "logger")
+logger = LoggerCustomizer.make_logger(config.LOG_PATH,
+                                      config.LOG_FILENAME,
+                                      config.LOG_LEVEL,
+                                      config.LOG_ROTATION_INTERVAL,
+                                      config.LOG_RETENTION_INTERVAL,
+                                      config.LOG_FORMAT)
 app.logger = logger
 
 

app/main.py

@@ -10,17 +10,12 @@
 
 @pytest.fixture(scope='module')
 def logger_instance():
-    _logger = LoggerCustomizer.make_logger(config.LOGGER, "logger")
-
-    return _logger
-
-
-@pytest.fixture(scope='module')
-def logger_external_configuration():
-    from pathlib import Path
-    config_path = Path(__file__).parent
-    config_path = config_path.absolute() / 'logging_config.json'
-    _logger = LoggerCustomizer.make_logger(config_path, "logger1")
+    _logger = LoggerCustomizer.make_logger(config.LOG_PATH,
+                                           config.LOG_FILENAME,
+                                           config.LOG_LEVEL,
+                                           config.LOG_ROTATION_INTERVAL,
+                                           config.LOG_RETENTION_INTERVAL,
+                                           config.LOG_FORMAT)
 
     return _logger
 

tests/logger_fixture.py

@@ -3,15 +3,10 @@
 import pytest
 
 from app.internal.logger_customizer import LoggerCustomizer, LoggerConfigError
+from app import config
 
 
 class TestLogger:
-    @staticmethod
-    def test_configuration_file(caplog, logger_external_configuration):
-        with caplog.at_level(logging.ERROR):
-            logger_external_configuration.error('Testing configuration ERROR')
-            assert 'Testing configuration' in caplog.text
-
     @staticmethod
     def test_log_debug(caplog, logger_instance):
         with caplog.at_level(logging.DEBUG):
@@ -38,18 +33,10 @@ def test_log_critical(caplog, logger_instance):
 
     @staticmethod
     def test_bad_configuration():
-        bad_config = {
-            "logger": {
-                "path": "./var/log",
-                "filename": "calendar.log",
-                "level": "eror",
-                "rotation": "20 days",
-                "retention": "1 month",
-                "format": ("<level>{level: <8}</level> "
-                           "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green>"
-                           "- <cyan>{name}</cyan>:<cyan>{function}</cyan>"
-                           " - <level>{message}</level>")
-            }
-        }
         with pytest.raises(LoggerConfigError):
-            LoggerCustomizer.make_logger(bad_config, 'logger')
+            LoggerCustomizer.make_logger(config.LOG_PATH,
+                                         config.LOG_FILENAME,
+                                         'eror',
+                                         config.LOG_ROTATION_INTERVAL,
+                                         config.LOG_RETENTION_INTERVAL,
+                                         config.LOG_FORMAT)