HL Python SDK: Add SDK response logging on error (#9471)

N-o-Z · web-flow · commit 5c44e89e87ff · 2025-09-02T11:04:40.000-04:00
* HL Python SDK: Add SDK response logging on error

* Fix pytest error
diff --git a/clients/python-wrapper/lakefs/exceptions.py b/clients/python-wrapper/lakefs/exceptions.py
@@ -5,6 +5,7 @@
 import json
 from contextlib import contextmanager
 from typing import Optional, Callable
+import logging
 
 import lakefs_sdk.exceptions
 from urllib3 import HTTPResponse
@@ -31,6 +32,8 @@ def __init__(self, status=None, reason=None, body=None):
             try:  # Try to get message from body
                 self.body = json.loads(body)
             except json.JSONDecodeError:
+                logging.debug("failed to decode response body: status (%s), reason (%s), body (%s)",
+                              status, reason, body)
                 self.body = {}
         else:
             self.body = {}
diff --git a/clients/python-wrapper/tests/utests/test_exceptions.py b/clients/python-wrapper/tests/utests/test_exceptions.py
@@ -0,0 +1,55 @@
+import http
+import json
+
+from lakefs_sdk import ApiException
+from lakefs.exceptions import api_exception_handler, ServerException
+
+
+class TestException(ApiException):
+    __test__ = False  # Not a test case
+    def __init__(self, status: int, reason: str, body: str):
+        super().__init__()
+        self.status = status
+        self.reason = reason
+        self.body = body
+
+def test_http_error_list():
+    expected_reason = "my reason"
+    body = json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}])
+    resp =  TestException(http.HTTPStatus.FORBIDDEN.value, expected_reason, body)
+    
+    try:
+        with api_exception_handler():
+            raise resp
+    except ServerException as e:
+        assert expected_reason == e.reason
+        assert e.body is not None
+        actual_body = json.dumps(e.body)
+        assert actual_body == body
+        return
+    
+    # make sure exception is not swallowed
+    assert False, "Exception not caught"
+
+def test_http_error_xml():
+    expected_reason = ""
+    body = '''<note>
+<to>Tove</to>
+<from>Jani</from>
+<heading>Reminder</heading>
+<body>Don't forget me this weekend!</body>
+</note>
+    '''
+    resp =  TestException(http.HTTPStatus.FORBIDDEN.value, expected_reason, body)
+
+    try:
+        with api_exception_handler():
+            raise resp
+    except ServerException as e:
+        assert expected_reason == e.reason
+        assert e.body is not None
+        assert not e.body # Body should be empty
+        return
+    
+    # make sure exception is not swallowed
+    assert False, "Exception not caught"
