Merge branch 'main' into silentworks/httpx-dependency-injection

silentworks · web-flow · commit 60ff26cb82b7 · 2025-06-11T10:23:24.000+01:00
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "1.0.1"
+  ".": "1.0.2"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## [1.0.2](https://github.com/supabase/postgrest-py/compare/v1.0.1...v1.0.2) (2025-05-21)
+
+
+### Bug Fixes
+
+* pass params as query params for get/head requests ([#593](https://github.com/supabase/postgrest-py/issues/593)) ([576a5b8](https://github.com/supabase/postgrest-py/commit/576a5b84e19c0a379ef10df24f3325c0519d406e))
+* validate JSON input for APIError ([#597](https://github.com/supabase/postgrest-py/issues/597)) ([3c8bdae](https://github.com/supabase/postgrest-py/commit/3c8bdae4135f79dcf903d0bd75f02c097db0b855))
+
 ## [1.0.1](https://github.com/supabase/postgrest-py/compare/v1.0.0...v1.0.1) (2025-03-24)
 
 
diff --git a/Makefile b/Makefile
@@ -38,6 +38,7 @@ remove_pytest_asyncio_from_sync:
 	sed -i 's/_async/_sync/g' tests/_sync/test_client.py
 	sed -i 's/Async/Sync/g' tests/_sync/test_client.py
 	sed -i 's/Async/Sync/g' postgrest/_sync/request_builder.py
+	sed -i 's/_client\.SyncClient/_client\.Client/g' tests/_sync/test_client.py
 
 sleep:
 	sleep 2
diff --git a/infra/init.sql b/infra/init.sql
@@ -77,6 +77,12 @@ as $function$
     select * from countries;
 $function$;
 
+create or replace function public.search_countries_by_name(search_name text)
+    returns setof countries
+    language sql
+as $function$
+    select * from countries where nicename ilike '%' || search_name || '%';
+$function$;
 
 create table
   orchestral_sections (id int8 primary key, name text);
diff --git a/poetry.lock b/poetry.lock
diff --git a/postgrest/_async/client.py b/postgrest/_async/client.py
@@ -166,6 +166,15 @@ def rpc(
 
         headers = Headers({"Prefer": f"count={count}"}) if count else Headers()
 
+        if method in ("HEAD", "GET"):
+            return AsyncRPCFilterRequestBuilder[Any](
+                self.session,
+                f"/rpc/{func}",
+                method,
+                headers,
+                QueryParams(params),
+                json={},
+            )
         # the params here are params to be sent to the RPC and not the queryparams!
         return AsyncRPCFilterRequestBuilder[Any](
             self.session, f"/rpc/{func}", method, headers, QueryParams(), json=params
diff --git a/postgrest/_async/request_builder.py b/postgrest/_async/request_builder.py
@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from json import JSONDecodeError
 from typing import Any, Generic, Optional, TypeVar, Union
 
 from httpx import Headers, QueryParams
@@ -19,7 +18,7 @@
     pre_update,
     pre_upsert,
 )
-from ..exceptions import APIError, generate_default_error_message
+from ..exceptions import APIError, APIErrorFromJSON, generate_default_error_message
 from ..types import ReturnMethod
 from ..utils import AsyncClient, get_origin_and_cast
 
@@ -75,10 +74,9 @@ async def execute(self) -> APIResponse[_ReturnT]:
                             return body
                 return APIResponse[_ReturnT].from_http_request_response(r)
             else:
-                raise APIError(r.json())
+                json_obj = APIErrorFromJSON.model_validate_json(r.content)
+                raise APIError(dict(json_obj))
         except ValidationError as e:
-            raise APIError(r.json()) from e
-        except JSONDecodeError:
             raise APIError(generate_default_error_message(r))
 
 
@@ -124,10 +122,9 @@ async def execute(self) -> SingleAPIResponse[_ReturnT]:
             ):  # Response.ok from JS (https://developer.mozilla.org/en-US/docs/Web/API/Response/ok)
                 return SingleAPIResponse[_ReturnT].from_http_request_response(r)
             else:
-                raise APIError(r.json())
+                json_obj = APIErrorFromJSON.model_validate_json(r.content)
+                raise APIError(dict(json_obj))
         except ValidationError as e:
-            raise APIError(r.json()) from e
-        except JSONDecodeError:
             raise APIError(generate_default_error_message(r))
 
 
diff --git a/postgrest/_sync/client.py b/postgrest/_sync/client.py
@@ -166,6 +166,15 @@ def rpc(
 
         headers = Headers({"Prefer": f"count={count}"}) if count else Headers()
 
+        if method in ("HEAD", "GET"):
+            return SyncRPCFilterRequestBuilder[Any](
+                self.session,
+                f"/rpc/{func}",
+                method,
+                headers,
+                QueryParams(params),
+                json={},
+            )
         # the params here are params to be sent to the RPC and not the queryparams!
         return SyncRPCFilterRequestBuilder[Any](
             self.session, f"/rpc/{func}", method, headers, QueryParams(), json=params
diff --git a/postgrest/_sync/request_builder.py b/postgrest/_sync/request_builder.py
@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from json import JSONDecodeError
 from typing import Any, Generic, Optional, TypeVar, Union
 
 from httpx import Headers, QueryParams
@@ -19,7 +18,7 @@
     pre_update,
     pre_upsert,
 )
-from ..exceptions import APIError, generate_default_error_message
+from ..exceptions import APIError, APIErrorFromJSON, generate_default_error_message
 from ..types import ReturnMethod
 from ..utils import SyncClient, get_origin_and_cast
 
@@ -75,10 +74,9 @@ def execute(self) -> APIResponse[_ReturnT]:
                             return body
                 return APIResponse[_ReturnT].from_http_request_response(r)
             else:
-                raise APIError(r.json())
+                json_obj = APIErrorFromJSON.model_validate_json(r.content)
+                raise APIError(dict(json_obj))
         except ValidationError as e:
-            raise APIError(r.json()) from e
-        except JSONDecodeError:
             raise APIError(generate_default_error_message(r))
 
 
@@ -124,10 +122,9 @@ def execute(self) -> SingleAPIResponse[_ReturnT]:
             ):  # Response.ok from JS (https://developer.mozilla.org/en-US/docs/Web/API/Response/ok)
                 return SingleAPIResponse[_ReturnT].from_http_request_response(r)
             else:
-                raise APIError(r.json())
+                json_obj = APIErrorFromJSON.model_validate_json(r.content)
+                raise APIError(dict(json_obj))
         except ValidationError as e:
-            raise APIError(r.json()) from e
-        except JSONDecodeError:
             raise APIError(generate_default_error_message(r))
 
 
@@ -290,7 +287,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, head=head)
         return SyncSelectRequestBuilder[_ReturnT](
@@ -317,7 +314,7 @@ def insert(
                 Otherwise, use the default value for the column.
                 Only applies for bulk inserts.
         Returns:
-            :class:`SyncQueryRequestBuilder`
+            :class:`AsyncQueryRequestBuilder`
         """
         method, params, headers, json = pre_insert(
             json,
@@ -353,7 +350,7 @@ def upsert(
                 not when merging with existing rows under `ignoreDuplicates: false`.
                 This also only applies when doing bulk upserts.
         Returns:
-            :class:`SyncQueryRequestBuilder`
+            :class:`AsyncQueryRequestBuilder`
         """
         method, params, headers, json = pre_upsert(
             json,
@@ -381,7 +378,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,
@@ -404,7 +401,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,
diff --git a/postgrest/base_request_builder.py b/postgrest/base_request_builder.py
@@ -660,7 +660,11 @@ def select(
         """
         method, params, headers, json = pre_select(*columns, count=None)
         self.params = self.params.add("select", params.get("select"))
-        self.headers["Prefer"] = "return=representation"
+        if self.headers.get("Prefer"):
+            self.headers["Prefer"] += ",return=representation"
+        else:
+            self.headers["Prefer"] = "return=representation"
+
         return self
 
     def single(self) -> Self:
diff --git a/postgrest/exceptions.py b/postgrest/exceptions.py
@@ -1,5 +1,23 @@
 from typing import Dict, Optional
 
+from pydantic import BaseModel
+
+
+class APIErrorFromJSON(BaseModel):
+    """
+    A pydantic object to validate an error info object
+    from a json string.
+    """
+
+    message: Optional[str]
+    """The error message."""
+    code: Optional[str]
+    """The error code."""
+    hint: Optional[str]
+    """The error hint."""
+    details: Optional[str]
+    """The error details."""
+
 
 class APIError(Exception):
     """
diff --git a/postgrest/version.py b/postgrest/version.py
@@ -1 +1 @@
-__version__ = "1.0.1"  # {x-release-please-version}
+__version__ = "1.0.2"  # {x-release-please-version}
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "postgrest"
-version = "1.0.1" # {x-release-please-version}
+version = "1.0.2" # {x-release-please-version}
 description = "PostgREST client for Python. This library provides an ORM interface to PostgREST."
 authors = ["Lương Quang Mạnh <luongquangmanh85@gmail.com>", "Joel Lee <joel@joellee.org>", "Anand", "Oliver Rice", "Andrew Smith <a.smith@silentworks.co.uk>"]
 homepage = "https://github.com/supabase/postgrest-py"
@@ -30,7 +30,7 @@ flake8 = "^7.2.0"
 black = "^25.1"
 isort = "^6.0.1"
 pre-commit = "^4.2.0"
-pytest-cov = "^6.1.0"
+pytest-cov = "^6.1.1"
 pytest-depends = "^1.0.1"
 pytest-asyncio = "^0.26.0"
 unasync-cli = { git = "https://github.com/supabase-community/unasync-cli.git", branch = "main" }
diff --git a/tests/_async/test_client.py b/tests/_async/test_client.py
@@ -1,7 +1,7 @@
 from unittest.mock import patch
 
 import pytest
-from httpx import BasicAuth, Headers
+from httpx import BasicAuth, Headers, Request, Response
 
 from postgrest import AsyncPostgrestClient
 from postgrest.exceptions import APIError
@@ -127,3 +127,28 @@ async def test_response_maybe_single(postgrest_client: AsyncPostgrestClient):
         exc_response = exc_info.value.json()
         assert isinstance(exc_response.get("message"), str)
         assert "code" in exc_response and int(exc_response["code"]) == 204
+
+
+# https://github.com/supabase/postgrest-py/issues/595
+@pytest.mark.asyncio
+async def test_response_client_invalid_response_but_valid_json(
+    postgrest_client: AsyncPostgrestClient,
+):
+    with patch(
+        "httpx._client.AsyncClient.request",
+        return_value=Response(
+            status_code=502,
+            text='"gateway error: Error: Network connection lost."',  # quotes makes this text a valid non-dict JSON object
+            request=Request(method="GET", url="http://example.com"),
+        ),
+    ):
+        client = postgrest_client.from_("test").select("a", "b").eq("c", "d").single()
+        assert "Accept" in client.headers
+        assert client.headers.get("Accept") == "application/vnd.pgrst.object+json"
+        with pytest.raises(APIError) as exc_info:
+            await client.execute()
+        assert isinstance(exc_info, pytest.ExceptionInfo)
+        exc_response = exc_info.value.json()
+        assert isinstance(exc_response.get("message"), str)
+        assert exc_response.get("message") == "JSON could not be generated"
+        assert "code" in exc_response and int(exc_response["code"]) == 502
diff --git a/tests/_async/test_filter_request_builder_integration.py b/tests/_async/test_filter_request_builder_integration.py
@@ -483,6 +483,48 @@ async def test_rpc_with_range():
     ]
 
 
+async def test_rpc_post_with_args():
+    res = (
+        await rest_client()
+        .rpc("search_countries_by_name", {"search_name": "Alban"})
+        .select("nicename, iso")
+        .execute()
+    )
+    assert res.data == [{"nicename": "Albania", "iso": "AL"}]
+
+
+async def test_rpc_get_with_args():
+    res = (
+        await rest_client()
+        .rpc("search_countries_by_name", {"search_name": "Alger"}, get=True)
+        .select("nicename, iso")
+        .execute()
+    )
+    assert res.data == [{"nicename": "Algeria", "iso": "DZ"}]
+
+
+async def test_rpc_get_with_count():
+    res = (
+        await rest_client()
+        .rpc("search_countries_by_name", {"search_name": "Al"}, get=True, count="exact")
+        .select("nicename")
+        .execute()
+    )
+    assert res.count == 2
+    assert res.data == [{"nicename": "Albania"}, {"nicename": "Algeria"}]
+
+
+async def test_rpc_head_count():
+    res = (
+        await rest_client()
+        .rpc("search_countries_by_name", {"search_name": "Al"}, head=True, count="exact")
+        .execute()
+    )
+
+    assert res.count == 2
+    assert res.data == []
+
+
 async def test_order():
     res = (
         await rest_client()
diff --git a/tests/_sync/test_client.py b/tests/_sync/test_client.py
@@ -1,7 +1,7 @@
 from unittest.mock import patch
 
 import pytest
-from httpx import BasicAuth, Headers
+from httpx import BasicAuth, Headers, Request, Response
 
 from postgrest import SyncPostgrestClient
 from postgrest.exceptions import APIError
@@ -123,3 +123,29 @@ def test_response_maybe_single(postgrest_client: SyncPostgrestClient):
         exc_response = exc_info.value.json()
         assert isinstance(exc_response.get("message"), str)
         assert "code" in exc_response and int(exc_response["code"]) == 204
+
+
+# https://github.com/supabase/postgrest-py/issues/595
+
+
+def test_response_client_invalid_response_but_valid_json(
+    postgrest_client: SyncPostgrestClient,
+):
+    with patch(
+        "httpx._client.Client.request",
+        return_value=Response(
+            status_code=502,
+            text='"gateway error: Error: Network connection lost."',  # quotes makes this text a valid non-dict JSON object
+            request=Request(method="GET", url="http://example.com"),
+        ),
+    ):
+        client = postgrest_client.from_("test").select("a", "b").eq("c", "d").single()
+        assert "Accept" in client.headers
+        assert client.headers.get("Accept") == "application/vnd.pgrst.object+json"
+        with pytest.raises(APIError) as exc_info:
+            client.execute()
+        assert isinstance(exc_info, pytest.ExceptionInfo)
+        exc_response = exc_info.value.json()
+        assert isinstance(exc_response.get("message"), str)
+        assert exc_response.get("message") == "JSON could not be generated"
+        assert "code" in exc_response and int(exc_response["code"]) == 502
diff --git a/tests/_sync/test_filter_request_builder_integration.py b/tests/_sync/test_filter_request_builder_integration.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "1.0.1"`
	`2`	`+ ".": "1.0.2"`
`3`	`3`	`}`