splight-lib 4.3.0.dev1__tar.gz → 4.3.1__tar.gz

splight_lib-4.3.1/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.1
+Name: splight-lib
+Version: 4.3.1
+Summary: Splight Library
+Author: Splight Dev
+Author-email: dev@splight-ae.com
+Requires-Python: >=3.8.1,<4
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: concurrent-log-handler (==0.9.21)
+Requires-Dist: cryptography (==35.0.0)
+Requires-Dist: email-validator (>=2.1.0.post1,<3.0.0)
+Requires-Dist: furl (==2.1.3)
+Requires-Dist: geojson-pydantic (==1.0.1)
+Requires-Dist: hexbytes (==0.2.2)
+Requires-Dist: httpx (==0.23.3)
+Requires-Dist: jinja2 (==3.0.2)
+Requires-Dist: mergedeep (==1.3.4)
+Requires-Dist: pandas (==1.4.0)
+Requires-Dist: parameterized (==0.8.1)
+Requires-Dist: pathspec (==0.11.1)
+Requires-Dist: protobuf (==4.21.6)
+Requires-Dist: py7zr (==0.18.5)
+Requires-Dist: pydantic (==2.4.2)
+Requires-Dist: pydantic-settings (==2.0.3)
+Requires-Dist: pysher (==1.0.8)
+Requires-Dist: pytz (==2021.3)
+Requires-Dist: pyyaml (==6.0.1)
+Requires-Dist: requests (>=2.26.0)
+Requires-Dist: retry (==0.9.2)
+Requires-Dist: simplejson (==3.17.6)
+Requires-Dist: strenum (==0.4.9)
+Requires-Dist: stringcase (==1.2.0)
+Requires-Dist: typing-extensions (>=4.6.1,<5.0.0)
+Description-Content-Type: text/markdown
+
+[![Lib upload](https://github.com/splightplatform/splight-lib/actions/workflows/libupload.yml/badge.svg)](https://github.com/splightplatform/splight-lib/actions/workflows/libupload.yml)
+
+## How to install
+
+For development
+
+- `make install`
+
+For productive envs.
+
+- `python setup.py install`
+
+## Tests
+
+```
+make test
+```
+

splight_lib-4.3.1/pyproject.toml

@@ -0,0 +1,64 @@
+[tool.poetry]
+name = "splight-lib"
+version = "4.3.1"
+description = "Splight Library"
+authors = ["Splight Dev <dev@splight-ae.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = ">=3.8.1,<4"
+concurrent-log-handler = "0.9.21"
+cryptography = "35.0.0"
+furl = "2.1.3"
+geojson-pydantic = "1.0.1"
+hexbytes = "0.2.2"
+httpx = "0.23.3"
+jinja2 = "3.0.2"
+mergedeep = "1.3.4"
+pandas = "1.4.0"
+parameterized = "0.8.1"
+pathspec = "0.11.1"
+protobuf = "4.21.6"
+py7zr = "0.18.5"
+pydantic = "2.4.2"
+pysher = "1.0.8"
+pytz = "2021.3"
+pyyaml = "6.0.1"
+requests = ">=2.26.0"
+retry = "0.9.2"
+simplejson = "3.17.6"
+strenum = "0.4.9"
+stringcase = "1.2.0"
+typing-extensions = "^4.6.1"
+pydantic-settings = "2.0.3"
+email-validator = "^2.1.0.post1"
+
+[tool.poetry.group.dev.dependencies]
+black = "23.3.0"
+isort = "5.12.0"
+ipdb = "^0.13.13"
+ipython = "8.12.2"
+flake8 = "^6.1.0"
+pre-commit = "3.2.2"
+pytest = "^7.4.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 79
+
+[tool.isort]
+profile = "black"
+line_length = 79
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "error",
+    "ignore::RuntimeWarning",
+    "ignore::UserWarning",
+    "ignore::pytest.PytestUnraisableExceptionWarning",
+    "ignore::pytest.PytestUnhandledThreadExceptionWarning",
+    "ignore::pytest.PytestAssertRewriteWarning",
+]

{splight-lib-4.3.0.dev1 → splight_lib-4.3.1}/splight_lib/client/communication/remote_client.py

@@ -46,7 +46,7 @@ class CommunicationFactory:
         assert (
             response.status_code == 201
         ), f"Cant create communication {self._model}."
-        return self._model.parse_obj(response.json())
+        return self._model.model_validate(response.json())
 
     def get(self, params=None):
         response = requests.get(
@@ -56,7 +56,7 @@ class CommunicationFactory:
             response.status_code == 200
         ), f"Cant fetch communication {self._model}."
         data = response.json()
-        return self._model.parse_obj(data)
+        return self._model.model_validate(data)
 
 
 class RemoteCommunicationClient(AbstractCommunicationClient):

{splight-lib-4.3.0.dev1 → splight_lib-4.3.1}/splight_lib/client/database/classmap.py

@@ -9,11 +9,12 @@ MODEL_NAME_MAP = {
     "chartitem": f"{ENGINE_PREFIX}/dashboard/chartitems/",
     "component": f"{ENGINE_PREFIX}/component/components/",
     "componentobject": f"{ENGINE_PREFIX}/component/objects/",
-    "routineobject": f"{ENGINE_PREFIX}/component/routines/",
     "dashboard": f"{ENGINE_PREFIX}/dashboard/dashboards/",
     "file": f"{ENGINE_PREFIX}/files/",
     "filter": f"{ENGINE_PREFIX}/dashboard/filters/",
+    "function": f"{ENGINE_PREFIX}/function/functions/",
     "query": f"{ENGINE_PREFIX}/queries/",
+    "routineobject": f"{ENGINE_PREFIX}/component/routines/",
     "secret": f"{ENGINE_PREFIX}/secrets/",
     "setpoint": f"{ENGINE_PREFIX}/setpoints/",
     "tab": f"{ENGINE_PREFIX}/dashboard/tabs/",

{splight-lib-4.3.0.dev1 → splight_lib-4.3.1}/splight_lib/client/database/remote_client.py

@@ -19,7 +19,6 @@ from splight_lib.client.exceptions import (
     InvalidModelName,
 )
 from splight_lib.constants import ENGINE_PREFIX
-from splight_lib.encryption import EncryptionClient
 from splight_lib.logging._internal import LogTags, get_splight_logger
 from splight_lib.restclient import SplightRestClient
 

splight_lib-4.3.1/splight_lib/client/tests/test_communication.py

@@ -0,0 +1,11 @@
+from unittest import TestCase
+
+
+class TestCommunication(TestCase):
+    def test_import_communication(self):
+        from splight_lib.client.communication.abstract import (
+            AbstractCommunicationClient,
+        )
+
+
+# TODO: complete tests for client/communication/remote_client.py

splight_lib-4.3.1/splight_lib/client/tests/test_database.py

@@ -0,0 +1,163 @@
+from unittest.mock import patch  # noqa E402
+
+import pytest  # noqa E402
+from furl import furl  # noqa E402
+
+from splight_lib.client.database.remote_client import (  # noqa E402
+    RemoteDatabaseClient,
+    SplightRestClient,
+)
+from splight_lib.client.exceptions import InvalidModelName  # noqa E402
+
+base_url = "http://test.com"
+access_id = "access_id"
+secret_key = "secret_key"
+
+
+class MockResponse:
+    status_code = 200
+
+    def __init__(self, json_data):
+        self.json_data = json_data
+
+    def raise_for_status(self):
+        return None
+
+    def json(self):
+        return self.json_data
+
+
+@patch("splight_lib.client.database.remote_client.SplightAuthToken")
+@patch("splight_lib.client.database.remote_client.SplightRestClient")
+def test_initialization(mock_rest_client, mock_auth_token):
+    client = RemoteDatabaseClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+
+    mock_auth_token.assert_called_once_with(
+        access_key=access_id, secret_key=secret_key
+    )
+    assert client._base_url.url == base_url
+    mock_rest_client().update_headers.assert_called_once()
+
+
+@patch.object(
+    SplightRestClient,
+    "post",
+    return_value=MockResponse({"name": "instance_name", "id": "some_id"}),
+)
+def test_save_without_id(mock_post):
+    client = RemoteDatabaseClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+
+    mock_instance = {"name": "instance_name"}
+    result = client.save("alert", mock_instance)
+
+    mock_post.assert_called_once()
+
+    assert "id" in result
+    assert result["name"] == mock_instance["name"]
+
+
+@patch.object(
+    SplightRestClient,
+    "put",
+    return_value=MockResponse({"name": "instance_name", "id": "instance_id"}),
+)
+def test_save_with_id(mock_put):
+    client = RemoteDatabaseClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+
+    mock_instance = {"id": "instance_id", "name": "instance_name"}
+    result = client.save("alert", mock_instance)
+
+    mock_put.assert_called_once_with(
+        furl(f"{base_url}/v2/engine/alert/alerts/instance_id/"),
+        json=mock_instance,
+    )
+    assert result == mock_instance
+
+
+@patch.object(SplightRestClient, "delete")
+def test_delete(mock_delete):
+    client = RemoteDatabaseClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+    client.delete("alert", "instance_id")
+    mock_delete.assert_called_once()
+
+
+def test_delete_invalid_model_name():
+    client = RemoteDatabaseClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+
+    with pytest.raises(InvalidModelName):
+        client.delete("invalid_resource_name", "instance_id")
+
+
+@patch.object(SplightRestClient, "get")
+def test_get_with_id(mock_get):
+    mock_instance_id = "123"
+    mock_get.return_value = MockResponse(
+        {"name": "instance_name", "id": mock_instance_id}
+    )
+    client = RemoteDatabaseClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+
+    result = client._get("alert", id=mock_instance_id)
+    mock_get.assert_called_once()
+    assert result["id"] == mock_instance_id
+
+
+@patch.object(SplightRestClient, "get")
+def test_get_without_id(mock_get):
+    mock_get.return_value = MockResponse(
+        {
+            "results": [{"name": "instance_name", "id": "instance_id"}],
+            "next": None,
+        }
+    )
+    client = RemoteDatabaseClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+    result = client._get("alert")
+
+    assert result[0]["id"] == "instance_id"
+    assert result[0]["name"] == "instance_name"
+
+
+@patch.object(SplightRestClient, "get")
+def test_get_without_id_and_set_first(mock_get):
+    mock_get.return_value = MockResponse(
+        {
+            "results": [{"name": "instance_name", "id": "instance_id"}],
+            "next": None,
+        }
+    )
+    client = RemoteDatabaseClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+    result = client._get("alert", first=True)
+
+    assert result[0]["id"] == "instance_id"
+    assert result[0]["name"] == "instance_name"

splight_lib-4.3.1/splight_lib/client/tests/test_datalake.py

@@ -0,0 +1,108 @@
+import os
+from unittest.mock import Mock, patch  # noqa E402
+
+import pandas as pd  # noqa E402
+
+from splight_lib.client.datalake import RemoteDatalakeClient  # noqa E402
+from splight_lib.client.datalake.remote_client import (  # noqa E402
+    SplightRestClient,
+)
+
+base_url = "http://test.com"
+access_id = "access_id"
+secret_key = "secret_key"
+
+
+class MockResponse:
+    status_code = 200
+
+    def __init__(self, json_data):
+        self.json_data = json_data
+
+    def raise_for_status(self):
+        return None
+
+    def json(self):
+        return self.json_data
+
+
+@patch("splight_lib.client.datalake.remote_client.SplightAuthToken")
+@patch("splight_lib.client.datalake.remote_client.SplightRestClient")
+def test_initialization(mock_rest_client, mock_auth_token):
+    client = RemoteDatalakeClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+
+    mock_auth_token.assert_called_once_with(
+        access_key=access_id, secret_key=secret_key
+    )
+    mock_rest_client.assert_called_once()
+
+
+@patch.object(
+    SplightRestClient, "post", return_value=MockResponse(({"key": "value"}))
+)
+def test_save(mock_post):
+    client = RemoteDatalakeClient(
+        base_url=base_url,
+        access_id=access_id,
+        secret_key=secret_key,
+    )
+    collection = "collection_name"
+    instances = [{"key": "value"}]
+    result = client.save(collection=collection, instances=instances)
+    mock_post.assert_called_once()
+    assert result == instances
+
+
+@patch.object(
+    SplightRestClient,
+    "get",
+    return_value=MockResponse({"results": [{"key": "value"}]}),
+)
+def test_raw_get(mock_get):
+    client = RemoteDatalakeClient(base_url, access_id, secret_key)
+    collection = "collection_name"
+    result = client._raw_get("resource", collection)
+    mock_get.assert_called_once()
+    assert result == [{"key": "value"}]
+
+
+@patch.object(SplightRestClient, "delete", return_value=MockResponse(None))
+def test_delete(mock_delete):
+    client = RemoteDatalakeClient(base_url, access_id, secret_key)
+    collection = "collection_name"
+    client.delete(collection)
+    mock_delete.assert_called_once()
+
+
+@patch.object(SplightRestClient, "post", return_value=MockResponse(None))
+def test_save_dataframe(mock_post):
+    client = RemoteDatalakeClient(base_url, access_id, secret_key)
+    collection = "collection_name"
+    dataframe = pd.DataFrame({"A": [1, 2], "B": [3, 4]})
+    client.save_dataframe(collection, dataframe)
+    mock_post.assert_called_once()
+
+
+@patch.object(SplightRestClient, "post", return_value=MockResponse(None))
+def test_create_index(mock_post):
+    client = RemoteDatalakeClient(base_url, access_id, secret_key)
+    collection = "collection_name"
+    indexes = [{"key": 1}]
+    client.create_index(collection, indexes)
+    mock_post.assert_called_once()
+
+
+@patch.object(
+    SplightRestClient, "post", return_value=MockResponse([{"key": "value"}])
+)
+def test_raw_aggregate(mock_post):
+    client = RemoteDatalakeClient(base_url, access_id, secret_key)
+    collection = "collection_name"
+    pipeline = [{"$match": {"key": "value"}}]
+    result = client.raw_aggregate(collection, pipeline)
+    mock_post.assert_called_once()
+    assert result == [{"key": "value"}]

splight_lib-4.3.1/splight_lib/client/tests/test_hub.py

@@ -0,0 +1,9 @@
+from unittest import TestCase
+
+
+class TestHub(TestCase):
+    def test_import_hub(self):
+        from splight_lib.client.hub.abstract import AbstractHubClient
+
+
+# TODO: complete tests for client/hub/client.py

{splight-lib-4.3.0.dev1 → splight_lib-4.3.1}/splight_lib/communication/event_handler.py

@@ -20,10 +20,6 @@ from splight_lib.models.event import (
     ComponentCommandStatus,
     ComponentCommandTriggerEvent,
     ComponentCommandUpdateEvent,
-    SetPointCreateEvent,
-    SetPointResponse,
-    SetPointResponseStatus,
-    SetPointUpdateEvent,
 )
 
 logger = get_splight_logger()
@@ -33,10 +29,6 @@ class InvalidCommandResponse(Exception):
     pass
 
 
-class InvalidSetPointResponse(Exception):
-    pass
-
-
 class InvalidBidingObject(Exception):
     pass
 
@@ -65,15 +57,15 @@ def database_object_event_handler(
         event = CommunicationEvent.parse_raw(event_str)
         if binding_object_type in DB_MODEL_TYPE_MAPPING.values():
             # Case in which is not a ComponentObject
-            handler_arg = binding_object_type.parse_obj(event.data)
+            handler_arg = binding_object_type.model_validate(event.data)
         elif issubclass(binding_object_type, ComponentObjectInstance):
             # Case for data represents a ComponentObject
-            component_obj = ComponentObject.parse_obj(event.data)
+            component_obj = ComponentObject.model_validate(event.data)
             model_class = ComponentObjectInstance.from_object(component_obj)
             handler_arg = model_class.parse_object(component_obj)
         elif issubclass(binding_object_type, RoutineObjectInstance):
             # Case for data represents a RoutineObject
-            routine_obj = RoutineObject.parse_obj(event.data)
+            routine_obj = RoutineObject.model_validate(event.data)
             model_class = RoutineObjectInstance.from_object(routine_obj)
             handler_arg = model_class.parse_object(routine_obj)
         else:
@@ -138,48 +130,3 @@ def command_event_handler(
         data=component_command
     )
     comm_client.trigger(component_command_callback_event)
-
-
-def setpoint_event_handler(
-    binding_function: Callable,
-    comm_client: AbstractCommunicationClient,
-    component_id: str,
-    event_str: str,
-):
-    """General handler for component's setpoint events.
-
-    Parameters
-    ----------
-    binding_function: Callable
-        Function to be executed.
-    comm_client: AbstractCommunicationClient
-        Communication client to send command response.
-    component_id: str
-        The component's id that is reacting to the setpoint event.
-    event_str:
-        The raw event string from pusher client.
-    """
-    logger.info("Setpoint triggered.", tags=LogTags.SETPOINT)
-    try:
-        event = SetPointCreateEvent.parse_raw(event_str)
-        setpoint = event.data
-        setpoint_response = binding_function(setpoint)
-        if not isinstance(setpoint_response, SetPointResponseStatus):
-            raise InvalidSetPointResponse("Setpoint response is invalid")
-
-        if setpoint_response != SetPointResponseStatus.IGNORE:
-            setpoint.responses = [
-                SetPointResponse(
-                    component=component_id,
-                    status=setpoint_response,
-                )
-            ]
-            setpoint_callback_event = SetPointUpdateEvent(data=setpoint)
-            comm_client.trigger(setpoint_callback_event)
-    except Exception as exc:
-        logger.error(
-            "Error while handling setpoint create: %s",
-            exc,
-            exc_info=True,
-            tags=LogTags.SETPOINT,
-        )

splight_lib-4.3.1/splight_lib/communication/tests/test_event_handler.py

@@ -0,0 +1 @@
+# TODO: complete tests for communication/event_handler.py