feat: add debug flag

dy0gu · dy0gu · commit a3cbd0a52473 · 2025-06-26T21:11:21.000+01:00
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -64,7 +64,7 @@ jobs:
           script-name: src/main.py
           mode: app
           include-data-dir: src/resources=resources
-          macos-app-icon: src/resources/icons/logo.png
+          macos-app-icon: src/resources/images/logo.png
           macos-signed-app-name: ${{ needs.prepare.outputs.signature }}
           macos-app-name: ${{ needs.prepare.outputs.name }}
           macos-app-version: ${{ needs.prepare.outputs.version }}
@@ -75,6 +75,7 @@ jobs:
           file-description: ${{ needs.prepare.outputs.name }} app, created by ${{ needs.prepare.outputs.author }}.
           output-dir: build
           enable-plugins: pyside6
+          include-qt-plugins: sensible,multimedia
 
       - name: Rename build
         working-directory: build
@@ -110,16 +111,17 @@ jobs:
           script-name: src/main.py
           mode: app
           include-data-dir: src/resources=resources
-          linux-icon: src/resources/icons/logo.png
+          linux-icon: src/resources/images/logo.png
           product-version: ${{ needs.prepare.outputs.version }}
           file-version: ${{ needs.prepare.outputs.version }}
           company-name: ${{ needs.prepare.outputs.author }}
           product-name: ${{ needs.prepare.outputs.name }}
           file-description: ${{ needs.prepare.outputs.name }} app, created by ${{ needs.prepare.outputs.author }}.
           output-dir: build
-          enable-plugins: pyside6
           clang: true
           static-libpython: yes
+          enable-plugins: pyside6
+          include-qt-plugins: sensible,multimedia
 
       - name: Rename build
         working-directory: build
@@ -155,7 +157,7 @@ jobs:
           script-name: src/main.py
           mode: app
           include-data-dir: src/resources=resources
-          windows-icon-from-ico: src/resources/icons/logo.png
+          windows-icon-from-ico: src/resources/images/logo.png
           windows-console-mode: disable
           product-version: ${{ needs.prepare.outputs.version }}
           file-version: ${{ needs.prepare.outputs.version }}
@@ -164,6 +166,7 @@ jobs:
           file-description: ${{ needs.prepare.outputs.name }} app, created by ${{ needs.prepare.outputs.author }}.
           output-dir: build
           enable-plugins: pyside6
+          include-qt-plugins: sensible,multimedia
 
       - name: Rename build
         working-directory: build
diff --git a/README.md b/README.md
@@ -65,6 +65,9 @@ With the exception of the points above, we believe this template to be decently
     python src/main.py
     ```
 
+  - The app will create and store logs in a diretory determined by `QStandardPaths.StandardLocation.GenericConfigLocation/AUTHOR_NAME/EXECUTABLE_NAME` which is OS independent.
+  These logs can be requested from users to get data on why things are not working. Running the binary with the `--debug` flag will increase the verbosity of the logs, for more detailed information.
+
 - ### Tooling 🧰
 
   - Mypy is used for type checking:
diff --git a/src/app.py b/src/app.py
@@ -22,7 +22,6 @@ def __init__(self, argv: list[str]):
         self.setOrganizationName(AUTHOR_NAME)
         self.setOrganizationDomain(AUTHOR_DOMAIN)
         self.setApplicationVersion(__version__)
-        self.setWindowIcon(QIcon(QPixmap(file_loader.loadResource(LOGO_PATH))))
 
         data = [
             self.applicationName(),
@@ -43,3 +42,7 @@ def __init__(self, argv: list[str]):
             )
         logger.info(column)
         logger.info(row)
+
+        self.setWindowIcon(
+            QIcon(QPixmap(file_loader.getResourcePath(LOGO_PATH)))
+        )
diff --git a/src/config/metadata.py b/src/config/metadata.py
@@ -7,7 +7,7 @@
 AUTHOR_NAME = "NEIAAC"
 AUTHOR_DOMAIN = "neiaac.com"
 
-LOGO_PATH = "icons/logo.png"
+LOGO_PATH = os.path.join("images", "logo.png")
 
 DATA_PATH = os.path.join(
     QStandardPaths.writableLocation(
diff --git a/src/main.py b/src/main.py
@@ -1,4 +1,6 @@
+import os
 import sys
+import tempfile
 
 from PySide6 import QtCore
 
@@ -15,4 +17,14 @@
         window = Window()
         window.show()
 
+        if "NUITKA_ONEFILE_PARENT" in os.environ:
+            splash_filename = os.path.join(
+                tempfile.gettempdir(),
+                "onefile_%d_splash_feedback.tmp"
+                % int(os.environ["NUITKA_ONEFILE_PARENT"]),
+            )
+
+            if os.path.exists(splash_filename):
+                os.unlink(splash_filename)
+
         sys.exit(app.exec())
diff --git a/src/pages/home.py b/src/pages/home.py
@@ -1,3 +1,4 @@
+import os
 from PySide6.QtWidgets import QWidget, QVBoxLayout, QHBoxLayout, QSizePolicy
 from PySide6.QtCore import Qt, QUrl
 from PySide6.QtMultimedia import QSoundEffect
@@ -29,7 +30,11 @@ def __init__(self):
 
         self.finishSound = QSoundEffect()
         self.finishSound.setSource(
-            QUrl.fromLocalFile(file_loader.loadResource("sounds/success.wav"))
+            QUrl.fromLocalFile(
+                file_loader.getResourcePath(
+                    os.path.join("sounds", "success.wav")
+                )
+            )
         )
         self.finishSound.setVolume(0.2)
 
diff --git a/src/resources/images/logo.png b/src/resources/images/logo.png
diff --git a/src/utils/file_loader.py b/src/utils/file_loader.py
@@ -1,15 +1,34 @@
 import os
 import sys
 
+from utils.logger import logger
 
-def loadFile(fileName: str) -> str:
+
+def getFilePath(fileName: str) -> str:
+    locations = (
+        # Files bundled inside the single binary build
+        os.path.join(os.path.dirname(__file__), os.pardir),
+        os.path.dirname(__file__),
+        # Files in the directory the single binary build is in
+        os.path.dirname(sys.argv[0]),
+    )
     try:
-        file = os.path.join(__compiled__.containing_dir, fileName)  # type: ignore
+        # Files in the standalone build directory
+        locations = locations + (__compiled__.containing_dir,)  # type: ignore
     except NameError:
-        file = os.path.join(os.path.dirname(sys.argv[0]), fileName)
-    return file
+        pass
+
+    for location in locations:
+        filePath = os.path.abspath(os.path.join(location, fileName))
+        if os.path.isfile(filePath):
+            logger.debug(f"Returning file path: {filePath}")
+            return filePath
+    logger.error(
+        f"Got a request to load file {fileName} but it could not be found, returning empty string"
+    )
+    return ""
 
 
-def loadResource(resourceName: str) -> str:
-    file = loadFile(os.path.join("resources", resourceName))
-    return file
+def getResourcePath(resourceName: str) -> str:
+    resourcePath = getFilePath(os.path.join("resources", resourceName))
+    return resourcePath
diff --git a/src/utils/logger.py b/src/utils/logger.py
@@ -25,17 +25,17 @@ class LogLevel(Enum):
     "[{time:YYYY-MM-DDTHH:mm:ss.SSS[Z]!UTC}] [<level>{level}</level>] {message}"
 )
 
-dev = "__compiled__" not in globals()
+trace = "__compiled__" not in globals() or "--debug" in sys.argv[1:]
 
 logger.remove()
 logger.level(LogLevel.INFO.value, color="<green>")
 
-if dev:
+if trace:
     logger.add(
         sys.stdout,
         colorize=True,
         format=formatter,
-        level=LogLevel.DEBUG.value,
+        level=LogLevel.TRACE.value,
         enqueue=True,
     )
 
@@ -45,21 +45,23 @@ class LogLevel(Enum):
     rotation=datetime.time(0, 0, 0, tzinfo=datetime.timezone.utc),
     retention="30 days",
     enqueue=True,
-    level=LogLevel.DEBUG.value if dev else LogLevel.INFO.value,
+    level=LogLevel.TRACE.value if trace else LogLevel.INFO.value,
 )
 
 
 def qMessageHandler(
     mode: QtCore.QtMsgType, _: QtCore.QMessageLogContext, message: str
 ):
     match mode:
+        case QtCore.QtMsgType.QtDebugMsg:
+            logger.debug(message)
         case QtCore.QtMsgType.QtInfoMsg:
-            logger.info(message)
+            logger.debug(message)
         case QtCore.QtMsgType.QtWarningMsg:
             logger.warning(message)
         case QtCore.QtMsgType.QtCriticalMsg:
             logger.error(message)
         case QtCore.QtMsgType.QtFatalMsg:
             logger.critical(message)
         case _:
-            logger.debug(message)
+            logger.trace(message)
diff --git a/src/utils/system_tray.py b/src/utils/system_tray.py
@@ -11,5 +11,5 @@ class SystemTray(QSystemTrayIcon):
     def __init__(self, visible: bool = False):
         super().__init__()
 
-        self.setIcon(QIcon(QPixmap(file_loader.loadResource(LOGO_PATH))))
+        self.setIcon(QIcon(QPixmap(file_loader.getResourcePath(LOGO_PATH))))
         self.setVisible(visible)
diff --git a/src/window.py b/src/window.py
@@ -1,6 +1,9 @@
 import os
 import sys
 
+from app import App
+from pages.guide import GuidePage
+
 old = sys.stdout
 try:
     sys.stdout = open(os.devnull, "w")
@@ -19,13 +22,14 @@
 from utils.data_saver import config
 from pages.home import HomePage
 from pages.settings import SettingsPage
-from pages.guide import GuidePage
 
 
 class Window(FluentWindow):
     def __init__(self):
         super().__init__()
 
+        App.alert(self, 0)
+
         self.setMicaEffectEnabled(False)
         self.resize(QSize(config.width.get(), config.height.get()))
         self.move(QPoint(config.x.get(), config.y.get()))
@@ -57,7 +61,7 @@ def __init__(self):
         self.splashScreen.finish()
 
     def closeEvent(self, e):
-        """Saves the current window geometry before closing."""
+        """Saves the current window geometry and other settings before closing."""
         config.width.set(self.width())
         config.height.set(self.height())
         config.x.set(self.x())
diff --git a/test/app_test.py b/test/app_test.py
@@ -27,7 +27,7 @@ def testAppMeta(qapp: App):
     assert qapp.organizationDomain() == AUTHOR_DOMAIN
     assert (
         qapp.windowIcon().pixmap(16, 16).toImage()
-        == QIcon(QPixmap(file_loader.loadResource(LOGO_PATH)))
+        == QIcon(QPixmap(file_loader.getResourcePath(LOGO_PATH)))
         .pixmap(16, 16)
         .toImage()
     )
