More refactors

Author: StephenNneji

RATapi/examples/normal_reflectivity/DSPC_custom_layers.py

@@ -5,6 +5,7 @@
 import numpy as np
 
 import RATapi as RAT
+import RATapi.wrappers
 
 
 def DSPC_custom_layers():
@@ -126,5 +127,10 @@ def DSPC_custom_layers():
 
 
 if __name__ == "__main__":
+    import RATapi
+    RATapi.wrappers.get_matlab_engine().editFile(r"C:\Users\steve\Documents\Development\python-RAT\RATapi\examples\normal_reflectivity\customBilayerDSPC.m")
+    import time
+    time.sleep(20)
     problem, results = DSPC_custom_layers()
+    
     RAT.plotting.plot_ref_sld(problem, results, True)

RATapi/wrappers.py

@@ -1,27 +1,32 @@
 """Wrappers for the interface between RATapi and MATLAB custom files."""
-
+import atexit
 import os
 import pathlib
 import platform
 import shutil
 import subprocess
-from contextlib import contextmanager
-from typing import Callable
+from contextlib import contextmanager, suppress
+from typing import Callable, Tuple
 
 from numpy.typing import ArrayLike
 
 import RATapi.rat_core
 
 MATLAB_PATH_FILE = os.path.join(os.path.dirname(os.path.realpath(__file__)), "matlab.txt")
+__MATLAB_ENGINE = None
+
+
+def get_matlab_engine():
+    return __MATLAB_ENGINE
 
 
 @contextmanager
-def cd(new_dir):
+def cd(new_dir: str):
     """Context manager to change to a given directory and return to current directory on exit.
 
     Parameters
     ----------
-    new_dir : string
+    new_dir : str
         The path to change to
     """
     prev_dir = os.getcwd()
@@ -32,38 +37,17 @@ def cd(new_dir):
         os.chdir(prev_dir)
 
 
-def set_matlab_path(matlab_exe_path):
-    """Set the path of MATLAB to use for custom functions.
-
-    This will also register the MATLAB COM server on Windows OS which could be slow.
-
-    Parameters
-    ----------
-    matlab_path : string
-        The full path of the MATLAB executable
-    """
-    if not matlab_exe_path:
-        return
-
-    if platform.system() == "Windows":
-        process = subprocess.Popen(f'"{matlab_exe_path}" -batch "comserver(\'register\')"')
-        process.wait()
-
-    with open(MATLAB_PATH_FILE, "w") as path_file:
-        path_file.write(matlab_exe_path)
-
-
-def get_matlab_paths(matlab_exe_path):
+def get_matlab_paths(matlab_exe_path: str) -> Tuple[str, str]:
     """Return paths for loading MATLAB engine C interface dynamic libraries.
 
     Parameters
     ----------
-    matlab_exe_path : string
+    matlab_exe_path : str
         The full path of the MATLAB executable
 
     Returns
     -------
-    paths : Tuple[string, string]
+    paths : Tuple[str, str]
         The path of the MATLAB bin and the DLL location
     """
     if not matlab_exe_path:
@@ -87,64 +71,82 @@ def get_matlab_paths(matlab_exe_path):
     return f"{bin_path.as_posix()}/", f"{dll_path.as_posix()}/"
 
 
-def start_matlab():
+def start_matlab(matlab_exe_path: str =""):
     """Load MATLAB engine dynamic libraries and creates wrapper object.
-
+    
+    Parameters
+    ----------
+    matlab_exe_path : str, default ""
+        The full path of the MATLAB executable
+    
     Returns
     -------
     engine : Optional[RATapi.rat_core.MatlabEngine]
         A matlab engine object
-
     """
-    try:
-        with open(MATLAB_PATH_FILE) as path_file:
-            matlab_path = path_file.read()
-    except FileNotFoundError:
-        matlab_path = ""
-
-    if not matlab_path:
-        matlab_path = shutil.which("matlab")
-        if matlab_path is None:
-            matlab_path = ""
-        else:
-            print(matlab_path)
-            temp = pathlib.Path(matlab_path)
-            if temp.is_symlink():
-                matlab_path = temp.readlink().as_posix()
-            set_matlab_path(matlab_path)
+    matlab_exe_path = find_existing_matlab()
 
-    if matlab_path:
-        bin_path, dll_path = get_matlab_paths(matlab_path)
+    if matlab_exe_path:
+        bin_path, dll_path = get_matlab_paths(matlab_exe_path)
         os.environ["MATLAB_DLL_PATH"] = dll_path
         if platform.system() == "Windows":
             os.environ["PATH"] = dll_path + os.pathsep + os.environ["PATH"]
 
         with cd(bin_path):
             engine = RATapi.rat_core.MatlabEngine()
-
+        # Ensure MATLAB is closed when Python shuts down.
+        atexit.register(engine.close)
+    
         return engine
 
 
+def set_matlab_path(matlab_exe_path: str) -> None:
+    """Set the path of MATLAB to use for custom functions.
+
+    This will also register the MATLAB COM server on Windows OS which could be slow.
+
+    Parameters
+    ----------
+    matlab_exe_path : str
+        The full path of the MATLAB executable
+    """
+    if not matlab_exe_path:
+        return
+    
+    global __MATLAB_ENGINE
+    if __MATLAB_ENGINE is not None:
+        __MATLAB_ENGINE.close()
+        atexit.unregister(__MATLAB_ENGINE.close)
+        __MATLAB_ENGINE = start_matlab(matlab_exe_path)
+
+
+    if platform.system() == "Windows":
+        process = subprocess.Popen(f'"{matlab_exe_path}" -batch "comserver(\'register\')"')
+        process.wait()
+
+    with open(MATLAB_PATH_FILE, "w") as path_file:
+        path_file.write(matlab_exe_path)
+
+
 class MatlabWrapper:
     """Creates a python callback for a MATLAB function.
 
     Parameters
     ----------
-    filename : string
+    filename : str
         The path of the file containing MATLAB function
     """
 
-    engine = start_matlab()
-
     def __init__(self, filename) -> None:
-        if self.engine is None:
+        engine = get_matlab_engine()
+        if engine is None:
             raise ValueError(
                 "MATLAB is not found. Please use `set_matlab_path` to set the location of your MATLAB installation"
             ) from None
 
         path = pathlib.Path(filename)
-        self.engine.cd(str(path.parent))
-        self.engine.setFunction(path.stem)
+        engine.cd(str(path.parent))
+        engine.setFunction(path.stem)
 
     def getHandle(self) -> Callable[[ArrayLike, ArrayLike, ArrayLike, int, int], tuple[ArrayLike, float]]:
         """Return a wrapper for the custom dynamic library function.
@@ -157,7 +159,7 @@ def getHandle(self) -> Callable[[ArrayLike, ArrayLike, ArrayLike, int, int], tup
         """
 
         def handle(*args):
-            return self.engine.invoke(*args)
+            return get_matlab_engine().invoke(*args)
 
         return handle
 
@@ -191,3 +193,24 @@ def handle(*args):
             return self.engine.invoke(*args)
 
         return handle
+
+
+def find_existing_matlab() -> str:
+    matlab_exe_path = ""
+
+    with suppress(FileNotFoundError), open(MATLAB_PATH_FILE) as path_file:
+        matlab_exe_path = path_file.read()
+
+    if not matlab_exe_path:
+        matlab_exe_path = shutil.which("matlab")
+        if matlab_exe_path is None:
+            matlab_exe_path = ""
+        else:
+            temp = pathlib.Path(matlab_exe_path)
+            if temp.is_symlink():
+                matlab_exe_path = temp.readlink().as_posix()
+            set_matlab_path(matlab_exe_path)
+        
+    return matlab_exe_path 
+
+__MATLAB_ENGINE = start_matlab()