Skip to content

[ModelicaSystem] add type hints for requestApi() and use kwargs for all calls #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 20, 2025
Merged

[ModelicaSystem] add type hints for requestApi() and use kwargs for all calls #340

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b13ba2
[ModelicaSystem] add type hints for requestApi() and use kwargs for a…
syntron Jun 23, 2025
78c9d8f
Merge branch 'master' into ModelicaSystem_requestApi
adeas31 Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions OMPython/ModelicaSystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ def _loadLibrary(self, lmodel: list):
apiCall = "loadFile"
else:
apiCall = "loadModel"
self._requestApi(apiCall, element)
self._requestApi(apiName=apiCall, entity=element)
elif isinstance(element, tuple):
if not element[1]:
expr_load_lib = f"loadModel({element[0]})"
Expand Down Expand Up @@ -483,13 +483,13 @@ def buildModel(self, variableFilter: Optional[str] = None):
else:
varFilter = 'variableFilter=".*"'

buildModelResult = self._requestApi("buildModel", self._model_name, properties=varFilter)
buildModelResult = self._requestApi(apiName="buildModel", entity=self._model_name, properties=varFilter)
logger.debug("OM model build result: %s", buildModelResult)

xml_file = pathlib.Path(buildModelResult[0]).parent / buildModelResult[1]
self._xmlparse(xml_file=xml_file)

def sendExpression(self, expr: str, parsed: bool = True):
def sendExpression(self, expr: str, parsed: bool = True) -> Any:
try:
retval = self._getconn.sendExpression(expr, parsed)
except OMCSessionException as ex:
Expand All @@ -500,7 +500,12 @@ def sendExpression(self, expr: str, parsed: bool = True):
return retval

# request to OMC
def _requestApi(self, apiName, entity=None, properties=None): # 2
def _requestApi(
self,
apiName: str,
entity: Optional[str] = None,
properties: Optional[str] = None,
) -> Any:
if entity is not None and properties is not None:
exp = f'{apiName}({entity}, {properties})'
elif entity is not None and properties is None:
Expand Down Expand Up @@ -1475,8 +1480,9 @@ def convertMo2Fmu(self, version: str = "2.0", fmuType: str = "me_cs",
includeResourcesStr = "true"
else:
includeResourcesStr = "false"
properties = f'version="{version}", fmuType="{fmuType}", fileNamePrefix="{fileNamePrefix}", includeResources={includeResourcesStr}'
fmu = self._requestApi('buildModelFMU', self._model_name, properties)
properties = (f'version="{version}", fmuType="{fmuType}", '
f'fileNamePrefix="{fileNamePrefix}", includeResources={includeResourcesStr}')
fmu = self._requestApi(apiName='buildModelFMU', entity=self._model_name, properties=properties)

# report proper error message
if not os.path.exists(fmu):
Expand All @@ -1493,7 +1499,7 @@ def convertFmu2Mo(self, fmuName): # 20
>>> convertFmu2Mo("c:/BouncingBall.Fmu")
"""

fileName = self._requestApi('importFMU', fmuName)
fileName = self._requestApi(apiName='importFMU', entity=fmuName)

# report proper error message
if not os.path.exists(fileName):
Expand Down Expand Up @@ -1531,7 +1537,7 @@ def optimize(self) -> dict[str, Any]:
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)
optimizeResult = self._requestApi(apiName='optimize', entity=cName, properties=properties)

return optimizeResult

Expand Down
Loading