Skip to content

[ModelicaSystem*] add timeout argument #382

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

Open
syntron wants to merge 8 commits into
base: master
Choose a base branch
from
Open

[ModelicaSystem*] add timeout argument #382

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
12eef69
[OMCSession*] define set_timeout()
syntron Nov 26, 2025
fb568de
[OMCSession*] align all usages of timeout to the same structure
syntron Nov 25, 2025
702208d
[OMCSession*] simplify code for timeout loops
syntron Nov 26, 2025
cce234b
[OMCSession] fix definiton of _timeout variable - use set_timeout() c…
syntron Nov 27, 2025
ae4711a
[OMCSession*] some additional cleanup (mypy / flake8)
syntron Nov 27, 2025
252af40
[OMCSession] move call to set_timeout() to __post_init__
syntron Nov 27, 2025
4e81487
[OMCSession] fix log message
syntron Jan 24, 2026
1e9b435
Merge branch 'master' into ModelicaSystem_timeout
adeas31 Jan 27, 2026
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
157 changes: 85 additions & 72 deletions OMPython/OMCSession.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,8 +488,6 @@ class OMCSessionRunData:
cmd_model_executable: Optional[str] = None
# additional library search path; this is mainly needed if OMCProcessLocal is run on Windows
cmd_library_path: Optional[str] = None
# command timeout
cmd_timeout: Optional[float] = 10.0

# working directory to be used on the *local* system
cmd_cwd_local: Optional[str] = None
Expand Down Expand Up @@ -564,13 +562,12 @@ def omc_run_data_update(self, omc_run_data: OMCSessionRunData) -> OMCSessionRunD
"""
return self.omc_process.omc_run_data_update(omc_run_data=omc_run_data)

@staticmethod
def run_model_executable(cmd_run_data: OMCSessionRunData) -> int:
def run_model_executable(self, 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 OMCSession.run_model_executable(cmd_run_data=cmd_run_data)
return self.omc_process.run_model_executable(cmd_run_data=cmd_run_data)

def execute(self, command: str):
return self.omc_process.execute(command=command)
Expand Down Expand Up @@ -685,6 +682,9 @@ def __post_init__(self) -> None:
"""
Create the connection to the OMC server using ZeroMQ.
"""
# set_timeout() is used to define the value of _timeout as it includes additional checks
self.set_timeout(timeout=self._timeout)

port = self.get_port()
if not isinstance(port, str):
raise OMCSessionException(f"Invalid content for port: {port}")
Expand Down Expand Up @@ -727,6 +727,44 @@ 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).

The defined value is set and the current value is returned. If None is provided as argument, nothing is changed.
"""
retval = self._timeout
if timeout is not None:
if timeout <= 0.0:
raise OMCSessionException(f"Invalid timeout value: {timeout}!")
self._timeout = timeout
return retval

@staticmethod
def escape_str(value: str) -> str:
"""
Expand Down Expand Up @@ -778,11 +816,9 @@ def omcpath_tempdir(self, tempdir_base: Optional[OMCPath] = None) -> OMCPath:

return tempdir

@staticmethod
def run_model_executable(cmd_run_data: OMCSessionRunData) -> int:
def run_model_executable(self, 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.
Run the command defined in cmd_run_data.
"""

my_env = os.environ.copy()
Expand All @@ -799,7 +835,7 @@ def run_model_executable(cmd_run_data: OMCSessionRunData) -> int:
text=True,
env=my_env,
cwd=cmd_run_data.cmd_cwd_local,
timeout=cmd_run_data.cmd_timeout,
timeout=self._timeout,
check=True,
)
stdout = cmdres.stdout.strip()
Expand Down Expand Up @@ -831,34 +867,28 @@ def sendExpression(self, command: str, parsed: bool = True) -> Any:
Caller should only check for OMCSessionException.
"""

# this is needed if the class is not fully initialized or in the process of deletion
if hasattr(self, '_timeout'):
timeout = self._timeout
else:
timeout = 1.0

if self._omc_zmq is None:
raise OMCSessionException("No OMC running. Please create a new instance of OMCSession!")

logger.debug("sendExpression(%r, parsed=%r)", command, parsed)

attempts = 0
while True:
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
attempts += 1
if attempts >= 50:
# in the deletion process, the content is cleared. Thus, any access to a class attribute must be checked
try:
log_content = self.get_log()
except OMCSessionException:
log_content = 'log not available'
raise OMCSessionException(f"No connection with OMC (timeout={timeout}). "
f"Log-file says: \n{log_content}")
time.sleep(timeout / 50.0)
else:
# in the deletion process, the content is cleared. Thus, any access to a class attribute must be checked
try:
log_content = self.get_log()
except OMCSessionException:
log_content = 'log not available'

logger.error(f"OMC did not start. Log-file says:\n{log_content}")
raise OMCSessionException(f"No connection with OMC (timeout={self._timeout}).")

if command == "quit()":
self._omc_zmq.close()
self._omc_zmq = None
Expand Down Expand Up @@ -954,7 +984,7 @@ def sendExpression(self, command: str, parsed: bool = True) -> Any:
raise OMCSessionException(f"OMC error occurred for 'sendExpression({command}, {parsed}):\n"
f"{msg_long_str}")

if parsed is False:
if not parsed:
return result

try:
Expand Down Expand Up @@ -1103,25 +1133,19 @@ def _omc_port_get(self) -> str:
port = None

# See if the omc server is running
attempts = 0
while True:
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
with open(file=omc_portfile_path, mode='r', encoding="utf-8") as f_p:
port = f_p.readline()
break

if port is not None:
break

attempts += 1
if attempts == 80.0:
raise OMCSessionException(f"OMC Server did not start (timeout={self._timeout}). "
f"Could not open file {omc_portfile_path}. "
f"Log-file says:\n{self.get_log()}")
time.sleep(self._timeout / 80.0)
else:
logger.error(f"Docker did not start. Log-file says:\n{self.get_log()}")
Copy link
Member

@adeas31 adeas31 Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a local server. Not a docker.

raise OMCSessionException(f"OMC Server did not start (timeout={self._timeout}).")
Copy link
Member

@adeas31 adeas31 Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forgot to log the file name?


logger.info(f"Local OMC Server is up and running at ZMQ port {port} "
f"pid={self._omc_process.pid if isinstance(self._omc_process, subprocess.Popen) else '?'}")
Expand Down Expand Up @@ -1202,8 +1226,8 @@ def _docker_process_get(self, docker_cid: str) -> Optional[DockerPopen]:
if sys.platform == 'win32':
raise NotImplementedError("Docker not supported on win32!")

docker_process = None
for _ in range(0, 40):
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"):
Expand All @@ -1214,10 +1238,11 @@ def _docker_process_get(self, docker_cid: str) -> Optional[DockerPopen]:
except psutil.NoSuchProcess as ex:
raise OMCSessionException(f"Could not find PID {docker_top} - "
"is this a docker instance spawned without --pid=host?") from ex

if docker_process is not None:
break
time.sleep(self._timeout / 40.0)
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}).")

return docker_process

Expand All @@ -1239,8 +1264,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
attempts = 0
while True:
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:
Expand All @@ -1251,16 +1276,11 @@ def _omc_port_get(self) -> str:
port = output.decode().strip()
except subprocess.CalledProcessError:
pass

if port is not None:
break

attempts += 1
if attempts == 80.0:
raise OMCSessionException(f"Docker based OMC Server did not start (timeout={self._timeout}). "
f"Could not open port file {omc_portfile_path}. "
f"Log-file says:\n{self.get_log()}")
time.sleep(self._timeout / 80.0)
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}).")
Copy link
Member

@adeas31 adeas31 Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again the log file name is skipped.


logger.info(f"Docker based OMC Server is up and running at port {port}")

Expand Down Expand Up @@ -1428,25 +1448,24 @@ 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
for _ in range(0, 40):
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:
if docker_cid is not None:
break
time.sleep(self._timeout / 40.0)

if docker_cid is None:
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 "
"especially if you did not docker pull the image before this command).")

docker_process = self._docker_process_get(docker_cid=docker_cid)
if docker_process is None:
raise OMCSessionException(f"Docker top did not contain omc process {self._random_string}. "
f"Log-file says:\n{self.get_log()}")
logger.error(f"Docker did not start. Log-file says:\n{self.get_log()}")
raise OMCSessionException(f"Docker top did not contain omc process {self._random_string}.")

return omc_process, docker_process, docker_cid

Expand Down Expand Up @@ -1598,12 +1617,11 @@ def _omc_process_get(self) -> subprocess.Popen:
return omc_process

def _omc_port_get(self) -> str:
omc_portfile_path: Optional[pathlib.Path] = None
port = None

# See if the omc server is running
attempts = 0
while True:
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:
Expand All @@ -1614,16 +1632,11 @@ def _omc_port_get(self) -> str:
port = output.decode().strip()
except subprocess.CalledProcessError:
pass

if port is not None:
break

attempts += 1
if attempts == 80.0:
raise OMCSessionException(f"WSL based OMC Server did not start (timeout={self._timeout}). "
f"Could not open port file {omc_portfile_path}. "
f"Log-file says:\n{self.get_log()}")
time.sleep(self._timeout / 80.0)
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}).")

logger.info(f"WSL based OMC Server is up and running at ZMQ port {port} "
f"pid={self._omc_process.pid if isinstance(self._omc_process, subprocess.Popen) else '?'}")
Expand Down