diffio 0.1.49__tar.gz → 0.1.51__tar.gz

{diffio-0.1.49/src/diffio.egg-info → diffio-0.1.51}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diffio
-Version: 0.1.49
+Version: 0.1.51
 Summary: Python SDK for the Diffio API.
 Author: Diffio
 License: MIT
@@ -58,6 +58,14 @@ export DIFFIO_API_BASE_URL="https://api.diffio.ai/v1"
 Use request options to override headers, timeouts, retries, or the API key per request.
 You can also pass `timeoutInSeconds` as an alias for `timeout`.
 
+Generation creation is retried only when you supply a non-empty `idempotencyKey`,
+even when `maxRetries` is configured globally or per request. Without a key, a
+timeout or lost response can hide an accepted generation, so the SDK returns the
+error after the first attempt. With a key, retries send the same key and payload.
+Reuse that key when manually retrying the same operation; use a new key for a new
+generation. The audio isolation and restore helpers do not supply a key and do
+not automatically retry their generation-creation step.
+
 ```py
 from diffio import DiffioClient, RequestOptions
 
@@ -90,6 +98,7 @@ generation = client.create_generation(
     model="diffio-3.5",
     sampling={"steps": 12, "guidance": 1.5},
     idempotencyKey="restore-job-2026-001",
+    requestOptions={"maxRetries": 2},
 )
 
 print(generation.generationId)
@@ -141,6 +150,11 @@ print(info["apiProjectId"], info["generationId"])
 
 ## Generation progress
 
+`wait_for_generation` and `generations.wait_for_complete` wait for the overall
+`status` to become `complete`. Individual stages can reach 100% while video
+restoration or final settlement is still pending; stage progress alone does not
+indicate overall completion.
+
 ```py
 from diffio import DiffioClient
 

{diffio-0.1.49 → diffio-0.1.51}/README.md

@@ -30,6 +30,14 @@ export DIFFIO_API_BASE_URL="https://api.diffio.ai/v1"
 Use request options to override headers, timeouts, retries, or the API key per request.
 You can also pass `timeoutInSeconds` as an alias for `timeout`.
 
+Generation creation is retried only when you supply a non-empty `idempotencyKey`,
+even when `maxRetries` is configured globally or per request. Without a key, a
+timeout or lost response can hide an accepted generation, so the SDK returns the
+error after the first attempt. With a key, retries send the same key and payload.
+Reuse that key when manually retrying the same operation; use a new key for a new
+generation. The audio isolation and restore helpers do not supply a key and do
+not automatically retry their generation-creation step.
+
 ```py
 from diffio import DiffioClient, RequestOptions
 
@@ -62,6 +70,7 @@ generation = client.create_generation(
     model="diffio-3.5",
     sampling={"steps": 12, "guidance": 1.5},
     idempotencyKey="restore-job-2026-001",
+    requestOptions={"maxRetries": 2},
 )
 
 print(generation.generationId)
@@ -113,6 +122,11 @@ print(info["apiProjectId"], info["generationId"])
 
 ## Generation progress
 
+`wait_for_generation` and `generations.wait_for_complete` wait for the overall
+`status` to become `complete`. Individual stages can reach 100% while video
+restoration or final settlement is still pending; stage progress alone does not
+indicate overall completion.
+
 ```py
 from diffio import DiffioClient
 

{diffio-0.1.49 → diffio-0.1.51}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "diffio"
-version = "0.1.49"
+version = "0.1.51"
 description = "Python SDK for the Diffio API."
 readme = "README.md"
 requires-python = ">=3.8"

{diffio-0.1.49 → diffio-0.1.51}/src/diffio/__init__.py

@@ -70,4 +70,4 @@ __all__ = [
     "WebhooksClient",
 ]
 
-__version__ = "0.1.49"
+__version__ = "0.1.51"

{diffio-0.1.49 → diffio-0.1.51}/src/diffio/client.py

@@ -311,6 +311,7 @@ class DiffioClient:
         idempotencyKey=None,
         requestOptions=None,
     ):
+        """Create a generation; automatic retries require a supplied idempotency key."""
         endpoint = MODEL_ENDPOINTS.get(model)
         if not endpoint:
             raise ValueError(f"Unsupported model: {model}")
@@ -323,7 +324,13 @@ class DiffioClient:
         if idempotencyKey is not None:
             payload["idempotencyKey"] = idempotencyKey
 
-        response = self._request("POST", endpoint, json_payload=payload, requestOptions=requestOptions)
+        response = self._request(
+            "POST",
+            endpoint,
+            json_payload=payload,
+            requestOptions=requestOptions,
+            allow_retries=isinstance(idempotencyKey, str) and bool(idempotencyKey.strip()),
+        )
         return CreateGenerationResponse.from_dict(response)
 
     def list_projects(self, *, requestOptions=None):
@@ -734,7 +741,7 @@ class DiffioClient:
             raiseOnError=raiseOnError,
         )
 
-    def _request(self, method, path, *, json_payload, requestOptions=None):
+    def _request(self, method, path, *, json_payload, requestOptions=None, allow_retries=True):
         request_path = path.lstrip("/")
         if self._api_prefix:
             request_path = f"{self._api_prefix}/{request_path}"
@@ -743,6 +750,9 @@ class DiffioClient:
         headers = _merge_headers({"Authorization": f"Bearer {api_key}"}, merged_options.headers)
         timeout = merged_options.timeout
         max_retries = merged_options.maxRetries if merged_options.maxRetries is not None else 0
+        # A lost response can hide an accepted generation; only its stable key makes replay safe.
+        if not allow_retries:
+            max_retries = 0
         retry_backoff = (
             merged_options.retryBackoff if merged_options.retryBackoff is not None else DEFAULT_RETRY_BACKOFF
         )

{diffio-0.1.49 → diffio-0.1.51/src/diffio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diffio
-Version: 0.1.49
+Version: 0.1.51
 Summary: Python SDK for the Diffio API.
 Author: Diffio
 License: MIT
@@ -58,6 +58,14 @@ export DIFFIO_API_BASE_URL="https://api.diffio.ai/v1"
 Use request options to override headers, timeouts, retries, or the API key per request.
 You can also pass `timeoutInSeconds` as an alias for `timeout`.
 
+Generation creation is retried only when you supply a non-empty `idempotencyKey`,
+even when `maxRetries` is configured globally or per request. Without a key, a
+timeout or lost response can hide an accepted generation, so the SDK returns the
+error after the first attempt. With a key, retries send the same key and payload.
+Reuse that key when manually retrying the same operation; use a new key for a new
+generation. The audio isolation and restore helpers do not supply a key and do
+not automatically retry their generation-creation step.
+
 ```py
 from diffio import DiffioClient, RequestOptions
 
@@ -90,6 +98,7 @@ generation = client.create_generation(
     model="diffio-3.5",
     sampling={"steps": 12, "guidance": 1.5},
     idempotencyKey="restore-job-2026-001",
+    requestOptions={"maxRetries": 2},
 )
 
 print(generation.generationId)
@@ -141,6 +150,11 @@ print(info["apiProjectId"], info["generationId"])
 
 ## Generation progress
 
+`wait_for_generation` and `generations.wait_for_complete` wait for the overall
+`status` to become `complete`. Individual stages can reach 100% while video
+restoration or final settlement is still pending; stage progress alone does not
+indicate overall completion.
+
 ```py
 from diffio import DiffioClient
 

{diffio-0.1.49 → diffio-0.1.51}/tests/test_client.py

@@ -7,6 +7,7 @@ import pytest
 
 from diffio import DiffioClient, ModelKey
 from diffio.client import MODEL_ENDPOINTS
+from diffio.errors import DiffioApiError
 
 
 def test_create_project_payload_and_headers(tmp_path: Path):
@@ -997,3 +998,124 @@ def test_webhooks_send_test_event_rejects_invalid_type():
             eventType="generation.unknown",
             mode="test",
         )
+
+
+@pytest.mark.parametrize("failure_kind", ["status", "transport"])
+@pytest.mark.parametrize("model", list(MODEL_ENDPOINTS))
+@pytest.mark.parametrize("options_scope", ["client", "request"])
+@pytest.mark.parametrize("idempotency_key", [None, "", "   ", 123])
+def test_create_generation_does_not_retry_without_usable_idempotency_key(
+    failure_kind, model, options_scope, idempotency_key
+):
+    calls = []
+
+    def handler(request):
+        calls.append(request)
+        if failure_kind == "transport":
+            raise httpx.ReadTimeout("Response lost after acceptance", request=request)
+        return httpx.Response(503, json={"error": "unavailable"})
+
+    retry_options = {"maxRetries": 2, "retryBackoff": 0}
+    with httpx.Client(base_url="https://api.test", transport=httpx.MockTransport(handler)) as http_client:
+        client = DiffioClient(
+            apiKey="diffio_live_test",
+            baseUrl="https://api.test",
+            httpClient=http_client,
+            requestOptions=retry_options if options_scope == "client" else None,
+        )
+        expected_error = httpx.ReadTimeout if failure_kind == "transport" else DiffioApiError
+        with pytest.raises(expected_error):
+            client.generations.create(
+                apiProjectId="proj",
+                model=model,
+                idempotencyKey=idempotency_key,
+                requestOptions=retry_options if options_scope == "request" else None,
+            )
+
+    assert len(calls) == 1
+
+
+@pytest.mark.parametrize("failure_kind", ["status", "transport"])
+@pytest.mark.parametrize("model", list(MODEL_ENDPOINTS))
+@pytest.mark.parametrize("options_scope", ["client", "request"])
+def test_create_generation_retries_same_idempotent_request(failure_kind, model, options_scope):
+    calls = []
+
+    def handler(request):
+        calls.append(request.content)
+        if len(calls) == 1:
+            if failure_kind == "transport":
+                raise httpx.ReadTimeout("Response lost after acceptance", request=request)
+            return httpx.Response(503, json={"error": "unavailable"})
+        return httpx.Response(
+            200,
+            json={
+                "generationId": "gen_original",
+                "apiProjectId": "proj",
+                "modelKey": model,
+                "status": "queued",
+                "idempotentReplay": True,
+            },
+        )
+
+    retry_options = {"maxRetries": 2, "retryBackoff": 0}
+    with httpx.Client(base_url="https://api.test", transport=httpx.MockTransport(handler)) as http_client:
+        client = DiffioClient(
+            apiKey="diffio_live_test",
+            baseUrl="https://api.test",
+            httpClient=http_client,
+            requestOptions=retry_options if options_scope == "client" else None,
+        )
+        generation = client.generations.create(
+            apiProjectId="proj",
+            model=model,
+            idempotencyKey="customer-operation-1",
+            sampling={"steps": 12},
+            params={"seed": 42},
+            requestOptions=retry_options if options_scope == "request" else None,
+        )
+
+    assert len(calls) == 2
+    assert calls[0] == calls[1]
+    assert json.loads(calls[1])["idempotencyKey"] == "customer-operation-1"
+    assert generation.generationId == "gen_original"
+    assert generation.idempotentReplay is True
+
+
+def test_wait_for_generation_waits_for_overall_completion_after_stage_completion():
+    responses = [
+        ("pending", "pending", 0),
+        ("processing", "running", 20),
+        ("processing", "complete", 100),
+        ("complete", "complete", 100),
+    ]
+    progress_calls = []
+
+    def handler(request):
+        status, video_status, video_progress = responses.pop(0)
+        return httpx.Response(
+            200,
+            json={
+                "generationId": "gen_video",
+                "apiProjectId": "proj",
+                "status": status,
+                "hasVideo": True,
+                "preProcessing": {"status": "complete", "progress": 100},
+                "inference": {"status": "complete", "progress": 100},
+                "restoredVideo": {"status": video_status, "progress": video_progress},
+            },
+        )
+
+    with httpx.Client(base_url="https://api.test", transport=httpx.MockTransport(handler)) as http_client:
+        client = DiffioClient(apiKey="diffio_live_test", httpClient=http_client)
+        progress = client.generations.wait_for_complete(
+            generationId="gen_video",
+            apiProjectId="proj",
+            pollInterval=0,
+            timeout=5,
+            onProgress=lambda progress: progress_calls.append(progress.status),
+        )
+
+    assert progress.status == "complete"
+    assert progress_calls == ["pending", "processing", "processing", "complete"]
+    assert not responses