Removed OMCSession

Author: adeas31

OMPython/__init__.py

@@ -1,30 +1,10 @@
 # -*- coding: utf-8 -*-
 """
 OMPython is a Python interface to OpenModelica.
-To get started, create an OMCSession/OMCSessionZMQ object:
-from OMPython import OMCSession/OMCSessionZMQ
-omc = OMCSession()/OMCSessionZMQ()
-omc.sendExpression(command)
-
-Note: Conversion from OMPython 1.0 to OMPython 2.0 is very simple
-1.0:
-import OMPython
-OMPython.execute(command)
-2.0:
-from OMPython import OMCSession
-OMPython = OMCSession()
-OMPython.execute(command)
-
-OMPython 3.0 includes a new class OMCSessionZMQ uses PyZMQ to communicate
-with OpenModelica. A new argument `useCorba=False` is added to ModelicaSystem
-class which means it will use OMCSessionZMQ by default. If you want to use
-OMCSession then create ModelicaSystem object like this,
-obj = ModelicaSystem(useCorba=True)
-
-The difference between execute and sendExpression is the type of the
-returned expression. sendExpression maps Modelica types to Python types,
-while execute tries to map also output that is not valid Modelica.
-That format is harder to use.
+To get started, create an OMCSessionZMQ object:
+from OMPython import OMCSessionZMQ
+omc = OMCSessionZMQ()
+omc.sendExpression("command")
 """
 
 from __future__ import absolute_import
@@ -553,7 +533,7 @@ def getClassNames(self, className=None, recursive=False, qualified=False, sort=F
                                  str(builtin).lower(), str(showProtected).lower()))
         return value
 
-class OMCSession(OMCSessionHelper, OMCSessionBase):
+class OMCSessionZMQ(OMCSessionHelper, OMCSessionBase):
 
     def __init__(self, readonly=False, timeout = 10.00,
                  docker = None, dockerContainer = None, dockerExtraArgs = None, dockerOpenModelicaPath = "omc",
@@ -662,16 +642,7 @@ def sendExpression(self, command, parsed=True):
                 else:
                     return result
         else:
-            raise Exception("Process Exited, No connection with OMC. Create a new instance of OMCSession")
-
-class OMCSessionZMQ(OMCSession):
-    def __init__(self, *args, **kwargs):
-        warnings.warn(
-            "OMCSessionZMQ is deprecated and will be remove in the next release. Please use OMCSession instead.",
-            DeprecationWarning,
-            stacklevel=2
-        )
-        super(OMCSessionZMQ, self).__init__(*args, **kwargs)
+            raise Exception("Process Exited, No connection with OMC. Create a new instance of OMCSessionZMQ")
 
 class ModelicaSystemError(Exception):
     pass
@@ -689,13 +660,8 @@ def __init__(self, fileName=None, modelName=None, lmodel=None, commandLineOption
         Note: If the model file is not in the current working directory, then the path where file is located must be included together with file name. Besides, if the Modelica model contains several different models within the same package, then in order to build the specific model, in second argument, user must put the package name with dot(.) followed by specific model name.
         ex: myModel = ModelicaSystem("ModelicaModel.mo", "modelName")
         """
-        if session is not None:
-            self.getconn = session
-        else:
-            self.getconn = OMCSession(omhome=omhome)
-
         if fileName is None and modelName is None and not lmodel:  # all None
-            self.getconn = OMCSession(omhome=omhome)
+            raise Exception("Cannot create ModelicaSystem object without any arguments")
             return
 
         self.tree = None
@@ -717,7 +683,10 @@ def __init__(self, fileName=None, modelName=None, lmodel=None, commandLineOption
 
         self._verbose = verbose
 
-        self.getconn = OMCSession(omhome=omhome)
+        if session is not None:
+            self.getconn = session
+        else:
+            self.getconn = OMCSessionZMQ(omhome=omhome)
 
         ## needed for properly deleting the session
         self._omc_log_file = self.getconn._omc_log_file

README.md

@@ -40,8 +40,8 @@ help(OMPython)
 ```
 
 ```python
-from OMPython import OMCSession
-omc = OMCSession()
+from OMPython import OMCSessionZMQ
+omc = OMCSessionZMQ()
 omc.sendExpression("getVersion()")
 ```
 
@@ -50,12 +50,8 @@ online.
 
 ## Bug Reports
 
-  - See OMPython bugs on the [OpenModelica
-    trac](https://trac.openmodelica.org/OpenModelica/query?component=OMPython)
-    or submit a [new
-    ticket](https://trac.openmodelica.org/OpenModelica/newticket).
-  - [Pull requests](https://github.com/OpenModelica/OMPython/pulls) are
-    welcome.
+  - Submit bugs through the [OpenModelica GitHub issues](https://github.com/OpenModelica/OMPython/issues/new).
+  - [Pull requests](https://github.com/OpenModelica/OMPython/pulls) are welcome ❤️.
 
 ## Contact
 

tests/test_ArrayDimension.py

@@ -10,7 +10,7 @@
 class Test_ArrayDimension:
 
     def test_ArrayDimension(self):
-        omc = OMPython.OMCSession()
+        omc = OMPython.OMCSessionZMQ()
 
         ## create a temp dir for each session
         tempdir = tempfile.mkdtemp()

tests/test_FMIRegression.py

@@ -10,7 +10,7 @@
 class Test_FMIRegression:
 
     def buildModelFMU(self, modelName):
-        omc = OMPython.OMCSession()
+        omc = OMPython.OMCSessionZMQ()
 
         ## create a temp dir for each session
         tempdir = tempfile.mkdtemp()

tests/test_docker.py

@@ -6,11 +6,11 @@
 class DockerTester(unittest.TestCase):
   @pytest.mark.skip(reason="This test would fail")
   def testDocker(self):
-    om = OMPython.OMCSession(docker="openmodelica/openmodelica:v1.16.1-minimal")
+    om = OMPython.OMCSessionZMQ(docker="openmodelica/openmodelica:v1.16.1-minimal")
     assert(om.sendExpression("getVersion()") == "OpenModelica 1.16.1")
-    omInner = OMPython.OMCSession(dockerContainer=om._dockerCid)
+    omInner = OMPython.OMCSessionZMQ(dockerContainer=om._dockerCid)
     assert(omInner.sendExpression("getVersion()") == "OpenModelica 1.16.1")
-    om2 = OMPython.OMCSession(docker="openmodelica/openmodelica:v1.16.1-minimal", port=11111)
+    om2 = OMPython.OMCSessionZMQ(docker="openmodelica/openmodelica:v1.16.1-minimal", port=11111)
     assert(om2.sendExpression("getVersion()") == "OpenModelica 1.16.1")
     del(om2)
     del(omInner)