mostly working

Author: UndyingSoul

.gitignore

@@ -158,3 +158,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+images/
+.DS_Store

config/logging.conf

@@ -0,0 +1,47 @@
+[loggers]
+keys=root
+
+[handlers]
+keys=stdout, stderr, file
+
+[formatters]
+keys=timestampedLog, levelLog, simpleLog, timestampedLogWithName
+
+[logger_root]
+level=DEBUG
+handlers=stdout, stdout, file
+
+[handler_stdout]
+class=StreamHandler
+level=DEBUG
+formatter=simpleLog
+stream=ext://sys.stdout
+
+[handler_stderr]
+class=StreamHandler
+level=ERROR
+formatter=levelLog
+stream=ext://sys.stdout
+
+[handler_file]
+class=handlers.TimedRotatingFileHandler
+level=DEBUG
+formatter=timestampedLogWithName
+args=('logs/latest.log', "D", 1, 0)
+
+[formatter_timestampedLogWithName]
+format=[%(asctime)-15s] %(levelname)-10s : %(message)s (%(locationClickable)s)
+
+[formatter_timestampedLog]
+format=%(asctime)-15s %(levelname)-10s: %(message)s
+
+[formatter_levelLog]
+format=%(levelname)-8s: %(message)s
+
+[formatter_simpleLog]
+class=utils.Logger.ColorFormatter
+format=%(message)s
+
+[formatter_customLogging]
+class=utils.Logger.CustomFormatter
+format=%(message)s

config/settings.json

@@ -0,0 +1,4 @@
+{
+  "logToFile": true,
+  "loggingLevel": "INFO"
+}

requirements.txt

@@ -0,0 +1,4 @@
+pillow==10.0.0
+pillow-avif-plugin==1.3.1
+argparse==1.4.0
+colorama==0.4.6

utils/Logger.py

@@ -0,0 +1,111 @@
+from colorama import Fore, Back
+import logging
+import logging.config
+from logging.handlers import TimedRotatingFileHandler
+import os
+import pathlib
+from utils.Settings import Setting as st
+Setting = st()
+
+RESET_SEQ = "\033[0m"
+COLOR_SEQ = "\033[1;%dm"
+BOLD_SEQ = "\033[1m"
+
+SECTION_LEVEL_NUM = 9
+
+
+class ColorFormatter(logging.Formatter):
+
+    def __init__(self, *args, **kwargs):
+        # can't do super(...) here because Formatter is an old school class
+        logging.Formatter.__init__(self, *args, **kwargs)
+
+    def format(self, record):
+        if record.levelno == logging.DEBUG:
+            self._style._fmt = Fore.LIGHTBLACK_EX + "%(message)s" + RESET_SEQ
+        elif record.levelno == logging.ERROR:
+            self._style._fmt = Fore.RED + \
+                "%(levelname)s: %(message)s" + RESET_SEQ
+        elif record.levelno == logging.CRITICAL:
+            self._style._fmt = Back.WHITE + Fore.RED + \
+                "%(levelname)s: %(message)s" + RESET_SEQ
+        elif record.levelno == logging.WARNING:
+            self._style._fmt = Fore.YELLOW + \
+                "%(levelname)s: %(message)s" + RESET_SEQ
+        elif record.levelno == logging.HEADER:
+            self._style._fmt = Fore.LIGHTBLUE_EX + \
+                "\n--- %(message)s ---" + RESET_SEQ
+        elif record.levelno == logging.COMPLETION:
+            self._style._fmt = Fore.GREEN + \
+                "\n--- %(message)s ---" + RESET_SEQ
+        elif record.levelno == logging.NOTE:
+            self._style._fmt = Fore.LIGHTBLUE_EX + \
+                "Note: " + RESET_SEQ + "%(message)s" + RESET_SEQ
+        else:
+            self._style._fmt = "%(message)s"
+        return super().format(record)
+
+
+def combining_filter(record):
+    record.location = '%s:%s:%s' % (
+        record.module, record.funcName, record.lineno)
+    record.locationClickable = '%s:%s' % (record.filename, record.lineno)
+    return True
+
+
+def setup_logging(
+    default_config='./config/logging.conf',
+    default_level=Setting.loggingLevel
+):
+    """
+    Setup logging configuration
+    """
+    triedToCreateFile = False
+    for i in range(0, 2):
+        try:
+            if os.path.exists(default_config):
+                logging.config.fileConfig(
+                    default_config, disable_existing_loggers=False)
+            else:
+                logging.basicConfig(level=default_level)
+        except (FileNotFoundError, OSError) as fnfe:
+            try:
+                loggingFilePath = pathlib.Path(fnfe.filename).parent
+                loggingFilePath.mkdir(parents=True, exist_ok=True)
+            except Exception as e:
+                pass
+            if triedToCreateFile:
+                print(
+                    f"{Back.WHITE}{Fore.RED}CRITICAL: Cannot find or create the logging directory or file, exiting{Back.RESET}{Fore.RESET}")
+                raise SystemExit(1)
+            else:
+                print(
+                    f"{Fore.RED}ERROR: Cannot find or create the logging directory or file {loggingFilePath}, creating one..{Fore.RESET}")
+                triedToCreateFile = True
+                continue
+
+    # logging level of notes should be just higher than info
+    logging.NOTE = 21
+    logging.addLevelName(logging.NOTE, "NOTE")
+
+    # logging level of header should be just higher than info
+    logging.HEADER = 22
+    logging.addLevelName(logging.HEADER, "HEADER")
+
+    # logging level of notes should be just higher than info
+    logging.COMPLETION = 31
+    logging.addLevelName(logging.COMPLETION, "COMPLETION")
+
+    for h in logging.root.handlers:
+        if type(h) == logging.StreamHandler:
+            h.setLevel(Setting.loggingLevel)
+        if type(h) == TimedRotatingFileHandler:
+            if not Setting.logToFile:
+                logging.root.removeHandler(h)
+                continue
+            h.addFilter(combining_filter)
+            h.namer = lambda name: str.replace(
+                name, "latest.log.", "") + ".log"
+            h.setLevel(logging.DEBUG)
+
+    logging.getLogger("PIL").setLevel(logging.DEBUG)

utils/Settings.py

@@ -0,0 +1,36 @@
+import json
+import logging
+import os
+
+
+class Setting():
+    def __init__(self):
+        settingsFileLocation = "./config/settings.json"
+        settingsDictionary = {}
+        LOGGING_LEVEL_MAPPER = {
+            "INFO": logging.INFO,
+            "WARNING": logging.WARNING,
+            "WARN": logging.WARNING,
+            "DEBUG": logging.DEBUG,
+            "ERROR": logging.ERROR,
+            "CRITICAL": logging.CRITICAL,
+        }
+        if os.path.exists(settingsFileLocation):
+            with open(settingsFileLocation, "r") as f:
+                settingsDictionary = json.load(f)
+                
+        self._loggingLevel = LOGGING_LEVEL_MAPPER[settingsDictionary["loggingLevel"]
+                                                  ] if "loggingLevel" in settingsDictionary.keys() else logging.INFO
+        self._logToFile = settingsDictionary["logToFile"] if "logToFile" in settingsDictionary.keys(
+        ) else True
+
+    def alwaysTrue():
+        return True
+
+    @property
+    def loggingLevel(self):
+        return int(self._loggingLevel)
+
+    @property
+    def logToFile(self):
+        return self._logToFile