Skip to content

Commit 11dec82

Browse files
committed
[ModelicaSystem] remove obsolete inputs for set*() methods
1 parent ca86982 commit 11dec82

File tree

1 file changed

+7
-50
lines changed

1 file changed

+7
-50
lines changed

OMPython/ModelicaSystem.py

Lines changed: 7 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -939,44 +939,13 @@ def getSolutions(self, varList=None, resultfile=None): # 12
939939

940940
@staticmethod
941941
def _prepare_input_data(
942-
raw_input: str | list[str] | dict[str, Any],
942+
raw_input: dict[str, Any],
943943
) -> dict[str, str]:
944944
"""
945945
Convert raw input to a structured dictionary {'key1': 'value1', 'key2': 'value2'}.
946946
"""
947947

948-
def prepare_str(str_in: str) -> dict[str, str]:
949-
str_in = str_in.replace(" ", "")
950-
key_val_list: list[str] = str_in.split("=")
951-
if len(key_val_list) != 2:
952-
raise ModelicaSystemError(f"Invalid 'key=value' pair: {str_in}")
953-
954-
input_data_from_str: dict[str, str] = {key_val_list[0]: key_val_list[1]}
955-
956-
return input_data_from_str
957-
958948
input_data: dict[str, str] = {}
959-
960-
if isinstance(raw_input, str):
961-
warnings.warn(message="The definition of values to set should use a dictionary, "
962-
"i.e. {'key1': 'val1', 'key2': 'val2', ...}. Please convert all cases which "
963-
"use a string ('key=val') or list ['key1=val1', 'key2=val2', ...]",
964-
category=DeprecationWarning,
965-
stacklevel=3)
966-
return prepare_str(raw_input)
967-
968-
if isinstance(raw_input, list):
969-
warnings.warn(message="The definition of values to set should use a dictionary, "
970-
"i.e. {'key1': 'val1', 'key2': 'val2', ...}. Please convert all cases which "
971-
"use a string ('key=val') or list ['key1=val1', 'key2=val2', ...]",
972-
category=DeprecationWarning,
973-
stacklevel=3)
974-
975-
for item in raw_input:
976-
input_data |= prepare_str(item)
977-
978-
return input_data
979-
980949
if isinstance(raw_input, dict):
981950
for key, val in raw_input.items():
982951
# convert all values to strings to align it on one type: dict[str, str]
@@ -1051,13 +1020,11 @@ def isParameterChangeable(
10511020
return False
10521021
return True
10531022

1054-
def setContinuous(self, cvals: str | list[str] | dict[str, Any]) -> bool:
1023+
def setContinuous(self, cvals: dict[str, Any]) -> bool:
10551024
"""
10561025
This method is used to set continuous values. It can be called:
10571026
with a sequence of continuous name and assigning corresponding values as arguments as show in the example below:
10581027
usage
1059-
>>> setContinuous("Name=value") # depreciated
1060-
>>> setContinuous(["Name1=value1","Name2=value2"]) # depreciated
10611028
>>> setContinuous(cvals={"Name1": "value1", "Name2": "value2"})
10621029
"""
10631030
inputdata = self._prepare_input_data(raw_input=cvals)
@@ -1068,13 +1035,11 @@ def setContinuous(self, cvals: str | list[str] | dict[str, Any]) -> bool:
10681035
datatype="continuous",
10691036
overwritedata=self.overridevariables)
10701037

1071-
def setParameters(self, pvals: str | list[str] | dict[str, Any]) -> bool:
1038+
def setParameters(self, pvals: dict[str, Any]) -> bool:
10721039
"""
10731040
This method is used to set parameter values. It can be called:
10741041
with a sequence of parameter name and assigning corresponding value as arguments as show in the example below:
10751042
usage
1076-
>>> setParameters("Name=value") # depreciated
1077-
>>> setParameters(["Name1=value1","Name2=value2"]) # depreciated
10781043
>>> setParameters(pvals={"Name1": "value1", "Name2": "value2"})
10791044
"""
10801045
inputdata = self._prepare_input_data(raw_input=pvals)
@@ -1085,13 +1050,11 @@ def setParameters(self, pvals: str | list[str] | dict[str, Any]) -> bool:
10851050
datatype="parameter",
10861051
overwritedata=self.overridevariables)
10871052

1088-
def setSimulationOptions(self, simOptions: str | list[str] | dict[str, Any]) -> bool:
1053+
def setSimulationOptions(self, simOptions: dict[str, Any]) -> bool:
10891054
"""
10901055
This method is used to set simulation options. It can be called:
10911056
with a sequence of simulation options name and assigning corresponding values as arguments as show in the example below:
10921057
usage
1093-
>>> setSimulationOptions("Name=value") # depreciated
1094-
>>> setSimulationOptions(["Name1=value1","Name2=value2"]) # depreciated
10951058
>>> setSimulationOptions(simOptions={"Name1": "value1", "Name2": "value2"})
10961059
"""
10971060
inputdata = self._prepare_input_data(raw_input=simOptions)
@@ -1102,13 +1065,11 @@ def setSimulationOptions(self, simOptions: str | list[str] | dict[str, Any]) ->
11021065
datatype="simulation-option",
11031066
overwritedata=self.simoptionsoverride)
11041067

1105-
def setLinearizationOptions(self, linearizationOptions: str | list[str] | dict[str, Any]) -> bool:
1068+
def setLinearizationOptions(self, linearizationOptions: dict[str, Any]) -> bool:
11061069
"""
11071070
This method is used to set linearization options. It can be called:
11081071
with a sequence of linearization options name and assigning corresponding value as arguments as show in the example below
11091072
usage
1110-
>>> setLinearizationOptions("Name=value") # depreciated
1111-
>>> setLinearizationOptions(["Name1=value1","Name2=value2"]) # depreciated
11121073
>>> setLinearizationOptions(linearizationOtions={"Name1": "value1", "Name2": "value2"})
11131074
"""
11141075
inputdata = self._prepare_input_data(raw_input=linearizationOptions)
@@ -1119,13 +1080,11 @@ def setLinearizationOptions(self, linearizationOptions: str | list[str] | dict[s
11191080
datatype="Linearization-option",
11201081
overwritedata=None)
11211082

1122-
def setOptimizationOptions(self, optimizationOptions: str | list[str] | dict[str, Any]) -> bool:
1083+
def setOptimizationOptions(self, optimizationOptions: dict[str, Any]) -> bool:
11231084
"""
11241085
This method is used to set optimization options. It can be called:
11251086
with a sequence of optimization options name and assigning corresponding values as arguments as show in the example below:
11261087
usage
1127-
>>> setOptimizationOptions("Name=value") # depreciated
1128-
>>> setOptimizationOptions(["Name1=value1","Name2=value2"]) # depreciated
11291088
>>> setOptimizationOptions(optimizationOptions={"Name1": "value1", "Name2": "value2"})
11301089
"""
11311090
inputdata = self._prepare_input_data(raw_input=optimizationOptions)
@@ -1136,15 +1095,13 @@ def setOptimizationOptions(self, optimizationOptions: str | list[str] | dict[str
11361095
datatype="optimization-option",
11371096
overwritedata=None)
11381097

1139-
def setInputs(self, name: str | list[str] | dict[str, Any]) -> bool:
1098+
def setInputs(self, name: dict[str, Any]) -> bool:
11401099
"""
11411100
This method is used to set input values. It can be called with a sequence of input name and assigning
11421101
corresponding values as arguments as show in the example below. Compared to other set*() methods this is a
11431102
special case as value could be a list of tuples - these are converted to a string in _prepare_input_data()
11441103
and restored here via ast.literal_eval().
11451104
1146-
>>> setInputs("Name=value") # depreciated
1147-
>>> setInputs(["Name1=value1","Name2=value2"]) # depreciated
11481105
>>> setInputs(name={"Name1": "value1", "Name2": "value2"})
11491106
"""
11501107
inputdata = self._prepare_input_data(raw_input=name)

0 commit comments

Comments
 (0)