rename [OMCSessionBase] => [OMCSessionCmd]; remove dependencies

Author: syntron

OMPython/ModelicaSystem.py

@@ -46,7 +46,7 @@
 from dataclasses import dataclass
 from typing import Optional
 
-from OMPython.OMCSession import OMCSessionBase, OMCSessionZMQ
+from OMPython.OMCSession import OMCSessionZMQ
 
 # define logger using the current module name as ID
 logger = logging.getLogger(__name__)
@@ -119,7 +119,7 @@ def __init__(
             verbose: bool = True,
             raiseerrors: bool = False,
             omhome: Optional[str] = None,
-            session: Optional[OMCSessionBase] = None
+            session: Optional[OMCSessionZMQ] = None
             ):
         """Initialize, load and build a model.
 

OMPython/OMCSession.py

@@ -3,6 +3,8 @@
 Definition of an OMC session.
 """
 
+from __future__ import annotations
+
 __license__ = """
  This file is part of OpenModelica.
 
@@ -33,7 +35,6 @@
 """
 
 import shutil
-import abc
 import getpass
 import logging
 import json
@@ -80,9 +81,12 @@ class OMCSessionException(Exception):
     pass
 
 
-class OMCSessionBase(metaclass=abc.ABCMeta):
+class OMCSessionCmd:
 
-    def __init__(self, readonly=False):
+    def __init__(self, session: OMCSessionZMQ, readonly: Optional[bool] = False):
+        if not isinstance(session, OMCSessionZMQ):
+            raise OMCSessionException("Invalid session definition!")
+        self._session = session
         self._readonly = readonly
         self._omc_cache = {}
 
@@ -92,21 +96,6 @@ def execute(self, command):
 
         return self.sendExpression(command, parsed=False)
 
-    @abc.abstractmethod
-    def sendExpression(self, command, parsed=True):
-        """
-        Sends an expression to the OpenModelica. The return type is parsed as if the
-        expression was part of the typed OpenModelica API (see ModelicaBuiltin.mo).
-        * Integer and Real are returned as Python numbers
-        * Strings, enumerations, and typenames are returned as Python strings
-        * Arrays, tuples, and MetaModelica lists are returned as tuples
-        * Records are returned as dicts (the name of the record is lost)
-        * Booleans are returned as True or False
-        * NONE() is returned as None
-        * SOME(value) is returned as value
-        """
-        pass
-
     def _ask(self, question: str, opt: Optional[list[str]] = None, parsed: Optional[bool] = True):
 
         if opt is None:
@@ -126,7 +115,7 @@ def _ask(self, question: str, opt: Optional[list[str]] = None, parsed: Optional[
         logger.debug('OMC ask: %s (parsed=%s)', expression, parsed)
 
         try:
-            res = self.sendExpression(expression, parsed=parsed)
+            res = self._session.sendExpression(expression, parsed=parsed)
         except OMCSessionException as ex:
             raise OMCSessionException("OMC _ask() failed: %s (parsed=%s)", expression, parsed) from ex
 
@@ -282,16 +271,14 @@ def getClassNames(self, className=None, recursive=False, qualified=False, sort=F
         return value
 
 
-class OMCSessionZMQ(OMCSessionBase):
+class OMCSessionZMQ:
 
     def __init__(self, readonly=False, timeout=10.00,
                  docker=None, dockerContainer=None, dockerExtraArgs=None, dockerOpenModelicaPath="omc",
                  dockerNetwork=None, port=None, omhome: str = None):
         if dockerExtraArgs is None:
             dockerExtraArgs = []
 
-        super().__init__(readonly=readonly)
-
         self.omhome = self._get_omhome(omhome=omhome)
 
         self._omc_process = None

OMPython/__init__.py

@@ -36,7 +36,7 @@
  CONDITIONS OF OSMC-PL.
 """
 
-from OMPython.OMCSession import OMCSessionBase, OMCSessionZMQ, OMCSessionException
+from OMPython.OMCSession import OMCSessionCmd, OMCSessionZMQ, OMCSessionException
 from OMPython.ModelicaSystem import ModelicaSystem, ModelicaSystemError, LinearizationResult
 
 # global names imported if import 'from OMPython import *' is used
@@ -47,5 +47,5 @@
 
     'OMCSessionException',
     'OMCSessionZMQ',
-    'OMCSessionBase',
+    'OMCSessionCmd',
 ]