[OMCSession] define and use OMPathBase

Author: syntron

OMPython/ModelicaSystem.py

@@ -29,7 +29,7 @@
     OMCSession,
     OMCSessionLocal,
 
-    OMPathABC,
+    OMPathBase,
 )
 
 # define logger using the current module name as ID
@@ -388,13 +388,13 @@ def __init__(
         self._version = self._parse_om_version(version=version_str)
 
         self._simulated = False  # True if the model has already been simulated
-        self._result_file: Optional[OMPathABC] = None  # for storing result file
+        self._result_file: Optional[OMPathBase] = None  # for storing result file
 
-        self._work_dir: OMPathABC = self.setWorkDirectory(work_directory)
+        self._work_dir: OMPathBase = self.setWorkDirectory(work_directory)
 
         self._model_name: Optional[str] = None
         self._libraries: Optional[list[str | tuple[str, str]]] = None
-        self._file_name: Optional[OMPathABC] = None
+        self._file_name: Optional[OMPathBase] = None
         self._variable_filter: Optional[str] = None
 
     def get_session(self) -> OMCSession:
@@ -412,7 +412,7 @@ def get_model_name(self) -> str:
 
         return self._model_name
 
-    def setWorkDirectory(self, work_directory: Optional[str | os.PathLike] = None) -> OMPathABC:
+    def setWorkDirectory(self, work_directory: Optional[str | os.PathLike] = None) -> OMPathBase:
         """
         Define the work directory for the ModelicaSystem / OpenModelica session. The model is build within this
         directory. If no directory is defined a unique temporary directory is created.
@@ -434,7 +434,7 @@ def setWorkDirectory(self, work_directory: Optional[str | os.PathLike] = None) -
         # ... and also return the defined path
         return workdir
 
-    def getWorkDirectory(self) -> OMPathABC:
+    def getWorkDirectory(self) -> OMPathBase:
         """
         Return the defined working directory for this ModelicaSystem / OpenModelica session.
         """
@@ -459,7 +459,7 @@ def check_model_executable(self):
         if returncode != 0:
             raise ModelicaSystemError("Model executable not working!")
 
-    def _xmlparse(self, xml_file: OMPathABC):
+    def _xmlparse(self, xml_file: OMPathBase):
         if not xml_file.is_file():
             raise ModelicaSystemError(f"XML file not generated: {xml_file}")
 
@@ -833,7 +833,7 @@ def _parse_om_version(version: str) -> tuple[int, int, int]:
     def _process_override_data(
             self,
             om_cmd: ModelExecutionCmd,
-            override_file: OMPathABC,
+            override_file: OMPathBase,
             override_var: dict[str, str],
             override_sim: dict[str, str],
     ) -> None:
@@ -865,7 +865,7 @@ def _process_override_data(
 
     def simulate_cmd(
             self,
-            result_file: OMPathABC,
+            result_file: OMPathBase,
             simflags: Optional[str] = None,
             simargs: Optional[dict[str, Optional[str | dict[str, Any] | numbers.Number]]] = None,
     ) -> ModelExecutionCmd:
@@ -963,14 +963,14 @@ def simulate(
         if resultfile is None:
             # default result file generated by OM
             self._result_file = self.getWorkDirectory() / f"{self._model_name}_res.mat"
-        elif isinstance(resultfile, OMPathABC):
+        elif isinstance(resultfile, OMPathBase):
             self._result_file = resultfile
         else:
             self._result_file = self._session.omcpath(resultfile)
             if not self._result_file.is_absolute():
                 self._result_file = self.getWorkDirectory() / resultfile
 
-        if not isinstance(self._result_file, OMPathABC):
+        if not isinstance(self._result_file, OMPathBase):
             raise ModelicaSystemError(f"Invalid result file path: {self._result_file} - must be an OMCPath object!")
 
         om_cmd = self.simulate_cmd(
@@ -1295,7 +1295,7 @@ def setInputs(
 
         return True
 
-    def _createCSVData(self, csvfile: Optional[OMPathABC] = None) -> OMPathABC:
+    def _createCSVData(self, csvfile: Optional[OMPathBase] = None) -> OMPathBase:
         """
         Create a csv file with inputs for the simulation/optimization of the model. If csvfile is provided as argument,
         this file is used; else a generic file name is created.
@@ -1623,7 +1623,7 @@ def set_command_line_options(self, command_line_option: str):
         expr = f'setCommandLineOptions("{command_line_option}")'
         self.sendExpression(expr=expr)
 
-    def _loadFile(self, fileName: OMPathABC):
+    def _loadFile(self, fileName: OMPathBase):
         # load file
         self.sendExpression(expr=f'loadFile("{fileName.as_posix()}")')
 
@@ -2004,7 +2004,7 @@ def convertMo2Fmu(
             fmuType: str = "me_cs",
             fileNamePrefix: Optional[str] = None,
             includeResources: bool = True,
-    ) -> OMPathABC:
+    ) -> OMPathBase:
         """Translate the model into a Functional Mockup Unit.
 
         Args:
@@ -2043,7 +2043,7 @@ def convertMo2Fmu(
     def convertFmu2Mo(
             self,
             fmu: os.PathLike,
-    ) -> OMPathABC:
+    ) -> OMPathBase:
         """
         In order to load FMU, at first it needs to be translated into Modelica model. This method is used to generate
         Modelica model from the given FMU. It generates "fmuName_me_FMU.mo".
@@ -2510,7 +2510,7 @@ def get_doe_solutions(
 
 def doe_get_solutions(
         msomc: ModelicaSystemOMC,
-        resultpath: OMPathABC,
+        resultpath: OMPathBase,
         doe_def: Optional[dict] = None,
         var_list: Optional[list] = None,
 ) -> Optional[tuple[str] | dict[str, dict[str, np.ndarray]]]:

OMPython/OMCSession.py

@@ -287,6 +287,7 @@ class OMPathCompatibilityWindows(pathlib.WindowsPath, OMPathCompatibility):
         Compatibility class for OMCPath on Windows systems (Python < 3.12)
         """
 
+    OMPathBase = OMPathCompatibility
     OMCPath = OMPathCompatibility
 else:
     class OMPathABC(pathlib.PurePosixPath, metaclass=abc.ABCMeta):
@@ -513,6 +514,7 @@ def size(self) -> int:
 
             raise OMCSessionException(f"Error reading file size for path {self.as_posix()}!")
 
+    OMPathBase = OMPathABC
     OMCPath = _OMCPath
 
 

OMPython/__init__.py

@@ -23,7 +23,9 @@
     doe_get_solutions,
 )
 from OMPython.OMCSession import (
+    OMPathBase,
     OMCPath,
+
     OMCSession,
 
     ModelExecutionData,
@@ -53,6 +55,7 @@
     'ModelicaDoEOMC',
     'ModelicaSystemError',
 
+    'OMPathBase',
     'OMCPath',
 
     'OMCSession',