wizata-dsapi 2.1.0.dev20__tar.gz → 2.1.0.dev22__tar.gz

{wizata_dsapi-2.1.0.dev20 → wizata_dsapi-2.1.0.dev22}/PKG-INFO

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

{wizata_dsapi-2.1.0.dev20 → wizata_dsapi-2.1.0.dev22}/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.dev22/wizata_dsapi/version.py

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

{wizata_dsapi-2.1.0.dev20 → wizata_dsapi-2.1.0.dev22}/wizata_dsapi/wizata_dsapi_client.py

@@ -213,8 +213,15 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         raise a formatted error from an API response.
         :param response: response from the server.
         """
-        if 'Content-Type' in response.headers and response.headers['Content-Type'] == 'application/json':
-            json_content = response.json()
+        if ('Content-Type' in response.headers
+                and response.headers['Content-Type'] == 'application/json'
+                and response.content):
+            try:
+                json_content = response.json()
+            except ValueError:
+                # A body that claims to be JSON and is not. Reporting the status is
+                # useful; replacing the real failure with a decoding error is not.
+                return RuntimeError(str(response.status_code) + " - " + response.reason)
             if "errors" in json_content.keys():
                 message = json_content["errors"][0]["message"]
                 return RuntimeError(str(response.status_code) + " - " + message)
@@ -303,11 +310,17 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
                 print(f' * Warning - version mismatch - server {server_version} vs local {wizata_dsapi.__version__}')
                 print(f'        python -m pip install --upgrade pip')
                 print(f'        pip install wizata_dsapi=={server_version}')
-        if response.status_code == 200:
+        if 200 <= response.status_code < 300:
             if 'Wizata-Roles' in response.headers:
                 self.roles = parse_string_list(response.headers['Wizata-Roles'])
             if 'Wizata-Twins' in response.headers:
                 self.twins = parse_string_list(response.headers['Wizata-Twins'])
+            if not response.content:
+                # 204 No Content, which is what a delete answers. Only 200 counted
+                # as success before, so a delete fell through to the error path and
+                # raised JSONDecodeError parsing an empty body — the call had
+                # worked, and the caller had to catch an exception to find out.
+                return None
             if result_type == "list":
                 obj_list = []
                 for obj_json in response.json():
@@ -361,6 +374,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 +385,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,
@@ -2337,6 +2380,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.dev20 → wizata_dsapi-2.1.0.dev22}/wizata_dsapi.egg-info/PKG-INFO

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

wizata_dsapi-2.1.0.dev20/wizata_dsapi/version.py

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