??? more renames

Author: syntron

OMPython/ModelicaSystemBase.py

@@ -16,13 +16,13 @@
 import numpy as np
 
 from OMPython.OMCSession import (
-    OMPathBase,
-    OMSessionBase,
+    PathBase,
+    SessionBase,
 )
 from OMPython.ModelExecution import ModelExecutionCmd
 
-OMCPath = OMPathBase
-OMCSession = OMSessionBase
+OMCPath = PathBase
+OMCSession = SessionBase
 
 # define logger using the current module name as ID
 logger = logging.getLogger(__name__)

OMPython/ModelicaSystemDoE.py

@@ -23,10 +23,10 @@
     ModelicaSystemOMC,
 )
 from OMPython.OMCSession import (
-    OMSessionBase,
+    SessionBase,
 )
 
-OMCSession = OMSessionBase
+OMCSession = SessionBase
 
 # define logger using the current module name as ID
 logger = logging.getLogger(__name__)

OMPython/ModelicaSystemOMC.py

@@ -19,10 +19,10 @@
     OMCSessionException,
     OMCSession,
     OMCSessionLocal,
-    OMPathBase,
+    PathBase,
 )
 
-OMCPath = OMPathBase
+OMCPath = PathBase
 
 # define logger using the current module name as ID
 logger = logging.getLogger(__name__)

OMPython/ModelicaSystemRunner.py

@@ -12,12 +12,12 @@
     ModelicaSystemError,
 )
 from OMPython.OMCSession import (
-    OMSessionBase,
-    OMSessionRunner,
+    SessionBase,
+    SessionRunner,
 )
 
-OMCSession = OMSessionBase
-OMCSessionDummy = OMSessionRunner
+OMCSession = SessionBase
+OMCSessionDummy = SessionRunner
 
 # define logger using the current module name as ID
 logger = logging.getLogger(__name__)
@@ -31,7 +31,7 @@ class ModelicaSystemRunner(ModelicaSystemBase):
     def __init__(
             self,
             work_directory: Optional[str | os.PathLike] = None,
-            session: Optional[OMSessionBase] = None,
+            session: Optional[SessionBase] = None,
     ) -> None:
         if session is None:
             session = OMCSessionDummy()

OMPython/OMCSession.py

@@ -64,7 +64,7 @@ class OMCSessionException(Exception):
     """
 
 
-class OMPathBase(pathlib.PurePosixPath, metaclass=abc.ABCMeta):
+class PathBase(pathlib.PurePosixPath, metaclass=abc.ABCMeta):
     """
     Implementation of a basic (PurePosix)Path object to be used within OMPython. The derived classes can use OMC as
     backend and - thus - work on different configurations like docker or WSL. The connection to OMC is provided via an
@@ -75,7 +75,7 @@ class OMPathBase(pathlib.PurePosixPath, metaclass=abc.ABCMeta):
     compared to standard pathlib.Path objects.
     """
 
-    def __init__(self, *path, session: OMSessionBase) -> None:
+    def __init__(self, *path, session: SessionBase) -> None:
         super().__init__(*path)
         self._session = session
 
@@ -164,7 +164,7 @@ def size(self) -> int:
         """
 
 
-class _OMCPath(OMPathBase):
+class _OMCPath(PathBase):
     """
     Implementation of a OMPathBase using OMC as backend. The connection to OMC is provided via an instances of an
     OMCSession* classes.
@@ -290,7 +290,7 @@ def size(self) -> int:
         raise OMCSessionException(f"Error reading file size for path {self.as_posix()}!")
 
 
-class _OMPathRunner(OMPathBase):
+class _PathRunner(PathBase):
     """
     Implementation of OMPathBase which does not use the session data at all. Thus, this implementation can run locally
     without any usage of OMC.
@@ -373,7 +373,7 @@ def size(self) -> int:
         return path.stat().st_size
 
 
-class OMPathCompatibility(pathlib.Path):
+class PathCompatibility(pathlib.Path):
     """
     Compatibility class for OMPathBase in Python < 3.12. This allows to run all code which uses OMPathBase (mainly
     ModelicaSystem) on these Python versions. There are remaining limitation as only local execution is possible.
@@ -384,8 +384,8 @@ def __new__(cls, *args, **kwargs):
         logger.warning("Python < 3.12 - using a version of class OMCPath "
                        "based on pathlib.Path for local usage only.")
 
-        if cls is OMPathCompatibility:
-            cls = OMPathCompatibilityWindows if os.name == 'nt' else OMPathCompatibilityPosix
+        if cls is PathCompatibility:
+            cls = PathCompatibilityWindows if os.name == 'nt' else PathCompatibilityPosix
         self = cls._from_parts(args)
         if not self._flavour.is_supported:
             raise NotImplementedError(f"cannot instantiate {cls.__name__} on your system")
@@ -398,24 +398,24 @@ def size(self) -> int:
         return self.stat().st_size
 
 
-class OMPathCompatibilityPosix(pathlib.PosixPath, OMPathCompatibility):
+class PathCompatibilityPosix(pathlib.PosixPath, PathCompatibility):
     """
     Compatibility class for OMCPath on Posix systems (Python < 3.12)
     """
 
 
-class OMPathCompatibilityWindows(pathlib.WindowsPath, OMPathCompatibility):
+class PathCompatibilityWindows(pathlib.WindowsPath, PathCompatibility):
     """
     Compatibility class for OMCPath on Windows systems (Python < 3.12)
     """
 
 
 if sys.version_info < (3, 12):
-    OMCPath = OMPathCompatibility
-    OMCPathDummy = OMPathCompatibility
+    OMCPath = PathCompatibility
+    OMCPathDummy = PathCompatibility
 else:
     OMCPath = _OMCPath
-    OMCPathDummy = _OMPathRunner
+    OMCPathDummy = _PathRunner
 
 
 # TODO: OMCSessionCMd => separate file; based on OMCSessionZMQ?
@@ -455,13 +455,13 @@ def escape_str(value: str) -> str:
         """
         return OMCSession.escape_str(value=value)
 
-    def omcpath(self, *path) -> OMPathBase:
+    def omcpath(self, *path) -> PathBase:
         """
         Create an OMCPath object based on the given path segments and the current OMC process definition.
         """
         return self.omc_process.omcpath(*path)
 
-    def omcpath_tempdir(self, tempdir_base: Optional[OMPathBase] = None) -> OMPathBase:
+    def omcpath_tempdir(self, tempdir_base: Optional[PathBase] = None) -> PathBase:
         """
         Get a temporary directory using OMC. It is our own implementation as non-local usage relies on OMC to run all
         filesystem related access.
@@ -510,7 +510,7 @@ def __call__(cls, *args, **kwargs):
 
 # TODO: define BaseSession / RunnerSession(BaseSession)
 # TODO: define OMCSession(BaseSession)
-class OMSessionMeta(abc.ABCMeta, PostInitCaller):
+class SessionMeta(abc.ABCMeta, PostInitCaller):
     """
     Helper class to get a combined metaclass of ABCMeta and PostInitCaller.
 
@@ -519,7 +519,7 @@ class OMSessionMeta(abc.ABCMeta, PostInitCaller):
     """
 
 
-class OMSessionBase(metaclass=OMSessionMeta):
+class SessionBase(metaclass=SessionMeta):
     """
     This class implements the basic structure a OMPython session definition needs. It provides the structure for an
     implementation using OMC as backend (via ZMQ) or a dummy implementation which just runs a model executable.
@@ -554,7 +554,7 @@ def escape_str(value: str) -> str:
         return value.replace("\\", "\\\\").replace('"', '\\"')
 
     @abc.abstractmethod
-    def model_execution_prefix(self, cwd: Optional[OMPathBase] = None) -> list[str]:
+    def model_execution_prefix(self, cwd: Optional[PathBase] = None) -> list[str]:
         """
         Helper function which returns a command prefix.
         """
@@ -566,28 +566,28 @@ def get_version(self) -> str:
         """
 
     @abc.abstractmethod
-    def set_workdir(self, workdir: OMPathBase) -> None:
+    def set_workdir(self, workdir: PathBase) -> None:
         """
         Set the workdir for this session.
         """
 
     @abc.abstractmethod
-    def omcpath(self, *path) -> OMPathBase:
+    def omcpath(self, *path) -> PathBase:
         """
         Create an OMPathBase object based on the given path segments and the current class.
         """
 
     @abc.abstractmethod
-    def omcpath_tempdir(self, tempdir_base: Optional[OMCPath] = None) -> OMPathBase:
+    def omcpath_tempdir(self, tempdir_base: Optional[OMCPath] = None) -> PathBase:
         """
         Get a temporary directory based on the specific definition for this session.
         """
 
     @staticmethod
-    def _tempdir(tempdir_base: OMPathBase) -> OMPathBase:
+    def _tempdir(tempdir_base: PathBase) -> PathBase:
         names = [str(uuid.uuid4()) for _ in range(100)]
 
-        tempdir: Optional[OMPathBase] = None
+        tempdir: Optional[PathBase] = None
         for name in names:
             # create a unique temporary directory name
             tempdir = tempdir_base / name
@@ -610,7 +610,7 @@ def sendExpression(self, command: str, parsed: bool = True) -> Any:
         """
 
 
-class OMCSession(OMSessionBase):
+class OMCSession(SessionBase):
     """
     Base class for an OMC session started via ZMQ. This class contains common functionality for all variants of an
     OMC session definition.
@@ -727,7 +727,7 @@ def escape_str(value: str) -> str:
         """
         return value.replace("\\", "\\\\").replace('"', '\\"')
 
-    def model_execution_prefix(self, cwd: Optional[OMPathBase] = None) -> list[str]:
+    def model_execution_prefix(self, cwd: Optional[PathBase] = None) -> list[str]:
         """
         Helper function which returns a command prefix needed for docker and WSL. It defaults to an empty list.
         """
@@ -739,14 +739,14 @@ def get_version(self) -> str:
         """
         return self.sendExpression("getVersion()", parsed=True)
 
-    def set_workdir(self, workdir: OMPathBase) -> None:
+    def set_workdir(self, workdir: PathBase) -> None:
         """
         Set the workdir for this session.
         """
         exp = f'cd("{workdir.as_posix()}")'
         self.sendExpression(exp)
 
-    def omcpath(self, *path) -> OMPathBase:
+    def omcpath(self, *path) -> PathBase:
         """
         Create an OMCPath object based on the given path segments and the current OMCSession* class.
         """
@@ -759,7 +759,7 @@ def omcpath(self, *path) -> OMPathBase:
             raise OMCSessionException("OMCPath is supported for Python < 3.12 only if OMCSessionLocal is used!")
         return OMCPath(*path, session=self)
 
-    def omcpath_tempdir(self, tempdir_base: Optional[OMPathBase] = None) -> OMPathBase:
+    def omcpath_tempdir(self, tempdir_base: Optional[PathBase] = None) -> PathBase:
         """
         Get a temporary directory using OMC. It is our own implementation as non-local usage relies on OMC to run all
         filesystem related access.
@@ -776,10 +776,10 @@ def omcpath_tempdir(self, tempdir_base: Optional[OMPathBase] = None) -> OMPathBa
         return self._tempdir(tempdir_base=tempdir_base)
 
     @staticmethod
-    def _tempdir(tempdir_base: OMPathBase) -> OMPathBase:
+    def _tempdir(tempdir_base: PathBase) -> PathBase:
         names = [str(uuid.uuid4()) for _ in range(100)]
 
-        tempdir: Optional[OMPathBase] = None
+        tempdir: Optional[PathBase] = None
         for name in names:
             # create a unique temporary directory name
             tempdir = tempdir_base / name
@@ -980,7 +980,7 @@ def _get_portfile_path(self) -> Optional[pathlib.Path]:
         return portfile_path
 
 
-class OMSessionRunner(OMSessionBase):
+class SessionRunner(SessionBase):
     """
     Dummy OMCSession implementation without any use of an OMC server.
     """
@@ -999,7 +999,7 @@ def __post_init__(self) -> None:
         No connection to an OMC server is created by this class!
         """
 
-    def model_execution_prefix(self, cwd: Optional[OMPathBase] = None) -> list[str]:
+    def model_execution_prefix(self, cwd: Optional[PathBase] = None) -> list[str]:
         """
         Helper function which returns a command prefix.
         """
@@ -1012,19 +1012,19 @@ def get_version(self) -> str:
         """
         return self._version
 
-    def set_workdir(self, workdir: OMPathBase) -> None:
+    def set_workdir(self, workdir: PathBase) -> None:
         """
         Set the workdir for this session.
         """
         os.chdir(workdir.as_posix())
 
-    def omcpath(self, *path) -> OMPathBase:
+    def omcpath(self, *path) -> PathBase:
         """
         Create an OMCPath object based on the given path segments and the current OMCSession* class.
         """
         return OMCPathDummy(*path, session=self)
 
-    def omcpath_tempdir(self, tempdir_base: Optional[OMPathBase] = None) -> OMPathBase:
+    def omcpath_tempdir(self, tempdir_base: Optional[PathBase] = None) -> PathBase:
         """
         Get a temporary directory without using OMC.
         """
@@ -1252,15 +1252,15 @@ def get_docker_container_id(self) -> str:
 
         return self._docker_container_id
 
-    def model_execution_prefix(self, cwd: Optional[OMPathBase] = None) -> list[str]:
+    def model_execution_prefix(self, cwd: Optional[PathBase] = None) -> list[str]:
         """
         Helper function which returns a command prefix needed for docker and WSL. It defaults to an empty list.
         """
         docker_cmd = [
             "docker", "exec",
             "--user", str(self._getuid()),
-            ]
-        if isinstance(cwd, OMPathBase):
+        ]
+        if isinstance(cwd, PathBase):
             docker_cmd += ["--workdir", cwd.as_posix()]
         docker_cmd += self._docker_extra_args
         if isinstance(self._docker_container_id, str):
@@ -1530,7 +1530,7 @@ def __init__(
         # connect to the running omc instance using ZMQ
         self._omc_port = self._omc_port_get()
 
-    def model_execution_prefix(self, cwd: Optional[OMPathBase] = None) -> list[str]:
+    def model_execution_prefix(self, cwd: Optional[PathBase] = None) -> list[str]:
         """
         Helper function which returns a command prefix needed for docker and WSL. It defaults to an empty list.
         """
@@ -1540,7 +1540,7 @@ def model_execution_prefix(self, cwd: Optional[OMPathBase] = None) -> list[str]:
             wsl_cmd += ['--distribution', self._wsl_distribution]
         if isinstance(self._wsl_user, str):
             wsl_cmd += ['--user', self._wsl_user]
-        if isinstance(cwd, OMPathBase):
+        if isinstance(cwd, PathBase):
             wsl_cmd += ['--cd', cwd.as_posix()]
         wsl_cmd += ['--']
 
@@ -1553,7 +1553,8 @@ def _omc_process_get(self) -> subprocess.Popen:
             self._wsl_omc,
             "--locale=C",
             "--interactive=zmq",
-            f"-z={self._random_string}"]
+            f"-z={self._random_string}",
+        ]
 
         omc_process = subprocess.Popen(omc_command,
                                        stdout=self._omc_loghandle,

OMPython/__init__.py

@@ -41,7 +41,7 @@
     OMCSession,
     OMCSessionDocker,
     OMCSessionDockerContainer,
-    OMSessionRunner,
+    SessionRunner,
     OMCSessionLocal,
     OMCSessionPort,
     OMCSessionWSL,
@@ -72,7 +72,7 @@
     'ModelExecutionData',
     'ModelExecutionException',
 
-    'OMSessionRunner',
+    'SessionRunner',
 
     'OMCSessionException',