[FEAT] Added custom logger function (#17)

* chore: replace print with logger

* feat: create custom logger function

* chore: add gitignore file

* config: use dictConfig to tweak logger

* chore: call the configure logging function

* feat: check log directory and file existence

* chore: replace print with logger

* chore: change log level to warn

* chore: customize warn level message

Author: yubinkarki

.gitignore

@@ -98,9 +98,12 @@ venv_*/
 .nvimrc
 .vimrc
 
+/logs/*
 mypy.ini
+*.DS_Store
+
 # Output Directories
 output
 result
 results
-outputs
+outputs

school_center.py

@@ -9,10 +9,17 @@
 import math
 import csv
 import random
+import logging
 import argparse
 import os
 from typing import Dict, List
 
+from utils.custom_logger import configure_logging
+
+
+configure_logging()
+
+logger = logging.getLogger(__name__)
 
 def create_dir(dirPath:str):
     """
@@ -201,11 +208,10 @@ def is_allocated(scode1: str, scode2:str) -> bool:
 
         if to_allot > 0: 
             remaining+=to_allot
-            print(f"{to_allot}/{s['count']} left for {s['scode']} {s['name-address']} centers: {len(centers_for_school)}")
+            logger.warn(f"{to_allot}/{s['count']} left for {s['scode']} {s['name-address']} centers: {len(centers_for_school)}")
 
 
-    print("Remaining capacity at each center (remaining_capacity cscode):")
-    print(sorted([(v,k) for k, v in centers_remaining_cap.items() if v != 0]))
-    print(f"Total remaining capacity across all centers: {sum({k:v for k, v in centers_remaining_cap.items() if v != 0}.values())}")
-    print(f"Students not assigned: {remaining}")
-
+    logger.info("Remaining capacity at each center (remaining_capacity cscode):")
+    logger.info(sorted([(v,k) for k, v in centers_remaining_cap.items() if v != 0]))
+    logger.info(f"Total remaining capacity across all centers: {sum({k:v for k, v in centers_remaining_cap.items() if v != 0}.values())}")
+    logger.info(f"Students not assigned: {remaining}")

utils/custom_file_handler.py

@@ -0,0 +1,12 @@
+"""File handler with a few tweaks."""
+
+from logging import FileHandler
+
+
+class CustomFileHandler(FileHandler):
+    """Custom logging file handler that adds an extra line at the EOF."""
+
+    def close(self):
+        if self.stream is not None:
+            self.stream.write("")
+        super().close()

utils/custom_logger.py

@@ -0,0 +1,79 @@
+"""Custom logging module with some formatting."""
+
+import os
+import sys
+import logging.config
+from os.path import abspath, dirname, join, exists
+
+
+ROOT_DIR: str = abspath(dirname(dirname(__file__)))
+LOGS_DIR: str = join(ROOT_DIR, "logs")
+LOGS_TARGET: str = join(ROOT_DIR, "logs", "custom_logs.log")
+CUSTOM_FILE_HANDLER_PATH = "utils.custom_file_handler.CustomFileHandler"
+
+if not exists(LOGS_DIR):
+    os.makedirs(LOGS_DIR)
+
+if not exists(LOGS_TARGET):
+    with open(LOGS_TARGET, "a", encoding="utf-8") as file:
+        os.utime(LOGS_TARGET, None)
+
+
+LOGGING_CONFIG: dict = {
+    "version": 1,
+    "formatters": {
+        "standard": {
+            "datefmt": "%y-%m-%d %H:%M:%S",
+            "format": "🚀 %(asctime)s - %(name)s - %(levelname)s - %(message)s \n",
+        },
+        "warn": {
+            "datefmt": "%y-%m-%d %H:%M:%S",
+            "format": "🔔 %(asctime)s - %(name)s - %(levelname)s - %(message)s \n",
+        },
+        "error": {
+            "datefmt": "%y-%m-%d %H:%M:%S",
+            "format": "❌ %(asctime)s - %(name)s - %(levelname)s - %(message)s \n",
+        },
+    },
+    "handlers": {
+        "file_error": {
+            "mode": "a",
+            "level": "ERROR",
+            "encoding": "utf-8",
+            "formatter": "error",
+            "filename": LOGS_TARGET,
+            "class": CUSTOM_FILE_HANDLER_PATH,
+        },
+        "console_info": {
+            "level": "INFO",
+            "stream": sys.stdout,
+            "formatter": "standard",
+            "class": "logging.StreamHandler",
+        },
+        "console_warn": {
+            "level": "WARN",
+            "formatter": "warn",
+            "stream": sys.stdout,
+            "class": "logging.StreamHandler",
+        },
+        "console_error": {
+            "level": "ERROR",
+            "stream": sys.stderr,
+            "formatter": "error",
+            "class": "logging.StreamHandler",
+        },
+    },
+    "loggers": {
+        "": {
+            "level": "INFO",
+            "propagate": True,
+            "handlers": ["file_error", "console_info", "console_warn", "console_error"],
+        }
+    },
+}
+
+
+# Call this once to initialize logger
+def configure_logging() -> None:
+    """Pass the logging configuration to logger."""
+    logging.config.dictConfig(LOGGING_CONFIG)