epyt-flow 0.1.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

epyt_flow/rest_api/base_handler.py

@@ -11,6 +11,20 @@ class BaseHandler():
     """
     Base class for all REST API handlers.
     """
+    def send_error(self, resp: falcon.Response, error_msg: str) -> None:
+        """
+        Sends an error message back.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        error_msg : `str`
+            Error message.
+        """
+        resp.status = falcon.HTTP_BAD_REQUEST
+        resp.data = error_msg.encode()
+
     def send_invalid_resource_id_error(self, resp: falcon.Response) -> None:
         """
         Sends an error that th given resource ID (e.g. scenario ID, or SCADA data ID) is invalid.

epyt_flow/rest_api/{scada_data_handler.py → scada_data/data_handlers.py}

@@ -1,170 +1,11 @@
 """
-The module provides all handlers for SCADA data requests.
+This module provides REST API handlers for accessing the final sensor readings
+(e.g. pressure, flow rate, etc.).
 """
 import warnings
 import falcon
 
-from .base_handler import BaseHandler
-from .res_manager import ResourceManager
-from ..simulation import SensorConfig, SensorFault
-
-
-class ScadaDataManager(ResourceManager):
-    """
-    Class for managing SCADA data.
-    """
-
-
-class ScadaDataBaseHandler(BaseHandler):
-    """
-    Base class for all handlers concerning SCADA data.
-
-    Parameters
-    ----------
-    scada_data_mgr : `~epyt_flow.rest_api.scenario_handler.ScadaDataBaseHandler`
-        SCADA data manager.
-    """
-    def __init__(self, scada_data_mgr: ScadaDataManager):
-        self.scada_data_mgr = scada_data_mgr
-
-
-class ScadaDataRemoveHandler(ScadaDataBaseHandler):
-    """
-    Class for handling a DELETE request for a given SCADA data instance.
-    """
-    def on_delete(self, _, resp: falcon.Response, data_id: str) -> None:
-        """
-        Deletes a given SCADA data instance.
-
-        Parameters
-        ----------
-        resp : `falcon.Response`
-            Response instance.
-        data_id : `str`
-            UUID of the SCADA data instance.
-        """
-        try:
-            if self.scada_data_mgr.validate_uuid(data_id) is False:
-                self.send_invalid_resource_id_error(resp)
-                return
-
-            self.scada_data_mgr.remove(data_id)
-        except Exception as ex:
-            warnings.warn(str(ex))
-            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
-
-
-class ScadaDataSensorConfigHandler(ScadaDataBaseHandler):
-    """
-    Class for handling GET and POST requests for the sensor configuration
-    of a given SCADA data instance.
-    """
-    def on_get(self, _, resp: falcon.Response, data_id: str) -> None:
-        """
-        Gets the sensor configuration of a given SCADA data instance.
-
-        Parameters
-        ----------
-        resp : `falcon.Response`
-            Response instance.
-        data_id : `str`
-            UUID of the SCADA data.
-        """
-        try:
-            if self.scada_data_mgr.validate_uuid(data_id) is False:
-                self.send_invalid_resource_id_error(resp)
-                return
-
-            my_sensor_config = self.scada_data_mgr.get(data_id).sensor_config
-            self.send_json_response(resp, my_sensor_config)
-        except Exception as ex:
-            warnings.warn(str(ex))
-            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
-
-    def on_post(self, req: falcon.Request, resp: falcon.Response, data_id: str) -> None:
-        """
-        Sets the sensor configuration of a given SCADA data instance.
-
-        Parameters
-        ----------
-        req : `falcon.Request`
-            Request instance.
-        resp : `falcon.Response`
-            Response instance.
-        data_id : `str`
-            UUID of the SCADA data.
-        """
-        try:
-            if self.scada_data_mgr.validate_uuid(data_id) is False:
-                self.send_invalid_resource_id_error(resp)
-                return
-
-            sensor_config = self.load_json_data_from_request(req)
-            if not isinstance(sensor_config, SensorConfig):
-                self.send_json_parsing_error(resp)
-                return
-
-            self.scada_data_mgr.get(data_id).sensor_config = sensor_config
-        except Exception as ex:
-            warnings.warn(str(ex))
-            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
-
-
-class ScadaDataSensorFaultsHandler(ScadaDataBaseHandler):
-    """
-    Class for handling GET and POST requests concerning sensor faults in a
-    given SCADA data instance.
-    """
-    def on_get(self, _, resp: falcon.Response, data_id: str) -> None:
-        """
-        Gets all sensor faults of a given SCADA data instance.
-
-        Parameters
-        ----------
-        resp : `falcon.Response`
-            Response instance.
-        data_id : `str`
-            UUID of the SCADA data.
-        """
-        try:
-            if self.scada_data_mgr.validate_uuid(data_id) is False:
-                self.send_invalid_resource_id_error(resp)
-                return
-
-            sensor_faults = self.scada_data_mgr.get(data_id).sensor_faults
-            self.send_json_response(resp, sensor_faults)
-        except Exception as ex:
-            warnings.warn(str(ex))
-            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
-
-    def on_post(self, req: falcon.Request, resp: falcon.Response, data_id: str) -> None:
-        """
-        Sets (i.e. overrides) the sensor faults in a given SCADA data instance.
-
-        Parameters
-        ----------
-        req : `falcon.Request`
-            Request instance.
-        resp : `falcon.Response`
-            Response instance.
-        data_id : `str`
-            UUID of the SCADA data.
-        """
-        try:
-            if self.scada_data_mgr.validate_uuid(data_id) is False:
-                self.send_invalid_resource_id_error(resp)
-                return
-
-            sensor_faults = self.load_json_data_from_request(req)
-            if not isinstance(sensor_faults, list) or \
-                    any(not isinstance(e, SensorFault) for e in sensor_faults):
-                self.send_json_parsing_error(resp)
-                return
-
-            self.scada_data_mgr.get(data_id).sensor_faults = sensor_faults
-        except Exception as ex:
-            warnings.warn(str(ex))
-            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+from .handlers import ScadaDataBaseHandler
 
 
 class ScadaDataPressuresHandler(ScadaDataBaseHandler):

epyt_flow/rest_api/scada_data/export_handlers.py

@@ -0,0 +1,140 @@
+"""
+This module provides REST API handlers for exporting a given SCADA data instance.
+"""
+import os
+from abc import abstractmethod
+import warnings
+import falcon
+
+from .handlers import ScadaDataBaseHandler
+from ...utils import get_temp_folder
+from ...simulation.scada import ScadaData, ScadaDataNumpyExport, ScadaDataMatlabExport, \
+    ScadaDataXlsxExport
+
+
+class ScadaDataBaseExportHandler(ScadaDataBaseHandler):
+    """
+    Base handler for exporting a given SCADA data instance.
+    """
+    def __init__(self, file_ext: str, **kwds):
+        self.__file_ext = file_ext
+
+        super().__init__(**kwds)
+
+    def create_temp_file_path(self, data_id: str, file_ext: str) -> None:
+        """
+        Returns a path to a temporary file for storing the SCADA data instance.
+
+        Parameters
+        ----------
+        data_id : `str`
+            UUID of the SCADA data.
+        file_ext : `str`
+            File extension.
+        """
+        return os.path.join(get_temp_folder(), f"{data_id}.{file_ext}")
+
+    def send_temp_file(self, resp: falcon.Response, tmp_file: str,
+                       content_type: str = "application/octet-stream") -> None:
+        """
+        Sends a given file (`tmp_file`) to the the client.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        tmp_file : `str`
+            Path to the temporary file to be send.
+        """
+        resp.status = falcon.HTTP_200
+        resp.content_type = content_type
+        with open(tmp_file, 'rb') as f:
+            resp.text = f.read()
+
+    @abstractmethod
+    def export(self, scada_data: ScadaData, tmp_file: str) -> None:
+        """
+        Exports a given SCADA data instance to a temporary file.
+
+        Parameters
+        ----------
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData`
+            SCADA data instance to be exported.
+        tmp_file : `str`
+            Path to temporary file.
+        """
+        raise NotImplementedError()
+
+    def on_get(self, _, resp: falcon.Response, data_id: str) -> None:
+        """
+        Gets the given SCADA data instance.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        data_id : `str`
+            UUID of the SCADA data.
+        """
+        try:
+            if self.scada_data_mgr.validate_uuid(data_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            my_scada_data = self.scada_data_mgr.get(data_id)
+
+            tmp_file = self.create_temp_file_path(data_id, self.__file_ext)
+            self.export(my_scada_data, tmp_file)
+
+            self.send_temp_file(resp, tmp_file)
+
+            os.remove(tmp_file)
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+
+class ScadaDataExportHandler(ScadaDataBaseExportHandler):
+    """
+    Class for handling a GET requests for exporting a given SCADA data instance
+    to an .epytflow_scada_data file.
+    """
+    def __init__(self, **kwds):
+        super().__init__(file_ext=".epytflow_scada_data", **kwds)
+
+    def export(self, scada_data: ScadaData, tmp_file: str) -> None:
+        scada_data.save_to_file(tmp_file)
+
+
+class ScadaDataXlsxExportHandler(ScadaDataBaseExportHandler):
+    """
+    Class for handling a GET requests for exporting a given SCADA data instance to a .xlsx file.
+    """
+    def __init__(self, **kwds):
+        super().__init__(file_ext=".xlsx", **kwds)
+
+    def export(self, scada_data: ScadaData, tmp_file: str) -> None:
+        ScadaDataXlsxExport(tmp_file).export(scada_data)
+
+
+class ScadaDataNumpyExportHandler(ScadaDataBaseExportHandler):
+    """
+    Class for handling a GET requests for exporting a given SCADA data instance to Numpy data file.
+    """
+    def __init__(self, **kwds):
+        super().__init__(file_ext=".npz", **kwds)
+
+    def export(self, scada_data: ScadaData, tmp_file: str) -> None:
+        ScadaDataNumpyExport(tmp_file).export(scada_data)
+
+
+class ScadaDataMatlabExportHandler(ScadaDataBaseExportHandler):
+    """
+    Class for handling a GET requests for exporting a given SCADA data instance
+    to a Matlab data file.
+    """
+    def __init__(self, **kwds):
+        super().__init__(file_ext=".mat", **kwds)
+
+    def export(self, scada_data: ScadaData, tmp_file: str) -> None:
+        ScadaDataMatlabExport(tmp_file).export(scada_data)

epyt_flow/rest_api/scada_data/handlers.py

@@ -0,0 +1,209 @@
+"""
+The module provides REST API handlers for some SCADA data requests.
+"""
+import warnings
+import falcon
+
+from ..base_handler import BaseHandler
+from ..res_manager import ResourceManager
+from ...simulation import SensorConfig, SensorFault
+
+
+class ScadaDataManager(ResourceManager):
+    """
+    Class for managing SCADA data.
+    """
+
+
+class ScadaDataBaseHandler(BaseHandler):
+    """
+    Base class for all handlers concerning SCADA data.
+
+    Parameters
+    ----------
+    scada_data_mgr : :class:`~epyt_flow.rest_api.scada_data.handlers.ScadaDataManager`
+        SCADA data manager.
+    """
+    def __init__(self, scada_data_mgr: ScadaDataManager):
+        self.scada_data_mgr = scada_data_mgr
+
+
+class ScadaDataRemoveHandler(ScadaDataBaseHandler):
+    """
+    Class for handling a DELETE request for a given SCADA data instance.
+    """
+    def on_delete(self, _, resp: falcon.Response, data_id: str) -> None:
+        """
+        Deletes a given SCADA data instance.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        data_id : `str`
+            UUID of the SCADA data instance.
+        """
+        try:
+            if self.scada_data_mgr.validate_uuid(data_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            self.scada_data_mgr.remove(data_id)
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+
+class ScadaDataSensorConfigHandler(ScadaDataBaseHandler):
+    """
+    Class for handling GET and POST requests for the sensor configuration
+    of a given SCADA data instance.
+    """
+    def on_get(self, _, resp: falcon.Response, data_id: str) -> None:
+        """
+        Gets the sensor configuration of a given SCADA data instance.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        data_id : `str`
+            UUID of the SCADA data.
+        """
+        try:
+            if self.scada_data_mgr.validate_uuid(data_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            my_sensor_config = self.scada_data_mgr.get(data_id).sensor_config
+            self.send_json_response(resp, my_sensor_config)
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+    def on_post(self, req: falcon.Request, resp: falcon.Response, data_id: str) -> None:
+        """
+        Sets the sensor configuration of a given SCADA data instance.
+
+        Parameters
+        ----------
+        req : `falcon.Request`
+            Request instance.
+        resp : `falcon.Response`
+            Response instance.
+        data_id : `str`
+            UUID of the SCADA data.
+        """
+        try:
+            if self.scada_data_mgr.validate_uuid(data_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            sensor_config = self.load_json_data_from_request(req)
+            if not isinstance(sensor_config, SensorConfig):
+                self.send_json_parsing_error(resp)
+                return
+
+            self.scada_data_mgr.get(data_id).sensor_config = sensor_config
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+
+class ScadaDataSensorFaultsHandler(ScadaDataBaseHandler):
+    """
+    Class for handling GET and POST requests concerning sensor faults in a
+    given SCADA data instance.
+    """
+    def on_get(self, _, resp: falcon.Response, data_id: str) -> None:
+        """
+        Gets all sensor faults of a given SCADA data instance.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        data_id : `str`
+            UUID of the SCADA data.
+        """
+        try:
+            if self.scada_data_mgr.validate_uuid(data_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            sensor_faults = self.scada_data_mgr.get(data_id).sensor_faults
+            self.send_json_response(resp, sensor_faults)
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+    def on_post(self, req: falcon.Request, resp: falcon.Response, data_id: str) -> None:
+        """
+        Sets (i.e. overrides) the sensor faults in a given SCADA data instance.
+
+        Parameters
+        ----------
+        req : `falcon.Request`
+            Request instance.
+        resp : `falcon.Response`
+            Response instance.
+        data_id : `str`
+            UUID of the SCADA data.
+        """
+        try:
+            if self.scada_data_mgr.validate_uuid(data_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            sensor_faults = self.load_json_data_from_request(req)
+            if not isinstance(sensor_faults, list) or \
+                    any(not isinstance(e, SensorFault) for e in sensor_faults):
+                self.send_json_parsing_error(resp)
+                return
+
+            self.scada_data_mgr.get(data_id).sensor_faults = sensor_faults
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+
+class ScadaDataConvertUnitsHandler(ScadaDataBaseHandler):
+    """
+    Class for handling POST requests concerning unit conversion of a
+    given SCADA data instance.
+    """
+    def on_post(self, req: falcon.Request, resp: falcon.Response, data_id: str) -> None:
+        """
+        Converts the units of a given SCADA data instance and returns a new SCADA data instance.
+
+        Parameters
+        ----------
+        req : `falcon.Request`
+            Request instance.
+        resp : `falcon.Response`
+            Response instance.
+        data_id : `str`
+            UUID of the SCADA data.
+        """
+        try:
+            if self.scada_data_mgr.validate_uuid(data_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            new_units = self.load_json_data_from_request(req)
+            if not isinstance(new_units, dict):
+                self.send_json_parsing_error(resp)
+                return
+
+            my_scada_data = self.scada_data_mgr.get(data_id)
+            try:
+                scada_data_new = my_scada_data.convert_units(**new_units)
+            except Exception as ex:
+                self.send_error(resp, str(ex))
+                return
+
+            new_scada_data_id = self.scada_data_mgr.create_new_item(scada_data_new)
+            self.send_json_response(resp, {"data_id": new_scada_data_id})
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR

epyt_flow/rest_api/scenario/event_handlers.py

@@ -0,0 +1,118 @@
+"""
+This module provides REST API handlers for scenario events.
+"""
+import warnings
+import falcon
+
+from .handlers import ScenarioBaseHandler
+from ...simulation import Leakage, SensorFault
+
+
+class ScenarioLeakageHandler(ScenarioBaseHandler):
+    """
+    Class for handling GET and POST requests concerning leakages.
+    """
+    def on_get(self, _, resp: falcon.Response, scenario_id: str) -> None:
+        """
+        Gets all leakages of a given scenario.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        scenario_id : `str`
+            UUID of the scenario.
+        """
+        try:
+            if self.scenario_mgr.validate_uuid(scenario_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            my_leakages = self.scenario_mgr.get(scenario_id).leakages
+            self.send_json_response(resp, my_leakages)
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+    def on_post(self, req: falcon.Request, resp: falcon.Response, scenario_id: str) -> None:
+        """
+        Adds a new leakage to a given scenario.
+
+        Parameters
+        ----------
+        req : `falcon.Request`
+            Request instance.
+        resp : `falcon.Response`
+            Response instance.
+        scenario_id : `str`
+            UUID of the scenario.
+        """
+        try:
+            if self.scenario_mgr.validate_uuid(scenario_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            leakage = self.load_json_data_from_request(req)
+            if not isinstance(leakage, Leakage):
+                self.send_json_parsing_error(resp)
+                return
+
+            self.scenario_mgr.get(scenario_id).add_leakage(leakage)
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+
+class ScenarioSensorFaultHandler(ScenarioBaseHandler):
+    """
+    Class for handling GET and POST requests concerning sensor faults.
+    """
+    def on_get(self, _, resp: falcon.Response, scenario_id: str) -> None:
+        """
+        Gets all sensor faults of a given scenario.
+
+        Parameters
+        ----------
+        resp : `falcon.Response`
+            Response instance.
+        scenario_id : `str`
+            UUID of the scenario.
+        """
+        try:
+            if self.scenario_mgr.validate_uuid(scenario_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            my_sensor_faults = self.scenario_mgr.get(scenario_id).sensor_faults
+            self.send_json_response(resp, my_sensor_faults)
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR
+
+    def on_post(self, req: falcon.Request, resp: falcon.Response, scenario_id: str) -> None:
+        """
+        Adds a new sensor fault to a given scenario.
+
+        Parameters
+        ----------
+        req : `falcon.Request`
+            Request instance.
+        resp : `falcon.Response`
+            Response instance.
+        scenario_id : `str`
+            UUID of the scenario.
+        """
+        try:
+            if self.scenario_mgr.validate_uuid(scenario_id) is False:
+                self.send_invalid_resource_id_error(resp)
+                return
+
+            sensor_fault = self.load_json_data_from_request(req)
+            if not isinstance(sensor_fault, SensorFault):
+                self.send_json_parsing_error(resp)
+                return
+
+            self.scenario_mgr.get(scenario_id).add_sensor_fault(sensor_fault)
+        except Exception as ex:
+            warnings.warn(str(ex))
+            resp.status = falcon.HTTP_INTERNAL_SERVER_ERROR