[OMCSession*] simplify code for timeout loops

Author: syntron

OMPython/OMCSession.py

@@ -724,6 +724,31 @@ def __del__(self):
             finally:
                 self._omc_process = None
 
+    def _timeout_loop(
+            self,
+            timeout: Optional[float] = None,
+            timestep: float = 0.1,
+    ):
+        """
+        Helper (using yield) for while loops to check OMC startup / response. The loop is executed as long as True is
+        returned, i.e. the first False will stop the while loop.
+        """
+
+        if timeout is None:
+            timeout = self._timeout
+        if timeout <= 0:
+            raise OMCSessionException(f"Invalid timeout: {timeout}")
+
+        timer = 0.0
+        yield True
+        while True:
+            timer += timestep
+            if timer > timeout:
+                break
+            time.sleep(timestep)
+            yield True
+        yield False
+
     def set_timeout(self, timeout: Optional[float] = None) -> float:
         """
         Set the timeout to be used for OMC communication (OMCSession).
@@ -844,17 +869,13 @@ def sendExpression(self, command: str, parsed: bool = True) -> Any:
 
         logger.debug("sendExpression(%r, parsed=%r)", command, parsed)
 
-        MAX_RETRIES = 50
-        attempts = 0
-        while attempts < MAX_RETRIES:
-            attempts += 1
-
+        loop = self._timeout_loop(timestep=0.05)
+        while next(loop):
             try:
                 self._omc_zmq.send_string(str(command), flags=zmq.NOBLOCK)
                 break
             except zmq.error.Again:
                 pass
-            time.sleep(self._timeout / MAX_RETRIES)
         else:
             # in the deletion process, the content is cleared. Thus, any access to a class attribute must be checked
             try:
@@ -1093,11 +1114,8 @@ def _omc_port_get(self) -> str:
         port = None
 
         # See if the omc server is running
-        MAX_RETRIES = 80
-        attempts = 0
-        while attempts < MAX_RETRIES:
-            attempts += 1
-
+        loop = self._timeout_loop(timestep=0.1)
+        while next(loop):
             omc_portfile_path = self._get_portfile_path()
             if omc_portfile_path is not None and omc_portfile_path.is_file():
                 # Read the port file
@@ -1106,7 +1124,6 @@ def _omc_port_get(self) -> str:
                 break
             if port is not None:
                 break
-            time.sleep(self._timeout / MAX_RETRIES)
         else:
             logger.error(f"Docker did not start. Log-file says:\n{self.get_log()}")
             raise OMCSessionException(f"OMC Server did not start (timeout={self._timeout}).")
@@ -1191,11 +1208,8 @@ def _docker_process_get(self, docker_cid: str) -> Optional[DockerPopen]:
             raise NotImplementedError("Docker not supported on win32!")
 
         docker_process = None
-        MAX_RETRIES = 40
-        attempts = 0
-        while attempts < MAX_RETRIES:
-            attempts += 1
-
+        loop = self._timeout_loop(timestep=0.2)
+        while next(loop):
             docker_top = subprocess.check_output(["docker", "top", docker_cid]).decode().strip()
             docker_process = None
             for line in docker_top.split("\n"):
@@ -1208,7 +1222,6 @@ def _docker_process_get(self, docker_cid: str) -> Optional[DockerPopen]:
                                                   "is this a docker instance spawned without --pid=host?") from ex
             if docker_process is not None:
                 break
-            time.sleep(self._timeout / MAX_RETRIES)
         else:
             logger.error(f"Docker did not start. Log-file says:\n{self.get_log()}")
             raise OMCSessionException(f"Docker based OMC Server did not start (timeout={self._timeout}).")
@@ -1233,11 +1246,8 @@ def _omc_port_get(self) -> str:
             raise OMCSessionException(f"Invalid docker container ID: {self._docker_container_id}")
 
         # See if the omc server is running
-        MAX_RETRIES = 80
-        attempts = 0
-        while attempts < MAX_RETRIES:
-            attempts += 1
-
+        loop = self._timeout_loop(timestep=0.1)
+        while next(loop):
             omc_portfile_path = self._get_portfile_path()
             if omc_portfile_path is not None:
                 try:
@@ -1250,7 +1260,6 @@ def _omc_port_get(self) -> str:
                     pass
             if port is not None:
                 break
-            time.sleep(self._timeout / MAX_RETRIES)
         else:
             logger.error(f"Docker did not start. Log-file says:\n{self.get_log()}")
             raise OMCSessionException(f"Docker based OMC Server did not start (timeout={self._timeout}).")
@@ -1421,19 +1430,15 @@ def _docker_omc_start(self) -> Tuple[subprocess.Popen, DockerPopen, str]:
             raise OMCSessionException(f"Invalid content for docker container ID file path: {docker_cid_file}")
 
         docker_cid = None
-        MAX_RETRIES = 40
-        attempts = 0
-        while attempts < MAX_RETRIES:
-            attempts += 1
-
+        loop = self._timeout_loop(timestep=0.1)
+        while next(loop):
             try:
                 with open(file=docker_cid_file, mode="r", encoding="utf-8") as fh:
                     docker_cid = fh.read().strip()
             except IOError:
                 pass
             if docker_cid is not None:
                 break
-            time.sleep(self._timeout / MAX_RETRIES)
         else:
             logger.error(f"Docker did not start. Log-file says:\n{self.get_log()}")
             raise OMCSessionException(f"Docker did not start (timeout={self._timeout} might be too short "
@@ -1598,11 +1603,8 @@ def _omc_port_get(self) -> str:
         port = None
 
         # See if the omc server is running
-        MAX_RETRIES = 80
-        attempts = 0
-        while attempts < MAX_RETRIES:
-            attempts += 1
-
+        loop = self._timeout_loop(timestep=0.1)
+        while next(loop):
             try:
                 omc_portfile_path = self._get_portfile_path()
                 if omc_portfile_path is not None:
@@ -1615,7 +1617,6 @@ def _omc_port_get(self) -> str:
                 pass
             if port is not None:
                 break
-            time.sleep(self._timeout / MAX_RETRIES)
         else:
             logger.error(f"Docker did not start. Log-file says:\n{self.get_log()}")
             raise OMCSessionException(f"WSL based OMC Server did not start (timeout={self._timeout}).")