(A010) Use function keyword arguments (#420)

* update docstring of __init__.py - do not promote depreciated OMCSessionZMQ

* reorder imports in __init__.py

* [OMCSession] use function keyword arguments if possible

Author: syntron

OMPython/OMCSession.py

@@ -50,7 +50,7 @@ def poll(self):
         return None if self.process.is_running() else True
 
     def kill(self):
-        return os.kill(self.pid, signal.SIGKILL)
+        return os.kill(pid=self.pid, signal=signal.SIGKILL)
 
     def wait(self, timeout):
         try:
@@ -854,10 +854,12 @@ def run_model_executable(self, cmd_run_data: OMCSessionRunData) -> int:
         return returncode
 
     def execute(self, command: str):
-        warnings.warn(message="This function is depreciated and will be removed in future versions; "
-                              "please use sendExpression() instead",
-                      category=DeprecationWarning,
-                      stacklevel=2)
+        warnings.warn(
+            message="This function is depreciated and will be removed in future versions; "
+                    "please use sendExpression() instead",
+            category=DeprecationWarning,
+            stacklevel=2,
+        )
 
         return self.sendExpression(command, parsed=False)
 

OMPython/__init__.py

@@ -1,10 +1,14 @@
 # -*- coding: utf-8 -*-
 """
 OMPython is a Python interface to OpenModelica.
-To get started, create an OMCSessionZMQ object:
-from OMPython import OMCSessionZMQ
-omc = OMCSessionZMQ()
+To get started on a local OMC server, create an OMCSessionLocal object:
+
+```
+import OMPython
+omc = OMPython.OMCSessionLocal()
 omc.sendExpression("command")
+```
+
 """
 
 from OMPython.ModelicaSystem import (
@@ -18,19 +22,20 @@
     OMCPath,
     OMCSession,
     OMCSessionCmd,
-    OMCSessionException,
-    OMCSessionRunData,
-    OMCSessionZMQ,
-    OMCSessionPort,
-    OMCSessionLocal,
     OMCSessionDocker,
     OMCSessionDockerContainer,
+    OMCSessionException,
+    OMCSessionLocal,
+    OMCSessionPort,
+    OMCSessionRunData,
     OMCSessionWSL,
+    OMCSessionZMQ,
 )
 
 # global names imported if import 'from OMPython import *' is used
 __all__ = [
     'LinearizationResult',
+
     'ModelicaSystem',
     'ModelicaSystemCmd',
     'ModelicaSystemDoE',
@@ -40,12 +45,12 @@
 
     'OMCSession',
     'OMCSessionCmd',
+    'OMCSessionDocker',
+    'OMCSessionDockerContainer',
     'OMCSessionException',
-    'OMCSessionRunData',
-    'OMCSessionZMQ',
     'OMCSessionPort',
     'OMCSessionLocal',
-    'OMCSessionDocker',
-    'OMCSessionDockerContainer',
+    'OMCSessionRunData',
     'OMCSessionWSL',
+    'OMCSessionZMQ',
 ]