fix: handle Py311 Validation errors (#219)

* fix: handle NoneType response

* fix: add default error message for non JSONDecodable objects

* fix: rename message -> details

* fix: handle exception instead of checking for no content

---------

Co-authored-by: [email protected] <[email protected]>

Author: J0

postgrest/_async/request_builder.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from json import JSONDecodeError
 from typing import Optional, Union
 
 from httpx import Headers, QueryParams
@@ -17,7 +18,7 @@
     pre_update,
     pre_upsert,
 )
-from ..exceptions import APIError
+from ..exceptions import APIError, generate_default_error_message
 from ..types import ReturnMethod
 from ..utils import AsyncClient
 
@@ -67,6 +68,8 @@ async def execute(self) -> APIResponse:
                 raise APIError(r.json())
         except ValidationError as e:
             raise APIError(r.json()) from e
+        except JSONDecodeError as e:
+            raise APIError(generate_default_error_message(r))
 
 
 class AsyncSingleRequestBuilder:
@@ -114,6 +117,8 @@ async def execute(self) -> SingleAPIResponse:
                 raise APIError(r.json())
         except ValidationError as e:
             raise APIError(r.json()) from e
+        except JSONDecodeError as e:
+            raise APIError(generate_default_error_message(r))
 
 
 class AsyncMaybeSingleRequestBuilder(AsyncSingleRequestBuilder):

postgrest/_sync/client.py

@@ -63,17 +63,17 @@ def from_(self, table: str) -> SyncRequestBuilder:
         Args:
             table: The name of the table
         Returns:
-            :class:`SyncRequestBuilder`
+            :class:`AsyncRequestBuilder`
         """
         return SyncRequestBuilder(self.session, f"/{table}")
 
     def table(self, table: str) -> SyncRequestBuilder:
-        """Alias to self.from_()."""
+        """Alias to :meth:`from_`."""
         return self.from_(table)
 
     @deprecated("0.2.0", "1.0.0", __version__, "Use self.from_() instead")
     def from_table(self, table: str) -> SyncRequestBuilder:
-        """Alias to self.from_()."""
+        """Alias to :meth:`from_`."""
         return self.from_(table)
 
     def rpc(self, func: str, params: dict) -> SyncFilterRequestBuilder:
@@ -83,14 +83,14 @@ def rpc(self, func: str, params: dict) -> SyncFilterRequestBuilder:
             func: The name of the remote procedure to run.
             params: The parameters to be passed to the remote procedure.
         Returns:
-            :class:`SyncFilterRequestBuilder`
+            :class:`AsyncFilterRequestBuilder`
         Example:
-            ::
+            .. code-block:: python
 
                 await client.rpc("foobar", {"arg": "value"}).execute()
 
         .. versionchanged:: 0.11.0
-            This method now returns a :class:`SyncFilterRequestBuilder` which allows you to
+            This method now returns a :class:`AsyncFilterRequestBuilder` which allows you to
             filter on the RPC's resultset.
         """
         # the params here are params to be sent to the RPC and not the queryparams!

postgrest/_sync/request_builder.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
-from typing import Optional
+from json import JSONDecodeError
+from typing import Optional, Union
 
 from httpx import Headers, QueryParams
 from pydantic import ValidationError
@@ -17,7 +18,7 @@
     pre_update,
     pre_upsert,
 )
-from ..exceptions import APIError
+from ..exceptions import APIError, generate_default_error_message
 from ..types import ReturnMethod
 from ..utils import SyncClient
 
@@ -67,6 +68,8 @@ def execute(self) -> APIResponse:
                 raise APIError(r.json())
         except ValidationError as e:
             raise APIError(r.json()) from e
+        except JSONDecodeError as e:
+            raise APIError(generate_default_error_message(r))
 
 
 class SyncSingleRequestBuilder:
@@ -114,6 +117,8 @@ def execute(self) -> SingleAPIResponse:
                 raise APIError(r.json())
         except ValidationError as e:
             raise APIError(r.json()) from e
+        except JSONDecodeError as e:
+            raise APIError(generate_default_error_message(r))
 
 
 class SyncMaybeSingleRequestBuilder(SyncSingleRequestBuilder):
@@ -220,7 +225,7 @@ def select(
             *columns: The names of the columns to fetch.
             count: The method to use to get the count of rows returned.
         Returns:
-            :class:`SyncSelectRequestBuilder`
+            :class:`AsyncSelectRequestBuilder`
         """
         method, params, headers, json = pre_select(*columns, count=count)
         return SyncSelectRequestBuilder(
@@ -229,7 +234,7 @@ def select(
 
     def insert(
         self,
-        json: dict,
+        json: Union[dict, list],
         *,
         count: Optional[CountMethod] = None,
         returning: ReturnMethod = ReturnMethod.representation,
@@ -243,7 +248,7 @@ def insert(
             returning: Either 'minimal' or 'representation'
             upsert: Whether the query should be an upsert.
         Returns:
-            :class:`SyncQueryRequestBuilder`
+            :class:`AsyncQueryRequestBuilder`
         """
         method, params, headers, json = pre_insert(
             json,
@@ -273,7 +278,7 @@ def upsert(
             ignore_duplicates: Whether duplicate rows should be ignored.
             on_conflict: Specified columns to be made to work with UNIQUE constraint.
         Returns:
-            :class:`SyncQueryRequestBuilder`
+            :class:`AsyncQueryRequestBuilder`
         """
         method, params, headers, json = pre_upsert(
             json,
@@ -300,7 +305,7 @@ def update(
             count: The method to use to get the count of rows returned.
             returning: Either 'minimal' or 'representation'
         Returns:
-            :class:`SyncFilterRequestBuilder`
+            :class:`AsyncFilterRequestBuilder`
         """
         method, params, headers, json = pre_update(
             json,
@@ -323,7 +328,7 @@ def delete(
             count: The method to use to get the count of rows returned.
             returning: Either 'minimal' or 'representation'
         Returns:
-            :class:`SyncFilterRequestBuilder`
+            :class:`AsyncFilterRequestBuilder`
         """
         method, params, headers, json = pre_delete(
             count=count,

postgrest/base_request_builder.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import json
+from json import JSONDecodeError
 from re import search
 from typing import (
     Any,
@@ -153,7 +154,10 @@ def _get_count_from_http_request_response(
     def from_http_request_response(
         cls: Type[APIResponse], request_response: RequestResponse
     ) -> APIResponse:
-        data = request_response.json()
+        try:
+            data = request_response.json()
+        except JSONDecodeError as e:
+            return cls(data=[], count=0)
         count = cls._get_count_from_http_request_response(request_response)
         return cls(data=data, count=count)
 

postgrest/exceptions.py

@@ -39,3 +39,12 @@ def json(self) -> Dict[str, str]:
             :class:`dict`
         """
         return self._raw_error
+
+
+def generate_default_error_message(r):
+    return {
+        "message": "JSON could not be generated",
+        "code": r.status_code,
+        "hint": "Refer to full message for details",
+        "details": str(r.content),
+    }

tests/_sync/test_client.py

@@ -99,7 +99,7 @@ def test_response_status_code_outside_ok(postgrest_client: SyncPostgrestClient):
 @pytest.mark.asyncio
 def test_response_maybe_single(postgrest_client: SyncPostgrestClient):
     with patch(
-        "postgrest._sync.request_builder.SyncSingleRequestBuilder.execute",
+        "postgrest._async.request_builder.AsyncSingleRequestBuilder.execute",
         side_effect=APIError(
             {"message": "mock error", "code": "400", "hint": "mock", "details": "mock"}
         ),