[ModelicaSystem] use pathlib.Path() / simplify

Author: syntron

OMPython/ModelicaSystem.py

@@ -317,7 +317,7 @@ def __init__(
             lmodel: Optional[list[str | tuple[str, str]]] = None,
             commandLineOptions: Optional[str] = None,
             variableFilter: Optional[str] = None,
-            customBuildDirectory: Optional[str | os.PathLike] = None,
+            customBuildDirectory: Optional[str | os.PathLike | pathlib.Path] = None,
             omhome: Optional[str] = None,
             session: Optional[OMCSessionZMQ] = None,
             build: Optional[bool] = True
@@ -375,7 +375,6 @@ def __init__(
         self.linearinputs = []  # linearization input list
         self.linearoutputs = []  # linearization output list
         self.linearstates = []  # linearization  states list
-        self.tempdir = ""
 
         if session is not None:
             if not isinstance(session, OMCSessionZMQ):
@@ -413,7 +412,7 @@ def __init__(
         self.setCommandLineOptions("--linearizationDumpLanguage=python")
         self.setCommandLineOptions("--generateSymbolicLinearization")
 
-        self.setTempDirectory(customBuildDirectory)
+        self.tempdir = self.setTempDirectory(customBuildDirectory)
 
         if self.fileName is not None:
             self.loadLibrary(lmodel=self.lmodel)
@@ -461,22 +460,24 @@ def loadLibrary(self, lmodel: list):
                                               '1)["Modelica"]\n'
                                               '2)[("Modelica","3.2.3"), "PowerSystems"]\n')
 
-    def setTempDirectory(self, customBuildDirectory):
+    def setTempDirectory(self, customBuildDirectory) -> pathlib.Path:
         # create a unique temp directory for each session and build the model in that directory
         if customBuildDirectory is not None:
             if not os.path.exists(customBuildDirectory):
                 raise IOError(customBuildDirectory, " does not exist")
-            self.tempdir = customBuildDirectory
+            tempdir = pathlib.Path(customBuildDirectory)
         else:
-            self.tempdir = tempfile.mkdtemp()
-            if not os.path.exists(self.tempdir):
-                raise IOError(self.tempdir, " cannot be created")
+            tempdir = pathlib.Path(tempfile.mkdtemp())
+            if not tempdir.is_dir():
+                raise IOError(tempdir, " cannot be created")
 
-        logger.info("Define tempdir as %s", self.tempdir)
-        exp = f'cd("{pathlib.Path(self.tempdir).absolute().as_posix()}")'
+        logger.info("Define tempdir as %s", tempdir)
+        exp = f'cd("{tempdir.absolute().as_posix()}")'
         self.sendExpression(exp)
 
-    def getWorkDirectory(self):
+        return tempdir
+
+    def getWorkDirectory(self) -> pathlib.Path:
         return self.tempdir
 
     def buildModel(self, variableFilter=None):
@@ -814,15 +815,15 @@ def simulate(self, resultfile: Optional[str] = None, simflags: Optional[str] = N
         >>> simulate(simargs={"noEventEmit": None, "noRestart": None, "override": "e=0.3,g=10"})  # using simargs
         """
 
-        om_cmd = ModelicaSystemCmd(runpath=pathlib.Path(self.tempdir), modelname=self.modelName, timeout=timeout)
+        om_cmd = ModelicaSystemCmd(runpath=self.tempdir, modelname=self.modelName, timeout=timeout)
 
         if resultfile is None:
             # default result file generated by OM
-            self.resultfile = (pathlib.Path(self.tempdir) / f"{self.modelName}_res.mat").as_posix()
+            self.resultfile = (self.tempdir / f"{self.modelName}_res.mat").as_posix()
         elif os.path.exists(resultfile):
             self.resultfile = resultfile
         else:
-            self.resultfile = (pathlib.Path(self.tempdir) / resultfile).as_posix()
+            self.resultfile = (self.tempdir / resultfile).as_posix()
         # always define the resultfile to use
         om_cmd.arg_set(key="r", val=self.resultfile)
 
@@ -833,7 +834,7 @@ def simulate(self, resultfile: Optional[str] = None, simflags: Optional[str] = N
         if simargs:
             om_cmd.args_set(args=simargs)
 
-        overrideFile = pathlib.Path(self.tempdir) / f"{self.modelName}_override.txt"
+        overrideFile = self.tempdir / f"{self.modelName}_override.txt"
         if self.overridevariables or self.simoptionsoverride:
             tmpdict = self.overridevariables.copy()
             tmpdict.update(self.simoptionsoverride)
@@ -1108,7 +1109,7 @@ def createCSVData(self) -> pathlib.Path:
             ]
             csv_rows.append(row)
 
-        csvFile = pathlib.Path(self.tempdir) / f'{self.modelName}.csv'
+        csvFile = self.tempdir / f'{self.modelName}.csv'
 
         with open(csvFile, "w", newline="") as f:
             writer = csv.writer(f)
@@ -1200,9 +1201,9 @@ def linearize(self, lintime: Optional[float] = None, simflags: Optional[str] = N
             raise IOError("Linearization cannot be performed as the model is not build, "
                           "use ModelicaSystem() to build the model first")
 
-        om_cmd = ModelicaSystemCmd(runpath=pathlib.Path(self.tempdir), modelname=self.modelName, timeout=timeout)
+        om_cmd = ModelicaSystemCmd(runpath=self.tempdir, modelname=self.modelName, timeout=timeout)
 
-        overrideLinearFile = pathlib.Path(self.tempdir) / f'{self.modelName}_override_linear.txt'
+        overrideLinearFile = self.tempdir / f'{self.modelName}_override_linear.txt'
 
         with open(overrideLinearFile, "w") as file:
             for key, value in self.overridevariables.items():
@@ -1235,7 +1236,7 @@ def linearize(self, lintime: Optional[float] = None, simflags: Optional[str] = N
         self.simulationFlag = om_cmd.run()
 
         # code to get the matrix and linear inputs, outputs and states
-        linearFile = pathlib.Path(self.tempdir) / "linearized_model.py"
+        linearFile = self.tempdir / "linearized_model.py"
 
         # support older openmodelica versions before OpenModelica v1.16.2 where linearize() generates "linear_modelname.mo" file
         if not linearFile.exists():

tests/test_ModelicaSystem.py

@@ -100,7 +100,7 @@ def test_customBuildDirectory(self):
         tmpdir = self.tmp / "tmpdir1"
         tmpdir.mkdir()
         m = OMPython.ModelicaSystem(filePath, "M", customBuildDirectory=tmpdir)
-        assert pathlib.Path(m.getWorkDirectory()).resolve() == tmpdir.resolve()
+        assert m.getWorkDirectory().resolve() == tmpdir.resolve()
         result_file = tmpdir / "a.mat"
         assert not result_file.exists()
         m.simulate(resultfile="a.mat")