Made exception handling framework with customizable output formatting

Author: DefinetlyNotAI

exception/__init__.py

@@ -0,0 +1,2 @@
+from .handler import Handler
+from .colors import Colors, Format

exception/colors.py

@@ -0,0 +1,19 @@
+class Colors:
+    RESET = "\033[0m"
+    BLACK = "\033[30m"
+    RED = "\033[31m"
+    GREEN = "\033[32m"
+    YELLOW = "\033[33m"
+    BLUE = "\033[34m"
+    MAGENTA = "\033[35m"
+    CYAN = "\033[36m"
+    WHITE = "\033[37m"
+
+
+class Format:
+    NORMAL = ""
+    BOLD = "\033[1m"
+    DIM = "\033[2m"
+    UNDERLINE = "\033[4m"
+    BLINK = "\033[5m"
+    INVERT = "\033[7m"

exception/handler.py

@@ -0,0 +1,102 @@
+import traceback
+import datetime
+import sys
+import re
+from .colors import Colors, Format
+from .messages import GENERIC_MESSAGES
+
+
+class Handler:
+    def __init__(self,
+                 show_line: bool = False,
+                 trace: bool = False,
+                 use_timestamp: bool = False,
+                 exit_script: bool = False,
+                 print_function: callable = print,
+                 return_string_rather_than_print: bool = False
+                 ):
+        # Handler defaults
+        self.show_line: bool = show_line
+        self.trace: bool = trace
+        self.use_timestamp: bool = use_timestamp
+        self.exit_script: bool = exit_script
+        self.print_function: callable = print_function
+        self.return_string_rather_than_print: bool = return_string_rather_than_print
+
+        # Formatter defaults
+        # # Color wise
+        self.main_color: Colors = Colors.WHITE
+        self.message_color: Colors = self.main_color
+        self.trace_color: Colors = self.main_color
+        self.timestamps_color: Colors = self.main_color
+        # # Format wise
+        self.main_format: Format = Format.NORMAL
+        self.message_text_format: Format = self.main_format
+        self.trace_text_format: Format = self.main_format
+        self.timestamps_text_format: Format = self.main_format
+        # # # Datetime wise
+        self.datetime_format: str = "%Y-%m-%d %H:%M:%S"
+
+    def formatter(self,
+                  main_format: Format = None,
+                  timestamps_format: Format = None,
+                  trace_format: Format = None,
+                  message_format: Format = None,
+                  main_color: Colors = None,
+                  timestamps_color: Colors = None,
+                  trace_color: Colors = None,
+                  message_color: Colors = None,
+                  datetime_format: str = None
+                  ):
+        # Format wise
+        self.main_format: Format = main_format or self.main_format  # Default to the main format
+        self.timestamps_text_format: Format = timestamps_format or self.main_format
+        self.trace_text_format: Format = trace_format or self.main_format
+        self.message_text_format: Format = message_format or self.main_format
+
+        # Color wise
+        self.main_color: Colors = main_color or self.main_color  # Default to the main main_color
+        self.timestamps_color: Colors = timestamps_color or self.main_color
+        self.trace_color: Colors = trace_color or self.main_color
+        self.message_color: Colors = message_color or self.main_color
+
+        # Datetime format
+        self.datetime_format: str = datetime_format if datetime_format else self.datetime_format
+
+    @staticmethod
+    def _fallback_message(exc_type):
+        exc_name = exc_type.__name__
+        readable = re.sub(r'(?<!^)(?=[A-Z])', ' ', exc_name)
+        return f"{readable} occurred [Unknown Exception for handler],"
+
+    def exception(self,
+                  msg=None,
+                  exit_script=None,
+                  quit_code=1,
+                  return_string_rather_than_print: bool = False
+                  ):
+        exc_type, exc_obj, tb = sys.exc_info()
+        line: str = tb.tb_lineno if tb and self.show_line else ''
+        trace_str: str = ''.join(traceback.format_exception(exc_type, exc_obj, tb)) if self.trace else ''
+
+        readable: str = GENERIC_MESSAGES.get(exc_type, self._fallback_message(exc_type))
+        time_str: str = datetime.datetime.now().strftime(self.datetime_format) if self.use_timestamp else ''
+
+        final_msg: str = (
+            f"{self.timestamps_text_format}{self.timestamps_color}{time_str}{Colors.RESET} > "
+            f"{self.message_text_format}{self.message_color}{readable}"
+            f"{'' if line == '' else f' on line {line}'}"
+            f"{'' if not msg else f' in-detailed info: {msg}'}{Colors.RESET}"
+        )
+
+        if self.trace:
+            final_msg += (
+                f"\n{self.trace_text_format}{self.trace_color}{trace_str}{Colors.RESET}"
+            )
+
+        if (return_string_rather_than_print is None and self.return_string_rather_than_print) or return_string_rather_than_print:
+            return final_msg
+        self.print_function(final_msg)
+
+        if (exit_script is None and self.exit_script) or exit_script:
+            sys.exit(quit_code)

exception/messages.py

@@ -0,0 +1,69 @@
+GENERIC_MESSAGES = {
+    BaseException: "A critical error occurred at the base exception level,",
+    BaseExceptionGroup: "A group of exceptions was raised simultaneously,",
+    Exception: "An unexpected error occurred,",
+    GeneratorExit: "A generator was closed before completing,",
+    KeyboardInterrupt: "Execution was stopped manually — usually by pressing Ctrl+C,",
+    SystemExit: "The program was told to exit,",
+    ArithmeticError: "A mathematical operation has gone wrong,",
+    AssertionError: "An internal check failed — something unexpected happened,",
+    AttributeError: "You tried to access an attribute that doesn't exist on this object,",
+    BufferError: "A buffer-related operation failed,",
+    EOFError: "Unexpected end of input — likely reading past the end of a file or input stream,",
+    ImportError: "Python couldn't import the requested module or object,",
+    LookupError: "A generic lookup operation failed (e,g,, index or key lookup),",
+    MemoryError: "The system ran out of memory while trying to complete the operation,",
+    NameError: "You tried to use a variable or function that hasn’t been defined,",
+    OSError: "A system-related operation failed — like accessing a file or device,",
+    ReferenceError: "A failed reference was used after the object was deleted,",
+    RuntimeError: "Something unexpected happened during runtime,",
+    StopAsyncIteration: "Async iteration finished — nothing more to yield,",
+    StopIteration: "Iteration has finished — the loop is done,",
+    SyntaxError: "There's a syntax error in your Python code,",
+    SystemError: "A low-level internal error occurred,",
+    TypeError: "An operation received a value of the wrong type,",
+    ValueError: "The value was the right type but made no sense,",
+    Warning: "A generic warning was raised,",
+    FloatingPointError: "A floating point calculation failed,",
+    OverflowError: "A number became too large to handle,",
+    ZeroDivisionError: "You tried to divide by zero — that's not allowed,",
+    BytesWarning: "Warning related to bytes or bytecode operations,",
+    DeprecationWarning: "You're using a deprecated feature that will be removed soon,",
+    EncodingWarning: "Warning related to encoding operations,",
+    FutureWarning: "You're using a feature that will change in future versions,",
+    ImportWarning: "There was something suspicious during an import,",
+    PendingDeprecationWarning: "This feature is going away soon — but not just yet,",
+    ResourceWarning: "A resource was not properly managed (e,g, file left open),",
+    RuntimeWarning: "A runtime condition was suspicious but not fatal,",
+    SyntaxWarning: "Something is wrong in the code's syntax but not fatal,",
+    UnicodeWarning: "Detected problematic Unicode operation,",
+    UserWarning: "A custom warning generated by the user,",
+    BlockingIOError: "A non-blocking operation couldn’t proceed immediately,",
+    ChildProcessError: "A child process operation failed,",
+    ConnectionError: "A connection-related issue occurred,",
+    FileExistsError: "The file already exists and can't be created again,",
+    FileNotFoundError: "The specified file was not found,",
+    InterruptedError: "A system call was interrupted by a signal,",
+    IsADirectoryError: "Tried to treat a directory like a file,",
+    NotADirectoryError: "Tried to access something as a directory but it's a file,",
+    PermissionError: "You don't have permission to perform this action,",
+    ProcessLookupError: "The specified process does not exist,",
+    TimeoutError: "An operation took too long and timed out,",
+    IndentationError: "Your code indentation is incorrect,",
+    IndexError: "You're trying to access a list or array index that doesn’t exist,",
+    KeyError: "You're using a key that isn’t present in the dictionary,",
+    ModuleNotFoundError: "Tried to import a module that doesn’t exist,",
+    NotImplementedError: "A feature was called that hasn’t been implemented yet,",
+    RecursionError: "Your code called itself too many times — infinite recursion?",
+    UnboundLocalError: "You tried to use a local variable before giving it a value,",
+    UnicodeError: "A Unicode-related error occurred,",
+    BrokenPipeError: "Tried writing to a pipe that's no longer open,",
+    ConnectionAbortedError: "The connection was closed by the remote host,",
+    ConnectionRefusedError: "The remote host actively refused the connection,",
+    ConnectionResetError: "The connection was forcibly closed by the remote host,",
+    TabError: "You mixed tabs and spaces — Python doesn't allow that,",
+    UnicodeDecodeError: "Failed to decode a byte sequence,",
+    UnicodeEncodeError: "Failed to encode text into bytes,",
+    UnicodeTranslateError: "Failed to translate characters during encoding,",
+    ExceptionGroup: "Multiple exceptions occurred simultaneously,"
+}