simudyne-pulse 0.7.0.dev17__tar.gz → 0.7.0.dev18__tar.gz

{simudyne_pulse-0.7.0.dev17/src/simudyne_pulse.egg-info → simudyne_pulse-0.7.0.dev18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev17
+Version: 0.7.0.dev18
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT

{simudyne_pulse-0.7.0.dev17 → simudyne_pulse-0.7.0.dev18}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simudyne-pulse"
-version = "0.7.0-dev.17"
+version = "0.7.0-dev.18"
 description = "Python SDK for the Simudyne Pulse synthetic market data API"
 readme = "README.md"
 license = "MIT"

{simudyne_pulse-0.7.0.dev17 → simudyne_pulse-0.7.0.dev18}/src/simudyne/resources/validation.py

@@ -561,19 +561,57 @@ class ValidationResource:
             job["plot_paths"] = _save_plots(job, plot_dir)
         return job
 
-    def list_jobs(self, limit: int = 50) -> dict:
+    def get_job_status(self, job_id: str) -> dict:
+        """Where a validation job has got to, without its result.
+
+        The full result is large and tier-filtered, so a poll loop should ask
+        this instead of :meth:`get_job` and fetch the result once, when
+        ``is_complete`` turns true.
+
+        Parameters
+        ----------
+        job_id : str
+            A validation job handle from :meth:`run`.
+
+        Returns
+        -------
+        dict
+            ``{job_id, status, message, is_complete, created_at, updated_at}``.
+            ``status`` is one of pending / running / completed / failed, and
+            only the last two are terminal — which is what ``is_complete``
+            says, so a caller need not keep that list itself.
+
+        Raises
+        ------
+        PulseAPIError
+            If the job does not exist or belongs to another key — status 404.
+
+        Examples
+        --------
+        >>> import time
+        >>> while not client.validation.get_job_status(job_id)["is_complete"]:
+        ...     time.sleep(30)
+        >>> result = client.validation.get_job(job_id, plot_dir="figures/")
+        """
+        return self._client._request("GET", f"{JOBS_PATH}/{job_id}/status")
+
+    def list_jobs(self, limit: int = 50, offset: int = 0) -> dict:
         """List your validation jobs, newest first.
 
         Parameters
         ----------
         limit : int, default 50
-            Maximum number of jobs to return.
+            Maximum number of jobs to return. Capped at 200 by the API.
+        offset : int, default 0
+            Jobs to skip before this page, for paging through more than
+            ``limit`` of them.
 
         Returns
         -------
         dict
-            Contains ``jobs``, a list of job summaries newest first, and
-            ``total``, the count before ``limit`` was applied.
+            ``{total, limit, offset, jobs}``. ``jobs`` is the page, newest
+            first; ``total`` is your full job count rather than the page size,
+            so a caller can tell whether more pages exist.
 
         Raises
         ------
@@ -591,5 +629,14 @@ class ValidationResource:
         >>> done = [j for j in listing["jobs"] if j["status"] == "completed"]
         >>> newest = done[0]
         >>> result = client.validation.get_job(newest["job_id"])
+
+        Page through the rest:
+
+        >>> seen = len(listing["jobs"])
+        >>> while seen < listing["total"]:
+        ...     page = client.validation.list_jobs(limit=10, offset=seen)
+        ...     seen += len(page["jobs"])
         """
-        return self._client._request("GET", JOBS_PATH, params={"limit": limit})
+        return self._client._request(
+            "GET", JOBS_PATH, params={"limit": limit, "offset": offset}
+        )

{simudyne_pulse-0.7.0.dev17 → simudyne_pulse-0.7.0.dev18/src/simudyne_pulse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev17
+Version: 0.7.0.dev18
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT

{simudyne_pulse-0.7.0.dev17 → simudyne_pulse-0.7.0.dev18}/tests/test_validation.py

@@ -202,7 +202,7 @@ class TestOneEntryPoint:
         res.get_job("v1")
         res.list_jobs(limit=5)
         assert client.calls[0][:2] == ("GET", "/validation/jobs/v1")
-        assert client.calls[1][2]["params"] == {"limit": 5}
+        assert client.calls[1][2]["params"] == {"limit": 5, "offset": 0}
 
 
 class TestSimulatedFrameShapes:
@@ -406,3 +406,24 @@ class TestBothSourcesAtOnce:
                 sim_ids=["s"] * 13,
                 **IDENTITY,
             )
+
+
+class TestPagingAndStatus:
+    """Matching pulse-api-pod 1.69.0: a paged list and a lightweight poll."""
+
+    def test_list_jobs_pages(self):
+        client = FakeClient([{"total": 60, "limit": 10, "offset": 10, "jobs": []}])
+        ValidationResource(client).list_jobs(limit=10, offset=10)
+        assert client.calls[0][2]["params"] == {"limit": 10, "offset": 10}
+
+    def test_list_jobs_starts_at_the_beginning(self):
+        client = FakeClient([{"total": 0, "limit": 50, "offset": 0, "jobs": []}])
+        ValidationResource(client).list_jobs()
+        assert client.calls[0][2]["params"] == {"limit": 50, "offset": 0}
+
+    def test_status_asks_the_cheap_endpoint(self):
+        """Not get_job: the full result is large and tier-filtered."""
+        client = FakeClient([{"job_id": "v1", "status": "running", "is_complete": False}])
+        out = ValidationResource(client).get_job_status("v1")
+        assert client.calls[0][1] == "/validation/jobs/v1/status"
+        assert out["is_complete"] is False