splight-lib 5.17.5.dev2__tar.gz → 5.18.0__tar.gz

{splight_lib-5.17.5.dev2 → splight_lib-5.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: splight-lib
-Version: 5.17.5.dev2
+Version: 5.18.0
 Summary: Splight Library
 Author: Splight Dev
 Author-email: dev@splight-ae.com

{splight_lib-5.17.5.dev2 → splight_lib-5.18.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splight-lib"
-version = "5.17.5dev2"
+version = "5.18.0"
 description = "Splight Library"
 authors = [
     {name = "Splight Dev",email = "dev@splight-ae.com"}
@@ -48,7 +48,7 @@ ipdb = "^0.13.13"
 ipython = "8.12.2"
 flake8 = "^6.1.0"
 pre-commit = "3.2.2"
-pytest = "^7.4.3"
+pytest = "^8.3.0"
 jsonref = "1.1.0"
 polyfactory = "2.13.0"
 openapi-schema-validator = "0.6.2"

{splight_lib-5.17.5.dev2 → splight_lib-5.18.0}/splight_lib/client/database/classmap.py

@@ -60,6 +60,6 @@ CUSTOM_PATHS_MAP = {
     "decrypt-secret": "{prefix}/secrets/decrypt/",
     "routine-status": "{prefix}/component/routines/{routine}/update_status/",
     "server-status": "{prefix}/server/servers/{server}/update-status/",
-    "set-asset-metadata": "{prefix}/asset/metadata/{metadata}/set-metadata/",
-    "set-asset-relationship": "{prefix}/asset/relations/{relationship}/set-relationship/",
+    "set-asset-metadata": "{prefix}/asset/metadata/{metadata}/set/",
+    "set-asset-relationship": "{prefix}/asset/relations/{relationship}/set/",
 }

{splight_lib-5.17.5.dev2 → splight_lib-5.18.0}/splight_lib/component/abstract.py

@@ -13,10 +13,7 @@ from pydantic_core import ValidationError
 from splight_lib.component.spec import Spec
 from splight_lib.execution.engine import EngineStatus, ExecutionEngine
 from splight_lib.logging._internal import LogTags, get_splight_logger
-from splight_lib.models.component import (
-    ComponentObjectInstance,
-    RoutineObjectInstance,
-)
+from splight_lib.models import ComponentObjectInstance, RoutineObjectInstance
 from splight_lib.restclient import ConnectError, HTTPError, Timeout
 
 REQUEST_EXCEPTIONS = (ConnectError, HTTPError, Timeout)
@@ -143,10 +140,8 @@ class SplightBaseComponent(ABC):
     def _register_exit(self):
         if self._execution_engine.state == EngineStatus.FAILED:
             os._exit(1)
-            # sys.exit(1)
         else:
             os._exit(0)
-            # sys.exit(0)
 
     def _wrap_start(self, original_start: Callable) -> Callable:
         """Wraps the start method to wait for all threads to finish.
@@ -178,7 +173,6 @@ class SplightBaseComponent(ABC):
                 self._health_check_thread.join()
                 self._execution_engine.stop()
                 os._exit(1)
-                # sys.exit(1)
 
             # Wait for healthcheck to update before stopping everything
             sleep(HealthCheckProcessor.HEALTHCHECK_INTERVAL)

{splight_lib-5.17.5.dev2 → splight_lib-5.18.0}/splight_lib/component/spec.py

@@ -8,7 +8,7 @@ from splight_lib.component.exceptions import (
     DuplicatedValuesError,
     ParameterDependencyError,
 )
-from splight_lib.models.component import (
+from splight_lib.models import (
     Component,
     ComponentObjectInstance,
     ComponentType,
@@ -18,9 +18,9 @@ from splight_lib.models.component import (
     Output,
     PrivacyPolicy,
     Routine,
+    SplightDatalakeBaseModel,
     get_field_value,
 )
-from splight_lib.models.datalake_base import SplightDatalakeBaseModel
 from splight_lib.utils.custom_model import create_custom_model
 
 VALID_PARAMETER_VALUES = {

splight_lib-5.18.0/splight_lib/conftest.py

@@ -0,0 +1,44 @@
+from pathlib import Path
+
+import pytest
+
+from splight_lib.client.database.abstract import AbstractDatabaseClient
+from splight_lib.client.datalake.abstract import AbstractDatalakeClient
+from splight_lib.settings import SplightAPIVersion, api_settings
+
+# Only load these tests when API_VERSION is v4
+API_V4_TESTS = Path("splight_lib/models/_v4")
+
+
+@pytest.fixture(autouse=True)
+def reset_singletons():
+    AbstractDatabaseClient._instances = {}
+    AbstractDatalakeClient._instances = {}
+
+
+class VersionAwareDirectory(pytest.Directory):
+    def collect(self):
+        # If API_VERSION is v4, only collect tests from the _v4 directory
+        if api_settings.API_VERSION == SplightAPIVersion.V4:
+            # Only collect tests inside splight_lib/models/_v4
+            if self.path.is_relative_to(Path.cwd() / API_V4_TESTS):
+                for path in self.path.glob("test_*.py"):
+                    yield from self.ihook.pytest_collect_file(
+                        file_path=path, parent=self
+                    )
+            return  # Skip other directories
+
+        # If API_VERSION is v3, collect tests from all directories (excluding _v4)
+        elif api_settings.API_VERSION == SplightAPIVersion.V3:
+            if not self.path.is_relative_to(Path.cwd() / API_V4_TESTS):
+                # Collect tests from all directories except _v4
+                for path in self.path.glob("test_*.py"):
+                    yield from self.ihook.pytest_collect_file(
+                        file_path=path, parent=self
+                    )
+            return  # Skip collection if it is the v4 directory in v3 mode
+
+
+@pytest.hookimpl
+def pytest_collect_directory(path, parent):
+    return VersionAwareDirectory.from_parent(parent=parent, path=path)

splight_lib-5.18.0/splight_lib/models/__init__.py

@@ -0,0 +1,297 @@
+from splight_lib.settings import SplightAPIVersion, api_settings
+
+# Get API version
+api_version = api_settings.API_VERSION
+
+# Import only the models for the current version
+if api_version == SplightAPIVersion.V3:
+    from splight_lib.models._v3 import (
+        DB_MODEL_TYPE_MAPPING,
+        Action,
+        AdvancedFilter,
+        Alert,
+        AlertItem,
+        Asset,
+        AssetKind,
+        AssetParams,
+        AssetRelationship,
+        Attribute,
+        Boolean,
+        Bus,
+        Chart,
+        ChartItem,
+        Component,
+        ComponentObject,
+        ComponentObjectInstance,
+        ComponentType,
+        CustomType,
+        Dashboard,
+        DashboardActionListChart,
+        DashboardAlertEventsChart,
+        DashboardAlertListChart,
+        DashboardAssetListChart,
+        DashboardBarChart,
+        DashboardBarGaugeChart,
+        DashboardCommandListChart,
+        DashboardGaugeChart,
+        DashboardHistogramChart,
+        DashboardImageChart,
+        DashboardStatChart,
+        DashboardTableChart,
+        DashboardTextChart,
+        DashboardTimeseriesChart,
+        DataRequest,
+        Endpoint,
+        ExternalGrid,
+        File,
+        Filter,
+        Function,
+        FunctionItem,
+        Generator,
+        Grid,
+        HubComponent,
+        HubServer,
+        InputParameter,
+        Inverter,
+        Line,
+        Metadata,
+        Number,
+        Output,
+        Parameter,
+        PipelineStep,
+        PrivacyPolicy,
+        QueryFilter,
+        Routine,
+        RoutineEvaluation,
+        RoutineObject,
+        RoutineObjectInstance,
+        Secret,
+        Segment,
+        Server,
+        SetPoint,
+        SlackGenerator,
+        SlackLine,
+        SplightDatalakeBaseModel,
+        String,
+        Tab,
+        Tag,
+        ThreeWindingTransformer,
+        Trace,
+        Transformer,
+    )
+
+    __all__ = [
+        "Action",
+        "AdvancedFilter",
+        "Alert",
+        "AlertItem",
+        "Asset",
+        "AssetParams",
+        "AssetRelationship",
+        "Tag",
+        "AssetKind",
+        "Attribute",
+        "Boolean",
+        "Chart",
+        "DashboardActionListChart",
+        "DashboardAlertEventsChart",
+        "DashboardAlertListChart",
+        "DashboardAssetListChart",
+        "DashboardBarChart",
+        "DashboardBarGaugeChart",
+        "DashboardCommandListChart",
+        "DashboardGaugeChart",
+        "DashboardHistogramChart",
+        "DashboardImageChart",
+        "DashboardStatChart",
+        "DashboardTableChart",
+        "DashboardTextChart",
+        "DashboardTimeseriesChart",
+        "ChartItem",
+        "Component",
+        "ComponentObject",
+        "ComponentObjectInstance",
+        "ComponentType",
+        "CustomType",
+        "Endpoint",
+        "Output",
+        "InputParameter",
+        "PrivacyPolicy",
+        "Routine",
+        "get_field_value",
+        "Parameter",
+        "DB_MODEL_TYPE_MAPPING",
+        "Dashboard",
+        "DataRequest",
+        "File",
+        "Filter",
+        "Function",
+        "FunctionItem",
+        "HubComponent",
+        "HubServer",
+        "QueryFilter",
+        "Metadata",
+        "Number",
+        "PipelineStep",
+        "SplightDatalakeBaseModel",
+        "Bus",
+        "ExternalGrid",
+        "Generator",
+        "Grid",
+        "Line",
+        "Inverter",
+        "SlackGenerator",
+        "SlackLine",
+        "ThreeWindingTransformer",
+        "Transformer",
+        "RoutineEvaluation",
+        "Secret",
+        "Segment",
+        "Server",
+        "SetPoint",
+        "String",
+        "RoutineObject",
+        "RoutineObjectInstance",
+        "Tab",
+        "Trace",
+    ]
+elif api_version == SplightAPIVersion.V4:
+    from splight_lib.models._v4 import (
+        DB_MODEL_TYPE_MAPPING,
+        AdvancedFilter,
+        Alert,
+        AlertItem,
+        Asset,
+        AssetKind,
+        AssetRelationship,
+        Attribute,
+        AttributeType,
+        Boolean,
+        Bus,
+        Chart,
+        ChartItem,
+        Component,
+        ComponentObject,
+        ComponentObjectInstance,
+        ComponentType,
+        CustomType,
+        Dashboard,
+        DashboardAlertEventsChart,
+        DashboardAlertListChart,
+        DashboardAssetListChart,
+        DashboardBarChart,
+        DashboardBarGaugeChart,
+        DashboardGaugeChart,
+        DashboardHistogramChart,
+        DashboardImageChart,
+        DashboardStatChart,
+        DashboardTableChart,
+        DashboardTextChart,
+        DashboardTimeseriesChart,
+        DataRequest,
+        Endpoint,
+        ExternalGrid,
+        File,
+        Filter,
+        Generator,
+        Grid,
+        HubComponent,
+        HubServer,
+        InputParameter,
+        Line,
+        Load,
+        Metadata,
+        Number,
+        Output,
+        Parameter,
+        PipelineStep,
+        PrivacyPolicy,
+        ResourceSummary,
+        Routine,
+        RoutineEvaluation,
+        RoutineObject,
+        RoutineObjectInstance,
+        Secret,
+        Segment,
+        Server,
+        SlackLine,
+        SplightDatalakeBaseModel,
+        String,
+        Tab,
+        Tag,
+        Trace,
+        Transformer,
+        ValueType,
+        get_field_value,
+    )
+
+    __all__ = [
+        "Alert",
+        "AlertItem",
+        "Asset",
+        "AssetRelationship",
+        "Component",
+        "RoutineObjectInstance",
+        "RoutineObject",
+        "RoutineEvaluation",
+        "ComponentObject",
+        "ComponentObjectInstance",
+        "ComponentType",
+        "CustomType",
+        "Endpoint",
+        "InputParameter",
+        "Output",
+        "PrivacyPolicy",
+        "Routine",
+        "get_field_value",
+        "Parameter",
+        "DB_MODEL_TYPE_MAPPING",
+        "AdvancedFilter",
+        "SplightDatalakeBaseModel",
+        "Chart",
+        "ChartItem",
+        "Dashboard",
+        "DashboardAlertEventsChart",
+        "DashboardAlertListChart",
+        "DashboardAssetListChart",
+        "DashboardBarChart",
+        "DashboardBarGaugeChart",
+        "DashboardGaugeChart",
+        "DashboardHistogramChart",
+        "DashboardImageChart",
+        "DashboardStatChart",
+        "DashboardTableChart",
+        "DashboardTextChart",
+        "DashboardTimeseriesChart",
+        "Filter",
+        "Tab",
+        "DataRequest",
+        "PipelineStep",
+        "Trace",
+        "File",
+        "HubComponent",
+        "HubServer",
+        "Boolean",
+        "Number",
+        "String",
+        "Secret",
+        "Server",
+        "Tag",
+        "Metadata",
+        "Attribute",
+        "ResourceSummary",
+        "AssetKind",
+        "ValueType",
+        "AttributeType",
+        "Bus",
+        "ExternalGrid",
+        "Generator",
+        "Grid",
+        "Line",
+        "Load",
+        "Segment",
+        "SlackLine",
+        "Transformer",
+    ]
+else:
+    raise ImportError(f"No models available for API version: '{api_version}'.")

splight_lib-5.18.0/splight_lib/models/_v3/__init__.py

@@ -0,0 +1,156 @@
+from splight_lib.settings import SplightAPIVersion, api_settings
+
+if api_settings.API_VERSION != SplightAPIVersion.V3:
+    raise ImportError(
+        f"Unable to import models from this module when API_VERSION is not set to '{SplightAPIVersion.V3}'."
+    )
+
+from splight_lib.models._v3.actions import Action, SetPoint
+from splight_lib.models._v3.alert import Alert, AlertItem
+from splight_lib.models._v3.asset import (
+    Asset,
+    AssetKind,
+    AssetParams,
+    AssetRelationship,
+)
+from splight_lib.models._v3.attribute import Attribute
+from splight_lib.models._v3.bus import Bus
+from splight_lib.models._v3.component import (
+    DB_MODEL_TYPE_MAPPING,
+    Component,
+    ComponentObject,
+    ComponentObjectInstance,
+    ComponentType,
+    CustomType,
+    Endpoint,
+    InputParameter,
+    Output,
+    Parameter,
+    PrivacyPolicy,
+    Routine,
+    RoutineEvaluation,
+    RoutineObject,
+    RoutineObjectInstance,
+    get_field_value,
+)
+from splight_lib.models._v3.dashboard import (
+    AdvancedFilter,
+    Chart,
+    ChartItem,
+    Dashboard,
+    DashboardActionListChart,
+    DashboardAlertEventsChart,
+    DashboardAlertListChart,
+    DashboardAssetListChart,
+    DashboardBarChart,
+    DashboardBarGaugeChart,
+    DashboardCommandListChart,
+    DashboardGaugeChart,
+    DashboardHistogramChart,
+    DashboardImageChart,
+    DashboardStatChart,
+    DashboardTableChart,
+    DashboardTextChart,
+    DashboardTimeseriesChart,
+    Filter,
+    Tab,
+)
+from splight_lib.models._v3.datalake import DataRequest, PipelineStep, Trace
+from splight_lib.models._v3.datalake_base import SplightDatalakeBaseModel
+from splight_lib.models._v3.external_grid import ExternalGrid
+from splight_lib.models._v3.file import File
+from splight_lib.models._v3.function import Function, FunctionItem, QueryFilter
+from splight_lib.models._v3.generator import Generator
+from splight_lib.models._v3.grid import Grid
+from splight_lib.models._v3.hub import HubComponent
+from splight_lib.models._v3.hub_server import HubServer
+from splight_lib.models._v3.inverter import Inverter
+from splight_lib.models._v3.line import Line
+from splight_lib.models._v3.metadata import Metadata
+from splight_lib.models._v3.native import Boolean, Number, String
+from splight_lib.models._v3.secret import Secret
+from splight_lib.models._v3.segment import Segment
+from splight_lib.models._v3.server import Server
+from splight_lib.models._v3.slack_generator import SlackGenerator
+from splight_lib.models._v3.slack_line import SlackLine
+from splight_lib.models._v3.tag import Tag
+from splight_lib.models._v3.three_winding_transformer import (
+    ThreeWindingTransformer,
+)
+from splight_lib.models._v3.transformer import Transformer
+
+__all__ = [
+    "Action",
+    "AdvancedFilter",
+    "Alert",
+    "AlertItem",
+    "Asset",
+    "AssetParams",
+    "AssetRelationship",
+    "Tag",
+    "AssetKind",
+    "Attribute",
+    "Boolean",
+    "Chart",
+    "DashboardActionListChart",
+    "DashboardAlertEventsChart",
+    "DashboardAlertListChart",
+    "DashboardAssetListChart",
+    "DashboardBarChart",
+    "DashboardBarGaugeChart",
+    "DashboardCommandListChart",
+    "DashboardGaugeChart",
+    "DashboardHistogramChart",
+    "DashboardImageChart",
+    "DashboardStatChart",
+    "DashboardTableChart",
+    "DashboardTextChart",
+    "DashboardTimeseriesChart",
+    "ChartItem",
+    "Component",
+    "ComponentObject",
+    "ComponentObjectInstance",
+    "ComponentType",
+    "CustomType",
+    "Endpoint",
+    "Output",
+    "InputParameter",
+    "PrivacyPolicy",
+    "Routine",
+    "get_field_value",
+    "SplightDatalakeBaseModel",
+    "DB_MODEL_TYPE_MAPPING",
+    "Parameter",
+    "Dashboard",
+    "DataRequest",
+    "File",
+    "Filter",
+    "Function",
+    "FunctionItem",
+    "HubComponent",
+    "HubServer",
+    "QueryFilter",
+    "Metadata",
+    "Number",
+    "PipelineStep",
+    "Bus",
+    "ExternalGrid",
+    "Generator",
+    "Grid",
+    "Line",
+    "Inverter",
+    "SlackGenerator",
+    "SlackLine",
+    "ThreeWindingTransformer",
+    "Transformer",
+    "RoutineEvaluation",
+    "Secret",
+    "Segment",
+    "Server",
+    "SetPoint",
+    "String",
+    "RoutineObject",
+    "RoutineObjectInstance",
+    "Tab",
+    "Trace",
+]

{splight_lib-5.17.5.dev2/splight_lib/models → splight_lib-5.18.0/splight_lib/models/_v3}/actions.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 
-from splight_lib.models.database_base import (
+from splight_lib.models.database import (
     ResourceSummary,
     SplightDatabaseBaseModel,
 )

{splight_lib-5.17.5.dev2/splight_lib/models → splight_lib-5.18.0/splight_lib/models/_v3}/alert.py

@@ -13,14 +13,14 @@ from pydantic import (
 from strenum import LowercaseStrEnum, UppercaseStrEnum
 from typing_extensions import TypedDict
 
-from splight_lib.models.database_base import (
-    ResourceSummary,
-    SplightDatabaseBaseModel,
-)
-from splight_lib.models.exceptions import (
+from splight_lib.models._v3.exceptions import (
     InvalidAlertConfiguration,
     MissingAlertItemExpression,
 )
+from splight_lib.models.database import (
+    ResourceSummary,
+    SplightDatabaseBaseModel,
+)
 
 
 class AlertItemType(UppercaseStrEnum):

{splight_lib-5.17.5.dev2/splight_lib/models → splight_lib-5.18.0/splight_lib/models/_v3}/asset.py

@@ -5,14 +5,13 @@ from zoneinfo import available_timezones
 from geojson_pydantic import GeometryCollection
 from pydantic import BaseModel, field_validator
 
-from splight_lib.models.attribute import Attribute
-from splight_lib.models.database_base import (
+from splight_lib.models._v3.attribute import Attribute
+from splight_lib.models._v3.exceptions import MethodNotAllowed
+from splight_lib.models._v3.metadata import Metadata
+from splight_lib.models.database import (
     ResourceSummary,
     SplightDatabaseBaseModel,
 )
-from splight_lib.models.exceptions import MethodNotAllowed
-from splight_lib.models.metadata import Metadata
-from splight_lib.settings import SplightAPIVersion, api_settings
 
 warnings.filterwarnings("ignore", category=UserWarning)
 
@@ -36,21 +35,7 @@ class AssetRelationship(SplightDatabaseBaseModel):
     asset: ResourceSummary | None = None
     related_asset: ResourceSummary | None = None
 
-    def save(self) -> None:
-        if (
-            self.id is not None
-            and api_settings.API_VERSION == SplightAPIVersion.V4
-        ):
-            raise NotImplementedError(
-                "Asset Relationship save operation is not supported in API v4"
-            )
-        super().save()
-
     def set(self, asset_id: str) -> None:
-        if api_settings.API_VERSION == SplightAPIVersion.V3:
-            raise NotImplementedError(
-                "Asset Relationsip set operation is not supported in API v3"
-            )
         self._db_client.operate(
             "set-asset-relationship",
             instance={

{splight_lib-5.17.5.dev2/splight_lib/models → splight_lib-5.18.0/splight_lib/models/_v3}/attribute.py

@@ -2,7 +2,7 @@ from enum import auto
 
 from strenum import PascalCaseStrEnum
 
-from splight_lib.models.database_base import SplightDatabaseBaseModel
+from splight_lib.models.database import SplightDatabaseBaseModel
 
 
 class AttributeType(PascalCaseStrEnum):

{splight_lib-5.17.5.dev2/splight_lib/models → splight_lib-5.18.0/splight_lib/models/_v3}/bus.py

@@ -1,6 +1,10 @@
-from splight_lib.models import AssetParams, AssetRelationship, Attribute
-from splight_lib.models.database_base import SplightDatabaseBaseModel
-from splight_lib.models.metadata import Metadata
+from splight_lib.models._v3.asset import (
+    AssetParams,
+    AssetRelationship,
+    Attribute,
+)
+from splight_lib.models._v3.metadata import Metadata
+from splight_lib.models.database import SplightDatabaseBaseModel
 
 
 class Bus(AssetParams, SplightDatabaseBaseModel):