hbj

Author: StephenNneji

RATapi/examples/normal_reflectivity/DSPC_custom_layers.py

@@ -128,9 +128,13 @@ 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")
+
+    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/inputs.py

@@ -80,9 +80,9 @@ def get_handle(self, index: int):
         if custom_file["language"] == Languages.Python:
             file_handle = get_python_handle(custom_file["filename"], custom_file["function_name"], custom_file["path"])
         elif custom_file["language"] == Languages.Matlab:
-            file_handle = RATapi.wrappers.MatlabWrapper(full_path).getHandle()
+            file_handle = RATapi.wrappers.MatlabWrapper(full_path).get_handle()
         elif custom_file["language"] == Languages.Cpp:
-            file_handle = RATapi.wrappers.DylibWrapper(full_path, custom_file["function_name"]).getHandle()
+            file_handle = RATapi.wrappers.DylibWrapper(full_path, custom_file["function_name"]).get_handle()
 
         return file_handle
 

RATapi/wrappers.py

@@ -1,12 +1,13 @@
 """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, suppress
-from typing import Callable, Tuple
+from typing import Callable
 
 from numpy.typing import ArrayLike
 
@@ -17,6 +18,13 @@
 
 
 def get_matlab_engine():
+    """Return MATLAB engine object if available else None.
+
+    Returns
+    -------
+    engine : Optional[RATapi.rat_core.MatlabEngine]
+        A matlab engine object
+    """
     return __MATLAB_ENGINE
 
 
@@ -37,7 +45,7 @@ def cd(new_dir: str):
         os.chdir(prev_dir)
 
 
-def get_matlab_paths(matlab_exe_path: str) -> Tuple[str, str]:
+def get_matlab_paths(matlab_exe_path: str) -> tuple[str, str]:
     """Return paths for loading MATLAB engine C interface dynamic libraries.
 
     Parameters
@@ -71,14 +79,14 @@ def get_matlab_paths(matlab_exe_path: str) -> Tuple[str, str]:
     return f"{bin_path.as_posix()}/", f"{dll_path.as_posix()}/"
 
 
-def start_matlab(matlab_exe_path: str =""):
+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]
@@ -96,7 +104,7 @@ def start_matlab(matlab_exe_path: str =""):
             engine = RATapi.rat_core.MatlabEngine()
         # Ensure MATLAB is closed when Python shuts down.
         atexit.register(engine.close)
-    
+
         return engine
 
 
@@ -112,14 +120,13 @@ def set_matlab_path(matlab_exe_path: str) -> None:
     """
     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()
@@ -148,7 +155,7 @@ def __init__(self, filename) -> None:
         engine.cd(str(path.parent))
         engine.setFunction(path.stem)
 
-    def getHandle(self) -> Callable[[ArrayLike, ArrayLike, ArrayLike, int, int], tuple[ArrayLike, float]]:
+    def get_handle(self) -> Callable[[ArrayLike, ArrayLike, ArrayLike, int, int], tuple[ArrayLike, float]]:
         """Return a wrapper for the custom dynamic library function.
 
         Returns
@@ -179,7 +186,7 @@ class DylibWrapper:
     def __init__(self, filename, function_name) -> None:
         self.engine = RATapi.rat_core.DylibEngine(filename, function_name)
 
-    def getHandle(self) -> Callable[[ArrayLike, ArrayLike, ArrayLike, int, int], tuple[ArrayLike, float]]:
+    def get_handle(self) -> Callable[[ArrayLike, ArrayLike, ArrayLike, int, int], tuple[ArrayLike, float]]:
         """Return a wrapper for the custom dynamic library function.
 
         Returns
@@ -196,6 +203,18 @@ def handle(*args):
 
 
 def find_existing_matlab() -> str:
+    """Find existing MATLAB from cache file or checking if the MATLAB command is available.
+
+    Parameters
+    ----------
+    matlab_exe_path : str, default ""
+        The full path of the MATLAB executable
+
+    Returns
+    -------
+    engine : Optional[RATapi.rat_core.MatlabEngine]
+        A matlab engine object
+    """
     matlab_exe_path = ""
 
     with suppress(FileNotFoundError), open(MATLAB_PATH_FILE) as path_file:
@@ -210,7 +229,8 @@ def find_existing_matlab() -> str:
             if temp.is_symlink():
                 matlab_exe_path = temp.readlink().as_posix()
             set_matlab_path(matlab_exe_path)
-        
-    return matlab_exe_path 
+
+    return matlab_exe_path
+
 
 __MATLAB_ENGINE = start_matlab()

tests/test_wrappers.py

@@ -20,7 +20,7 @@ def test_matlab_wrapper() -> None:
         assert pathlib.Path(mocked_engine.cd.call_args[0][0]).samefile(".")
 
         wrapper.engine.invoke.return_value = ([2], 5)
-        handle = wrapper.getHandle()
+        handle = wrapper.get_handle()
         result = handle([1], [2], [3], 0)
         assert result == ([2], 5)
         assert wrapper.engine.invoke.call_args[0] == ([1], [2], [3], 0)
@@ -40,7 +40,7 @@ def test_dylib_wrapper() -> None:
         mocked_engine.assert_called_once_with("demo.dylib", "demo")
 
         wrapper.engine.invoke.return_value = ([2], 5)
-        handle = wrapper.getHandle()
+        handle = wrapper.get_handle()
         result = handle([1], [2], [3], 0)
         assert result == ([2], 5)
         assert wrapper.engine.invoke.call_args[0] == ([1], [2], [3], 0)