quantpad-data 0.7.0__tar.gz → 0.7.1__tar.gz

{quantpad_data-0.7.0 → quantpad_data-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quantpad-data
-Version: 0.7.0
+Version: 0.7.1
 Summary: Official Python client for the QuantPad market-data API
 Project-URL: Documentation, https://api.quantpad.ai/external/docs
 Author: QuantPad

{quantpad_data-0.7.0 → quantpad_data-0.7.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "quantpad-data"
-version = "0.7.0"
+version = "0.7.1"
 description = "Official Python client for the QuantPad market-data API"
 readme = "README.md"
 requires-python = ">=3.10"

{quantpad_data-0.7.0 → quantpad_data-0.7.1}/quantpad_data/client.py

@@ -84,7 +84,7 @@ V2_NOT_AVAILABLE = (
     "QuantPad support about /v2 access."
 )
 
-VERSION = "0.7.0"
+VERSION = "0.7.1"
 USER_AGENT = f"quantpad-data-python/{VERSION}"
 TICK_SCHEMAS = (
     "trades", "mbp-1", "mbp-10", "cmbp-1", "tcbbo", "cbbo-1s",
@@ -143,6 +143,25 @@ BARS_TIMEOUT = (30, 1800)
 V2_DATA_TIMEOUT = (10, 1800)
 
 
+def _prose_with_hint(error: dict) -> str:
+    """The sentence to raise from a structured refusal.
+
+    ``message`` first; a ``hint`` follows it as a second sentence when the
+    service sent one.  Kept out of the message on the wire so a caller
+    reading the body can still tell the refusal from the advice, and put
+    back here because the exception text is the only thing most callers
+    ever see.  A body with a hint and no message is stringified whole, as
+    it always was.
+    """
+    message = error.get("message")
+    if not message:
+        return str(error)
+    hint = error.get("hint")
+    if isinstance(hint, str) and hint.strip():
+        return f"{message} {hint.strip()}"
+    return str(message)
+
+
 class Client:
     def __init__(
         self,
@@ -189,6 +208,14 @@ class Client:
         user where the service had written a sentence.  So the prose is
         unwrapped from ``message`` when there is one, and the object is
         kept beside it for the callers that need to branch on it.
+
+        A ``hint`` rides with the prose.  The /v2 404 for a symbol nothing
+        resolves carries what to send instead -- ``NQ.FUT`` with
+        ``stype_in='parent'`` for a bare ``NQ`` -- as its own field so a
+        caller branching on the body can tell it from the message; but the
+        exception a notebook prints is the message, and advice a client
+        drops on the floor is advice nobody gets (the shape
+        ``options.chain`` had with ``truncated``).
         """
         try:
             body = response.json()
@@ -198,7 +225,7 @@ class Client:
             return str(body), None
         error = body.get("error") or body.get("detail") or body
         if isinstance(error, dict):
-            return str(error.get("message") or error), error
+            return _prose_with_hint(error), error
         return str(error), None
 
     @classmethod

quantpad_data-0.7.1/tests/test_refusal_hint.py

@@ -0,0 +1,71 @@
+"""A structured refusal's ``hint`` reaches the exception text.
+
+The /v2 404 for a symbol nothing resolves carries what to send instead as
+its own ``hint`` field -- ``NQ.FUT with stype_in='parent'`` for a bare
+``NQ`` -- so a caller reading the body can tell the refusal from the
+advice.  The client used to raise ``message`` alone, which is the shape
+``options.chain`` had with ``truncated``: the server said the useful thing
+and the SDK dropped it before anyone could read it.
+"""
+
+from __future__ import annotations
+
+import json
+
+import pytest
+import requests
+
+from quantpad_data.client import Client
+from quantpad_data.errors import NotFoundError
+
+MESSAGE = "None of the requested symbols resolve to an instrument on GLBX.MDP3 over this window."
+HINT = "For NQ try NQ.FUT with stype_in='parent' (every contract in the chain)."
+
+
+def _response(body: dict, status: int = 404) -> requests.Response:
+    response = requests.Response()
+    response.status_code = status
+    response.url = "https://example.test/v2/timeseries/get_range"
+    response._content = json.dumps({"error": body}).encode()
+    response.headers["Content-Type"] = "application/json"
+    return response
+
+
+def _client() -> Client:
+    return Client(api_key="k", base_url="https://example.test")
+
+
+class TestTheHintIsRaisedWithTheMessage:
+    def test_the_exception_text_carries_both_sentences_in_order(self):
+        with pytest.raises(NotFoundError) as caught:
+            _client()._raise_for_status(
+                _response({"message": MESSAGE, "hint": HINT, "not_found": ["NQ"]}),
+                "/v2/timeseries/get_range",
+            )
+        text = str(caught.value)
+        assert text == f"{MESSAGE} {HINT}"
+
+    def test_the_structured_body_is_still_available_beside_it(self):
+        """Branching callers read the fields; the hint joining the prose
+        must not take the fields away."""
+        message, detail = Client._envelope(
+            _response({"message": MESSAGE, "hint": HINT, "not_found": ["NQ"]})
+        )
+        assert detail["hint"] == HINT
+        assert detail["not_found"] == ["NQ"]
+        assert message.startswith(MESSAGE)
+
+    def test_a_refusal_without_a_hint_reads_exactly_as_before(self):
+        message, _ = Client._envelope(_response({"message": MESSAGE}))
+        assert message == MESSAGE
+
+    @pytest.mark.parametrize("hint", ["", "   ", None, 7, ["not", "prose"]])
+    def test_a_blank_or_non_prose_hint_adds_nothing(self, hint):
+        message, _ = Client._envelope(_response({"message": MESSAGE, "hint": hint}))
+        assert message == MESSAGE
+
+    def test_a_hint_with_no_message_does_not_become_the_message(self):
+        """A body with advice but no refusal is malformed; stringify it
+        whole as the client always has rather than promote the hint."""
+        message, _ = Client._envelope(_response({"hint": HINT}))
+        assert message == str({"hint": HINT})