wizata-dsapi 1.2.3__tar.gz → 1.2.4__tar.gz

{wizata_dsapi-1.2.3 → wizata_dsapi-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wizata_dsapi
-Version: 1.2.3
+Version: 1.2.4
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-1.2.3 → wizata_dsapi-1.2.4}/wizata_dsapi/__init__.py

@@ -4,7 +4,7 @@ from .api_dto import ApiDto, VarType
 from .paged_query_result import PagedQueryResult
 from .plot import Plot
 from .mlmodel import MLModel, MLModelConfig
-from .request import Request, filter_map
+from .request import Request, filter_map, RequestGroup, RequestGroupMap
 from .execution import Execution, ExecutionStatus, ExecutionStepLog, AbortedException
 from .experiment import Experiment
 from .ds_dataframe import DSDataFrame

{wizata_dsapi-1.2.3 → wizata_dsapi-1.2.4}/wizata_dsapi/request.py

@@ -1,5 +1,8 @@
 import uuid
 from datetime import datetime, timedelta, timezone
+
+from reactivex.operators import group_by
+
 from .dataframe_toolkit import generate_epoch
 from .api_dto import ApiDto
 
@@ -13,23 +16,75 @@ filter_map = {
 }
 
 
-def _format_group(my_group:dict) -> dict:
+class RequestGroupMap:
+    """
+    Define a mapping between a set of datapoints and their corresponding event datapoint.
+    :ivar event_hardware_id str: hardware id of the datapoint identifying event inside a group.
+    :ivar event_datapoint: datapoint complete definition corresponding to event_hardware_id.
+    :ivar datapoints_hardware_ids list: list of all related datapoints.
+    :ivar datapoints dict: dict with key as hardware id and value datapoint for all mapped datapoints.
+    """
+
+    def __init__(self,
+                 event_hardware_id: str,
+                 datapoints_hardware_ids: list):
+        self.event_hardware_id = event_hardware_id
+        self.datapoints_hardware_ids = datapoints_hardware_ids
+        self.event_datapoint = None
+        self.datapoints = {}
+
+
+class RequestGroup:
     """
-    verify and format a group
-    :param my_group: group to check and format
-    :return: formatted group
+    Define a group statement within a structured query.
     """
-    if my_group is None or not isinstance(my_group, dict):
-        raise ValueError(f"illegal group {my_group}")
-    if "group_by" not in my_group:
-        my_group["group_by"] = "id"
-    elif my_group["group_by"] not in ["id" , "type"]:
-        raise ValueError(f"illegal group {my_group['group_by']}")
-    if "event_ids" in my_group:
-        my_group["events"] = my_group["event_ids"]
-    if "system_id" not in my_group or my_group["system_id"] is None or not isinstance(["system_id"], str):
-        raise ValueError(f"please specify system_id in {my_group}")
-    return my_group
+
+    def __init__(self,
+                 system_id,
+                 events: list = None,
+                 group_by: str = "id",
+                 start_delay: int = 0,
+                 end_delay: int = 0,
+                 maps: list = None):
+        self.system_id = system_id
+        self.group_by = group_by
+        self.events = events
+        self.maps = maps
+        self.start_delay = start_delay
+        self.end_delay = end_delay
+
+    @classmethod
+    def from_dict(cls, my_dict):
+        if my_dict is None or not isinstance(my_dict, dict):
+            raise ValueError(f"illegal group {my_dict}")
+
+        if "system_id" not in my_dict or my_dict["system_id"] is None:
+            if not isinstance(["system_id"], str) and not isinstance(my_dict["system_id"], int):
+                raise ValueError(f"please specify system_id in {my_dict}")
+
+        group = RequestGroup(
+            system_id=["system_id"]
+        )
+
+        # set group_by
+        if "group_by" in my_dict:
+            if my_dict["group_by"] not in ["id", "type"]:
+                raise ValueError(f"illegal group {my_dict['group_by']}")
+            group.group_by = my_dict["group_by"]
+
+        # one of the two is accepted to set events
+        if "event_ids" in my_dict:
+            group.events = my_dict["event_ids"]
+        if "events" in my_dict:
+            group.events = my_dict["events"]
+
+        if "start_delay" in my_dict:
+            group.start_delay = int(my_dict["start_delay"])
+
+        if "end_delay" in my_dict:
+            group.end_delay = int(my_dict["end_delay"])
+
+        return group
 
 
 class Request(ApiDto):
@@ -137,18 +192,18 @@ class Request(ApiDto):
             raise TypeError(f'field must be None, str or a list of str')
 
     @property
-    def groups(self) -> list:
+    def groups(self) -> list[RequestGroup]:
         """
         return formatted groups list based on group
         :return:
         """
         if self.group is not None and self.group != {}:
             if not isinstance(self.group, list):
-                return [_format_group(self.group)]
+                return [RequestGroup.from_dict(self.group)]
             else:
                 groups = []
                 for group in self.group:
-                    groups.append(_format_group(group))
+                    groups.append(RequestGroup.from_dict(group))
                 return groups
         else:
             return []

wizata_dsapi-1.2.4/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "1.2.4"

{wizata_dsapi-1.2.3 → wizata_dsapi-1.2.4}/wizata_dsapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wizata-dsapi
-Version: 1.2.3
+Version: 1.2.4
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

wizata_dsapi-1.2.3/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "1.2.3"