Skip to content

Finish error handling #278

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
merged 7 commits into from
May 22, 2025
Merged

Finish error handling #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
81bcc74
Revert "[ModelicaSystem] remove OMCSessionException for now"
syntron May 1, 2025
f67f740
[OMCSessionZMQ] allways check for errors if using sendExpression()
syntron Apr 26, 2025
b7fc5b2
[ModelicaSystem] exception handling for sendExpression()
syntron Apr 28, 2025
b2e4cb3
[ModelicaSystem] remove last call to getErrorString()
syntron Apr 29, 2025
efc1d60
[OMCSessionZMQ] use 'getMessagesStringInternal()' to check for OMC er…
syntron May 7, 2025
eae47bb
[OMCSessionZMQ] raise error if parsing of send Expression() result fails
syntron May 8, 2025
94ec48b
[ModelicaSystem] do not print all output of OM command executed
syntron Apr 30, 2025
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
18 changes: 12 additions & 6 deletions OMPython/ModelicaSystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@
import importlib
import pathlib
from dataclasses import dataclass
import textwrap
from typing import Optional

from OMPython.OMCSession import OMCSessionZMQ
from OMPython.OMCSession import OMCSessionZMQ, OMCSessionException

# define logger using the current module name as ID
logger = logging.getLogger(__name__)
Expand Down Expand Up @@ -332,8 +333,14 @@ def buildModel(self, variableFilter=None):
self.xmlparse()

def sendExpression(self, expr, parsed=True):
logger.debug("sendExpression(%r, %r)", expr, parsed)
return self.getconn.sendExpression(expr, parsed)
try:
retval = self.getconn.sendExpression(expr, parsed)
except OMCSessionException as ex:
raise ModelicaSystemError(f"Error executing {repr(expr)}") from ex

logger.debug(f"Result of executing {repr(expr)}: {textwrap.shorten(repr(retval), width=100)}")

return retval

# request to OMC
def requestApi(self, apiName, entity=None, properties=None): # 2
Expand Down Expand Up @@ -425,7 +432,7 @@ def getContinuous(self, names=None): # 4
try:
value = self.getSolutions(i)
self.continuouslist[i] = value[0][-1]
except Exception as ex:
except OMCSessionException as ex:
raise ModelicaSystemError(f"{i} could not be computed") from ex
return self.continuouslist

Expand Down Expand Up @@ -1093,8 +1100,7 @@ def linearize(self, lintime: Optional[float] = None, simflags: Optional[str] = N
linearFile = pathlib.Path(f'linear_{self.modelName}.py')

if not linearFile.exists():
errormsg = self.sendExpression("getErrorString()")
raise ModelicaSystemError(f"Linearization failed: {linearFile} not found: {errormsg}")
raise ModelicaSystemError(f"Linearization failed: {linearFile} not found!")

# this function is called from the generated python code linearized_model.py at runtime,
# to improve the performance by directly reading the matrices A, B, C and D from the julia code and avoid building the linearized modelica model
Expand Down
63 changes: 61 additions & 2 deletions OMPython/OMCSession.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
import os
import pathlib
import psutil
import re
import signal
import subprocess
import sys
Expand Down Expand Up @@ -325,6 +326,9 @@ def __init__(self, timeout=10.00,
# connect to the running omc instance using ZMQ
self._connect_to_omc(timeout)

self._re_log_entries = None
self._re_log_raw = None
Copy link
Member

Choose a reason for hiding this comment

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

Do we really need to make them class members?


def __del__(self):
try:
self.sendExpression("quit()")
Expand Down Expand Up @@ -549,6 +553,62 @@ def sendExpression(self, command, parsed=True):
return None
else:
result = self._omc.recv_string()

if command == "getErrorString()":
# no error handling if 'getErrorString()' is called
pass
elif command == "getMessagesStringInternal()":
# no error handling if 'getMessagesStringInternal()' is called; parsing NOT possible!
if parsed:
logger.warning("Result of 'getMessagesStringInternal()' cannot be parsed - set parsed to False!")
parsed = False
else:
# allways check for error
self._omc.send_string('getMessagesStringInternal()', flags=zmq.NOBLOCK)
error_raw = self._omc.recv_string()
# run error handling only if there is something to check
if error_raw != "{}\n":
if not self._re_log_entries:
Copy link
Member

Choose a reason for hiding this comment

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

self._re_log_entries and self._re_log_raw can be local variables here.

Copy link
Contributor Author

@syntron syntron May 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I defined them as class variables to do the initialisation once (if needed at all). Later, the compiled re struture is just reused ... However, if the expected numbers of calls to this part is low, it makes sense to run this each time.

Copy link
Member

Choose a reason for hiding this comment

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

The actual re compilation is run each time, its just they are initialized to none only once. I don't think initializing them to none locally is expensive.

Copy link
Contributor Author

@syntron syntron May 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

in OMCSession.py line 584ff (definition of sendExpression()):

if not self._re_log_entries:
    self._re_log_entries = re.compile(...)

if not self._re_log_raw:
    self._re_log_raw = re.compile(...)

Compilation is done only once (on first call; self._re* class variables are None); after that, the variables are set (not None) and, thus, the compiled version is used ...

self._re_log_entries = re.compile(pattern=r'record OpenModelica\.Scripting\.ErrorMessage'
'(.*?)'
r'end OpenModelica\.Scripting\.ErrorMessage;',
flags=re.MULTILINE | re.DOTALL)
if not self._re_log_raw:
self._re_log_raw = re.compile(
pattern=r"\s+message = \"(.*?)\",\n" # message
r"\s+kind = .OpenModelica.Scripting.ErrorKind.(.*?),\n" # kind
r"\s+level = .OpenModelica.Scripting.ErrorLevel.(.*?),\n" # level
r"\s+id = (.*?)" # id
"(,\n|\n)", # end marker
flags=re.MULTILINE | re.DOTALL)

# extract all ErrorMessage records
log_entries = self._re_log_entries.findall(string=error_raw)
for log_entry in reversed(log_entries):
log_raw = self._re_log_raw.findall(string=log_entry)
if len(log_raw) != 1 or len(log_raw[0]) != 5:
logger.warning("Invalid ErrorMessage record returned by 'getMessagesStringInternal()':"
f" {repr(log_entry)}!")

log_message = log_raw[0][0].encode().decode('unicode_escape')
log_kind = log_raw[0][1]
log_level = log_raw[0][2]
log_id = log_raw[0][3]

msg = (f"[OMC log for 'sendExpression({command}, {parsed})']: "
f"[{log_kind}:{log_level}:{log_id}] {log_message}")

# response according to the used log level
# see: https://build.openmodelica.org/Documentation/OpenModelica.Scripting.ErrorLevel.html
if log_level == 'error':
raise OMCSessionException(msg)
elif log_level == 'warning':
logger.warning(msg)
elif log_level == 'notification':
logger.info(msg)
else: # internal
logger.debug(msg)

if parsed is True:
try:
return om_parser_typed(result)
Expand All @@ -557,7 +617,6 @@ def sendExpression(self, command, parsed=True):
try:
return om_parser_basic(result)
except (TypeError, UnboundLocalError) as ex:
logger.warning('OMParser error: %s. Returning the unparsed result.', ex)
return result
raise OMCSessionException("Cannot parse OMC result") from ex
else:
return result
Loading