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

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

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

{wizata_dsapi-2.1.0.dev22 → wizata_dsapi-2.1.0.dev24}/wizata_dsapi/api_config.py

@@ -20,6 +20,8 @@ from .pipeline_image import PipelineImage
 from .deployment import Deployment
 from .insight import Insight
 from .edge_device import EdgeDevice
+from .notification import RecipientList
+from .execution_log import ExecutionLog
 
 
 # Entities withdrawn from the client, and what to say instead.
@@ -85,6 +87,22 @@ _registry = {
             "cloud_dsapi": ['lists', 'get_by_id', 'update', 'delete', 'search'],
             "cloud_context": []
         },
+    "recipientlists":
+        {
+            "class": RecipientList,
+            # Keyed by 'key', not an id: /notifications/recipients/<key>/. Listing
+            # is what get_by_key uses, so both go together.
+            "cloud_dsapi": ['lists', 'get_by_key'],
+            "cloud_context": []
+        },
+    "executionlogs":
+        {
+            "class": ExecutionLog,
+            # Read one by id. Searching them is search_executions(), which asks a
+            # different endpoint entirely and has its own runner-stream argument.
+            "cloud_dsapi": ['get_by_id'],
+            "cloud_context": []
+        },
     "datastores":
         {
             "class": DataStore,

{wizata_dsapi-2.1.0.dev22 → wizata_dsapi-2.1.0.dev24}/wizata_dsapi/execution_log.py

@@ -45,6 +45,17 @@ class ExecutionLog(Dto):
     :ivar list messages: list of error and/or warning messages
     """
 
+    @classmethod
+    def route(cls):
+        """
+        Endpoint name in Web API — GET /execute/<id>/ returns one execution.
+        """
+        return "execute"
+
+    @classmethod
+    def get_type(cls):
+        return "json"
+
     @classmethod
     def from_dict(cls, data: dict) -> "ExecutionLog":
 

{wizata_dsapi-2.1.0.dev22 → wizata_dsapi-2.1.0.dev24}/wizata_dsapi/notification.py

@@ -581,6 +581,21 @@ class RecipientList:
     (follows preferences) or a free address with explicit channel.
     """
 
+    @classmethod
+    def route(cls):
+        """
+        Endpoint name in Web API.
+
+        Recipient lists live under notifications rather than at the top level, which
+        is why a route was never declared and get() answered "not supported" for an
+        entity the API has served all along.
+        """
+        return "notifications/recipients"
+
+    @classmethod
+    def get_type(cls):
+        return "json"
+
     def __init__(self, key: str = None, name: str = None):
         self.key: Optional[str] = key
         self.name: Optional[str] = name

wizata_dsapi-2.1.0.dev24/wizata_dsapi/version.py

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

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

@@ -1984,72 +1984,82 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         else:
             raise self.__raise_error(response)
 
+    #: Executions are streamed per runner, and the two do not mix: a scheduled run
+    #: is logged by the pipeline runner, an experiment by the experiment runner.
+    #: Searching the wrong one returns a confident, complete, empty answer.
+    PRODUCTION_RUNS = "pipeline_runner"
+    EXPERIMENT_RUNS = "experiment_runner"
+
     def search_executions(self,
+                          search_query=None,
+                          service: str = PRODUCTION_RUNS,
+                          pipeline: str = None,
+                          twin: str = None,
+                          status=None,
                           page: int = 1,
-                          size: int = 20,
-                          sort: str = "id",
-                          direction: str = "asc",
-                          pipeline_id: uuid.UUID = None,
-                          twin_id:  uuid.UUID = None,
-                          template_id: uuid.UUID = None,
-                          status: ExecutionStatus = None) -> PagedQueryResult:
+                          size: int = 20) -> PagedQueryResult:
+        """
+        Search executions with filters, sorting and pagination.
+
+        Executions are searched per runner. ``service`` selects which: scheduled
+        runs are logged by :attr:`PRODUCTION_RUNS`, experiments by
+        :attr:`EXPERIMENT_RUNS`. They are separate streams, so looking in the wrong
+        one answers "no executions" rather than telling you that you asked the
+        wrong question.
+
+        :param search_query: SearchQuery or dict for the full query. When given,
+            the convenience arguments below are ignored.
+        :param service: which runner's executions to search.
+        :param pipeline: pipeline KEY, not id - executions are labelled by key.
+        :param twin: twin hardware id.
+        :param status: ExecutionStatus, or its value.
+        :param page: page number, from 1.
+        :param size: results per page.
+        :return: PagedQueryResult with Execution results.
         """
-        get executions with a paged query.
-        :param page: numero of the page - default 1.
-        :param size: quantity per page - default 20 max 100.
-        :param sort: column to sort results - default id.
-        :param direction: sorting direction by default asc, accept also desc.
-        :param pipeline_id: filter on a specific pipeline.
-        :param twin_id: filter on a specific twin.
-        :param template_id: filter on a specific template.
-        :param status: filter on a specific status.
-        :return: PagedQueryResults, check total for number of potential results and results for the list of entity.
-        """
-        query = PagedQueryResult(
-            page=page,
-            size=size,
-            sort=sort,
-            direction=direction
-        )
-
-        if sort not in ["id", "pipelineId", "twinId", "templateId",
-                        "createdDate" , "createdById",
-                        "updatedDate", "updatedById",
-                        "status"]:
-            raise ValueError("invalid sort column")
-
-        parameter_str = "?page=" + str(page) + "&size=" + str(size) + "&sort=" + str(sort) + "&direction=" + str(direction)
-
-        if pipeline_id is not None:
-            parameter_str += "&pipelineId=" + sanitize_url_parameter(str(pipeline_id))
-
-        if twin_id is not None:
-            parameter_str += "&twinId=" + sanitize_url_parameter(str(twin_id))
-
-        if template_id is not None:
-            parameter_str += "&templateId=" + sanitize_url_parameter(str(template_id))
-
-        if status is not None:
-            if not isinstance(status, ExecutionStatus):
-                raise ValueError(f'status is not a valid ExecutionStatus')
-            parameter_str += "&status=" + sanitize_url_parameter(status.value)
+        if search_query is None:
+            search_query = SearchQuery()
+            search_query.page = page
+            search_query.size = size
+            search_query.service_name = service
+            filters = {}
+            if pipeline is not None:
+                filters["pipeline"] = {"eq": str(pipeline)}
+            if twin is not None:
+                filters["twin"] = {"eq": str(twin)}
+            if status is not None:
+                value = status.value if isinstance(status, ExecutionStatus) else status
+                filters["status"] = {"eq": str(value)}
+            search_query.filters = filters
+        elif isinstance(search_query, dict):
+            search_query = SearchQuery.from_dict(search_query)
 
-        response = requests.request("GET",
-                                    self.__url() + "execute/filter" + parameter_str,
-                                    headers=self.__header()
-                                    )
-        if response.status_code == 200:
-            response_obj = response.json()
-            query.total = int(response_obj["total"])
-            query.results = []
-            for obj in response_obj["results"]:
-                execution = Execution()
-                execution.from_json(obj)
-                query.results.append(execution)
-            return query
-        else:
+        response = requests.post(
+            self.__url() + "execute/search",
+            headers=self.__header(),
+            data=json.dumps(search_query.to_dict())
+        )
+        if response.status_code != 200:
             raise self.__raise_error(response)
 
+        body = response.json()
+        # PagedQueryResult refuses a null sort, so a response that omits it would
+        # raise on an answer that succeeded. The executions endpoint orders by
+        # timestamp descending unless told otherwise; say so rather than break.
+        query = PagedQueryResult(
+            page=body.get("page", page),
+            size=body.get("size", size),
+            sort=body.get("sort") or "timestamp",
+            direction=body.get("direction") or "desc"
+        )
+        query.total = int(body.get("total", 0))
+        # ExecutionLog, not Execution: this endpoint answers with log rows, whose
+        # id is a uuid and whose pipeline, twin and template are keys rather than
+        # ids. Execution.from_json reads id as an int and raises on the first row.
+        query.results = [ExecutionLog.from_dict(obj)
+                         for obj in body.get("results", [])]
+        return query
+
     def search_execution(self, search_query=None) -> PagedQueryResult:
         """
         search executions using filters, sorting and pagination via POST.

{wizata_dsapi-2.1.0.dev22 → wizata_dsapi-2.1.0.dev24}/wizata_dsapi.egg-info/PKG-INFO

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

wizata_dsapi-2.1.0.dev22/wizata_dsapi/version.py

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