Skip to content

D005 OMCSession - classes update #435

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

Merged
adeas31 merged 6 commits into from
Apr 29, 2026
Merged

D005 OMCSession - classes update #435

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4a614a6
(D004) define OMSessionRunner
syntron Feb 9, 2026
684d32c
(D005) update classes in OMCSession
syntron Feb 9, 2026
08b0047
fix docstrings; replace old OMCPathDummy by OM*Path* to indicate it w…
syntron Apr 29, 2026
39139e0
update timeout hadnling - define default value only once
syntron Apr 29, 2026
b6ec039
add log message on timeout change
syntron Apr 29, 2026
8b6ec96
Merge branch 'master' into D005-OMCSession_classes_update
syntron Apr 29, 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
Prev Previous commit
Next Next commit
update timeout hadnling - define default value only once 
* definition in OMSessionABC
* move `set_timeout()` to this class
* all other places use `timeout: Optional[float] = None`
  • Loading branch information
@syntron
syntron committed Apr 29, 2026
commit 39139e07f91e60abbfa880f023dfe93926de130b
52 changes: 25 additions & 27 deletions OMPython/OMCSession.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,7 @@ class OMSessionABC(metaclass=OMSessionMeta):

def __init__(
self,
timeout: float = 10.00,
timeout: Optional[float] = None,
**kwargs,
) -> None:
"""
Expand All @@ -939,7 +939,8 @@ def __init__(
self.model_execution_local = False

# store variables
self._timeout = timeout
self._timeout = 10.0
self.set_timeout(timeout=timeout)
# command prefix (to be used for docker or WSL)
self._cmd_prefix: list[str] = []

Expand All @@ -948,6 +949,19 @@ def __post_init__(self) -> None:
Post initialisation method.
"""

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

def get_cmd_prefix(self) -> list[str]:
"""
Get session definition used for this instance of OMPath.
Expand Down Expand Up @@ -1040,7 +1054,7 @@ class OMCSessionABC(OMSessionABC, metaclass=abc.ABCMeta):

def __init__(
self,
timeout: float = 10.00,
timeout: Optional[float] = None,
**kwargs,
) -> None:
"""
Expand Down Expand Up @@ -1085,9 +1099,6 @@ 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 @@ -1156,19 +1167,6 @@ def _timeout_loop(
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 @@ -1432,7 +1430,7 @@ class OMCSessionPort(OMCSessionABC):
def __init__(
self,
omc_port: str,
timeout: float = 10.0,
timeout: Optional[float] = None,
) -> None:
super().__init__(timeout=timeout)
self._omc_port = omc_port
Expand All @@ -1445,7 +1443,7 @@ class OMCSessionLocal(OMCSessionABC):

def __init__(
self,
timeout: float = 10.00,
timeout: Optional[float] = None,
omhome: Optional[str | os.PathLike] = None,
) -> None:

Expand Down Expand Up @@ -1526,7 +1524,7 @@ class OMCSessionZMQ(OMSessionABC):

def __init__(
self,
timeout: float = 10.00,
timeout: Optional[float] = None,
omhome: Optional[str] = None,
omc_process: Optional[OMCSessionABC] = None,
) -> None:
Expand Down Expand Up @@ -1597,7 +1595,7 @@ class OMCSessionDockerABC(OMCSessionABC, metaclass=abc.ABCMeta):

def __init__(
self,
timeout: float = 10.0,
timeout: Optional[float] = None,
docker: Optional[str] = None,
dockerContainer: Optional[str] = None,
dockerExtraArgs: Optional[list] = None,
Expand Down Expand Up @@ -1752,7 +1750,7 @@ class OMCSessionDocker(OMCSessionDockerABC):

def __init__(
self,
timeout: float = 10.00,
timeout: Optional[float] = None,
docker: Optional[str] = None,
dockerExtraArgs: Optional[list] = None,
dockerOpenModelicaPath: str | os.PathLike = "omc",
Expand Down Expand Up @@ -1905,7 +1903,7 @@ class OMCSessionDockerContainer(OMCSessionDockerABC):

def __init__(
self,
timeout: float = 10.00,
timeout: Optional[float] = None,
dockerContainer: Optional[str] = None,
dockerExtraArgs: Optional[list] = None,
dockerOpenModelicaPath: str | os.PathLike = "omc",
Expand Down Expand Up @@ -2005,7 +2003,7 @@ class OMCSessionWSL(OMCSessionABC):

def __init__(
self,
timeout: float = 10.00,
timeout: Optional[float] = None,
wsl_omc: str = 'omc',
wsl_distribution: Optional[str] = None,
wsl_user: Optional[str] = None,
Expand Down Expand Up @@ -2093,7 +2091,7 @@ class OMSessionRunner(OMSessionABC):

def __init__(
self,
timeout: float = 10.0,
timeout: Optional[float] = None,
version: str = "1.27.0",
ompath_runner: Type[OMPathRunnerABC] = OMPathRunnerLocal,
cmd_prefix: Optional[list[str]] = None,
Expand Down