Merge branch 'remove_depreciated_functionality' into v5.0.0-syntron7

Author: syntron

OMPython/ModelicaSystem.py

@@ -283,44 +283,6 @@ def definition(self) -> OMCSessionRunData:
 
         return omc_run_data_updated
 
-    @staticmethod
-    def parse_simflags(simflags: str) -> dict[str, Optional[str | dict[str, Any] | numbers.Number]]:
-        """
-        Parse a simflag definition; this is deprecated!
-
-        The return data can be used as input for self.args_set().
-        """
-        warnings.warn("The argument 'simflags' is depreciated and will be removed in future versions; "
-                      "please use 'simargs' instead", DeprecationWarning, stacklevel=2)
-
-        simargs: dict[str, Optional[str | dict[str, Any] | numbers.Number]] = {}
-
-        args = [s for s in simflags.split(' ') if s]
-        for arg in args:
-            if arg[0] != '-':
-                raise ModelicaSystemError(f"Invalid simulation flag: {arg}")
-            arg = arg[1:]
-            parts = arg.split('=')
-            if len(parts) == 1:
-                simargs[parts[0]] = None
-            elif parts[0] == 'override':
-                override = '='.join(parts[1:])
-
-                override_dict = {}
-                for item in override.split(','):
-                    kv = item.split('=')
-                    if not 0 < len(kv) < 3:
-                        raise ModelicaSystemError(f"Invalid value for '-override': {override}")
-                    if kv[0]:
-                        try:
-                            override_dict[kv[0]] = kv[1]
-                        except (KeyError, IndexError) as ex:
-                            raise ModelicaSystemError(f"Invalid value for '-override': {override}") from ex
-
-                simargs[parts[0]] = override_dict
-
-        return simargs
-
 
 class ModelicaSystem:
     """
@@ -1052,7 +1014,6 @@ def getOptimizationOptions(
     def simulate_cmd(
             self,
             result_file: OMCPath,
-            simflags: Optional[str] = None,
             simargs: Optional[dict[str, Optional[str | dict[str, Any] | numbers.Number]]] = None,
             timeout: Optional[float] = None,
     ) -> ModelicaSystemCmd:
@@ -1066,13 +1027,6 @@ def simulate_cmd(
         However, if only non-structural parameters are used, it is possible to reuse an existing instance of
         ModelicaSystem to create several version ModelicaSystemCmd to run the model using different settings.
 
-        Parameters
-        ----------
-        result_file
-        simflags
-        simargs
-        timeout
-
         Returns
         -------
             An instance if ModelicaSystemCmd to run the requested simulation.
@@ -1088,11 +1042,7 @@ def simulate_cmd(
         # always define the result file to use
         om_cmd.arg_set(key="r", val=result_file.as_posix())
 
-        # allow runtime simulation flags from user input
-        if simflags is not None:
-            om_cmd.args_set(args=om_cmd.parse_simflags(simflags=simflags))
-
-        if simargs:
+        if simargs is not None:
             om_cmd.args_set(args=simargs)
 
         if self._override_variables or self._simulate_options_override:
@@ -1130,7 +1080,6 @@ def simulate_cmd(
     def simulate(
             self,
             resultfile: Optional[str | os.PathLike] = None,
-            simflags: Optional[str] = None,
             simargs: Optional[dict[str, Optional[str | dict[str, Any] | numbers.Number]]] = None,
             timeout: Optional[float] = None,
     ) -> None:
@@ -1140,8 +1089,6 @@ def simulate(
 
         Args:
             resultfile: Path to a custom result file
-            simflags: String of extra command line flags for the model binary.
-              This argument is deprecated, use simargs instead.
             simargs: Dict with simulation runtime flags.
             timeout: Maximum execution time in seconds.
 
@@ -1169,7 +1116,6 @@ def simulate(
 
         om_cmd = self.simulate_cmd(
             result_file=self._result_file,
-            simflags=simflags,
             simargs=simargs,
             timeout=timeout,
         )
@@ -1681,7 +1627,6 @@ def optimize(self) -> dict[str, Any]:
     def linearize(
             self,
             lintime: Optional[float] = None,
-            simflags: Optional[str] = None,
             simargs: Optional[dict[str, Optional[str | dict[str, Any] | numbers.Number]]] = None,
             timeout: Optional[float] = None,
     ) -> LinearizationResult:
@@ -1691,8 +1636,6 @@ def linearize(
 
         Args:
             lintime: Override "stopTime" value.
-            simflags: String of extra command line flags for the model binary.
-              This argument is deprecated, use simargs instead.
             simargs: A dict with command line flags and possible options; example: "simargs={'csvInput': 'a.csv'}"
             timeout: Maximum execution time in seconds.
 
@@ -1740,11 +1683,7 @@ def linearize(
 
         om_cmd.arg_set(key="l", val=str(lintime or self._linearization_options["stopTime"]))
 
-        # allow runtime simulation flags from user input
-        if simflags is not None:
-            om_cmd.args_set(args=om_cmd.parse_simflags(simflags=simflags))
-
-        if simargs:
+        if simargs is not None:
             om_cmd.args_set(args=simargs)
 
         # the file create by the model executable which contains the matrix and linear inputs, outputs and states

OMPython/OMCSession.py

@@ -51,7 +51,6 @@
 import time
 from typing import Any, Optional, Tuple
 import uuid
-import warnings
 import zmq
 
 import psutil
@@ -623,12 +622,6 @@ def run_model_executable(cmd_run_data: OMCSessionRunData) -> int:
 
         return returncode
 
-    def execute(self, command: str):
-        warnings.warn("This function is depreciated and will be removed in future versions; "
-                      "please use sendExpression() instead", DeprecationWarning, stacklevel=2)
-
-        return self.sendExpression(command, parsed=False)
-
     def sendExpression(self, command: str, parsed: bool = True) -> Any:
         """
         Send an expression to the OMC server and return the result.

tests/test_ModelicaSystemCmd.py

@@ -35,15 +35,12 @@ def test_simflags(mscmd_firstorder):
 
     mscmd.args_set({
         "noEventEmit": None,
-        "override": {'b': 2}
+        "override": {'b': 2, 'a': 4},
     })
-    with pytest.deprecated_call():
-        mscmd.args_set(args=mscmd.parse_simflags(simflags="-noEventEmit -noRestart -override=a=1,x=3"))
 
     assert mscmd.get_cmd_args() == [
         '-noEventEmit',
-        '-noRestart',
-        '-override=a=1,b=2,x=3',
+        '-override=a=4,b=2',
     ]
 
     mscmd.args_set({
@@ -52,6 +49,5 @@ def test_simflags(mscmd_firstorder):
 
     assert mscmd.get_cmd_args() == [
         '-noEventEmit',
-        '-noRestart',
-        '-override=a=1,x=3',
+        '-override=a=4',
     ]

tests/test_ZMQ.py

@@ -36,9 +36,7 @@ def test_Simulate(om, model_time_str):
     assert om.sendExpression('res.resultFile')
 
 
-def test_execute(om):
-    with pytest.deprecated_call():
-        assert om.execute('"HelloWorld!"') == '"HelloWorld!"\n'
+def test_sendExpression(om):
     assert om.sendExpression('"HelloWorld!"', parsed=False) == '"HelloWorld!"\n'
     assert om.sendExpression('"HelloWorld!"', parsed=True) == 'HelloWorld!'