Final changes before the 0.5.0 release (#49)

* get_state timeout as the last argument

* Fix exception handling

* Remove unnecessary method from the Response class

* Fix Platform - compatible only with Linux

* Fix typo

* Improve exception handling and documentation

Author: GabyUnalaq

README.md

@@ -9,7 +9,6 @@
 ![Build](https://github.com/eclipse-ankaios/ank-sdk-python/actions/workflows/build.yml/badge.svg?job=build)
 ![PyPI - Version](https://img.shields.io/pypi/v/ankaios_sdk)
 ![Python](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-blue)
-![OS](https://img.shields.io/badge/os-independent-lightgrey)
 
 ![License](https://img.shields.io/badge/license-Apache%202.0-blue)
 [![Ankaios](https://img.shields.io/badge/main_project-repo-blue)](https://github.com/eclipse-ankaios/ankaios)

ankaios_sdk/_components/control_interface.py

@@ -139,7 +139,7 @@ def connect(self) -> None:
         from the input fifo and opening the output fifo.
 
         Raises:
-            AnkaiosConnectionException: If an error occurred.
+            ControlInterfaceException: If an error occurred.
         """
         if self._state == ControlInterfaceState.INITIALIZED:
             raise ControlInterfaceException("Already connected.")
@@ -229,7 +229,7 @@ def _read_from_control_interface(self) -> None:
         The responses are then sent to the Ankaios class to be handled.
 
         Raises:
-            AnkaiosConnectionException: If an error occurs
+            ControlInterfaceException: If an error occurs
                 while reading the fifo.
         """
         # The pragma: no cover is used on small checks that are not expected
@@ -339,7 +339,7 @@ def _write_to_pipe(self, to_ankaios: _control_api.ToAnkaios) -> None:
             to_ankaios (_control_api.ToAnkaios): The ToAnkaios proto message.
 
         Raises:
-            AnkaiosConnectionException: If the output pipe is None.
+            ControlInterfaceException: If the output pipe is None.
         """
         if self._output_file is None:
             self._logger.error(
@@ -363,7 +363,7 @@ def write_request(self, request: Request) -> None:
             request (Request): The request object to be written.
 
         Raises:
-            AnkaiosConnectionException: If not connected.
+            ControlInterfaceException: If not connected.
         """
         if not self._state == ControlInterfaceState.INITIALIZED:
             raise ControlInterfaceException(
@@ -380,7 +380,7 @@ def _send_initial_hello(self) -> None:
         to the control interface.
 
         Raises:
-            AnkaiosConnectionException: If an error occurred.
+            ControlInterfaceException: If not connected.
         """
         initial_hello = _control_api.ToAnkaios(
             hello=_control_api.Hello(

ankaios_sdk/_components/response.py

@@ -170,18 +170,6 @@ def get_request_id(self) -> str:
         """
         return self._response.requestId
 
-    def check_request_id(self, request_id: str) -> bool:
-        """
-        Checks if the request id of the response matches the given request id.
-
-        Args:
-            request_id (str): The request id to check against.
-
-        Returns:
-            bool: True if the request_id matches, False otherwise.
-        """
-        return self._response.requestId == request_id
-
     def get_content(self) -> \
             tuple[
                 'ResponseType',