wizata-dsapi 2.1.0.dev17__tar.gz → 2.1.0.dev18__tar.gz

{wizata_dsapi-2.1.0.dev17 → wizata_dsapi-2.1.0.dev18}/PKG-INFO

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

wizata_dsapi-2.1.0.dev18/wizata_dsapi/version.py

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

{wizata_dsapi-2.1.0.dev17 → wizata_dsapi-2.1.0.dev18}/wizata_dsapi/wizata_dsapi_client.py

@@ -1124,7 +1124,12 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
             else:
                 raise ValueError('No plot has been fetch.')
         elif figure is not None:
-            return plotly.io.from_json(plot.figure)
+            # Read `figure`, not `plot.figure` — with only a figure passed there is no
+            # plot to read it from. A live plot's envelope carries the figure as the
+            # JSON string it was stored as, an experiment plot as a dict once decoded,
+            # and both must render.
+            return plotly.io.from_json(figure if isinstance(figure, str)
+                                       else json.dumps(figure))
         elif plot_id is not None:
             plot = self.get(Plot(plot_id=plot_id))
             if plot.figure is not None:
@@ -1156,6 +1161,90 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
         else:
             raise TypeError("execution must be an ExecutionLog")
 
+    @staticmethod
+    def _pipeline_ref(pipeline) -> str:
+        """
+        Path segment addressing a pipeline, from a key, a UUID or a Pipeline.
+
+        The live-plot route accepts both the key and the UUID, so a caller passes
+        whichever it already has. A Pipeline is asked for its key first: a deployed
+        plot is addressed by pipeline KEY everywhere else it appears (the blob path,
+        ExecutionLog.plots), so the key is the reference that matches what comes back.
+        """
+        if isinstance(pipeline, Pipeline):
+            reference = pipeline.key if pipeline.key is not None else pipeline.pipeline_id
+        else:
+            reference = pipeline
+        if reference is None:
+            raise ValueError("a pipeline key, UUID or Pipeline is required")
+        return urllib.parse.quote(str(reference), safe="")
+
+    def deployed_plots(self, pipeline, twin: str = None) -> list:
+        """
+        list a deployed pipeline's LIVE plots - what its deployments are currently
+        drawing, one per (twin, plot step).
+
+        A live plot is overwritten on every triggered run, so there is exactly one
+        current figure per plot and no history to page through. Fetch one with
+        :meth:`deployed_plot`. Experiment plots are elsewhere and unchanged - one blob
+        per execution, see :meth:`plots`.
+
+        :param pipeline: pipeline key, UUID or Pipeline - both references are accepted.
+        :param twin: hardware id, to list only that twin's plots.
+        :return: list of dict {pipelineKey, twin, script, dataframe, key, deploymentId,
+            produced, lastModified, size}. 'produced' is False when the definition has
+            this plot step but no run has written it yet.
+        """
+        response = self._process_request(
+            method="GET",
+            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/plots/",
+            params={"twin": twin} if twin is not None else None
+        )
+        return response.json().get("results", [])
+
+    def deployed_plot(self,
+                      pipeline,
+                      script: str,
+                      dataframe: str,
+                      twin: str = None,
+                      shape: str = "figure") -> dict:
+        """
+        fetch one of a deployed pipeline's LIVE plots.
+
+        The plot step is identified by BOTH its script and its input dataframe - that
+        pair is the plot's identity, as :meth:`deployed_plots` lists it.
+
+        Returns the envelope, not the bare figure, because the provenance is the point:
+        a live plot is overwritten on every run and 'generatedAt' / 'executionId' say
+        which one wrote it. Render it with ``client.plot(figure=envelope["figure"])``.
+
+        :param pipeline: pipeline key, UUID or Pipeline - both references are accepted.
+        :param script: the plot step's script.
+        :param dataframe: the plot step's input dataframe.
+        :param twin: hardware id - required on a templated pipeline.
+        :param shape: 'figure' (default) for the stored Plotly figure, or 'data' for its
+            traces projected to 'series'.
+        :return: dict with {pipelineKey, twin, script, dataframe, name, executionId,
+            release, sha, imageId, generatedAt} plus 'figure', or 'series' and
+            'notProjected' when shape is 'data'.
+        """
+        if script is None or dataframe is None:
+            raise ValueError(
+                "script and dataframe are both parts of a plot's identity - pass both"
+            )
+        if shape not in ("figure", "data"):
+            raise ValueError(f"shape must be 'figure' or 'data', got {shape!r}")
+
+        params = {"script": script, "dataframe": dataframe, "format": shape}
+        if twin is not None:
+            params["twin"] = twin
+        response = self._process_request(
+            method="GET",
+            route=f"{Pipeline.route()}/{self._pipeline_ref(pipeline)}/plots/",
+            params=params
+        )
+        return response.json()
+
     def upload_model(self,
                      model_info: ModelInfo,
                      bytes_content = None):

{wizata_dsapi-2.1.0.dev17 → wizata_dsapi-2.1.0.dev18}/wizata_dsapi.egg-info/PKG-INFO

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

wizata_dsapi-2.1.0.dev17/wizata_dsapi/version.py

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