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

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

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

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

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

{splight_lib-4.3.4 → splight_lib-4.3.6}/splight_lib/models/__init__.py

@@ -18,7 +18,7 @@ from splight_lib.models.dashboard import (
     Tab,
 )
 from splight_lib.models.file import File
-from splight_lib.models.function import Function, FunctionItem
+from splight_lib.models.function import Function, FunctionItem, QueryFilter
 from splight_lib.models.hub import HubComponent
 from splight_lib.models.metadata import Metadata
 from splight_lib.models.native import Boolean, Number, String
@@ -41,6 +41,7 @@ __all__ = [
     Filter,
     Function,
     FunctionItem,
+    QueryFilter,
     HubComponent,
     Metadata,
     Number,

{splight_lib-4.3.4 → splight_lib-4.3.6}/splight_lib/models/base.py

@@ -75,8 +75,8 @@ class SplightDatalakeBaseModel(BaseModel):
     timestamp: datetime = Field(
         default_factory=lambda: datetime.now(timezone.utc)
     )
-    instance_id: Optional[str] = None
-    instance_type: Optional[str] = None
+    instance_id: str = ""
+    instance_type: str = ""
     _collection_name: ClassVar[str] = "DatalakeModel"
     _dl_client: AbstractDatalakeClient = PrivateAttr()
 
@@ -119,9 +119,10 @@ class SplightDatalakeBaseModel(BaseModel):
 
     def save(self):
         dl_client = self.__get_datalake_client()
+        instance_dict = json.loads(self.model_dump_json())
         dl_client.save(
             collection=self._collection_name,
-            instances=json.loads(self.json()),
+            instances=instance_dict,
         )
 
     async def async_save(self):
@@ -129,7 +130,7 @@ class SplightDatalakeBaseModel(BaseModel):
 
         await dl_client.async_save(
             collection=self._collection_name,
-            instances=json.loads(self.json()),
+            instances=json.loads(self.model_dump_json()),
         )
 
     @classmethod

{splight_lib-4.3.4 → splight_lib-4.3.6}/splight_lib/models/component.py

@@ -89,15 +89,8 @@ class DataAddress(Parameter):
         return value
 
 
-class DataAddressValue(BaseModel):
-    asset: str
-    attribute: str
-
-    model_config = ConfigDict(extra="ignore")
-
-
 class InputDataAddress(DataAddress):
-    value: Optional[Union[List[DataAddressValue], DataAddressValue]] = None
+    value: Optional[Union[List[DLDataAddress], DLDataAddress]] = None
 
 
 class OutputParameter(BaseModel):
@@ -283,7 +276,7 @@ def get_field_value(field: Union[InputParameter, List[InputParameter]]):
         value = field.value.copy()
         value = value if multiple else [value]
         for item in value:
-            item.update({"type": field.value_type})
+            item.type = field.value_type
 
         value = [model_class.model_validate(item) for item in value]
         value = value[0] if not multiple else value

{splight_lib-4.3.4 → splight_lib-4.3.6}/splight_lib/models/data_address.py

@@ -1,7 +1,7 @@
-from typing import List
+from typing import List, Optional
 
 import pandas as pd
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 from splight_lib.models.native import Boolean, NativeOutput, Number, String
 
@@ -9,7 +9,7 @@ from splight_lib.models.native import Boolean, NativeOutput, Number, String
 class DataAddresses(BaseModel):
     asset: str
     attribute: str
-    type: str
+    type: Optional[str] = None
 
     _type_map = {
         "Number": Number,
@@ -17,6 +17,8 @@ class DataAddresses(BaseModel):
         "Boolean": Boolean,
     }
 
+    model_config = ConfigDict(extra="ignore")
+
     def get(self, **params) -> List["NativeOutput"]:
         params["asset"] = self.asset
         params["attribute"] = self.attribute

splight_lib-4.3.6/splight_lib/models/function.py

@@ -0,0 +1,135 @@
+import json
+import re
+from enum import auto
+from typing import List, Literal, Optional
+
+from pydantic import (
+    BaseModel,
+    Field,
+    PositiveInt,
+    ValidationError,
+    model_validator,
+)
+from strenum import LowercaseStrEnum, UppercaseStrEnum
+from typing_extensions import TypedDict
+
+from splight_lib.constants import DESCRIPTION_MAX_LENGTH
+from splight_lib.models.base import SplightDatabaseBaseModel
+
+
+class FunctionItemType(UppercaseStrEnum):
+    EXPRESSION = auto()
+    QUERY = auto()
+
+
+class QueryFilter(TypedDict):
+    id: str
+    name: str
+
+
+class GroupUnit(LowercaseStrEnum):
+    SECOND = auto()
+    MINUTE = auto()
+    HOUR = auto()
+    DAY = auto()
+    MONTH = auto()
+
+
+class GroupCriteria(LowercaseStrEnum):
+    EMPTY = ""
+    AVG = auto()
+    SUM = auto()
+    MIN = auto()
+    MAX = auto()
+    LAST = auto()
+
+
+class FunctionItem(BaseModel):
+    id: Optional[str] = Field(None, max_length=100)
+    ref_id: str
+    type: FunctionItemType = FunctionItemType.QUERY
+    expression: 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_plain: Optional[str] = None
+
+    @model_validator(mode="after")
+    def validate_expression(self):
+        if self.expression:
+            if self.type != FunctionItemType.EXPRESSION:
+                raise ValidationError(
+                    "type must be EXPRESSION if a expression is passed."
+                )
+            self.expression_plain = (
+                self._get_expression_plain()
+                if self.expression_plain is None
+                else self.expression_plain
+            )
+        return self
+
+    @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."
+                )
+            self.query_plain = (
+                self._get_query_plain()
+                if self.query_plain is None
+                else self.query_plain
+            )
+        return self
+
+    def _get_expression_plain(self):
+        pattern = r"\$\w+"
+        args = re.findall(pattern, self.expression)
+        str_args = ", ".join(args)
+        body = f"function ({str_args}) {{ return {self.expression} }}"
+        expression_plain = {
+            "$function": {"body": body, "args": args, "lang": "js"}
+        }
+        return json.dumps(expression_plain)
+
+    def _get_query_plain(self):
+        query_plain = [
+            {
+                "$match": {
+                    "asset": self.query_filter_asset["id"],
+                    "attribute": self.query_filter_attribute["id"],
+                }
+            }
+        ]
+        return json.dumps(query_plain)
+
+
+class Function(SplightDatabaseBaseModel):
+    id: Optional[str] = Field(None, max_length=100)
+    name: str
+    description: Optional[str] = Field(
+        default=None, max_length=DESCRIPTION_MAX_LENGTH
+    )
+
+    active: bool = True
+    time_window: int = 5 * 60
+    function_items: List[FunctionItem] = []
+
+    type: Literal["cron", "rate"]
+    target_variable: str
+    target_asset: Optional[QueryFilter] = None
+    target_attribute: Optional[QueryFilter] = None
+
+    cron_minutes: Optional[str] = None
+    cron_hours: Optional[str] = None
+    cron_dom: Optional[str] = None
+    cron_month: Optional[str] = None
+    cron_dow: Optional[str] = None
+    cron_year: Optional[str] = None
+
+    rate_value: Optional[PositiveInt] = None
+    rate_unit: Optional[Literal["day", "hour", "minute"]] = None

{splight_lib-4.3.4 → splight_lib-4.3.6}/splight_lib/models/native.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, Dict, List, Optional, Union
+from typing import ClassVar, Dict, List, Literal, Optional, Union
 
 import pandas as pd
 from pydantic import field_validator
@@ -42,14 +42,17 @@ class NativeOutput(SplightDatalakeBaseModel):
 
 class Number(NativeOutput):
     value: float
+    output_format: Literal["Number"] = "Number"
     _output_format: ClassVar[str] = "Number"
 
 
 class String(NativeOutput):
     value: str
+    output_format: Literal["String"] = "String"
     _output_format: ClassVar[str] = "String"
 
 
 class Boolean(NativeOutput):
     value: bool
+    output_format: Literal["Boolean"] = "Boolean"
     _output_format: ClassVar[str] = "Boolean"

splight_lib-4.3.4/splight_lib/models/function.py

@@ -1,68 +0,0 @@
-from enum import auto
-from typing import List, Optional
-
-from pydantic import BaseModel, Field
-from strenum import LowercaseStrEnum, UppercaseStrEnum
-from typing_extensions import TypedDict
-
-from splight_lib.constants import DESCRIPTION_MAX_LENGTH
-from splight_lib.models.base import SplightDatabaseBaseModel
-
-
-class FunctionItemType(UppercaseStrEnum):
-    EXPRESSION = auto()
-    QUERY = auto()
-
-
-class QueryFilter(TypedDict):
-    id: str
-    name: str
-
-
-class GroupUnit(LowercaseStrEnum):
-    SECOND = auto()
-    MINUTE = auto()
-    HOUR = auto()
-    DAY = auto()
-    MONTH = auto()
-
-
-class GroupCriteria(LowercaseStrEnum):
-    EMPTY = ""
-    AVG = auto()
-    SUM = auto()
-    MIN = auto()
-    MAX = auto()
-    LAST = auto()
-
-
-class FunctionItem(BaseModel):
-    id: Optional[str] = Field(None, max_length=100)
-    ref_id: str
-    type: FunctionItemType = FunctionItemType.QUERY
-    expression: str = ""
-    query_filter_asset: Optional[QueryFilter] = None
-    expression_plain: Optional[str] = None
-    expression_plain: Optional[str] = None
-    query_group_unint: Optional[GroupUnit] = None
-    query_group_function: Optional[GroupCriteria] = None
-    query_sort_field: Optional[str] = None
-    query_sort_direction: Optional[int] = None
-    query_plain: Optional[str] = None
-
-
-class Function(SplightDatabaseBaseModel):
-    id: Optional[str] = Field(None, max_length=100)
-    name: str
-    description: Optional[str] = Field(
-        default=None, max_length=DESCRIPTION_MAX_LENGTH
-    )
-
-    active: bool = True
-    frequency: int = 60
-    time_window: int = 5 * 60
-    function_items: List[FunctionItem] = []
-
-    target_variable: str
-    target_asset: Optional[str] = Field(None, alias="target_asset_id")
-    target_attribute: Optional[str] = Field(None, alias="target_attribute_id")