getanyapi 0.46.2__tar.gz → 0.47.0__tar.gz

{getanyapi-0.46.2 → getanyapi-0.47.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: getanyapi
-Version: 0.46.2
+Version: 0.47.0
 Summary: Official typed Python SDK for AnyAPI: any API, one wallet, USD, no subscriptions.
 Project-URL: Homepage, https://getanyapi.com
 Project-URL: Documentation, https://getanyapi.com/docs

{getanyapi-0.46.2 → getanyapi-0.47.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "getanyapi"
-version = "0.46.2"
+version = "0.47.0"
 description = "Official typed Python SDK for AnyAPI: any API, one wallet, USD, no subscriptions."
 readme = "README.md"
 requires-python = ">=3.10"

{getanyapi-0.46.2 → getanyapi-0.47.0}/src/getanyapi/__init__.py

@@ -44,6 +44,7 @@ from .types import (
     HighlightField,
     LaneHealth,
     LinearPricingOffer,
+    NotFoundReason,
     Output,
     OutputFound,
     OutputNotFound,
@@ -54,7 +55,7 @@ from .types import (
     unwrap,
 )
 
-__version__ = "0.46.2"
+__version__ = "0.47.0"
 
 __all__ = [
     # clients + top-level functions
@@ -68,6 +69,7 @@ __all__ = [
     "Output",
     "OutputFound",
     "OutputNotFound",
+    "NotFoundReason",
     "Balance",
     "AccountProfile",
     "CatalogEntry",

{getanyapi-0.46.2 → getanyapi-0.47.0}/src/getanyapi/types.py

@@ -68,11 +68,26 @@ class OutputFound(BaseModel, Generic[T]):
     data: T
 
 
+# Why a call answered ``found: false``. The gateway publishes this list as the
+# ``reason`` enum on every found-data output schema, so the runtime names the same
+# words; ``tests/test_not_found_reason.py`` holds the two together once the live
+# OpenAPI carries the field. ``not_found``: the source states the target does not
+# exist, or returned nothing for it. ``suspended``: the platform has suspended the
+# account.
+NotFoundReason = Literal["not_found", "suspended"]
+NOT_FOUND_REASONS: tuple[str, ...] = ("not_found", "suspended")
+
+
 class OutputNotFound(BaseModel):
-    """The ``found: false`` branch: no matching entity, ``data`` is None."""
+    """The ``found: false`` branch: no matching entity, ``data`` is None.
+
+    ``reason`` says why; it is absent only on a response from a gateway older
+    than the field.
+    """
 
     found: Literal[False]
     data: None = None
+    reason: NotFoundReason | None = None
 
 
 # Output[T] is the discriminated union on `found`.

{getanyapi-0.46.2 → getanyapi-0.47.0}/tests/test_envelope.py

@@ -51,6 +51,30 @@ def test_not_found_envelope() -> None:
     assert result.hint is None
 
 
+def test_not_found_envelope_carries_its_reason() -> None:
+    result = RunResult[dict[str, Any]].model_validate(
+        {
+            "output": {"found": False, "data": None, "reason": "suspended"},
+            "provider": "AnyAPI",
+            "costUsd": 0.0,
+            "items": 0,
+            "replayed": False,
+        }
+    )
+    assert isinstance(result.output, OutputNotFound)
+    assert result.output.reason == "suspended"
+    with pytest.raises(ValidationError):
+        RunResult[dict[str, Any]].model_validate(
+            {
+                "output": {"found": False, "data": None, "reason": "UserUnavailable"},
+                "provider": "AnyAPI",
+                "costUsd": 0.0,
+                "items": 0,
+                "replayed": False,
+            }
+        )
+
+
 def test_unwrap_returns_data_when_found() -> None:
     result = RunResult[dict[str, Any]].model_validate(
         {

getanyapi-0.47.0/tests/test_not_found_reason.py

@@ -0,0 +1,44 @@
+"""The runtime's reason words are a copy of the enum the gateway publishes.
+
+Every ``/v1/run/*`` operation in the committed OpenAPI snapshot that declares a
+``reason`` enum on its output must declare exactly ``NOT_FOUND_REASONS``, in
+order. Until the snapshot carries the field (it is refreshed from the live
+gateway after deploy) there is nothing to compare.
+"""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any
+
+from getanyapi.types import NOT_FOUND_REASONS
+
+_OPENAPI = Path(__file__).resolve().parents[3] / "openapi.json"
+
+
+def _published_reason_enums() -> list[list[str]]:
+    document: dict[str, Any] = json.loads(_OPENAPI.read_text())
+    enums: list[list[str]] = []
+    for path, operations in document["paths"].items():
+        if not path.startswith("/v1/run/"):
+            continue
+        schema = (
+            operations.get("post", {})
+            .get("responses", {})
+            .get("200", {})
+            .get("content", {})
+            .get("application/json", {})
+            .get("schema", {})
+        )
+        output = schema.get("properties", {}).get("output", {})
+        for branch in output.get("anyOf", [output]):
+            reason = branch.get("properties", {}).get("reason", {})
+            if isinstance(reason.get("enum"), list):
+                enums.append(list(reason["enum"]))
+    return enums
+
+
+def test_reason_words_match_the_published_enum() -> None:
+    for published in _published_reason_enums():
+        assert published == list(NOT_FOUND_REASONS)