Settings: Move QMessageBox, get_settings() to app

(Remove the SettingsStore dependency on Qt.)

Author: ferdnyc

src/classes/app.py

@@ -130,7 +130,7 @@ def __init__(self, *args, mode=None):
             pass
 
         # Init settings
-        self.settings = settings.SettingStore()
+        self.settings = settings.SettingStore(parent=self)
         self.settings.load()
 
         # Init and attach exception handler
@@ -273,6 +273,16 @@ def __init__(self, *args, mode=None):
             # Recover backup file (this can't happen until after the Main Window has completely loaded)
             self.window.RecoverBackup.emit()
 
+    def settings_load_error(self, filepath=None):
+        """Use QMessageBox to warn the user of a settings load issue"""
+        _ = self._tr
+        QMessageBox.warning(
+            None,
+            _("Settings Error"),
+            _("Error loading settings file: %(file_path)s. Settings will be reset.")
+            % {"file_path": filepath}
+            )
+
     def _tr(self, message):
         return self.translate("", message)
 
@@ -291,7 +301,6 @@ def cleanup(self):
             log.error("Couldn't save user settings on exit.", exc_info=1)
 
 
-
 # Log the session's end
 @atexit.register
 def onLogTheEnd():

src/classes/settings.py

@@ -1,54 +1,64 @@
-""" 
+"""
  @file
- @brief This file loads and saves settings 
+ @brief This file loads and saves settings
  @author Noah Figg <[email protected]>
  @author Jonathan Thomas <[email protected]>
  @author Olivier Girard <[email protected]>
- 
+
  @section LICENSE
- 
+
  Copyright (c) 2008-2018 OpenShot Studios, LLC
  (http://www.openshotstudios.com). This file is part of
  OpenShot Video Editor (http://www.openshot.org), an open-source project
  dedicated to delivering high quality video editing and animation solutions
  to the world.
- 
+
  OpenShot Video Editor is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
- 
+
  OpenShot Video Editor is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
- 
+
  You should have received a copy of the GNU General Public License
  along with OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.
  """
 
 # SettingStore - class which allows getting/storing of settings, loading and saving to json
 import os
 
-from PyQt5.QtCore import QStandardPaths, QCoreApplication
-from PyQt5.QtWidgets import QMessageBox
-
-from classes.logger import log
 from classes import info
+from classes.logger import log
 from classes.json_data import JsonDataStore
 
 
 def get_settings():
-    """ Get the current QApplication's settings instance """
-    return QCoreApplication.instance().settings
+    """ Get the current application's settings instance """
+    return SettingStore.get_app().settings
 
 
 class SettingStore(JsonDataStore):
     """ This class only allows setting pre-existing keys taken from default settings file, and merges user settings
     on load, assumes default OS dir."""
 
-    def __init__(self):
-        JsonDataStore.__init__(self)
+    @classmethod
+    def save_app(cls, app_reference):
+        cls._app = app_reference
+
+    @classmethod
+    def get_app(cls):
+        if hasattr(cls, "_app"):
+            return cls._app
+        return None
+
+    def __init__(self, parent=None):
+        super().__init__()
+        # Also keep track of our parent, if defined
+        if parent:
+            SettingStore.save_app(parent)
         # Set the data type name for logging clarity (base class functions use this variable)
         self.data_type = "user settings"
         self.settings_filename = "openshot.settings"
@@ -72,8 +82,11 @@ def set(self, key, value):
         if key in user_values:
             user_values[key]["value"] = value
         else:
-            log.warn("{} key '{}' not valid. The following are valid: {}".format(self.data_type, key,
-                                                                                 list(self._data.keys())))
+            log.warn(
+                "{} key '{}' not valid. The following are valid: {}".format(
+                self.data_type, key,
+                list(self._data.keys()),
+                ))
 
     def load(self):
         """ Load user settings file from disk, merging with allowed settings in default settings file.
@@ -90,17 +103,16 @@ def load(self):
 
         # Load user settings (if found)
         if os.path.exists(os.fsencode(file_path)):
-
             # Will raise exception to caller on failure to read
             try:
                 user_settings = self.read_from_file(file_path)
             except Exception as ex:
-                log.error("Error loading settings file: %s" % ex)
-
-                _ = QCoreApplication.instance()._tr
-                QMessageBox.warning(None, _("Settings Error"),
-                                          _("Error loading settings file: %(file_path)s. Settings will be reset.") % { "file_path": file_path})
+                log.error("Error loading settings file: %s", ex)
                 user_settings = {}
+                app = SettingStore.get_app()
+                if app:
+                    # We have a parent, ask to show a message box
+                    app.settings_load_error(file_path)
 
         # Merge default and user settings, excluding settings not in default, Save settings
         self._data = self.merge_settings(default_settings, user_settings)