SwiftGUI_Logging 0.1.3__tar.gz → 0.1.4__tar.gz

{swiftgui_logging-0.1.3 → swiftgui_logging-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SwiftGUI_Logging
-Version: 0.1.3
+Version: 0.1.4
 Summary: A collection of helpful logging-functionality based on the logging package
 License-Expression: Apache-2.0
 License-File: LICENSE

{swiftgui_logging-0.1.3 → swiftgui_logging-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "SwiftGUI_Logging"
-version = "0.1.3"
+version = "0.1.4"
 packages = [
     { include = "SwiftGUI_Logging", from = "src" }
 ]

{swiftgui_logging-0.1.3 → swiftgui_logging-0.1.4}/src/SwiftGUI_Logging/Configs/ExceptionLogging.py

@@ -11,6 +11,9 @@ def exceptions_to_file(
         buffer_size: int = 5000,
         trigger_level: int = logging.ERROR,
         log_level: int = logging.DEBUG,
+        include_main_thread: bool = True,
+        include_threads: bool = True,
+        include_tkinter: bool = True,
         reraise: bool = False,
         datetime_format: str = "_%Y-%m-%d_%H-%M-%S",
         formatter_format: str = "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
@@ -29,6 +32,9 @@ def exceptions_to_file(
     :param buffer_size: How many reports are saved before the first ones are overritten again
     :param trigger_level: Level at which the exceptions are treated. Reports at and above this level trigger a file-write
     :param log_level: Logs below this level are ignored and not written to the file
+    :param include_main_thread: True, if the "normal thread's" exceptions should be caught
+    :param include_threads: True, if Thread-exceptions should be caught too
+    :param include_tkinter: True, if Tkinter-exceptions should be caught too
     :param reraise: True, if the exception should still be raised, even though it was logged. Good for debugging purposes
     :param datetime_format: Format of the timestamp that extends the filename
     :param formatter_format: Format of the log-entries in the file
@@ -71,5 +77,13 @@ def exceptions_to_file(
 
     logger.addHandler(buffer_handler)
 
-    sgl.reroute_exceptions(logger, reraise=reraise, loglevel=trigger_level, pass_text_to_function=exception_occured)
+    sgl.reroute_exceptions(
+        logger,
+        reraise=reraise,
+        loglevel=trigger_level,
+        pass_text_to_function=exception_occured,
+        include_main_thread=include_main_thread,
+        include_threads=include_threads,
+        include_tkinter=include_tkinter,
+    )
 

{swiftgui_logging-0.1.3 → swiftgui_logging-0.1.4}/src/SwiftGUI_Logging/ExceptionHandling.py

@@ -1,8 +1,13 @@
 import logging.handlers
+import threading
 import traceback
 import sys
 from typing import Callable, Any
 
+try:
+    import tkinter as tk
+except ImportError:
+    tk = None
 
 def reroute_exceptions(
         logger: logging.Logger = logging.getLogger(),
@@ -10,6 +15,9 @@ def reroute_exceptions(
         *,
         logger_warnings: logging.Logger = None,
         loglevel_warnings: int = logging.WARNING,
+        include_main_thread: bool = True,
+        include_threads: bool = True,
+        include_tkinter: bool = True,
         reraise: bool = False,
         print_to_console: bool = False,
         pass_text_to_function: Callable[[str], Any] = None,
@@ -21,7 +29,10 @@ def reroute_exceptions(
     :param loglevel: The loglevel for EXCEPTIONS
     :param logger_warnings: The logger where WARNINGS go
     :param loglevel_warnings: The level of logging for WARNINGS
-    :param reraise: True, if the exception should be raised again
+    :param reraise: True, if the exception should be raised again. THIS DOESN'T WORK FOR THREAD EXCEPTIONS!
+    :param include_main_thread: True, if the "normal thread's" exceptions should be caught
+    :param include_threads: True, if Thread-exceptions should be caught too
+    :param include_tkinter: True, if Tkinter-exceptions should be caught too
     :param pass_text_to_function: Pass a function/method and the exception-text is passed to it
     :param print_to_console: True, if the text should be printed to the console using print(...)
     :return:
@@ -32,8 +43,8 @@ def reroute_exceptions(
     if loglevel_warnings is None:
         loglevel_warnings = loglevel
 
-    def catch(exctype, value, tb):
-        text = "".join(traceback.format_exception(exctype, value, tb))
+    def catch(exctype, value, tb, additional_text: str = ""):
+        text = additional_text + "".join(traceback.format_exception(exctype, value, tb))
 
         if issubclass(exctype, Warning):    # Warnings
             if logger_warnings is not None:
@@ -58,7 +69,31 @@ def reroute_exceptions(
         if print_to_console:
             print(text)
 
+    def catch_normal(exctype, value, tb):
+        catch(exctype, value, tb)
         if reraise:
             sys.__excepthook__(exctype, value, tb)
 
-    sys.excepthook = catch
+    def catch_thread(exc: threading.ExceptHookArgs):
+        catch(exc.exc_type, exc.exc_value, exc.exc_traceback, f"On thread {exc.thread}:\n")
+
+    if include_main_thread:
+        sys.excepthook = catch_normal
+
+    if include_threads:
+        threading.excepthook = catch_thread
+
+    if include_tkinter and tk is not None:
+        # Catch tkinter exceptions
+        actual_callback = tk.Tk.report_callback_exception
+        def catch_tkinter(self, exctype, value, tb):
+            catch(exctype, value, tb, additional_text="Tkinter exception:\n")
+
+            if reraise:
+                actual_callback(self, exctype, value, tb)   # I know this shows warnings, but it works
+
+        tk.Tk.report_callback_exception = catch_tkinter
+
+
+
+

{swiftgui_logging-0.1.3 → swiftgui_logging-0.1.4}/src/SwiftGUI_Logging/MemoryHandlerRotatingBuffer.py

@@ -20,7 +20,6 @@ class MemoryHandlerRotatingBuffer(logging.handlers.MemoryHandler):
         """
         super().__init__(capacity, flushLevel, target, flushOnClose=False)
         self.call_after_flushing = call_after_flushing if call_after_flushing else lambda *_:_
-        self._should_flush = False
 
     def shouldFlush(self, record):
         """
@@ -31,17 +30,10 @@ class MemoryHandlerRotatingBuffer(logging.handlers.MemoryHandler):
         if len(self.buffer) > self.capacity:    # Remove 0th element so the buffer doesn't "overflow"
             self.buffer.pop(0)
 
-        if record.levelno >= self.flushLevel:
-            self._should_flush = True
-            return True
-
-        return False
+        return record.levelno >= self.flushLevel
 
     def flush(self):
-        super().flush() # Don't put this in the if, this is necessary due to Python-magic...
-
-        if self._should_flush:
-            self.call_after_flushing()
-            self._should_flush = False
+        super().flush()
+        self.call_after_flushing()