Skip to content

[OMCSessionZMQ] fix sendExpression() #300

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 1 commit into from
Jun 16, 2025
Merged

[OMCSessionZMQ] fix sendExpression() #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
140 changes: 72 additions & 68 deletions OMPython/OMCSession.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,72 +570,76 @@ def sendExpression(self, command, parsed=True):
self._omc.close()
self._omc = None
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:
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)
except pyparsing.ParseException as ex:
logger.warning('OMTypedParser error: %s. Returning the basic parser result.', ex.msg)
try:
return om_parser_basic(result)
except (TypeError, UnboundLocalError) as ex:
raise OMCSessionException("Cannot parse OMC result") from ex
else:
return result
result = self._omc.recv_string()

if command == "getErrorString()":
# no error handling if 'getErrorString()' is called
if parsed:
logger.warning("Result of 'getErrorString()' cannot be parsed!")
return result

if command == "getMessagesStringInternal()":
# no error handling if 'getMessagesStringInternal()' is called
if parsed:
logger.warning("Result of 'getMessagesStringInternal()' cannot be parsed!")
return result

# always 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:
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)}!")
continue

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 False:
return result

try:
return om_parser_typed(result)
except pyparsing.ParseException as ex:
logger.warning('OMTypedParser error: %s. Returning the basic parser result.', ex.msg)
try:
return om_parser_basic(result)
except (TypeError, UnboundLocalError) as ex:
raise OMCSessionException("Cannot parse OMC result") from ex
Loading