rename classes: *Process* => *Session*

Author: syntron

OMPython/ModelicaSystem.py

@@ -52,8 +52,8 @@
     OMCSessionException,
     OMCSessionRunData,
     OMCSessionZMQ,
-    OMCProcess,
-    OMCProcessLocal,
+    OMCSession,
+    OMCSessionLocal,
     OMCPath,
 )
 
@@ -336,7 +336,7 @@ def __init__(
             command_line_options: Optional[list[str]] = None,
             work_directory: Optional[str | os.PathLike] = None,
             omhome: Optional[str] = None,
-            omc_process: Optional[OMCProcess] = None,
+            omc_process: Optional[OMCSession] = None,
     ) -> None:
         """Create a ModelicaSystem instance. To define the model use model() or convertFmu2Mo().
 
@@ -464,13 +464,13 @@ def model(
         if model_file is not None:
             file_path = pathlib.Path(model_file)
             # special handling for OMCProcessLocal - consider a relative path
-            if isinstance(self._session.omc_process, OMCProcessLocal) and not file_path.is_absolute():
+            if isinstance(self._session.omc_process, OMCSessionLocal) and not file_path.is_absolute():
                 file_path = pathlib.Path.cwd() / file_path
             if not file_path.is_file():
                 raise IOError(f"Model file {file_path} does not exist!")
 
             self._file_name = self.getWorkDirectory() / file_path.name
-            if (isinstance(self._session.omc_process, OMCProcessLocal)
+            if (isinstance(self._session.omc_process, OMCSessionLocal)
                     and file_path.as_posix() == self._file_name.as_posix()):
                 pass
             elif self._file_name.is_file():
@@ -1207,7 +1207,7 @@ def plot(
         plot is created by OMC which needs access to the local display. This is not the case for docker and WSL.
         """
 
-        if not isinstance(self._session.omc_process, OMCProcessLocal):
+        if not isinstance(self._session.omc_process, OMCSessionLocal):
             raise ModelicaSystemError("Plot is using the OMC plot functionality; "
                                       "thus, it is only working if OMC is running locally!")
 
@@ -1967,7 +1967,7 @@ def __init__(
             variable_filter: Optional[str] = None,
             work_directory: Optional[str | os.PathLike] = None,
             omhome: Optional[str] = None,
-            omc_process: Optional[OMCProcess] = None,
+            omc_process: Optional[OMCSession] = None,
             # simulation specific input
             # TODO: add more settings (simulation options, input options, ...)
             simargs: Optional[dict[str, Optional[str | dict[str, str] | numbers.Number]]] = None,

OMPython/OMCSession.py

@@ -293,7 +293,7 @@ class OMCPathReal(pathlib.PurePosixPath):
     errors as well as usage on a Windows system due to slightly different definitions (PureWindowsPath).
     """
 
-    def __init__(self, *path, session: OMCProcess) -> None:
+    def __init__(self, *path, session: OMCSession) -> None:
         super().__init__(*path)
         self._session = session
 
@@ -322,7 +322,7 @@ def is_absolute(self):
         Check if the path is an absolute path considering the possibility that we are running locally on Windows. This
         case needs special handling as the definition of is_absolute() differs.
         """
-        if isinstance(self._session, OMCProcessLocal) and platform.system() == 'Windows':
+        if isinstance(self._session, OMCSessionLocal) and platform.system() == 'Windows':
             return pathlib.PureWindowsPath(self.as_posix()).is_absolute()
         return super().is_absolute()
 
@@ -546,7 +546,7 @@ def __init__(
             self,
             timeout: float = 10.00,
             omhome: Optional[str] = None,
-            omc_process: Optional[OMCProcess] = None,
+            omc_process: Optional[OMCSession] = None,
     ) -> None:
         """
         Initialisation for OMCSessionZMQ
@@ -557,8 +557,8 @@ def __init__(
                       stacklevel=2)
 
         if omc_process is None:
-            omc_process = OMCProcessLocal(omhome=omhome, timeout=timeout)
-        elif not isinstance(omc_process, OMCProcess):
+            omc_process = OMCSessionLocal(omhome=omhome, timeout=timeout)
+        elif not isinstance(omc_process, OMCSession):
             raise OMCSessionException("Invalid definition of the OMC process!")
         self.omc_process = omc_process
 
@@ -570,7 +570,7 @@ def escape_str(value: str) -> str:
         """
         Escape a string such that it can be used as string within OMC expressions, i.e. escape all double quotes.
         """
-        return OMCProcess.escape_str(value=value)
+        return OMCSession.escape_str(value=value)
 
     def omcpath(self, *path) -> OMCPath:
         """
@@ -599,7 +599,7 @@ def run_model_executable(cmd_run_data: OMCSessionRunData) -> int:
         Run the command defined in cmd_run_data. This class is defined as static method such that there is no need to
         keep instances of over classes around.
         """
-        return OMCProcess.run_model_executable(cmd_run_data=cmd_run_data)
+        return OMCSession.run_model_executable(cmd_run_data=cmd_run_data)
 
     def execute(self, command: str):
         return self.omc_process.execute(command=command)
@@ -641,7 +641,7 @@ def __call__(cls, *args, **kwargs):
         return obj
 
 
-class OMCProcessMeta(abc.ABCMeta, PostInitCaller):
+class OMCSessionMeta(abc.ABCMeta, PostInitCaller):
     """
     Helper class to get a combined metaclass of ABCMeta and PostInitCaller.
 
@@ -650,7 +650,7 @@ class OMCProcessMeta(abc.ABCMeta, PostInitCaller):
     """
 
 
-class OMCProcess(metaclass=OMCProcessMeta):
+class OMCSession(metaclass=OMCSessionMeta):
     """
     Base class for an OMC session. This class contains common functionality for all OMC sessions.
 
@@ -771,7 +771,7 @@ def omcpath(self, *path) -> OMCPath:
 
         # fallback solution for Python < 3.12; a modified pathlib.Path object is used as OMCPath replacement
         if sys.version_info < (3, 12):
-            if isinstance(self, OMCProcessLocal):
+            if isinstance(self, OMCSessionLocal):
                 # noinspection PyArgumentList
                 return OMCPath(*path)
             raise OMCSessionException("OMCPath is supported for Python < 3.12 only if OMCProcessLocal is used!")
@@ -1040,7 +1040,7 @@ def omc_run_data_update(self, omc_run_data: OMCSessionRunData) -> OMCSessionRunD
         raise NotImplementedError("This method must be implemented in subclasses!")
 
 
-class OMCProcessPort(OMCProcess):
+class OMCSessionPort(OMCSession):
     """
     OMCProcess implementation which uses a port to connect to an already running OMC server.
     """
@@ -1059,7 +1059,7 @@ def omc_run_data_update(self, omc_run_data: OMCSessionRunData) -> OMCSessionRunD
         raise OMCSessionException("OMCProcessPort does not support omc_run_data_update()!")
 
 
-class OMCProcessLocal(OMCProcess):
+class OMCSessionLocal(OMCSession):
     """
     OMCProcess implementation which runs the OMC server locally on the machine (Linux / Windows).
     """
@@ -1185,7 +1185,7 @@ def omc_run_data_update(self, omc_run_data: OMCSessionRunData) -> OMCSessionRunD
         return omc_run_data_copy
 
 
-class OMCProcessDockerHelper(OMCProcess):
+class OMCSessionDockerHelper(OMCSession):
     """
     Base class for OMCProcess implementations which run the OMC server in a Docker container.
     """
@@ -1322,7 +1322,7 @@ def omc_run_data_update(self, omc_run_data: OMCSessionRunData) -> OMCSessionRunD
         return omc_run_data_copy
 
 
-class OMCProcessDocker(OMCProcessDockerHelper):
+class OMCSessionDocker(OMCSessionDockerHelper):
     """
     OMC process running in a Docker container.
     """
@@ -1465,7 +1465,7 @@ def _docker_omc_start(self) -> Tuple[subprocess.Popen, DockerPopen, str]:
         return omc_process, docker_process, docker_cid
 
 
-class OMCProcessDockerContainer(OMCProcessDockerHelper):
+class OMCSessionDockerContainer(OMCSessionDockerHelper):
     """
     OMC process running in a Docker container (by container ID).
     """
@@ -1558,7 +1558,7 @@ def _docker_omc_start(self) -> Tuple[subprocess.Popen, DockerPopen]:
         return omc_process, docker_process
 
 
-class OMCProcessWSL(OMCProcess):
+class OMCSessionWSL(OMCSession):
     """
     OMC process running in Windows Subsystem for Linux (WSL).
     """

OMPython/__init__.py

@@ -48,11 +48,11 @@
     OMCSessionException,
     OMCSessionRunData,
     OMCSessionZMQ,
-    OMCProcessPort,
-    OMCProcessLocal,
-    OMCProcessDocker,
-    OMCProcessDockerContainer,
-    OMCProcessWSL,
+    OMCSessionPort,
+    OMCSessionLocal,
+    OMCSessionDocker,
+    OMCSessionDockerContainer,
+    OMCSessionWSL,
 )
 
 # global names imported if import 'from OMPython import *' is used
@@ -67,9 +67,9 @@
     'OMCSessionException',
     'OMCSessionRunData',
     'OMCSessionZMQ',
-    'OMCProcessPort',
-    'OMCProcessLocal',
-    'OMCProcessDocker',
-    'OMCProcessDockerContainer',
-    'OMCProcessWSL',
+    'OMCSessionPort',
+    'OMCSessionLocal',
+    'OMCSessionDocker',
+    'OMCSessionDockerContainer',
+    'OMCSessionWSL',
 ]

tests/test_ModelicaSystem.py

@@ -155,7 +155,7 @@ def test_customBuildDirectory(tmp_path, model_firstorder):
 @skip_on_windows
 @skip_python_older_312
 def test_getSolutions_docker(model_firstorder):
-    omcp = OMPython.OMCProcessDocker(docker="openmodelica/openmodelica:v1.25.0-minimal")
+    omcp = OMPython.OMCSessionDocker(docker="openmodelica/openmodelica:v1.25.0-minimal")
     omc = OMPython.OMCSessionZMQ(omc_process=omcp)
 
     mod = OMPython.ModelicaSystem(

tests/test_ModelicaSystemDoE.py

@@ -69,7 +69,7 @@ def test_ModelicaSystemDoE_local(tmp_path, model_doe, param_doe):
 @skip_on_windows
 @skip_python_older_312
 def test_ModelicaSystemDoE_docker(tmp_path, model_doe, param_doe):
-    omcp = OMPython.OMCProcessDocker(docker="openmodelica/openmodelica:v1.25.0-minimal")
+    omcp = OMPython.OMCSessionDocker(docker="openmodelica/openmodelica:v1.25.0-minimal")
     omc = OMPython.OMCSessionZMQ(omc_process=omcp)
     assert omc.sendExpression("getVersion()") == "OpenModelica 1.25.0"
 

tests/test_OMCPath.py

@@ -24,7 +24,7 @@ def test_OMCPath_OMCSessionZMQ():
 
 
 def test_OMCPath_OMCProcessLocal():
-    omp = OMPython.OMCProcessLocal()
+    omp = OMPython.OMCSessionLocal()
     om = OMPython.OMCSessionZMQ(omc_process=omp)
 
     _run_OMCPath_checks(om)
@@ -35,7 +35,7 @@ def test_OMCPath_OMCProcessLocal():
 @skip_on_windows
 @skip_python_older_312
 def test_OMCPath_OMCProcessDocker():
-    omcp = OMPython.OMCProcessDocker(docker="openmodelica/openmodelica:v1.25.0-minimal")
+    omcp = OMPython.OMCSessionDocker(docker="openmodelica/openmodelica:v1.25.0-minimal")
     om = OMPython.OMCSessionZMQ(omc_process=omcp)
     assert om.sendExpression("getVersion()") == "OpenModelica 1.25.0"
 
@@ -48,7 +48,7 @@ def test_OMCPath_OMCProcessDocker():
 @pytest.mark.skip(reason="Not able to run WSL on github")
 @skip_python_older_312
 def test_OMCPath_OMCProcessWSL():
-    omcp = OMPython.OMCProcessWSL(
+    omcp = OMPython.OMCSessionWSL(
         wsl_omc='omc',
         wsl_user='omc',
         timeout=30.0,

tests/test_ZMQ.py

@@ -46,7 +46,7 @@ def test_execute(om):
 
 def test_omcprocessport_execute(om):
     port = om.omc_process.get_port()
-    omcp = OMPython.OMCProcessPort(omc_port=port)
+    omcp = OMPython.OMCSessionPort(omc_port=port)
 
     # run 1
     om1 = OMPython.OMCSessionZMQ(omc_process=omcp)
@@ -62,7 +62,7 @@ def test_omcprocessport_execute(om):
 
 def test_omcprocessport_simulate(om, model_time_str):
     port = om.omc_process.get_port()
-    omcp = OMPython.OMCProcessPort(omc_port=port)
+    omcp = OMPython.OMCSessionPort(omc_port=port)
 
     om = OMPython.OMCSessionZMQ(omc_process=omcp)
     assert om.sendExpression(f'loadString("{model_time_str}")') is True

tests/test_docker.py

@@ -10,15 +10,15 @@
 
 @skip_on_windows
 def test_docker():
-    omcp = OMPython.OMCProcessDocker(docker="openmodelica/openmodelica:v1.25.0-minimal")
+    omcp = OMPython.OMCSessionDocker(docker="openmodelica/openmodelica:v1.25.0-minimal")
     om = OMPython.OMCSessionZMQ(omc_process=omcp)
     assert om.sendExpression("getVersion()") == "OpenModelica 1.25.0"
 
-    omcpInner = OMPython.OMCProcessDockerContainer(dockerContainer=omcp.get_docker_container_id())
+    omcpInner = OMPython.OMCSessionDockerContainer(dockerContainer=omcp.get_docker_container_id())
     omInner = OMPython.OMCSessionZMQ(omc_process=omcpInner)
     assert omInner.sendExpression("getVersion()") == "OpenModelica 1.25.0"
 
-    omcp2 = OMPython.OMCProcessDocker(docker="openmodelica/openmodelica:v1.25.0-minimal", port=11111)
+    omcp2 = OMPython.OMCSessionDocker(docker="openmodelica/openmodelica:v1.25.0-minimal", port=11111)
     om2 = OMPython.OMCSessionZMQ(omc_process=omcp2)
     assert om2.sendExpression("getVersion()") == "OpenModelica 1.25.0"