??? WiP / TODO: rename all other *session* elements; cleanup tests

Author: syntron

OMPython/OMCSession.py

@@ -98,10 +98,10 @@ class OMCProcessCmd:
     Implementation of Open Modelica Compiler API functions. Depreciated!
     """
 
-    def __init__(self, session: OMCProcess, readonly: bool = False):
-        if not isinstance(session, OMCProcess):
+    def __init__(self, omc_process: OMCProcess, readonly: bool = False):
+        if not isinstance(omc_process, OMCProcess):
             raise OMCProcessException("Invalid session definition!")
-        self._session = session
+        self._omc_process = omc_process
         self._readonly = readonly
         self._omc_cache: dict[tuple[str, bool], Any] = {}
 
@@ -122,7 +122,7 @@ def _ask(self, question: str, opt: Optional[list[str]] = None, parsed: bool = Tr
                 return self._omc_cache[p]
 
         try:
-            res = self._session.sendExpression(expression, parsed=parsed)
+            res = self._omc_process.sendExpression(expression, parsed=parsed)
         except OMCProcessException as ex:
             raise OMCProcessException(f"OMC _ask() failed: {expression} (parsed={parsed})") from ex
 
@@ -292,29 +292,29 @@ class OMCPath(pathlib.PurePosixPath):
     errors as well as usage on a Windows system due to slightly different definitions (PureWindowsPath).
     """
 
-    def __init__(self, *path, session: OMCProcess):
+    def __init__(self, *path, omc_process: OMCProcess):
         super().__init__(*path)
-        self._session = session
+        self._omc_process = omc_process
 
     def with_segments(self, *pathsegments):
         """
         Create a new OMCPath object with the given path segments.
 
         The original definition of Path is overridden to ensure session is set.
         """
-        return type(self)(*pathsegments, session=self._session)
+        return type(self)(*pathsegments, omc_process=self._omc_process)
 
     def is_file(self, *, follow_symlinks=True) -> bool:
         """
         Check if the path is a regular file.
         """
-        return self._session.sendExpression(f'regularFileExists("{self.as_posix()}")')
+        return self._omc_process.sendExpression(f'regularFileExists("{self.as_posix()}")')
 
     def is_dir(self, *, follow_symlinks=True) -> bool:
         """
         Check if the path is a directory.
         """
-        return self._session.sendExpression(f'directoryExists("{self.as_posix()}")')
+        return self._omc_process.sendExpression(f'directoryExists("{self.as_posix()}")')
 
     def is_absolute(self):
         """
@@ -332,7 +332,7 @@ def read_text(self, encoding=None, errors=None, newline=None) -> str:
         The additional arguments `encoding`, `errors` and `newline` are only defined for compatibility with Path()
         definition.
         """
-        return self._session.sendExpression(f'readFile("{self.as_posix()}")')
+        return self._omc_process.sendExpression(f'readFile("{self.as_posix()}")')
 
     def write_text(self, data: str, encoding=None, errors=None, newline=None):
         """
@@ -358,20 +358,20 @@ def mkdir(self, mode=0o777, parents=False, exist_ok=False):
         if self.is_dir() and not exist_ok:
             raise FileExistsError(f"Directory {self.as_posix()} already exists!")
 
-        return self._session.sendExpression(f'mkdir("{self.as_posix()}")')
+        return self._omc_process.sendExpression(f'mkdir("{self.as_posix()}")')
 
     def cwd(self):
         """
         Returns the current working directory as an OMCPath object.
         """
-        cwd_str = self._session.sendExpression('cd()')
-        return OMCPath(cwd_str, session=self._session)
+        cwd_str = self._omc_process.sendExpression('cd()')
+        return OMCPath(cwd_str, omc_process=self._omc_process)
 
     def unlink(self, missing_ok: bool = False) -> None:
         """
         Unlink (delete) the file or directory represented by this path.
         """
-        res = self._session.sendExpression(f'deleteFile("{self.as_posix()}")')
+        res = self._omc_process.sendExpression(f'deleteFile("{self.as_posix()}")')
         if not res and not missing_ok:
             raise FileNotFoundError(f"Cannot delete file {self.as_posix()} - it does not exists!")
 
@@ -406,12 +406,12 @@ def _omc_resolve(self, pathstr: str) -> str:
                       'cd(omcpath_cwd)')
 
         try:
-            result = self._session.sendExpression(command=expression, parsed=False)
+            result = self._omc_process.sendExpression(command=expression, parsed=False)
             result_parts = result.split('\n')
             pathstr_resolved = result_parts[1]
             pathstr_resolved = pathstr_resolved[1:-1]  # remove quotes
 
-            omcpath_resolved = self._session.omcpath(pathstr_resolved)
+            omcpath_resolved = self._omc_process.omcpath(pathstr_resolved)
         except OMCProcessException as ex:
             raise OMCProcessException(f"OMCPath resolve failed for {pathstr}!") from ex
 
@@ -440,7 +440,7 @@ def size(self) -> int:
         if not self.is_file():
             raise OMCProcessException(f"Path {self.as_posix()} is not a file!")
 
-        res = self._session.sendExpression(f'stat("{self.as_posix()}")')
+        res = self._omc_process.sendExpression(f'stat("{self.as_posix()}")')
         if res[0]:
             return int(res[1])
 
@@ -652,7 +652,7 @@ def omcpath(self, *path) -> OMCPath:
         """
         Create an OMCPath object based on the given path segments and the current OMC session.
         """
-        return OMCPath(*path, session=self)
+        return OMCPath(*path, omc_process=self)
 
     def omcpath_tempdir(self, tempdir_base: Optional[OMCPath] = None) -> OMCPath:
         """

tests/test_OMSessionCmd.py

@@ -3,7 +3,7 @@
 
 def test_isPackage():
     omczmq = OMPython.OMCProcessLocal()
-    omccmd = OMPython.OMCProcessCmd(session=omczmq)
+    omccmd = OMPython.OMCProcessCmd(omc_process=omczmq)
     assert not omccmd.isPackage('Modelica')
 
 
@@ -13,7 +13,7 @@ def test_isPackage2():
         model_name="Modelica.Electrical.Analog.Examples.CauerLowPassAnalog",
         libraries=["Modelica"],
     )
-    omccmd = OMPython.OMCProcessCmd(session=mod.get_omc_process())
+    omccmd = OMPython.OMCProcessCmd(omc_process=mod.get_omc_process())
     assert omccmd.isPackage('Modelica')