splight-lib 5.2.7__tar.gz → 5.4.0__tar.gz

{splight_lib-5.2.7 → splight_lib-5.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-lib
-Version: 5.2.7
+Version: 5.4.0
 Summary: Splight Library
 Author: Splight Dev
 Author-email: dev@splight-ae.com
@@ -23,6 +23,7 @@ Requires-Dist: mergedeep (==1.3.4)
 Requires-Dist: pandas (==1.5.2)
 Requires-Dist: parameterized (==0.8.1)
 Requires-Dist: pathspec (==0.11.1)
+Requires-Dist: progressbar2 (==4.4.1)
 Requires-Dist: protobuf (==4.21.6)
 Requires-Dist: py7zr (==0.20.8)
 Requires-Dist: pydantic (==2.4.2)

{splight_lib-5.2.7 → splight_lib-5.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "splight-lib"
-version = "5.2.7"
+version = "5.4.0"
 description = "Splight Library"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"
@@ -33,6 +33,7 @@ pydantic-settings = "2.0.3"
 email-validator = "^2.1.0.post1"
 apscheduler = "3.10.4"
 typer = "0.9.0"
+progressbar2 = "4.4.1"
 
 [tool.poetry.group.dev.dependencies]
 black = "23.3.0"

{splight_lib-5.2.7 → splight_lib-5.4.0}/splight_lib/client/database/classmap.py

@@ -11,7 +11,7 @@ MODEL_NAME_MAP = {
     "component": f"{ENGINE_PREFIX}/component/components/",
     "componentobject": f"{ENGINE_PREFIX}/component/objects/",
     "dashboard": f"{ENGINE_PREFIX}/dashboard/dashboards/",
-    "file": f"{ENGINE_PREFIX}/file/files/",
+    "file": f"{ENGINE_PREFIX}/files/",
     "filter": f"{ENGINE_PREFIX}/dashboard/filters/",
     "function": f"{ENGINE_PREFIX}/function/functions/",
     "query": f"{ENGINE_PREFIX}/queries/",

{splight_lib-5.2.7 → splight_lib-5.4.0}/splight_lib/client/database/remote_client.py

@@ -1,6 +1,8 @@
 from tempfile import NamedTemporaryFile
 from typing import Any, Dict, Generator, List, Optional, Union
 
+import progressbar
+import requests
 from furl import furl
 from httpx._status_codes import codes
 from retry import retry
@@ -16,6 +18,7 @@ from splight_lib.client.database.classmap import (
 from splight_lib.client.exceptions import (
     SPLIGHT_REQUEST_EXCEPTIONS,
     InstanceNotFound,
+    InvalidModel,
     InvalidModelName,
 )
 from splight_lib.constants import ENGINE_PREFIX
@@ -145,7 +148,6 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         response.raise_for_status()
         return response.json()
 
-    # @retry(SPLIGHT_REQUEST_EXCEPTIONS, tries=3, delay=1)
     def _retrieve_multiple(
         self, resource_name: str, first: bool = False, **kwargs
     ) -> List[Dict]:
@@ -196,16 +198,33 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         ------
         InvalidModelName thrown when the model name is not correct.
         """
+        if resource_name.lower() != "file":
+            raise InvalidModel("Only files can be downloaded.")
         api_path = self._get_api_path(resource_name)
         resource_id = instance.get("id")
-        url = self._base_url / api_path / f"{resource_id}/download/"
+        url = self._base_url / api_path / f"{resource_id}/download_url/"
         response = self._restclient.get(url)
         response.raise_for_status()
-        f = NamedTemporaryFile("wb+")
-        f.write(response.content)
-        f.seek(0)
+        download_url = response.json().get("url")
+
+        file = NamedTemporaryFile(mode="wb+", suffix=instance["name"])
+        # TODO: Check why python wget is raised and error with code 403
+        response = requests.get(download_url, stream=True)
+        with open(file.name, "wb") as f:
+            length = int(response.headers.get("content-length"))
+            chunk_size = 8192
+            total_chunks = length // chunk_size + 1
+            widgets = ["Downloading: ", progressbar.Bar("#")]
+            bar = progressbar.ProgressBar(
+                max_value=total_chunks, widgets=widgets
+            ).start()
+            for counter, chunk in enumerate(
+                response.iter_content(chunk_size=chunk_size)
+            ):
+                f.write(chunk)
+                bar.update(counter)
         logger.debug("Downloaded instance %s.", id, tags=LogTags.DATABASE)
-        return f
+        return file
 
     def _pages(
         self, url: furl, **kwargs
@@ -233,16 +252,11 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         api_path = self._get_api_path(resource_name)
         url = self._base_url / api_path
         if model_name == "file":
-            with open(instance["file"], "rb") as f:
-                file = {"file": f}
-                response = self._restclient.post(
-                    url, data=instance, files=file
-                )
+            instance = self._create_file(instance, url)
         else:
             response = self._restclient.post(url, json=instance)
-
-        response.raise_for_status()
-        instance = response.json()
+            response.raise_for_status()
+            instance = response.json()
         logger.debug(
             "Instance %s created", instance["id"], tags=LogTags.DATABASE
         )
@@ -265,6 +279,35 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         response.raise_for_status()
         return response.json()
 
+    def _create_file(self, instance: Dict, url: furl):
+        response = self._restclient.post(url, data=instance)
+        response.raise_for_status()
+        file_path = instance["file"]
+        # Check is this is handled somewher
+        created_instance = response.json()
+        self._upload_file(created_instance, file_path=file_path)
+        return created_instance
+
+    def _upload_file(self, instance: Dict, file_path: str):
+        api_path = self._get_api_path("file")
+        resource_id = instance.get("id")
+        url = self._base_url / api_path / f"{resource_id}/upload_url/"
+        response = self._restclient.get(url)
+        response.raise_for_status()
+        upload_url = response.json().get("url")
+        file = open(file_path, "rb")
+        file_name = instance["name"]
+        with open(file_path, "rb") as fid:
+            file = {"file": (file_name, fid)}
+            response = requests.put(
+                upload_url,
+                files=file,
+            )
+            response.raise_for_status()
+        logger.debug(
+            "File uploaded succesfully %s.", resource_id, tags=LogTags.DATABASE
+        )
+
     @staticmethod
     def _get_api_path(resource_name: str) -> str:
         model_name = resource_name.lower()

{splight_lib-5.2.7 → splight_lib-5.4.0}/splight_lib/client/exceptions.py

@@ -30,3 +30,7 @@ class InstanceNotFound(Exception):
 
     def __str__(self) -> str:
         return self._msg
+
+
+class InvalidModel(Exception):
+    ...

{splight_lib-5.2.7 → splight_lib-5.4.0}/splight_lib/models/exceptions.py

@@ -28,3 +28,7 @@ class InvalidAlertConfiguration(Exception):
 
 class MissingAlertItemExpression(Exception):
     pass
+
+
+class ForbiddenOperation(Exception):
+    pass

{splight_lib-5.2.7 → splight_lib-5.4.0}/splight_lib/models/file.py

@@ -1,13 +1,12 @@
 import json
-import os
 from typing import Dict, List, Optional
 
-from pydantic import Field, field_validator, model_validator
-from pysher.pusher import hashlib
+from pydantic import Field, field_validator
 
 from splight_lib.constants import DESCRIPTION_MAX_LENGTH
 from splight_lib.models.asset import Asset
 from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.exceptions import ForbiddenOperation
 
 
 class File(SplightDatabaseBaseModel):
@@ -20,24 +19,7 @@ class File(SplightDatabaseBaseModel):
     )
     metadata: Dict = {}
     content_type: Optional[str] = None
-    url: Optional[str] = None
-    checksum: Optional[str] = None
-
-    @model_validator(mode="after")
-    def validate_file(self):
-        if self.file:
-            self.file = self.file.replace("/", os.sep)
-            self.file = self.file.replace("\\", os.sep)
-
-            # Compute the checksum if missing
-            if self.checksum is None:
-                hasher = hashlib.md5()
-                with open(self.file, "rb") as file:
-                    # Read in chunks of 8KiB for large files
-                    while chunk := file.read(8192):
-                        hasher.update(chunk)
-                self.checksum = hasher.hexdigest()
-        return self
+    parent: Optional[str] = None
 
     @field_validator("metadata", mode="before")
     def validate_metadata(cls, v):
@@ -65,12 +47,13 @@ class File(SplightDatabaseBaseModel):
         return res
 
     def save(self):
+        if self.id:
+            raise ForbiddenOperation(
+                "File object already exists in database. Can't be updated"
+            )
         saved = self._db_client.save(
             self.__class__.__name__, self.model_dump(exclude_none=True)
         )
         if not self.id:
             self.id = saved["id"]
         self.name = saved["name"]
-        self.content_type = saved["content_type"]
-        self.checksum = saved["checksum"]
-        self.url = saved["url"]