Merge pull request #29 from bbtufty/gamefinder-logging

Improved GameFinder logging

CHANGES.rst

@@ -22,6 +22,11 @@ DupeParser
 
 - Logging tidied up to make more readable
 
+GameFinder
+~~~~~~~~~~
+
+- Logging tidied up to make more readable
+
 ROMChooser
 ~~~~~~~~~~
 
@@ -56,6 +61,7 @@ General
 ~~~~~~~
 
 - Due to changes to the re module, ROMSearch requires python>=3.11
+- Allowed specifying log level in the config file
 
 0.0.6 (2024-05-23)
 ==================

README.md

@@ -25,12 +25,14 @@ To get started, see the [documentation](https://romsearch.readthedocs.io/en/late
 Currently, ROMSearch is in early development, and so many features may be added over time. At the moment, ROMSearch
 works for the following consoles:
 
-* Nintendo - GameCube
-* Nintendo - Nintendo Entertainment System
-* Nintendo - Super Nintendo Entertainment System
-* Sony - PlayStation
-* Sony - PlayStation 2
-* Sony - PlayStation Portable
+* Nintendo
+   * Nintendo Entertainment System
+   * Super Nintendo Entertainment System
+   * GameCube
+* Sony
+   * PlayStation
+   * PlayStation 2
+   * PlayStation Portable
 
 but be aware there may be quirks that will only become apparent over time. We encourage users to open
 [issues](https://github.com/bbtufty/romsearch/issues) as and where they find them.

docs/configs/config.rst

@@ -78,6 +78,10 @@ Syntax: ::
     discord:                            # OPTIONAL. If defined, supply a webhook URL so that ROMSearch can post Discord
       webhook_url: [webhook_url]        #           notifications
 
+    logger:
+      level: info                       # OPTIONAL. If defined, can set the log level to be printed to terminal and
+                                        #           logs
+
 Sample
 ======
 

docs/intro.rst

@@ -36,12 +36,17 @@ everything and then filter from the downloaded files. For more details, see the
 Currently, ROMSearch is in early development, and so many features may be added over time. At the moment, ROMSearch
 has the capability for:
 
-* Nintendo - GameCube
-* Nintendo - Nintendo Entertainment System
-* Nintendo - Super Nintendo Entertainment System
-* Sony - PlayStation
-* Sony - PlayStation 2
-* Sony - PlayStation Portable
+* Nintendo
+
+  * GameCube
+  * Nintendo - Nintendo Entertainment System
+  * Nintendo - Super Nintendo Entertainment System
+
+* Sony
+
+  * PlayStation
+  * PlayStation 2
+  * PlayStation Portable
 
 but be aware there may be quirks that will only become apparent over time. We encourage users to open
 `issues <https://github.com/bbtufty/romsearch/issues>`_ as and where they find them. Known issues can be found at

romsearch/configs/sample_config.yml

@@ -55,3 +55,6 @@ romchooser:
 
 discord:
   webhook_url: "https://discord.com/api/webhooks/discord_url"
+
+logger:
+  level: debug

romsearch/gui/gui_config.py

@@ -1,6 +1,4 @@
 import os
-from functools import partial
-
 from PySide6.QtCore import Qt
 from PySide6.QtGui import QFont
 from PySide6.QtWidgets import (QMainWindow,
@@ -13,6 +11,7 @@
                                QFrame,
                                QPlainTextEdit,
                                )
+from functools import partial
 
 import romsearch
 from romsearch.util import load_yml, save_yml, load_json, save_json
@@ -94,12 +93,13 @@ def __init__(self,
 
         super().__init__()
 
+        self.ui = main_ui
+
         if logger is None:
-            logger = get_gui_logger()
+            log_level = self.ui.radioButtonConfigLoggerLevel.checkedButton().text().lower()
+            logger = get_gui_logger(log_level=log_level)
         self.logger = logger
 
-        self.ui = main_ui
-
         # Read in the various pre-set configs we've got
         self.mod_dir = os.path.dirname(romsearch.__file__)
 
@@ -354,6 +354,7 @@ def load_config(self,
             self.set_checkboxes()
             self.set_text_fields()
             self.set_romsearch_method()
+            self.set_logger_level()
             self.set_includes_excludes()
 
     def set_directory_name(self,
@@ -524,6 +525,29 @@ def set_romsearch_method(self):
 
         return True
 
+    def set_logger_level(self):
+        """Set the logger level from the config file"""
+
+        if "logger" not in self.config:
+            return False
+
+        if "level" in self.config["logger"]:
+
+            level = self.config["logger"]["level"]
+
+            if level == "debug":
+                button = self.ui.radioButtonConfigLoggerLevelDebug
+            elif level == "info":
+                button = self.ui.radioButtonConfigLoggerLevelInfo
+            elif level == "critical":
+                button = self.ui.radioButtonConfigLoggerLevelCritical
+            else:
+                raise ValueError(f"Do not understand logger level {level}")
+
+            button.setChecked(True)
+
+        return True
+
     def set_includes_excludes(self):
         """Set any includes/excludes config file"""
 
@@ -606,6 +630,9 @@ def save_config(self):
         # Dat filters we do a bit differently
         self.get_dat_filters()
 
+        # Finally, the logger level
+        self.get_logger_level()
+
         # Save out the config file
         save_yml(filename, self.config)
 
@@ -787,3 +814,15 @@ def get_dat_filters(self):
             self.config["romchooser"]["dat_filters"] = dat_filters
 
         return True
+
+    def get_logger_level(self):
+        """Get the logger level from the button config"""
+
+        if "logger" not in self.config:
+            self.config["logger"] = {}
+
+        # Get the method from the radio button group
+        logger_level = self.ui.radioButtonConfigLoggerLevel.checkedButton().text().lower()
+        self.config["logger"]["level"] = logger_level
+
+        return True

romsearch/gui/gui_romsearch.py

@@ -24,12 +24,13 @@ def __init__(self):
 
         super().__init__()
 
-        self.logger = get_gui_logger()
-        self.logger.warning("Do not close this window!")
-
         self.ui = Ui_RomSearch()
         self.ui.setupUi(self)
 
+        log_level = self.ui.radioButtonConfigLoggerLevel.checkedButton().text().lower()
+        self.logger = get_gui_logger(log_level=log_level)
+        self.logger.warning("Do not close this window!")
+
         # Set up the worker threads for later
         self.romsearch_thread = None
         self.romsearch_worker = None

romsearch/gui/layout_romsearch.py

@@ -27,7 +27,7 @@ class Ui_RomSearch(object):
     def setupUi(self, RomSearch):
         if not RomSearch.objectName():
             RomSearch.setObjectName(u"RomSearch")
-        RomSearch.resize(950, 785)
+        RomSearch.resize(1036, 798)
         sizePolicy = QSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Expanding)
         sizePolicy.setHorizontalStretch(0)
         sizePolicy.setVerticalStretch(0)
@@ -1182,6 +1182,79 @@ def setupUi(self, RomSearch):
         self.horizontalLayout_8.addLayout(self.gridLayoutConfigDiscord)
 
         self.tabWidgetConfig.addTab(self.tabConfigDiscord, "")
+        self.tabConfigLogger = QWidget()
+        self.tabConfigLogger.setObjectName(u"tabConfigLogger")
+        self.gridLayout_2 = QGridLayout(self.tabConfigLogger)
+        self.gridLayout_2.setObjectName(u"gridLayout_2")
+        self.gridLayoutConfigLogger = QGridLayout()
+        self.gridLayoutConfigLogger.setObjectName(u"gridLayoutConfigLogger")
+        self.gridLayoutConfigLoggerLeft = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
+
+        self.gridLayoutConfigLogger.addItem(self.gridLayoutConfigLoggerLeft, 0, 1, 1, 1)
+
+        self.gridLayoutConfigLoggerMiddle = QGridLayout()
+        self.gridLayoutConfigLoggerMiddle.setObjectName(u"gridLayoutConfigLoggerMiddle")
+        self.labelConfigLoggerLevelTitle = QLabel(self.tabConfigLogger)
+        self.labelConfigLoggerLevelTitle.setObjectName(u"labelConfigLoggerLevelTitle")
+        self.labelConfigLoggerLevelTitle.setFont(font)
+        self.labelConfigLoggerLevelTitle.setAlignment(Qt.AlignmentFlag.AlignCenter)
+
+        self.gridLayoutConfigLoggerMiddle.addWidget(self.labelConfigLoggerLevelTitle, 2, 0, 1, 1)
+
+        self.lineConfigLoggerLevelDividerTop = QFrame(self.tabConfigLogger)
+        self.lineConfigLoggerLevelDividerTop.setObjectName(u"lineConfigLoggerLevelDividerTop")
+        self.lineConfigLoggerLevelDividerTop.setFrameShadow(QFrame.Shadow.Plain)
+        self.lineConfigLoggerLevelDividerTop.setFrameShape(QFrame.Shape.HLine)
+
+        self.gridLayoutConfigLoggerMiddle.addWidget(self.lineConfigLoggerLevelDividerTop, 1, 0, 1, 1)
+
+        self.lineConfigLoggerLevelDividerBottom = QFrame(self.tabConfigLogger)
+        self.lineConfigLoggerLevelDividerBottom.setObjectName(u"lineConfigLoggerLevelDividerBottom")
+        self.lineConfigLoggerLevelDividerBottom.setFrameShadow(QFrame.Shadow.Plain)
+        self.lineConfigLoggerLevelDividerBottom.setFrameShape(QFrame.Shape.HLine)
+
+        self.gridLayoutConfigLoggerMiddle.addWidget(self.lineConfigLoggerLevelDividerBottom, 6, 0, 1, 1)
+
+        self.radioButtonConfigLoggerLevelInfo = QRadioButton(self.tabConfigLogger)
+        self.radioButtonConfigLoggerLevel = QButtonGroup(RomSearch)
+        self.radioButtonConfigLoggerLevel.setObjectName(u"radioButtonConfigLoggerLevel")
+        self.radioButtonConfigLoggerLevel.addButton(self.radioButtonConfigLoggerLevelInfo)
+        self.radioButtonConfigLoggerLevelInfo.setObjectName(u"radioButtonConfigLoggerLevelInfo")
+        self.radioButtonConfigLoggerLevelInfo.setChecked(True)
+
+        self.gridLayoutConfigLoggerMiddle.addWidget(self.radioButtonConfigLoggerLevelInfo, 4, 0, 1, 1)
+
+        self.verticalSpacerConfigLoggerBottom = QSpacerItem(20, 40, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Expanding)
+
+        self.gridLayoutConfigLoggerMiddle.addItem(self.verticalSpacerConfigLoggerBottom, 7, 0, 1, 1)
+
+        self.verticalSpacerConfigLoggerTop = QSpacerItem(20, 40, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Expanding)
+
+        self.gridLayoutConfigLoggerMiddle.addItem(self.verticalSpacerConfigLoggerTop, 0, 0, 1, 1)
+
+        self.radioButtonConfigLoggerLevelDebug = QRadioButton(self.tabConfigLogger)
+        self.radioButtonConfigLoggerLevel.addButton(self.radioButtonConfigLoggerLevelDebug)
+        self.radioButtonConfigLoggerLevelDebug.setObjectName(u"radioButtonConfigLoggerLevelDebug")
+
+        self.gridLayoutConfigLoggerMiddle.addWidget(self.radioButtonConfigLoggerLevelDebug, 3, 0, 1, 1)
+
+        self.radioButtonConfigLoggerLevelCritical = QRadioButton(self.tabConfigLogger)
+        self.radioButtonConfigLoggerLevel.addButton(self.radioButtonConfigLoggerLevelCritical)
+        self.radioButtonConfigLoggerLevelCritical.setObjectName(u"radioButtonConfigLoggerLevelCritical")
+
+        self.gridLayoutConfigLoggerMiddle.addWidget(self.radioButtonConfigLoggerLevelCritical, 5, 0, 1, 1)
+
+
+        self.gridLayoutConfigLogger.addLayout(self.gridLayoutConfigLoggerMiddle, 0, 2, 1, 1)
+
+        self.gridLayoutConfigLoggerRight = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
+
+        self.gridLayoutConfigLogger.addItem(self.gridLayoutConfigLoggerRight, 0, 3, 1, 1)
+
+
+        self.gridLayout_2.addLayout(self.gridLayoutConfigLogger, 0, 0, 1, 1)
+
+        self.tabWidgetConfig.addTab(self.tabConfigLogger, "")
 
         self.verticalLayout_2.addWidget(self.tabWidgetConfig)
 
@@ -1218,7 +1291,7 @@ def setupUi(self, RomSearch):
         RomSearch.setCentralWidget(self.centralwidget)
         self.menubar = QMenuBar(RomSearch)
         self.menubar.setObjectName(u"menubar")
-        self.menubar.setGeometry(QRect(0, 0, 950, 33))
+        self.menubar.setGeometry(QRect(0, 0, 1036, 33))
         self.menuFile = QMenu(self.menubar)
         self.menuFile.setObjectName(u"menuFile")
         self.menuHelp = QMenu(self.menubar)
@@ -1501,6 +1574,11 @@ def retranslateUi(self, RomSearch):
         self.lineEditConfigDiscordWebhookUrl.setText("")
         self.lineEditConfigDiscordWebhookUrl.setPlaceholderText(QCoreApplication.translate("RomSearch", u"https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", None))
         self.tabWidgetConfig.setTabText(self.tabWidgetConfig.indexOf(self.tabConfigDiscord), QCoreApplication.translate("RomSearch", u"Discord", None))
+        self.labelConfigLoggerLevelTitle.setText(QCoreApplication.translate("RomSearch", u"Log level", None))
+        self.radioButtonConfigLoggerLevelInfo.setText(QCoreApplication.translate("RomSearch", u"Info", None))
+        self.radioButtonConfigLoggerLevelDebug.setText(QCoreApplication.translate("RomSearch", u"Debug", None))
+        self.radioButtonConfigLoggerLevelCritical.setText(QCoreApplication.translate("RomSearch", u"Critical", None))
+        self.tabWidgetConfig.setTabText(self.tabWidgetConfig.indexOf(self.tabConfigLogger), QCoreApplication.translate("RomSearch", u"Logger", None))
         self.tabWidgetModules.setTabText(self.tabWidgetModules.indexOf(self.tabConfig), QCoreApplication.translate("RomSearch", u"Config", None))
 #if QT_CONFIG(statustip)
         self.pushButtonExit.setStatusTip(QCoreApplication.translate("RomSearch", u"Exit ROMSearch", None))