splight-lib 4.3.6__tar.gz → 4.3.8__tar.gz

{splight_lib-4.3.6 → splight_lib-4.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-lib
-Version: 4.3.6
+Version: 4.3.8
 Summary: Splight Library
 Author: Splight Dev
 Author-email: dev@splight-ae.com

{splight_lib-4.3.6 → splight_lib-4.3.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "splight-lib"
-version = "4.3.6"
+version = "4.3.8"
 description = "Splight Library"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"

{splight_lib-4.3.6 → splight_lib-4.3.8}/splight_lib/models/function.py

@@ -28,6 +28,7 @@ class QueryFilter(TypedDict):
 
 
 class GroupUnit(LowercaseStrEnum):
+    EMPTY = ""
     SECOND = auto()
     MINUTE = auto()
     HOUR = auto()
@@ -45,25 +46,35 @@ class GroupCriteria(LowercaseStrEnum):
 
 
 class FunctionItem(BaseModel):
+    # NOTE: the defaults are inconsistent because
+    # we never made a clear contract between the lib, api and frontend
+
     id: Optional[str] = Field(None, max_length=100)
+
     ref_id: str
     type: FunctionItemType = FunctionItemType.QUERY
+
     expression: str = ""
+    expression_plain: str = ""
+
     query_filter_asset: Optional[QueryFilter] = None
     query_filter_attribute: Optional[QueryFilter] = None
-    expression_plain: Optional[str] = None
-    query_group_unit: Optional[GroupUnit] = None
-    query_group_function: Optional[GroupCriteria] = None
-    query_sort_field: Optional[str] = None
-    query_sort_direction: Optional[int] = None
+
+    query_group_function: GroupCriteria = GroupCriteria.EMPTY
+    query_group_unit: GroupUnit = GroupUnit.EMPTY
+
+    query_sort_field: str = ""
+    query_sort_direction: int = -1
+
+    # NOTE: why is this None as default but not "" like 'expression_plain'
     query_plain: Optional[str] = None
 
     @model_validator(mode="after")
     def validate_expression(self):
-        if self.expression:
-            if self.type != FunctionItemType.EXPRESSION:
+        if self.type == FunctionItemType.EXPRESSION:
+            if self.expression is None:
                 raise ValidationError(
-                    "type must be EXPRESSION if a expression is passed."
+                    f"Parameter 'expression' is required for expression type function items"
                 )
             self.expression_plain = (
                 self._get_expression_plain()
@@ -74,11 +85,12 @@ class FunctionItem(BaseModel):
 
     @model_validator(mode="after")
     def validate_query(self):
-        if self.query_filter_asset is not None:
-            if self.type != FunctionItemType.QUERY:
-                raise ValidationError(
-                    "type must be QUERY if a query_filter_asset is passed."
-                )
+        if self.type == FunctionItemType.QUERY:
+            for attr in [self.query_filter_asset, self.query_filter_attribute]:
+                if attr is None:
+                    raise ValidationError(
+                        f"Parameter '{attr}' is required for query type functions items"
+                    )
             self.query_plain = (
                 self._get_query_plain()
                 if self.query_plain is None
@@ -103,8 +115,35 @@ class FunctionItem(BaseModel):
                     "asset": self.query_filter_asset["id"],
                     "attribute": self.query_filter_attribute["id"],
                 }
-            }
+            },
         ]
+        # NOTE: The frontend only sets the rest of the query
+        # if both group_unit and group_function are set
+        if self.query_group_unit and self.query_group_function:
+            query_plain.extend(
+                [
+                    {
+                        "$addFields": {
+                            "timestamp": {
+                                "$dateTrunc": {
+                                    "date": "$timestamp",
+                                    "unit": self.query_group_unit,
+                                    "binSize": 1,
+                                }
+                            }
+                        }
+                    },
+                    {
+                        "$group": {
+                            "_id": "$timestamp",
+                            "value": {
+                                f"${self.query_group_function}": "$value"
+                            },
+                            "timestamp": {"$last": "$timestamp"},
+                        }
+                    },
+                ]
+            )
         return json.dumps(query_plain)
 
 
@@ -121,8 +160,8 @@ class Function(SplightDatabaseBaseModel):
 
     type: Literal["cron", "rate"]
     target_variable: str
-    target_asset: Optional[QueryFilter] = None
-    target_attribute: Optional[QueryFilter] = None
+    target_asset: QueryFilter  # NOTE: optional in API
+    target_attribute: QueryFilter  # NOTE: optional in API
 
     cron_minutes: Optional[str] = None
     cron_hours: Optional[str] = None
@@ -133,3 +172,27 @@ class Function(SplightDatabaseBaseModel):
 
     rate_value: Optional[PositiveInt] = None
     rate_unit: Optional[Literal["day", "hour", "minute"]] = None
+
+    @model_validator(mode="after")
+    def validate_type(self):
+        if self.type == "cron":
+            for attr in [
+                self.cron_year,
+                self.cron_month,
+                self.cron_hours,
+                self.cron_minutes,
+                self.cron_dow,
+                self.cron_dom,
+            ]:
+                if attr is None:
+                    raise ValidationError(
+                        f"Parameter {attr} is required for '{self.type}' type functions"
+                    )
+        if self.type == "rate":
+            for attr in [self.rate_value, self.rate_unit]:
+                if attr is None:
+                    raise ValidationError(
+                        f"Parameter {attr} is required for '{self.type}' type functions"
+                    )
+
+        return self