refactor matlab helper

Author: StephenNneji

rascal2/config.py

@@ -162,6 +162,9 @@ def get_matlab_engine(engine_ready, engine_output):
 class MatlabHelper:
     """Helper to start MATLAB on another process."""
 
+    class ConfigError(Exception):
+        """Error when setting up MATLAB for RasCAL usage."""
+
     _instance = None
 
     def __new__(cls):
@@ -170,6 +173,7 @@ def __new__(cls):
             cls._instance.ready_event = mp.Event()
             cls._instance.close_event = mp.Event()
             cls._instance.engine_output = None
+            cls._instance.matlab_dir = ""
             cls._instance.__engine = None
             cls._instance.async_start()
 
@@ -221,19 +225,31 @@ def get_matlab_path(self):
             Return MATLAB install directory.
         """
         install_dir = ""
-        error = ""
 
         try:
             with open(MATLAB_ARCH_FILE) as path_file:
                 lines = path_file.readlines()
                 if len(lines) == 4:
+                    arch = {"x86_64": "maci64", "arm64": "maca64"}
+                    if platform.system() == "Darwin" and arch.get(platform.mac_ver()[-1]) != lines[0].strip():
+                        # installed intel Matlab on ARM or vice versa
+                        raise MatlabHelper.ConfigError(
+                            "The installed MATLAB is incompatible, "
+                            f"ensure the {platform.mac_ver()[-1]} version of "
+                            "MATLAB is installed instead."
+                        )
+
                     install_dir = pathlib.Path(lines[1]).parent.parent
                 else:
-                    error = "Matlab not found, specify MATLAB location in settings i.e. 'File > Settings' menu"
-        except FileNotFoundError:
-            error = "Matlab engine could not be found, ensure it is installed properly"
-        if error:
+                    raise MatlabHelper.ConfigError(
+                        "Matlab not found, specify MATLAB location in settings i.e. 'File > Settings' menu."
+                    )
+        except (FileNotFoundError, MatlabHelper.ConfigError) as ex:
+            if isinstance(ex, FileNotFoundError):
+                ex.add_note("Matlab engine could not be found, ensure it is installed properly.")
             self.engine_output[:] = []
-            self.engine_output.append(Exception(error))
-            LOGGER.error(f"{error}. Attempt to read MATLAB _arch file failed {MATLAB_ARCH_FILE}.")
-        return str(install_dir)
+            self.engine_output.append(ex)
+            LOGGER.error(f"Attempt to read MATLAB _arch file failed {MATLAB_ARCH_FILE}.\n {ex}.")
+
+        self.matlab_dir = str(install_dir)
+        return self.matlab_dir

rascal2/dialogs/settings_dialog.py

@@ -136,7 +136,7 @@ def __init__(self):
         label_layout.addWidget(QtWidgets.QLabel("Current Matlab Directory:"))
         label_layout.addStretch(1)
         self.matlab_path = QtWidgets.QLineEdit(self)
-        self.matlab_path.setText(MatlabHelper().get_matlab_path())
+        self.matlab_path.setText(MatlabHelper().matlab_dir)
         self.matlab_path.setReadOnly(True)
         self.matlab_path.setPlaceholderText("Select MATLAB directory")
         self.matlab_path.setFocusPolicy(QtCore.Qt.FocusPolicy.NoFocus)
@@ -180,28 +180,19 @@ def set_matlab_paths(self):
         if not self.changed:
             return
 
-        # should_init = False
         with suppress(FileNotFoundError), open(MATLAB_ARCH_FILE, "r+") as path_file:
             try:
                 install_dir = pathlib.Path(self.matlab_path.text())
-                LOGGER.info(f"install_dir: {install_dir}")
                 if not getattr(sys, "frozen", False):
                     return
 
-                # if len(path_file.readlines()) == 0:
-                #     should_init = True
-
                 path_file.seek(0)
                 if platform.system() == "Windows":
                     arch = "win64"
                 elif platform.system() == "Darwin":
-                    if platform.mac_ver()[-1] == "arm64" and (install_dir / "bin/maca64").exists():
-                        arch = "maca64"
-                    else:
-                        arch = "maci64"
+                    arch = "maca64" if platform.mac_ver()[-1] == "arm64" else "maci64"
                 else:
                     arch = "glnxa64"
-                LOGGER.info(f"arch: {arch}")
                 path_file.writelines(
                     [
                         f"{arch}\n",
@@ -213,5 +204,5 @@ def set_matlab_paths(self):
                 path_file.truncate()
             except Exception as ex:
                 LOGGER.error("exception occurred", exc_info=ex)
-        # if should_init:
+
         MatlabHelper().async_start()