abysshub 0.1.1.dev1__tar.gz → 0.1.1.dev2__tar.gz

{abysshub-0.1.1.dev1 → abysshub-0.1.1.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: abysshub
-Version: 0.1.1.dev1
+Version: 0.1.1.dev2
 Summary: The official Python library for the Abyss API.
 Project-URL: Homepage, https://abysshub.com
 Project-URL: Source, https://github.com/Abysshub/abysshub-sdk
@@ -133,6 +133,8 @@ A refusal, a failed run, a timeout and a lost connection all raise one class, `A
 | `param` | the Field, body key, query key or header at fault, else `None` |
 | `doc_url` | the code on the API access page, else `None` |
 | `request_id` | quote it to support, else `None` |
+| `shortfall` | with `insufficient_funds`: how much Byssium the wallet is short, else `None` |
+| `price` | with `price_above_max`: what the run costs now, else `None` |
 | `run` | the run, for a failed run or a timeout, else `None`; an `AsyncRun` from `AsyncAbyss` |
 
 - **Refusals:** `invalid_api_key` (401), `not_found` (404), `invalid_request`, `invalid_input`, `held_input_*`, `input_unreachable` and `idempotency_key_reused` (422), `insufficient_funds` (402), `spend_cap_reached` and `price_above_max` (400), `idempotency_key_in_use` (409), `rate_limited` (429), `server_error` (500).

{abysshub-0.1.1.dev1 → abysshub-0.1.1.dev2}/README.md

@@ -116,6 +116,8 @@ A refusal, a failed run, a timeout and a lost connection all raise one class, `A
 | `param` | the Field, body key, query key or header at fault, else `None` |
 | `doc_url` | the code on the API access page, else `None` |
 | `request_id` | quote it to support, else `None` |
+| `shortfall` | with `insufficient_funds`: how much Byssium the wallet is short, else `None` |
+| `price` | with `price_above_max`: what the run costs now, else `None` |
 | `run` | the run, for a failed run or a timeout, else `None`; an `AsyncRun` from `AsyncAbyss` |
 
 - **Refusals:** `invalid_api_key` (401), `not_found` (404), `invalid_request`, `invalid_input`, `held_input_*`, `input_unreachable` and `idempotency_key_reused` (422), `insufficient_funds` (402), `spend_cap_reached` and `price_above_max` (400), `idempotency_key_in_use` (409), `rate_limited` (429), `server_error` (500).

{abysshub-0.1.1.dev1 → abysshub-0.1.1.dev2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "abysshub"
-version = "0.1.1.dev1"
+version = "0.1.1.dev2"
 description = "The official Python library for the Abyss API."
 readme = "README.md"
 license = "MIT"

{abysshub-0.1.1.dev1 → abysshub-0.1.1.dev2}/src/abysshub/_client.py

@@ -535,6 +535,8 @@ def _refusal(status: int, body: Any, request_id: str | None) -> AbyssError:
         status=status,
         param=_text(error.get("param")),
         doc_url=_text(error.get("doc_url")),
+        shortfall=_number(error.get("shortfall")),
+        price=_number(error.get("price")),
         request_id=body_request_id if isinstance(body_request_id, str) else request_id,
     )
 
@@ -543,6 +545,12 @@ def _text(value: Any) -> str | None:
     return value if isinstance(value, str) else None
 
 
+def _number(value: Any) -> float | None:
+    if isinstance(value, bool) or not isinstance(value, (int, float)):
+        return None
+    return float(value)
+
+
 def _parse(text: str | None) -> Any:
     if text is None:
         return None

{abysshub-0.1.1.dev1 → abysshub-0.1.1.dev2}/src/abysshub/_error.py

@@ -19,6 +19,10 @@ class AbyssError(Exception):
     param: str | None
     doc_url: str | None
     request_id: str | None
+    shortfall: float | None
+    """With ``insufficient_funds``: how much Byssium the wallet is short; else None."""
+    price: float | None
+    """With ``price_above_max``: what the run costs now; else None."""
     run: Run | AsyncRun | None
     """The run, for a failed run or a timeout: an ``AsyncRun`` from ``AsyncAbyss``."""
 
@@ -31,6 +35,8 @@ class AbyssError(Exception):
         param: str | None = None,
         doc_url: str | None = None,
         request_id: str | None = None,
+        shortfall: float | None = None,
+        price: float | None = None,
         run: Run | AsyncRun | None = None,
     ) -> None:
         super().__init__(message)
@@ -40,6 +46,8 @@ class AbyssError(Exception):
         self.param = param
         self.doc_url = doc_url
         self.request_id = request_id
+        self.shortfall = shortfall
+        self.price = price
         self.run = run
 
     def __repr__(self) -> str:

{abysshub-0.1.1.dev1 → abysshub-0.1.1.dev2}/tests/test_client.py

@@ -67,3 +67,17 @@ def test_every_request_sends_the_user_agent() -> None:
         assert server.problems == []
     finally:
         server.close()
+
+
+def test_a_refusal_without_shortfall_or_price_carries_none_for_both() -> None:
+    recording = load_exchanges("run-refused-invalid-input.json")[0]
+    server = Replay(recording, "abyss_sk_x")
+    try:
+        with Abyss(api_key="abyss_sk_x", base_url=server.base) as abyss, pytest.raises(AbyssError) as raised:
+            abyss.run(recording["call"]["widget"], recording["call"]["input"])
+        assert raised.value.code == "invalid_input"
+        assert raised.value.shortfall is None
+        assert raised.value.price is None
+        assert server.problems == []
+    finally:
+        server.close()