SwiftGUI_Logging 0.1.0__tar.gz → 0.1.2__tar.gz

swiftgui_logging-0.1.2/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: SwiftGUI_Logging
+Version: 0.1.2
+Summary: A collection of helpful logging-functionality based on the logging package
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: Eric aka CheesecakeTV
+Author-email: cheesecaketv53+pypi@gmail.com
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Project-URL: Documentation, https://github.com/CheesecakeTV/SwiftGUI-Docs
+Project-URL: Repository, https://github.com/CheesecakeTV/SwiftGUI-Logging
+Project-URL: issues, https://github.com/CheesecakeTV/SwiftGUI/issues
+Description-Content-Type: text/markdown
+
+
+# SwiftGUI-Logging: Motivation
+A small package ment to extend logging to better fit actual applications.
+
+Before getting into the logging-package, I usually implemented 
+something like this (but more complicated):
+```py
+def main():
+    ...
+
+if __name__ == "__main__":
+    try:
+        main()  # Run the main program
+    except Exception as ex: # An exception occured
+        with open("Crashlog.txt", "w") as f:    # Save exception to file
+            f.write(str(ex))
+```
+If `main()` causes an exception, the file `Crashlog.txt` is created
+containing information about the exception.
+That means, only "the interesting logs" take up storage space.
+
+Unfortunately, you can't implement such a functionality using the 
+logging-package.
+
+Until now.
+
+SwiftGUI-Logging provides a very easy way to set up crashlogs that 
+are fully compatible with the logging-package.
+
+# Basic usage
+## Installation
+Install the package by running this on your terminal:
+```bash
+pip install SwiftGUI_Logging
+```
+
+## Crashlogging to a file
+Simply call `SwiftGUI_Logging.Configs.exceptions_to_file(filepath)` 
+to set up the crashlogger.
+
+That's all.
+
+Example:
+```py
+import time
+import SwiftGUI_Logging as sgl
+import logging
+
+def main():
+    for i in range(10):
+        logging.debug(f"Test {i}")
+        print(i)
+        time.sleep(0.25)
+
+    logging.info("Crashing the program now")
+
+    1 / 0   # Cause a ZeroDivisionError, which crashes the program
+
+if __name__ == '__main__':
+    sgl.Configs.exceptions_to_file("Crashlogs/Crash.log") # Set up the crash-log
+    main()  # Execute program
+```
+
+You'll find that the directory `Crashlogs` was created.
+After the program executes, the directory contains a file like
+`Crash_2026-02-24_16-33-52.log`.
+
+As you can see, the time of the crash was inserted into the 
+filename, so that multiple crashlogs don't overwrite each other.
+
+The file contains the most recent log-entries (from `logging.debug`)
+and the exception with full traceback:
+```log
+2026-02-24 16:33:49,940 - root - DEBUG - Test 0
+2026-02-24 16:33:50,197 - root - DEBUG - Test 1
+2026-02-24 16:33:50,451 - root - DEBUG - Test 2
+2026-02-24 16:33:50,704 - root - DEBUG - Test 3
+2026-02-24 16:33:50,958 - root - DEBUG - Test 4
+2026-02-24 16:33:51,214 - root - DEBUG - Test 5
+2026-02-24 16:33:51,469 - root - DEBUG - Test 6
+2026-02-24 16:33:51,723 - root - DEBUG - Test 7
+2026-02-24 16:33:51,979 - root - DEBUG - Test 8
+2026-02-24 16:33:52,235 - root - DEBUG - Test 9
+2026-02-24 16:33:52,490 - root - INFO - Crashing the program now
+2026-02-24 16:33:52,490 - root - ERROR - Traceback (most recent call last):
+  File "C:\Users\chees\PycharmProjects\SwiftGUI-Logging\tests\test.py", line 17, in <module>
+    main()  # Execute program
+  File "C:\Users\chees\PycharmProjects\SwiftGUI-Logging\tests\test.py", line 13, in main
+    1 / 0   # Cause a ZeroDivisionError, which crashes the program
+ZeroDivisionError: division by zero
+```
+
+`sgl.Configs.exceptions_to_file` can do a bit more, but for most programs,
+the default configuration is fine.
+
+## Other functionality
+`SwiftGUI_Logging` provides some other functionality, but these
+aren't nearly as important as the `exceptions_to_file`-function.
+
+A detailed documentation will follow.
+
+# SwiftGUI
+This package was written as an addition to 
+my Python GUI-package `SwiftGUI`:
+https://github.com/CheesecakeTV/SwiftGUI
+
+Since `SwiftGUI_Logging` itself has nothing to to with GUIs, 
+it is its own package.
+
+Consider checking out `SwiftGUI` if you want to easily create 
+user-interfaces for python.
+If you already know the package `PySimpleGUI`, you'll learn the 
+basics of`SwiftGUI` with little to no effort.
+
+
+

swiftgui_logging-0.1.2/README.md

@@ -0,0 +1,115 @@
+
+# SwiftGUI-Logging: Motivation
+A small package ment to extend logging to better fit actual applications.
+
+Before getting into the logging-package, I usually implemented 
+something like this (but more complicated):
+```py
+def main():
+    ...
+
+if __name__ == "__main__":
+    try:
+        main()  # Run the main program
+    except Exception as ex: # An exception occured
+        with open("Crashlog.txt", "w") as f:    # Save exception to file
+            f.write(str(ex))
+```
+If `main()` causes an exception, the file `Crashlog.txt` is created
+containing information about the exception.
+That means, only "the interesting logs" take up storage space.
+
+Unfortunately, you can't implement such a functionality using the 
+logging-package.
+
+Until now.
+
+SwiftGUI-Logging provides a very easy way to set up crashlogs that 
+are fully compatible with the logging-package.
+
+# Basic usage
+## Installation
+Install the package by running this on your terminal:
+```bash
+pip install SwiftGUI_Logging
+```
+
+## Crashlogging to a file
+Simply call `SwiftGUI_Logging.Configs.exceptions_to_file(filepath)` 
+to set up the crashlogger.
+
+That's all.
+
+Example:
+```py
+import time
+import SwiftGUI_Logging as sgl
+import logging
+
+def main():
+    for i in range(10):
+        logging.debug(f"Test {i}")
+        print(i)
+        time.sleep(0.25)
+
+    logging.info("Crashing the program now")
+
+    1 / 0   # Cause a ZeroDivisionError, which crashes the program
+
+if __name__ == '__main__':
+    sgl.Configs.exceptions_to_file("Crashlogs/Crash.log") # Set up the crash-log
+    main()  # Execute program
+```
+
+You'll find that the directory `Crashlogs` was created.
+After the program executes, the directory contains a file like
+`Crash_2026-02-24_16-33-52.log`.
+
+As you can see, the time of the crash was inserted into the 
+filename, so that multiple crashlogs don't overwrite each other.
+
+The file contains the most recent log-entries (from `logging.debug`)
+and the exception with full traceback:
+```log
+2026-02-24 16:33:49,940 - root - DEBUG - Test 0
+2026-02-24 16:33:50,197 - root - DEBUG - Test 1
+2026-02-24 16:33:50,451 - root - DEBUG - Test 2
+2026-02-24 16:33:50,704 - root - DEBUG - Test 3
+2026-02-24 16:33:50,958 - root - DEBUG - Test 4
+2026-02-24 16:33:51,214 - root - DEBUG - Test 5
+2026-02-24 16:33:51,469 - root - DEBUG - Test 6
+2026-02-24 16:33:51,723 - root - DEBUG - Test 7
+2026-02-24 16:33:51,979 - root - DEBUG - Test 8
+2026-02-24 16:33:52,235 - root - DEBUG - Test 9
+2026-02-24 16:33:52,490 - root - INFO - Crashing the program now
+2026-02-24 16:33:52,490 - root - ERROR - Traceback (most recent call last):
+  File "C:\Users\chees\PycharmProjects\SwiftGUI-Logging\tests\test.py", line 17, in <module>
+    main()  # Execute program
+  File "C:\Users\chees\PycharmProjects\SwiftGUI-Logging\tests\test.py", line 13, in main
+    1 / 0   # Cause a ZeroDivisionError, which crashes the program
+ZeroDivisionError: division by zero
+```
+
+`sgl.Configs.exceptions_to_file` can do a bit more, but for most programs,
+the default configuration is fine.
+
+## Other functionality
+`SwiftGUI_Logging` provides some other functionality, but these
+aren't nearly as important as the `exceptions_to_file`-function.
+
+A detailed documentation will follow.
+
+# SwiftGUI
+This package was written as an addition to 
+my Python GUI-package `SwiftGUI`:
+https://github.com/CheesecakeTV/SwiftGUI
+
+Since `SwiftGUI_Logging` itself has nothing to to with GUIs, 
+it is its own package.
+
+Consider checking out `SwiftGUI` if you want to easily create 
+user-interfaces for python.
+If you already know the package `PySimpleGUI`, you'll learn the 
+basics of`SwiftGUI` with little to no effort.
+
+

{swiftgui_logging-0.1.0 → swiftgui_logging-0.1.2}/pyproject.toml

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

{swiftgui_logging-0.1.0 → swiftgui_logging-0.1.2}/src/SwiftGUI_Logging/Configs/ExceptionLogging.py

@@ -37,8 +37,6 @@ def exceptions_to_file(
     filepath = Path(filepath)
     filepath.parent.mkdir(parents=True, exist_ok=True)
 
-    filepath = filepath.parent / (filepath.stem + dt.now().strftime(datetime_format) + filepath.suffix)
-
     if isinstance(logger, str):
         logger = logging.getLogger(logger)
 
@@ -49,21 +47,29 @@ def exceptions_to_file(
     stream_handler.setFormatter(
         logging.Formatter(formatter_format)
     )
-    buffer_handler = sgl.MemoryHandlerRotatingBuffer(buffer_size, trigger_level, target=stream_handler)
-
-    logger.addHandler(buffer_handler)
 
     def exception_occured(*_):
+        nonlocal stream
         stream.seek(0)
+
         if not stream.read(1):
             # Nothing to report
-            print("Nothing to report")
             return
 
-        with open(filepath, "w") as f:
+        # Add current datetime to filename
+        actual_filepath = filepath.parent / (filepath.stem + dt.now().strftime(datetime_format) + filepath.suffix)
+
+        with open(actual_filepath, "a") as f:
             stream.seek(0)
-            #f.write(stream.read())
             shutil.copyfileobj(stream, f)
 
+        stream.close()
+        stream = io.StringIO()  # "Clear" the buffer
+        stream_handler.setStream(stream)
+
+    buffer_handler = sgl.MemoryHandlerRotatingBuffer(buffer_size, trigger_level, target=stream_handler, call_after_flushing=exception_occured)
+
+    logger.addHandler(buffer_handler)
+
     sgl.reroute_exceptions(logger, reraise=reraise, loglevel=trigger_level, pass_text_to_function=exception_occured)
 

{swiftgui_logging-0.1.0 → swiftgui_logging-0.1.2}/src/SwiftGUI_Logging/MemoryHandlerRotatingBuffer.py

@@ -1,9 +1,10 @@
 import logging.handlers
+from typing import Callable
 
 
 class MemoryHandlerRotatingBuffer(logging.handlers.MemoryHandler):
 
-    def __init__(self, capacity, flushLevel=logging.ERROR, target=None):
+    def __init__(self, capacity, flushLevel=logging.ERROR, target=None, call_after_flushing: Callable = None):
         """
         This handler saves the last n records.
         Following records replace the oldest ones.
@@ -14,9 +15,11 @@ class MemoryHandlerRotatingBuffer(logging.handlers.MemoryHandler):
 
         :param capacity: How many records to buffer before the oldest ones get deleted
         :param flushLevel: At which level of record the whole buffer is passed to the target-handler
+        :param call_after_flushing: Call this function after passing the entries to the target
         :param target: Handler to receive all records if necessary
         """
         super().__init__(capacity, flushLevel, target, flushOnClose=False)
+        self.call_after_flushing = call_after_flushing if call_after_flushing else lambda *_:_
 
     def shouldFlush(self, record):
         """
@@ -29,3 +32,8 @@ class MemoryHandlerRotatingBuffer(logging.handlers.MemoryHandler):
 
         return record.levelno >= self.flushLevel
 
+    def flush(self):
+        super().flush()
+        self.call_after_flushing()
+
+

swiftgui_logging-0.1.0/PKG-INFO

@@ -1,21 +0,0 @@
-Metadata-Version: 2.4
-Name: SwiftGUI_Logging
-Version: 0.1.0
-Summary: A collection of helpful logging-functionality based on the logging package
-License-Expression: Apache-2.0
-License-File: LICENSE
-Author: Eric aka CheesecakeTV
-Author-email: cheesecaketv53+pypi@gmail.com
-Requires-Python: >=3.10
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Project-URL: Documentation, https://github.com/CheesecakeTV/SwiftGUI-Docs
-Project-URL: Repository, https://github.com/CheesecakeTV/SwiftGUI-Logging
-Project-URL: issues, https://github.com/CheesecakeTV/SwiftGUI/issues
-Description-Content-Type: text/markdown
-
-
-# SwiftGUI-Logging
-
-Still WIP
-

swiftgui_logging-0.1.0/README.md

@@ -1,4 +0,0 @@
-
-# SwiftGUI-Logging
-
-Still WIP