Merge branch 'OMCProcess_docstrings' into small_updates

Author: syntron

OMPython/OMCSession.py

@@ -486,11 +486,17 @@ def __del__(self):
                 self._omc_process = None
 
     def get_port(self) -> Optional[str]:
+        """
+        Get the port to connect to the OMC process.
+        """
         if not isinstance(self._omc_port, str):
             raise OMCSessionException(f"Invalid port to connect to OMC process: {self._omc_port}")
         return self._omc_port
 
     def get_log(self) -> str:
+        """
+        Get the log file content of the OMC session.
+        """
         if self._omc_loghandle is None:
             raise OMCSessionException("Log file not available!")
 
@@ -512,6 +518,9 @@ def _get_portfile_path(self) -> Optional[pathlib.Path]:
 
 
 class OMCProcessPort(OMCProcess):
+    """
+    OMCProcess implementation which uses a port to connect to an already running OMC server.
+    """
 
     def __init__(
             self,
@@ -522,6 +531,9 @@ def __init__(
 
 
 class OMCProcessLocal(OMCProcess):
+    """
+    OMCProcess implementation which runs the OMC server locally on the machine (Linux / Windows).
+    """
 
     def __init__(
             self,
@@ -603,6 +615,9 @@ def _omc_port_get(self) -> str:
 
 
 class OMCProcessDockerHelper(OMCProcess):
+    """
+    Base class for OMCProcess implementations which run the OMC server in a Docker container.
+    """
 
     def __init__(
             self,
@@ -695,20 +710,29 @@ def _omc_port_get(self) -> str:
         return port
 
     def get_server_address(self) -> Optional[str]:
+        """
+        Get the server address of the OMC server running in a Docker container.
+        """
         if self._dockerNetwork == "separate" and isinstance(self._dockerCid, str):
             output = subprocess.check_output(["docker", "inspect", self._dockerCid]).decode().strip()
             return json.loads(output)[0]["NetworkSettings"]["IPAddress"]
 
         return None
 
     def get_docker_container_id(self) -> str:
+        """
+        Get the Docker container ID of the Docker container with the OMC server.
+        """
         if not isinstance(self._dockerCid, str):
             raise OMCSessionException(f"Invalid docker container ID: {self._dockerCid}!")
 
         return self._dockerCid
 
 
 class OMCProcessDocker(OMCProcessDockerHelper):
+    """
+    OMC process running in a Docker container.
+    """
 
     def __init__(
             self,
@@ -849,6 +873,9 @@ def _docker_omc_start(self) -> Tuple[subprocess.Popen, DummyPopen, str]:
 
 
 class OMCProcessDockerContainer(OMCProcessDockerHelper):
+    """
+    OMC process running in a Docker container (by container ID).
+    """
 
     def __init__(
             self,
@@ -939,6 +966,9 @@ def _docker_omc_start(self) -> Tuple[subprocess.Popen, DummyPopen]:
 
 
 class OMCProcessWSL(OMCProcess):
+    """
+    OMC process running in Windows Subsystem for Linux (WSL).
+    """
 
     def __init__(
             self,