ModelicaSystem update __init__() (#350)

* [ModelicaSystem] split __init__()

new:
* __init__() - initialisation
* model_definition() - model related definitions

* [ModelicaSystem] split __init__() - mypy fix in ModelicaSystemCmd

* [ModelicaSystem] split __init__() - mypy fix in convertMo2Fmu()

* [ModelicaSystem] split __init__() - update unittest

* [ModelicaSystem] rename model_definition() => model()

* [ModelicaSystem] fix error message

* [ModelicaSystem.definition()] check if it was called before

* [ModelicaSystem] rename lmodel => libraries

* [ModelicaSystem] update docstring for __init__() and model()

* [test_ModelicaSystem] test_relative_path will fail at the moment; a fix is available

* [test_ModelicaSystem] fix rebase fallout

* [test_ModelicaSystem] fix rebase fallout (2)

* [ModelicaSystemDoE] fix usage of ModelicaSystem

* [ModelicaSystem] fix mypy

* [ModelicaSystem] fix default value for fileNamePrefix

Author: syntron

OMPython/ModelicaSystem.py

@@ -124,9 +124,12 @@ def __init__(
             self,
             session: OMCSessionZMQ,
             runpath: OMCPath,
-            modelname: str,
+            modelname: Optional[str] = None,
             timeout: Optional[float] = None,
     ) -> None:
+        if modelname is None:
+            raise ModelicaSystemError("Missing model name!")
+
         self._session = session
         self._runpath = runpath
         self._model_name = modelname
@@ -321,60 +324,25 @@ def parse_simflags(simflags: str) -> dict[str, Optional[str | dict[str, Any] | n
 class ModelicaSystem:
     def __init__(
             self,
-            fileName: Optional[str | os.PathLike] = None,
-            modelName: Optional[str] = None,
-            lmodel: Optional[list[str | tuple[str, str]]] = None,
             commandLineOptions: Optional[list[str]] = None,
-            variableFilter: Optional[str] = None,
             customBuildDirectory: Optional[str | os.PathLike] = None,
             omhome: Optional[str] = None,
             omc_process: Optional[OMCProcess] = None,
-            build: bool = True,
     ) -> None:
-        """Initialize, load and build a model.
-
-        The constructor loads the model file and builds it, generating exe and
-        xml files, etc.
+        """Create a ModelicaSystem instance. To define the model use model() or convertFmu2Mo().
 
         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.
-            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
-              and lmodel=[("Modelica","3.2.3")] for specifying both the name
-              and the version.
             commandLineOptions: List with extra command line options as elements. The list elements are
               provided to omc via setCommandLineOptions(). If set, the default values will be overridden.
               To disable any command line options, use an empty list.
-            variableFilter: A regular expression. Only variables fully
-              matching the regexp will be stored in the result file.
-              Leaving it unspecified is equivalent to ".*".
             customBuildDirectory: Path to a directory to be used for temporary
               files like the model executable. If left unspecified, a tmp
               directory will be created.
-            omhome: OPENMODELICAHOME value to be used when creating the OMC
-              session.
+            omhome: path to OMC to be used when creating the OMC session (see OMCSessionZMQ).
             omc_process: definition of a (local) OMC process to be used. If
               unspecified, a new local session will be created.
-            build: Boolean controlling whether or not the model should be
-              built when constructor is called. If False, the constructor
-              simply loads the model without compiling.
-
-        Examples:
-            mod = ModelicaSystem("ModelicaModel.mo", "modelName")
-            mod = ModelicaSystem("ModelicaModel.mo", "modelName", ["Modelica"])
-            mod = ModelicaSystem("ModelicaModel.mo", "modelName", [("Modelica","3.2.3"), "PowerSystems"])
         """
 
-        if fileName is None and modelName is None and not lmodel:  # all None
-            raise ModelicaSystemError("Cannot create ModelicaSystem object without any arguments")
-
-        if modelName is None:
-            raise ModelicaSystemError("A modelname must be provided (argument modelName)!")
-
         self._quantities: list[dict[str, Any]] = []
         self._params: dict[str, str] = {}  # even numerical values are stored as str
         self._inputs: dict[str, list | None] = {}
@@ -408,44 +376,86 @@ def __init__(
         for opt in commandLineOptions:
             self.setCommandLineOptions(commandLineOptions=opt)
 
-        if lmodel is None:
-            lmodel = []
+        self._simulated = False  # True if the model has already been simulated
+        self._result_file: Optional[OMCPath] = None  # for storing result file
+
+        self._work_dir: OMCPath = self.setWorkDirectory(customBuildDirectory)
+
+        self._model_name: Optional[str] = None
+        self._libraries: Optional[list[str | tuple[str, str]]] = None
+        self._file_name: Optional[OMCPath] = None
+        self._variable_filter: Optional[str] = None
+
+    def model(
+            self,
+            name: Optional[str] = None,
+            file: Optional[str | os.PathLike] = None,
+            libraries: Optional[list[str | tuple[str, str]]] = None,
+            variable_filter: Optional[str] = None,
+            build: bool = True,
+    ) -> None:
+        """Load and build a Modelica model.
+
+        This method loads the model file and builds it if requested (build == True).
+
+        Args:
+            file: Path to the model file. Either absolute or relative to
+              the current working directory.
+            name: The name of the model class. If it is contained within
+              a package, "PackageName.ModelName" should be used.
+            libraries: 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
+              and lmodel=[("Modelica","3.2.3")] for specifying both the name
+              and the version.
+            variable_filter: A regular expression. Only variables fully
+              matching the regexp will be stored in the result file.
+              Leaving it unspecified is equivalent to ".*".
+            build: Boolean controlling whether the model should be
+              built when constructor is called. If False, the constructor
+              simply loads the model without compiling.
+
+        Examples:
+            mod = ModelicaSystem()
+            # and then one of the lines below
+            mod.model(name="modelName", file="ModelicaModel.mo", )
+            mod.model(name="modelName", file="ModelicaModel.mo", libraries=["Modelica"])
+            mod.model(name="modelName", file="ModelicaModel.mo", libraries=[("Modelica","3.2.3"), "PowerSystems"])
+        """
+
+        if self._model_name is not None:
+            raise ModelicaSystemError("Can not reuse this instance of ModelicaSystem "
+                                      f"defined for {repr(self._model_name)}!")
+
+        if name is None or not isinstance(name, str):
+            raise ModelicaSystemError("A model name must be provided!")
+
+        if libraries is None:
+            libraries = []
 
-        if not isinstance(lmodel, list):
-            raise ModelicaSystemError(f"Invalid input type for lmodel: {type(lmodel)} - list expected!")
+        if not isinstance(libraries, list):
+            raise ModelicaSystemError(f"Invalid input type for libraries: {type(libraries)} - list expected!")
 
-        self._lmodel = lmodel  # may be needed if model is derived from other model
-        self._model_name = modelName  # Model class name
-        if fileName is not None:
-            file_name = self._session.omcpath(fileName).resolve()
+        # set variables
+        self._model_name = name  # Model class name
+        self._libraries = libraries  # may be needed if model is derived from other model
+        if file is not None:
+            file_name = self._session.omcpath(file).resolve()
         else:
             file_name = None
-        self._file_name: Optional[OMCPath] = file_name  # Model file/package name
-        self._simulated = False  # True if the model has already been simulated
-        self._result_file: Optional[OMCPath] = None  # for storing result file
-        self._variable_filter = variableFilter
+        self._file_name = file_name  # Model file/package name
+        self._variable_filter = variable_filter
 
         if self._file_name is not None and not self._file_name.is_file():  # if file does not exist
             raise IOError(f"{self._file_name} does not exist!")
 
-        # set default command Line Options for linearization as
-        # linearize() will use the simulation executable and runtime
-        # flag -l to perform linearization
-        self.setCommandLineOptions("--linearizationDumpLanguage=python")
-        self.setCommandLineOptions("--generateSymbolicLinearization")
-
-        self._work_dir: OMCPath = self.setWorkDirectory(customBuildDirectory)
-
+        if self._libraries:
+            self._loadLibrary(libraries=self._libraries)
         if self._file_name is not None:
-            self._loadLibrary(lmodel=self._lmodel)
             self._loadFile(fileName=self._file_name)
 
-        # allow directly loading models from MSL without fileName
-        elif fileName is None and modelName is not None:
-            self._loadLibrary(lmodel=self._lmodel)
-
         if build:
-            self.buildModel(variableFilter)
+            self.buildModel(variable_filter)
 
     def session(self) -> OMCSessionZMQ:
         """
@@ -465,9 +475,9 @@ def _loadFile(self, fileName: OMCPath):
         self.sendExpression(f'loadFile("{fileName.as_posix()}")')
 
     # for loading file/package, loading model and building model
-    def _loadLibrary(self, lmodel: list):
+    def _loadLibrary(self, libraries: list):
         # load Modelica standard libraries or Modelica files if needed
-        for element in lmodel:
+        for element in libraries:
             if element is not None:
                 if isinstance(element, str):
                     if element.endswith(".mo"):
@@ -1587,9 +1597,13 @@ def _createCSVData(self, csvfile: Optional[OMCPath] = None) -> OMCPath:
 
         return csvfile
 
-    def convertMo2Fmu(self, version: str = "2.0", fmuType: str = "me_cs",
-                      fileNamePrefix: str = "<default>",
-                      includeResources: bool = True) -> str:
+    def convertMo2Fmu(
+            self,
+            version: str = "2.0",
+            fmuType: str = "me_cs",
+            fileNamePrefix: Optional[str] = None,
+            includeResources: bool = True,
+    ) -> str:
         """Translate the model into a Functional Mockup Unit.
 
         Args:
@@ -1606,12 +1620,13 @@ def convertMo2Fmu(self, version: str = "2.0", fmuType: str = "me_cs",
             '/tmp/tmpmhfx9umo/CauerLowPassAnalog.fmu'
         """
 
-        if fileNamePrefix == "<default>":
-            fileNamePrefix = self._model_name
-        if includeResources:
-            includeResourcesStr = "true"
-        else:
-            includeResourcesStr = "false"
+        if fileNamePrefix is None:
+            if self._model_name is None:
+                fileNamePrefix = "<default>"
+            else:
+                fileNamePrefix = self._model_name
+        includeResourcesStr = "true" if includeResources else "false"
+
         properties = (f'version="{version}", fmuType="{fmuType}", '
                       f'fileNamePrefix="{fileNamePrefix}", includeResources={includeResourcesStr}')
         fmu = self._requestApi(apiName='buildModelFMU', entity=self._model_name, properties=properties)
@@ -1903,15 +1918,17 @@ def __init__(
         """
 
         self._mod = ModelicaSystem(
-            fileName=fileName,
-            modelName=modelName,
-            lmodel=lmodel,
             commandLineOptions=commandLineOptions,
-            variableFilter=variableFilter,
             customBuildDirectory=customBuildDirectory,
             omhome=omhome,
             omc_process=omc_process,
         )
+        self._mod.model(
+            file=fileName,
+            name=modelName,
+            libraries=lmodel,
+            variable_filter=variableFilter,
+        )
 
         self._model_name = modelName
 

tests/test_FMIExport.py

@@ -5,8 +5,11 @@
 
 
 def test_CauerLowPassAnalog():
-    mod = OMPython.ModelicaSystem(modelName="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
-                                  lmodel=["Modelica"])
+    mod = OMPython.ModelicaSystem()
+    mod.model(
+        name="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
+        libraries=["Modelica"],
+    )
     tmp = pathlib.Path(mod.getWorkDirectory())
     try:
         fmu = mod.convertMo2Fmu(fileNamePrefix="CauerLowPassAnalog")
@@ -16,7 +19,11 @@ def test_CauerLowPassAnalog():
 
 
 def test_DrumBoiler():
-    mod = OMPython.ModelicaSystem(modelName="Modelica.Fluid.Examples.DrumBoiler.DrumBoiler", lmodel=["Modelica"])
+    mod = OMPython.ModelicaSystem()
+    mod.model(
+        name="Modelica.Fluid.Examples.DrumBoiler.DrumBoiler",
+        libraries=["Modelica"],
+    )
     tmp = pathlib.Path(mod.getWorkDirectory())
     try:
         fmu = mod.convertMo2Fmu(fileNamePrefix="DrumBoiler")