Update error gist

Author: WillyJL

modules/api.py

@@ -25,7 +25,7 @@
 import re
 
 from modules.structs import ContextLimiter, CounterContext, Game, MsgBox, OldGame, Os, SearchResult, Status
-from modules import globals, async_thread, callbacks, colors, db, icons, msgbox, parser, utils
+from modules import globals, async_thread, callbacks, colors, db, error, icons, msgbox, parser, utils
 
 session: aiohttp.ClientSession = None
 full_interval = int(dt.timedelta(days=7).total_seconds())
@@ -145,7 +145,7 @@ async def login():
         new_cookies = json.loads(data[0])
         await asyncio.shield(db.update_cookies(new_cookies))
     except Exception:
-        raise msgbox.Exc("Login window failure", f"Something went wrong with the login window subprocess:\n{utils.get_error()}\n\nThe \"log.txt\" file might contain more information.\nPlease submit a bug report on F95Zone or GitHub including this file.", MsgBox.error, more=utils.get_traceback())
+        raise msgbox.Exc("Login window failure", f"Something went wrong with the login window subprocess:\n{error.text()}\n\nThe \"log.txt\" file might contain more information.\nPlease submit a bug report on F95Zone or GitHub including this file.", MsgBox.error, more=error.traceback())
 
 
 async def assert_login():
@@ -470,7 +470,7 @@ async def check_notifs(login=False):
     except Exception:
         async with aiofiles.open(globals.self_path / "notifs_broken.bin", "wb") as f:
             await f.write(res)
-        raise msgbox.Exc("Notifs check error", f"Something went wrong checking your unread notifications:\n{utils.get_error()}\n\nThe response body has been saved to:\n{globals.self_path}{os.sep}notifs_broken.bin\nPlease submit a bug report on F95Zone or GitHub including this file.", MsgBox.error, more=utils.get_traceback())
+        raise msgbox.Exc("Notifs check error", f"Something went wrong checking your unread notifications:\n{error.text()}\n\nThe response body has been saved to:\n{globals.self_path}{os.sep}notifs_broken.bin\nPlease submit a bug report on F95Zone or GitHub including this file.", MsgBox.error, more=error.traceback())
     if alerts != 0 and inbox != 0:
         msg = f"You have {alerts + inbox} unread notifications.\n({alerts} alert{'s' if alerts > 1 else ''} and {inbox} conversation{'s' if inbox > 1 else ''})"
     elif alerts != 0 and inbox == 0:
@@ -539,7 +539,7 @@ async def check_updates():
     except Exception:
         async with aiofiles.open(globals.self_path / "update_broken.bin", "wb") as f:
             await f.write(res)
-        raise msgbox.Exc("Update check error", f"Something went wrong checking for F95Checker updates:\n{utils.get_error()}\n\nThe response body has been saved to:\n{globals.self_path}{os.sep}update_broken.bin\nPlease submit a bug report on F95Zone or GitHub including this file.", MsgBox.error, more=utils.get_traceback())
+        raise msgbox.Exc("Update check error", f"Something went wrong checking for F95Checker updates:\n{error.text()}\n\nThe response body has been saved to:\n{globals.self_path}{os.sep}update_broken.bin\nPlease submit a bug report on F95Zone or GitHub including this file.", MsgBox.error, more=error.traceback())
     async def update_callback():
         progress = 0.0
         total = float(asset_size)

modules/callbacks.py

@@ -10,7 +10,7 @@
 import os
 
 from modules.structs import Game, MsgBox, Os, SearchResult, ThreadMatch
-from modules import globals, api, async_thread, db, filepicker, icons, msgbox, utils
+from modules import globals, api, async_thread, db, error, filepicker, icons, msgbox, utils
 
 
 def update_start_with_system(toggle: bool):
@@ -48,7 +48,7 @@ def update_start_with_system(toggle: bool):
                 globals.autostart.unlink()
         globals.start_with_system = toggle
     except Exception:
-        utils.push_popup(msgbox.msgbox, "Start with system error", f"Something went wrong changing the start with system setting:\n{utils.get_error()}", MsgBox.error, more=utils.get_traceback())
+        utils.push_popup(msgbox.msgbox, "Start with system error", f"Something went wrong changing the start with system setting:\n{error.text()}", MsgBox.error, more=error.traceback())
 
 
 async def _launch_exe(path: str):
@@ -121,7 +121,7 @@ def select_callback(selected):
         }
         utils.push_popup(msgbox.msgbox, "File not found", "The selected executable could not be found.\n\nDo you want to select another one?", MsgBox.warn, buttons)
     except Exception:
-        utils.push_popup(msgbox.msgbox, "Game launch error", f"Something went wrong launching {executable}:\n{utils.get_error()}", MsgBox.error, more=utils.get_traceback())
+        utils.push_popup(msgbox.msgbox, "Game launch error", f"Something went wrong launching {executable}:\n{error.text()}", MsgBox.error, more=error.traceback())
 
 
 def launch_game(game: Game, executable: str = None):
@@ -189,7 +189,7 @@ def select_callback(selected):
         }
         utils.push_popup(msgbox.msgbox, "Folder not found", "The parent folder for the game executable could not be found.\n\nDo you want to select another executable?", MsgBox.warn, buttons)
     except Exception:
-        utils.push_popup(msgbox.msgbox, "Open folder error", f"Something went wrong opening the folder for {executable}:\n{utils.get_error()}", MsgBox.error, more=utils.get_traceback())
+        utils.push_popup(msgbox.msgbox, "Open folder error", f"Something went wrong opening the folder for {executable}:\n{error.text()}", MsgBox.error, more=error.traceback())
 
 
 def open_game_folder(game: Game, executable: str = None):
@@ -246,7 +246,7 @@ async def _open_webpage(url: str):
                 stderr=subprocess.DEVNULL
             )
         except Exception:
-            utils.push_popup(msgbox.msgbox, "Open webpage error", f"Something went wrong opening {name}:\n{utils.get_error()}", MsgBox.error, more=utils.get_traceback())
+            utils.push_popup(msgbox.msgbox, "Open webpage error", f"Something went wrong opening {name}:\n{error.text()}", MsgBox.error, more=error.traceback())
     if globals.settings.browser_html:
         async def _fetch_open_page():
             html = await api.download_webpage(url)

modules/db.py

@@ -11,7 +11,7 @@
 import re
 
 from modules.structs import Browser, DefaultStyle, DisplayMode, Game, MsgBox, SearchResult, Settings, Status, ThreadMatch, Timestamp, Type
-from modules import globals, async_thread, colors, msgbox, utils
+from modules import globals, async_thread, colors, error, msgbox, utils
 
 connection: aiosqlite.Connection = None
 
@@ -570,4 +570,4 @@ async def migrate_legacy(config: str | pathlib.Path | dict):
 
         await save()
     except Exception:
-        utils.push_popup(msgbox.msgbox, "Config migration error", f"Something went wrong transferring data from the previous version:\n{utils.get_error()}", MsgBox.error, more=utils.get_traceback())
+        utils.push_popup(msgbox.msgbox, "Config migration error", f"Something went wrong transferring data from the previous version:\n{error.text()}", MsgBox.error, more=error.traceback())

modules/error.py

@@ -0,0 +1,35 @@
+# https://gist.github.com/Willy-JL/f733c960c6b0d2284bcbee0316f88878
+import traceback as _traceback
+import sys
+
+
+def traceback(exc: Exception = None):
+    # Full error traceback with line numbers and previews
+    if exc:
+        exc_info = type(exc), exc, exc.__traceback__
+    else:
+        exc_info = sys.exc_info()
+    tb_lines = _traceback.format_exception(*exc_info)
+    tb = "".join(tb_lines)
+    return tb
+
+
+def text(exc: Exception = None):
+    # Short error text like "ExcName: exception text"
+    exc = exc or sys.exc_info()[1]
+    return f"{type(exc).__name__}: {str(exc) or 'No further details'}"
+
+
+# Example usage
+if __name__ == "__main__":
+    import error  # This script is designed as a module you import
+
+    try:
+        0/0
+    except Exception as exc:
+        # can be used with no arguments inside except blocks
+        print(error.text())
+        print(error.traceback())
+        # or if you have the exception object you can pass that
+        print(error.text(exc))
+        print(error.traceback(exc))

modules/gui.py

@@ -18,7 +18,7 @@
 import sys
 
 from modules.structs import Browser, DefaultStyle, DisplayMode, ExeState, Filter, FilterMode, Game, MsgBox, Os, SortSpec, Status, Tag, TrayMsg, Type
-from modules import globals, api, async_thread, callbacks, colors, db, filepicker, icons, imagehelper, login, msgbox, ratingwidget, rpc_thread, utils
+from modules import globals, api, async_thread, callbacks, colors, db, error, filepicker, icons, imagehelper, login, msgbox, ratingwidget, rpc_thread, utils
 
 imgui.io = None
 imgui.style = None
@@ -316,8 +316,8 @@ def __init__(self):
         # Show errors in threads
         def syncexcepthook(args: threading.ExceptHookArgs):
             if args.exc_type is not msgbox.Exc:
-                err = utils.get_error(args.exc_value)
-                tb = utils.get_traceback(args.exc_type, args.exc_value, args.exc_traceback)
+                err = error.text(args.exc_value)
+                tb = error.traceback(args.exc_type, args.exc_value, args.exc_traceback)
                 utils.push_popup(msgbox.msgbox, "Oops!", f"Something went wrong in a parallel task of a separate thread:\n{err}", MsgBox.error, more=tb)
         threading.excepthook = syncexcepthook
         def asyncexcepthook(future: asyncio.Future):
@@ -327,8 +327,8 @@ def asyncexcepthook(future: asyncio.Future):
                 return
             if not exc or type(exc) is msgbox.Exc:
                 return
-            err = utils.get_error(exc)
-            tb = utils.get_traceback(exc)
+            err = error.text(exc)
+            tb = error.traceback(exc)
             if isinstance(exc, asyncio.TimeoutError) or isinstance(exc, aiohttp.ClientError):
                 utils.push_popup(msgbox.msgbox, "Connection error", f"A connection request to F95Zone has failed:\n{err}\n\nPossible causes include:\n - You are refreshing with too many workers, try lowering them in settings\n - Your timeout value is too low, try increasing it in settings\n - F95Zone is experiencing difficulties, try waiting a bit and retrying\n - F95Zone is blocked in your country, network, antivirus or firewall, try a VPN\n - Your retries value is too low, try increasing it in settings (last resort!)", MsgBox.warn, more=tb)
                 return

modules/parser.py

@@ -1,14 +1,12 @@
 import multiprocessing
 import datetime as dt
-import traceback
 import functools
-import builtins
 import bs4
-import sys
 import re
 import os
 
 from modules.structs import MsgBox, Status, Tag, Type
+from modules import error
 
 html = functools.partial(bs4.BeautifulSoup, features="lxml")
 _html = html
@@ -211,14 +209,12 @@ def get_long_game_attr(*names: list[str]):
         else:
             image_url = "-"
 
-    except Exception as exc:
-        err = f"{builtins.type(exc).__name__}: {str(exc) or 'No further details'}"
-        tb = "".join(traceback.format_exception(*sys.exc_info()))
+    except Exception:
         e = ParserException(
             title="Thread parsing error",
-            msg=f"Something went wrong while parsing thread {game_id}:\n{err}",
+            msg=f"Something went wrong while parsing thread {game_id}:\n{error.text()}",
             type=MsgBox.error,
-            more=tb
+            more=error.traceback()
         )
         if pipe:
             pipe.put_nowait(e)

modules/rpc_thread.py

@@ -2,8 +2,8 @@
 import threading
 import asyncio
 
-from modules import globals, async_thread, callbacks, msgbox, utils
 from modules.structs import MsgBox
+from modules import globals, async_thread, callbacks, error, msgbox, utils
 
 server: xmlrpc.server.SimpleXMLRPCServer = None
 thread: threading.Thread = None
@@ -18,7 +18,7 @@ def run_loop():
         try:
             server = xmlrpc.server.SimpleXMLRPCServer(("localhost", globals.rpc_port), logRequests=False, allow_none=True)
         except Exception:
-            raise msgbox.Exc("RPC server error", f"Failed to start RPC server on localhost port {globals.rpc_port}:\n{utils.get_error()}\n\nThis means that the web browser extension will not work, while F95Checker\nitself should be unaffected. Some common causes are:\n - Hyper-V\n - Docker\n - Antivirus or firewall", MsgBox.warn, more=utils.get_traceback())
+            raise msgbox.Exc("RPC server error", f"Failed to start RPC server on localhost port {globals.rpc_port}:\n{error.text()}\n\nThis means that the web browser extension will not work, while F95Checker\nitself should be unaffected. Some common causes are:\n - Hyper-V\n - Docker\n - Antivirus or firewall", MsgBox.warn, more=error.traceback())
 
         server.register_function(globals.gui.show, "show_window")
         def add_game(url):

modules/utils.py

@@ -2,7 +2,6 @@
 import OpenGL.GL as gl
 import concurrent
 import functools
-import traceback
 import asyncio
 import weakref
 import typing
@@ -60,20 +59,6 @@ def reset_timer(_):
     globals.refresh_task.add_done_callback(done_callback)
 
 
-# https://gist.github.com/Willy-JL/f733c960c6b0d2284bcbee0316f88878
-def get_traceback(*exc_info: list):
-    exc_info = exc_info or sys.exc_info()
-    if len(exc_info) == 1:
-        exc_info = type(exc_info), exc_info, exc_info.__traceback__
-    tb_lines = traceback.format_exception(*exc_info)
-    tb = "".join(tb_lines)
-    return tb
-
-def get_error(exc: Exception = None):
-    exc = exc or sys.exc_info()[1]
-    return f"{type(exc).__name__}: {str(exc) or 'No further details'}"
-
-
 class daemon:
     def __init__(self, proc):
         self.finalize = weakref.finalize(proc, self.kill, proc)