wizata-dsapi 2.1.0.dev19__tar.gz → 2.1.0.dev21__tar.gz

{wizata_dsapi-2.1.0.dev19 → wizata_dsapi-2.1.0.dev21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.1.0.dev19
+Version: 2.1.0.dev21
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-2.1.0.dev19 → wizata_dsapi-2.1.0.dev21}/wizata_dsapi/api_config.py

@@ -32,6 +32,16 @@ from .edge_device import EdgeDevice
 # by the platform internally (the 12.1 adopt-triggers migration reads them through
 # `ApiDataManager.backend_api`, which never consults this registry). What goes is
 # the ability to schedule through the public client.
+
+#: Entities the API paginates instead of listing.
+#
+# ``lists()`` fetches ``GET /<route>/``, and for these there is no such route — only
+# ``POST /<route>/search``. Declaring 'lists' without this set was worse than not
+# declaring it: the client advertised the operation and answered 404, and the
+# documentation shipped a sample nobody could run. Listing now gathers the pages
+# from the search endpoint, so the caller gets what the operation promised.
+_LISTS_VIA_SEARCH = {Deployment}
+
 _retired = {
     "triggers": (
         Trigger,

wizata_dsapi-2.1.0.dev21/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "2.1.0.dev21"

{wizata_dsapi-2.1.0.dev19 → wizata_dsapi-2.1.0.dev21}/wizata_dsapi/wizata_dsapi_client.py

@@ -361,6 +361,10 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         :return: list of all elements with at least the id property.
         """
         dto_class = self._get_class(entity=entity, operation="lists")
+        from .api_config import _LISTS_VIA_SEARCH
+        if dto_class in _LISTS_VIA_SEARCH:
+            # No GET /<route>/ exists for these; the API paginates them instead.
+            return self._list_via_search(dto_class)
         return self._process_request(
             method="GET",
             route=dto_class.route() + "/",
@@ -368,6 +372,32 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
             result_type="list"
         )
 
+    def _list_via_search(self, dto_class) -> list:
+        """
+        Every record of an entity the API only paginates.
+
+        Walks the pages rather than trusting one to hold everything: a caller asking
+        to list is asking for all of them, and silently returning the first fifty is
+        the kind of wrong that looks right until an estate grows.
+        """
+        results, page = [], 1
+        while True:
+            search_query = SearchQuery()
+            search_query.page = page
+            search_query.size = 100
+            response = requests.post(
+                self.__url() + dto_class.route() + "/search",
+                headers=self.__header(),
+                data=json.dumps(search_query.to_dict())
+            )
+            if response.status_code != 200:
+                raise self.__raise_error(response)
+            paged = PagedQueryResult.from_dict(response.json(), dto_class=dto_class)
+            results.extend(paged.results or [])
+            if not paged.results or len(results) >= (paged.total or 0):
+                return results
+            page += 1
+
     def get(self,
             obj=None,
             id: uuid.UUID = None,
@@ -1209,6 +1239,38 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
             raise ValueError("a pipeline key, UUID or Pipeline is required")
         return urllib.parse.quote(str(reference), safe="")
 
+    def _pipeline_uuid(self, pipeline) -> str:
+        """
+        Path segment for a route that addresses a pipeline by UUID only.
+
+        Distinct from :meth:`_pipeline_ref`, and the difference is not cosmetic: the
+        live-plot route resolves a key OR a UUID (DEV-6027), while the branch, deploy
+        and preview routes parse the segment with ``uuid.UUID(id)`` and answer
+        ``400 badly formed hexadecimal UUID string`` for a key.
+
+        Callers hold keys — that is what a pipeline is called everywhere a person
+        reads one — so the key is resolved here rather than refused.
+
+        :param pipeline: pipeline key, UUID or Pipeline.
+        :return: the pipeline's UUID as a path segment.
+        """
+        if isinstance(pipeline, Pipeline):
+            if pipeline.pipeline_id is not None:
+                return str(pipeline.pipeline_id)
+            pipeline = pipeline.key
+        if pipeline is None:
+            raise ValueError("a pipeline key, UUID or Pipeline is required")
+        if isinstance(pipeline, uuid.UUID):
+            return str(pipeline)
+        try:
+            return str(uuid.UUID(str(pipeline)))
+        except (ValueError, AttributeError, TypeError):
+            pass
+        resolved = self.get(pipeline_key=str(pipeline))
+        if resolved is None or resolved.pipeline_id is None:
+            raise ValueError(f"pipeline {pipeline!r} could not be resolved to an id")
+        return str(resolved.pipeline_id)
+
     def deployed_plots(self, pipeline, twin: str = None) -> list:
         """
         list a deployed pipeline's LIVE plots - what its deployments are currently
@@ -2088,7 +2150,7 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         """
         response = self._process_request(
             method="GET",
-            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/branches/"
+            route=f"{Pipeline.route()}/{self._pipeline_uuid(pipeline)}/branches/"
         )
         return response.json()
 
@@ -2109,7 +2171,7 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
             payload["source"] = source
         response = self._process_request(
             method="POST",
-            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/branches/",
+            route=f"{Pipeline.route()}/{self._pipeline_uuid(pipeline)}/branches/",
             data=json.dumps(payload)
         )
         return Pipeline.from_dict(response.json())
@@ -2127,7 +2189,7 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         """
         self._process_request(
             method="DELETE",
-            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/branches/{branch}/"
+            route=f"{Pipeline.route()}/{self._pipeline_uuid(pipeline)}/branches/{branch}/"
         )
 
     def merge_branch(self, pipeline, branch: str) -> dict:
@@ -2140,7 +2202,7 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         """
         response = self._process_request(
             method="POST",
-            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/branches/{branch}/merge"
+            route=f"{Pipeline.route()}/{self._pipeline_uuid(pipeline)}/branches/{branch}/merge"
         )
         return response.json()
 
@@ -2154,7 +2216,7 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         """
         response = self._process_request(
             method="GET",
-            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/branches/{branch}/"
+            route=f"{Pipeline.route()}/{self._pipeline_uuid(pipeline)}/branches/{branch}/"
         )
         return Pipeline.from_dict(response.json())
 
@@ -2239,7 +2301,7 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
                 payload[name] = value
         response = self._process_request(
             method="POST",
-            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/deploy/",
+            route=f"{Pipeline.route()}/{self._pipeline_uuid(pipeline)}/deploy/",
             data=json.dumps(payload)
         )
         return Deployment.from_dict(response.json())
@@ -2258,7 +2320,7 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         payload = {k: v for k, v in kwargs.items() if v is not None}
         response = self._process_request(
             method="POST",
-            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/deploy/preview/",
+            route=f"{Pipeline.route()}/{self._pipeline_uuid(pipeline)}/deploy/preview/",
             data=json.dumps(payload)
         )
         return response.json()
@@ -2305,6 +2367,31 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         """
         return self._deployment_action(deployment, "retry")
 
+    def search_deployments(self, search_query=None) -> PagedQueryResult:
+        """
+        Search deployments using a paged query.
+
+        The only way to ask what is deployed: there is no GET /deployments/, because
+        a deployment is not created by posting one — it is the result of deploying a
+        pipeline — and the estate is paginated rather than listed.
+
+        :param search_query: SearchQuery instance or dict with filters, sort, page, size.
+        :return: PagedQueryResult with Deployment results.
+        """
+        if search_query is None:
+            search_query = SearchQuery()
+        elif isinstance(search_query, dict):
+            search_query = SearchQuery.from_dict(search_query)
+        response = requests.post(
+            self.__url() + "deployments/search",
+            headers=self.__header(),
+            data=json.dumps(search_query.to_dict())
+        )
+        if response.status_code == 200:
+            return PagedQueryResult.from_dict(response.json(), dto_class=Deployment)
+        else:
+            raise self.__raise_error(response)
+
     def await_deployment(self,
                          deployment,
                          timeout: int = 900,

{wizata_dsapi-2.1.0.dev19 → wizata_dsapi-2.1.0.dev21}/wizata_dsapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.1.0.dev19
+Version: 2.1.0.dev21
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

wizata_dsapi-2.1.0.dev19/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "2.1.0.dev19"