Rename _modelName to _model_name

Author: ondras12345

OMPython/ModelicaSystem.py

@@ -117,7 +117,7 @@ class ModelicaSystemCmd:
 
     def __init__(self, runpath: pathlib.Path, modelname: str, timeout: Optional[float] = None) -> None:
         self._runpath = pathlib.Path(runpath).resolve().absolute()
-        self._modelname = modelname
+        self._model_name = modelname
         self._timeout = timeout
         self._args: dict[str, str | None] = {}
         self._arg_override: dict[str, str] = {}
@@ -179,9 +179,9 @@ def args_set(self, args: dict[str, Optional[str | dict[str, str]]]) -> None:
     def get_exe(self) -> pathlib.Path:
         """Get the path to the compiled model executable."""
         if platform.system() == "Windows":
-            path_exe = self._runpath / f"{self._modelname}.exe"
+            path_exe = self._runpath / f"{self._model_name}.exe"
         else:
-            path_exe = self._runpath / self._modelname
+            path_exe = self._runpath / self._model_name
 
         if not path_exe.exists():
             raise ModelicaSystemError(f"Application file path not found: {path_exe}")
@@ -221,7 +221,7 @@ def run(self) -> int:
             path_dll = ""
 
             # set the process environment from the generated .bat file in windows which should have all the dependencies
-            path_bat = self._runpath / f"{self._modelname}.bat"
+            path_bat = self._runpath / f"{self._model_name}.bat"
             if not path_bat.exists():
                 raise ModelicaSystemError("Batch file (*.bat) does not exist " + str(path_bat))
 
@@ -385,7 +385,7 @@ def __init__(
 
         self._xml_file = None
         self._lmodel = lmodel  # may be needed if model is derived from other model
-        self._modelName = modelName  # Model class name
+        self._model_name = modelName  # Model class name
         self._fileName = pathlib.Path(fileName).resolve() if fileName is not None else None  # Model file/package name
         self._inputFlag = False  # for model with input quantity
         self._simulationFlag = False  # if the model is simulated?
@@ -479,7 +479,7 @@ def buildModel(self, variableFilter: Optional[str] = None):
         else:
             varFilter = 'variableFilter=".*"'
 
-        buildModelResult = self._requestApi("buildModel", self._modelName, properties=varFilter)
+        buildModelResult = self._requestApi("buildModel", self._model_name, properties=varFilter)
         logger.debug("OM model build result: %s", buildModelResult)
 
         self._xml_file = pathlib.Path(buildModelResult[0]).parent / buildModelResult[1]
@@ -938,11 +938,11 @@ def simulate(self,
             mod.simulate(simargs={"noEventEmit": None, "noRestart": None, "override": "override": {"e": 0.3, "g": 10}})  # using simargs
         """
 
-        om_cmd = ModelicaSystemCmd(runpath=self._tempdir, modelname=self._modelName, timeout=timeout)
+        om_cmd = ModelicaSystemCmd(runpath=self._tempdir, modelname=self._model_name, timeout=timeout)
 
         if resultfile is None:
             # default result file generated by OM
-            self._resultfile = self._tempdir / f"{self._modelName}_res.mat"
+            self._resultfile = self._tempdir / f"{self._model_name}_res.mat"
         elif os.path.exists(resultfile):
             self._resultfile = pathlib.Path(resultfile)
         else:
@@ -957,7 +957,7 @@ def simulate(self,
         if simargs:
             om_cmd.args_set(args=simargs)
 
-        overrideFile = self._tempdir / f"{self._modelName}_override.txt"
+        overrideFile = self._tempdir / f"{self._model_name}_override.txt"
         if self._override_variables or self._simulate_options_override:
             tmpdict = self._override_variables.copy()
             tmpdict.update(self._simulate_options_override)
@@ -1145,7 +1145,7 @@ def isParameterChangeable(self, name, value):
         if q[0]["changeable"] == "false":
             logger.debug(f"setParameters() failed : It is not possible to set the following signal {repr(name)}. "
                          "It seems to be structural, final, protected or evaluated or has a non-constant binding, "
-                         f"use sendExpression(\"setParameterValue({self._modelName}, {name}, {value})\") "
+                         f"use sendExpression(\"setParameterValue({self._model_name}, {name}, {value})\") "
                          "and rebuild the model using buildModel() API")
             return False
         return True
@@ -1272,7 +1272,7 @@ def _createCSVData(self) -> pathlib.Path:
             ]
             csv_rows.append(row)
 
-        csvFile = self._tempdir / f'{self._modelName}.csv'
+        csvFile = self._tempdir / f'{self._model_name}.csv'
 
         with open(file=csvFile, mode="w", encoding="utf-8", newline="") as fh:
             writer = csv.writer(fh)
@@ -1299,13 +1299,13 @@ def convertMo2Fmu(self, version: str = "2.0", fmuType: str = "me_cs",
         """
 
         if fileNamePrefix == "<default>":
-            fileNamePrefix = self._modelName
+            fileNamePrefix = self._model_name
         if includeResources:
             includeResourcesStr = "true"
         else:
             includeResourcesStr = "false"
         properties = f'version="{version}", fmuType="{fmuType}", fileNamePrefix="{fileNamePrefix}", includeResources={includeResourcesStr}'
-        fmu = self._requestApi('buildModelFMU', self._modelName, properties)
+        fmu = self._requestApi('buildModelFMU', self._model_name, properties)
 
         # report proper error message
         if not os.path.exists(fmu):
@@ -1357,7 +1357,7 @@ def optimize(self) -> dict[str, Any]:
              'timeTemplates': 0.002007785,
              'timeTotal': 1.079097854}
         """
-        cName = self._modelName
+        cName = self._model_name
         properties = ','.join(f"{key}={val}" for key, val in self._optimization_options.items())
         self.setCommandLineOptions("-g=Optimica")
         optimizeResult = self._requestApi('optimize', cName, properties)
@@ -1402,9 +1402,9 @@ def load_module_from_path(module_name, file_path):
                 "use ModelicaSystem() to build the model first"
             )
 
-        om_cmd = ModelicaSystemCmd(runpath=self._tempdir, modelname=self._modelName, timeout=timeout)
+        om_cmd = ModelicaSystemCmd(runpath=self._tempdir, modelname=self._model_name, timeout=timeout)
 
-        overrideLinearFile = self._tempdir / f'{self._modelName}_override_linear.txt'
+        overrideLinearFile = self._tempdir / f'{self._model_name}_override_linear.txt'
 
         with open(file=overrideLinearFile, mode="w", encoding="utf-8") as fh:
             for key, value in self._override_variables.items():
@@ -1443,9 +1443,9 @@ def load_module_from_path(module_name, file_path):
         # code to get the matrix and linear inputs, outputs and states
         linearFile = self._tempdir / "linearized_model.py"
 
-        # support older openmodelica versions before OpenModelica v1.16.2 where linearize() generates "linear_modelname.mo" file
+        # support older openmodelica versions before OpenModelica v1.16.2 where linearize() generates "linear_model_name.mo" file
         if not linearFile.exists():
-            linearFile = pathlib.Path(f'linear_{self._modelName}.py')
+            linearFile = pathlib.Path(f'linear_{self._model_name}.py')
 
         if not linearFile.exists():
             raise ModelicaSystemError(f"Linearization failed: {linearFile} not found!")

tests/test_ModelicaSystemCmd.py

@@ -18,7 +18,7 @@ def model_firstorder(tmp_path):
 @pytest.fixture
 def mscmd_firstorder(model_firstorder):
     mod = OMPython.ModelicaSystem(fileName=model_firstorder.as_posix(), modelName="M")
-    mscmd = OMPython.ModelicaSystemCmd(runpath=mod.getWorkDirectory(), modelname=mod._modelName)
+    mscmd = OMPython.ModelicaSystemCmd(runpath=mod.getWorkDirectory(), modelname=mod._model_name)
     return mscmd