[ModelicaSystem] fix mypy warnings - fix reorder of inputs

* define modelName as first (required!) argument
* use *kwargs in tests

Author: syntron

OMPython/ModelicaSystem.py

@@ -314,8 +314,8 @@ def parse_simflags(simflags: str) -> dict[str, Optional[str | dict[str, str]]]:
 class ModelicaSystem:
     def __init__(
             self,
-            fileName: Optional[str | os.PathLike] = None,
-            modelName: Optional[str] = None,
+            modelName: str,
+            fileName: Optional[str | os.PathLike | pathlib.Path] = None,
             lmodel: Optional[list[str | tuple[str, str]]] = None,
             commandLineOptions: Optional[str] = None,
             variableFilter: Optional[str] = None,
@@ -330,10 +330,10 @@ def __init__(
         xml files, etc.
 
         Args:
-            fileName: Path to the model file. Either absolute or relative to
-              the current working directory.
             modelName: The name of the model class. If it is contained within
               a package, "PackageName.ModelName" should be used.
+            fileName: Path to the model file. Either absolute or relative to
+              the current working directory.
             lmodel: List of libraries to be loaded before the model itself is
               loaded. Two formats are supported for the list elements:
               lmodel=["Modelica"] for just the library name
@@ -421,7 +421,7 @@ def __init__(
             self.loadFile(fileName=self.fileName)
 
         # allow directly loading models from MSL without fileName
-        elif fileName is None and modelName is not None:
+        else:
             self.loadLibrary(lmodel=self.lmodel)
 
         if build:

tests/test_ModelicaSystem.py

@@ -26,7 +26,7 @@ def __del__(self):
     def testModelicaSystemLoop(self):
         def worker():
             filePath = (self.tmp / "M.mo").as_posix()
-            m = OMPython.ModelicaSystem(filePath, "M")
+            m = OMPython.ModelicaSystem(fileName=filePath, modelName="M")
             m.simulate()
             m.convertMo2Fmu(fmuType="me")
         for _ in range(10):
@@ -35,7 +35,7 @@ def worker():
     def test_setParameters(self):
         omc = OMPython.OMCSessionZMQ()
         model_path = omc.sendExpression("getInstallationDirectoryPath()") + "/share/doc/omc/testmodels/"
-        mod = OMPython.ModelicaSystem(model_path + "BouncingBall.mo", "BouncingBall")
+        mod = OMPython.ModelicaSystem(fileName=model_path + "BouncingBall.mo", modelName="BouncingBall")
 
         # method 1
         mod.setParameters("e=1.234")
@@ -59,7 +59,7 @@ def test_setParameters(self):
     def test_setSimulationOptions(self):
         omc = OMPython.OMCSessionZMQ()
         model_path = omc.sendExpression("getInstallationDirectoryPath()") + "/share/doc/omc/testmodels/"
-        mod = OMPython.ModelicaSystem(model_path + "BouncingBall.mo", "BouncingBall")
+        mod = OMPython.ModelicaSystem(fileName=model_path + "BouncingBall.mo", modelName="BouncingBall")
 
         # method 1
         mod.setSimulationOptions("stopTime=1.234")
@@ -89,7 +89,7 @@ def test_relative_path(self):
             model_relative = str(model_file)
             assert "/" not in model_relative
 
-            mod = OMPython.ModelicaSystem(model_relative, "M")
+            mod = OMPython.ModelicaSystem(fileName=model_relative, modelName="M")
             assert float(mod.getParameters("a")[0]) == -1
         finally:
             # clean up the temporary file
@@ -99,7 +99,7 @@ def test_customBuildDirectory(self):
         filePath = (self.tmp / "M.mo").as_posix()
         tmpdir = self.tmp / "tmpdir1"
         tmpdir.mkdir()
-        m = OMPython.ModelicaSystem(filePath, "M", customBuildDirectory=tmpdir)
+        m = OMPython.ModelicaSystem(fileName=filePath, modelName="M", customBuildDirectory=tmpdir)
         assert m.getWorkDirectory().resolve() == tmpdir.resolve()
         result_file = tmpdir / "a.mat"
         assert not result_file.exists()
@@ -108,7 +108,7 @@ def test_customBuildDirectory(self):
 
     def test_getSolutions(self):
         filePath = (self.tmp / "M.mo").as_posix()
-        mod = OMPython.ModelicaSystem(filePath, "M")
+        mod = OMPython.ModelicaSystem(fileName=filePath, modelName="M")
         x0 = 1
         a = -1
         tau = -1 / a
@@ -144,7 +144,7 @@ def test_getters(self):
   y = der(x);
 end M_getters;
 """)
-        mod = OMPython.ModelicaSystem(model_file.as_posix(), "M_getters")
+        mod = OMPython.ModelicaSystem(fileName=model_file.as_posix(), modelName="M_getters")
 
         q = mod.getQuantities()
         assert isinstance(q, list)
@@ -322,7 +322,7 @@ def test_simulate_inputs(self):
   y = x;
 end M_input;
 """)
-        mod = OMPython.ModelicaSystem(model_file.as_posix(), "M_input")
+        mod = OMPython.ModelicaSystem(fileName=model_file.as_posix(), modelName="M_input")
 
         mod.setSimulationOptions("stopTime=1.0")
 

tests/test_ModelicaSystemCmd.py

@@ -23,7 +23,7 @@ def __init__(self, *args, **kwargs):
   der(x) = x*a;
 end M;
                    """)
-        self.mod = OMPython.ModelicaSystem(self.model.as_posix(), "M")
+        self.mod = OMPython.ModelicaSystem(fileName=self.model.as_posix(), modelName="M")
 
     def __del__(self):
         shutil.rmtree(self.tmp, ignore_errors=True)

tests/test_linearization.py

@@ -31,7 +31,7 @@ def __del__(self):
 
     def test_example(self):
         filePath = (self.tmp / "linearTest.mo").as_posix()
-        mod = OMPython.ModelicaSystem(filePath, "linearTest")
+        mod = OMPython.ModelicaSystem(fileName=filePath, modelName="linearTest")
         [A, B, C, D] = mod.linearize()
         expected_matrixA = [[-3, 2, 0, 0], [-7, 0, -5, 1], [-1, 0, -1, 4], [0, 1, -1, 5]]
         assert A == expected_matrixA, f"Matrix does not match the expected value. Got: {A}, Expected: {expected_matrixA}"
@@ -61,7 +61,7 @@ def test_getters(self):
     y2 = phi + u1;
 end Pendulum;
 """)
-        mod = OMPython.ModelicaSystem(model_file.as_posix(), "Pendulum", ["Modelica"])
+        mod = OMPython.ModelicaSystem(fileName=model_file.as_posix(), modelName="Pendulum", lmodel=["Modelica"])
 
         d = mod.getLinearizationOptions()
         assert isinstance(d, dict)

tests/test_optimization.py

@@ -45,7 +45,7 @@ def test_example(self):
 end BangBang2021;
 """)
 
-        mod = OMPython.ModelicaSystem(model_file.as_posix(), "BangBang2021")
+        mod = OMPython.ModelicaSystem(fileName=model_file.as_posix(), modelName="BangBang2021")
 
         mod.setOptimizationOptions(["numberOfIntervals=16", "stopTime=1",
                                     "stepSize=0.001", "tolerance=1e-8"])