FIX: Fix client display of backend error messages

Author: nmacholl

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+### 0.19.0 - TBD
+
+#### Enhancements
+- Added the `Publisher`, `Venue`, and `Dataset` enums.
+- Replace null prices with `NaN` when `pretty_px=True` in `DBNStore.to_df()`
+
+#### Bug fixes
+- Fixed issue where exception messages were displaying JSON encoded data
+
 ## 0.18.1 - 2023-08-16
 
 #### Bug fixes

databento/common/error.py

@@ -37,7 +37,23 @@ def __init__(
         self.http_status = http_status
         self.http_body = http_body
         self.json_body = json_body
-        self.message = message
+
+        try:
+            json_message = self.json_body["detail"]["message"]
+            json_case = self.json_body["detail"]["case"]
+            json_docs = self.json_body["detail"]["docs"]
+        except (TypeError, KeyError):
+            self.message = message
+        else:
+            composed_message = [
+                json_case,
+                json_message,
+            ]
+            if json_docs:
+                composed_message.append(f"documentation: {json_docs}")
+
+            self.message = "\n".join(composed_message)
+
         self.headers = headers or {}
         self.request_id = self.headers.get("request-id", None)
 

tests/test_historical_error.py

@@ -60,7 +60,7 @@ async def test_check_http_status_async(
     response = MagicMock(
         spec=aiohttp.ClientResponse,
         status=status_code,
-        json=AsyncMock(return_value=MagicMock()),
+        json=AsyncMock(return_value={}),
     )
     with pytest.raises(expected_exception) as exc:
         await check_http_error_async(response)

tests/test_historical_timeseries.py

@@ -62,7 +62,12 @@ def test_get_range_error_no_file_write(
 ) -> None:
     # Arrange
     mocked_response = MagicMock()
-    mocked_response.__enter__.return_value = MagicMock(status_code=500)
+    mocked_response.__enter__.return_value = MagicMock(
+        status_code=500,
+        json=MagicMock(
+            return_value={},
+        ),
+    )
     monkeypatch.setattr(requests, "post", MagicMock(return_value=mocked_response))
 
     output_file = tmp_path / "output.dbn"