test: add tests for custom httpx client

Author: silentworks

Makefile

@@ -39,6 +39,8 @@ remove_pytest_asyncio_from_sync:
 	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
+	sed -i 's/SyncHTTPTransport/HTTPTransport/g' tests/_sync/test_client.py
+	sed -i 's/SyncHTTPTransport/HTTPTransport/g' tests/_sync/client.py
 
 sleep:
 	sleep 2

postgrest/_sync/request_builder.py

@@ -287,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:`AsyncSelectRequestBuilder`
+            :class:`SyncSelectRequestBuilder`
         """
         method, params, headers, json = pre_select(*columns, count=count, head=head)
         return SyncSelectRequestBuilder[_ReturnT](
@@ -314,7 +314,7 @@ def insert(
                 Otherwise, use the default value for the column.
                 Only applies for bulk inserts.
         Returns:
-            :class:`AsyncQueryRequestBuilder`
+            :class:`SyncQueryRequestBuilder`
         """
         method, params, headers, json = pre_insert(
             json,
@@ -350,7 +350,7 @@ def upsert(
                 not when merging with existing rows under `ignoreDuplicates: false`.
                 This also only applies when doing bulk upserts.
         Returns:
-            :class:`AsyncQueryRequestBuilder`
+            :class:`SyncQueryRequestBuilder`
         """
         method, params, headers, json = pre_upsert(
             json,
@@ -378,7 +378,7 @@ def update(
             count: The method to use to get the count of rows returned.
             returning: Either 'minimal' or 'representation'
         Returns:
-            :class:`AsyncFilterRequestBuilder`
+            :class:`SyncFilterRequestBuilder`
         """
         method, params, headers, json = pre_update(
             json,
@@ -401,7 +401,7 @@ def delete(
             count: The method to use to get the count of rows returned.
             returning: Either 'minimal' or 'representation'
         Returns:
-            :class:`AsyncFilterRequestBuilder`
+            :class:`SyncFilterRequestBuilder`
         """
         method, params, headers, json = pre_delete(
             count=count,

postgrest/exceptions.py

@@ -1,4 +1,4 @@
-from typing import Dict, Optional
+from typing import Any, Dict, Optional
 
 from pydantic import BaseModel
 
@@ -34,7 +34,7 @@ class APIError(Exception):
     details: Optional[str]
     """The error details."""
 
-    def __init__(self, error: Dict[str, str]) -> None:
+    def __init__(self, error: Dict[str, Any]) -> None:
         self._raw_error = error
         self.message = error.get("message")
         self.code = error.get("code")

pyproject.toml

@@ -44,6 +44,9 @@ furo = ">=2023.9.10,<2025.0.0"
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
+filterwarnings = [
+    "ignore::DeprecationWarning", # ignore deprecation warnings globally
+]
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/_async/client.py

@@ -1,4 +1,7 @@
+from httpx import AsyncHTTPTransport, Limits
+
 from postgrest import AsyncPostgrestClient
+from postgrest.utils import AsyncClient
 
 REST_URL = "http://127.0.0.1:3000"
 
@@ -7,3 +10,20 @@ def rest_client():
     return AsyncPostgrestClient(
         base_url=REST_URL,
     )
+
+
+def rest_client_httpx():
+    transport = AsyncHTTPTransport(
+        retries=4,
+        limits=Limits(
+            max_connections=1,
+            max_keepalive_connections=1,
+            keepalive_expiry=None,
+        ),
+    )
+    headers = {"x-user-agent": "my-app/0.0.1"}
+    http_client = AsyncClient(transport=transport, headers=headers)
+    return AsyncPostgrestClient(
+        base_url=REST_URL,
+        http_client=http_client,
+    )

tests/_async/test_client.py

@@ -1,10 +1,19 @@
 from unittest.mock import patch
 
 import pytest
-from httpx import BasicAuth, Headers, Request, Response
+from httpx import (
+    AsyncHTTPTransport,
+    BasicAuth,
+    Headers,
+    Limits,
+    Request,
+    Response,
+    Timeout,
+)
 
 from postgrest import AsyncPostgrestClient
 from postgrest.exceptions import APIError
+from postgrest.utils import AsyncClient
 
 
 @pytest.fixture
@@ -46,6 +55,32 @@ async def test_custom_headers(self):
             assert session.headers.items() >= headers.items()
 
 
+class TestHttpxClientConstructor:
+    @pytest.mark.asyncio
+    async def test_custom_httpx_client(self):
+        transport = AsyncHTTPTransport(
+            retries=10,
+            limits=Limits(
+                max_connections=1,
+                max_keepalive_connections=1,
+                keepalive_expiry=None,
+            ),
+        )
+        headers = {"x-user-agent": "my-app/0.0.1"}
+        http_client = AsyncClient(transport=transport, headers=headers)
+        async with AsyncPostgrestClient(
+            "https://example.com", http_client=http_client, timeout=20.0
+        ) as client:
+            session = client.session
+
+            assert session.base_url == "https://example.com"
+            assert session.timeout == Timeout(
+                timeout=5.0
+            )  # Should be the default 5 since we use custom httpx client
+            assert session.headers.get("x-user-agent") == "my-app/0.0.1"
+            assert isinstance(session, AsyncClient)
+
+
 class TestAuth:
     def test_auth_token(self, postgrest_client: AsyncPostgrestClient):
         postgrest_client.auth("s3cr3t")

tests/_async/test_filter_request_builder_integration.py

@@ -1,11 +1,30 @@
-from .client import rest_client
+from postgrest import CountMethod
+
+from .client import rest_client, rest_client_httpx
+
+
+async def test_multivalued_param_httpx():
+    res = (
+        await rest_client_httpx()
+        .from_("countries")
+        .select("country_name, iso", count=CountMethod.exact)
+        .lte("numcode", 8)
+        .gte("numcode", 4)
+        .execute()
+    )
+
+    assert res.count == 2
+    assert res.data == [
+        {"country_name": "AFGHANISTAN", "iso": "AF"},
+        {"country_name": "ALBANIA", "iso": "AL"},
+    ]
 
 
 async def test_multivalued_param():
     res = (
         await rest_client()
         .from_("countries")
-        .select("country_name, iso", count="exact")
+        .select("country_name, iso", count=CountMethod.exact)
         .lte("numcode", 8)
         .gte("numcode", 4)
         .execute()
@@ -506,7 +525,12 @@ async def test_rpc_get_with_args():
 async def test_rpc_get_with_count():
     res = (
         await rest_client()
-        .rpc("search_countries_by_name", {"search_name": "Al"}, get=True, count="exact")
+        .rpc(
+            "search_countries_by_name",
+            {"search_name": "Al"},
+            get=True,
+            count=CountMethod.exact,
+        )
         .select("nicename")
         .execute()
     )
@@ -517,7 +541,12 @@ async def test_rpc_get_with_count():
 async def test_rpc_head_count():
     res = (
         await rest_client()
-        .rpc("search_countries_by_name", {"search_name": "Al"}, head=True, count="exact")
+        .rpc(
+            "search_countries_by_name",
+            {"search_name": "Al"},
+            head=True,
+            count=CountMethod.exact,
+        )
         .execute()
     )
 

tests/_sync/client.py

@@ -1,4 +1,7 @@
+from httpx import HTTPTransport, Limits
+
 from postgrest import SyncPostgrestClient
+from postgrest.utils import SyncClient
 
 REST_URL = "http://127.0.0.1:3000"
 
@@ -7,3 +10,20 @@ def rest_client():
     return SyncPostgrestClient(
         base_url=REST_URL,
     )
+
+
+def rest_client_httpx():
+    transport = HTTPTransport(
+        retries=4,
+        limits=Limits(
+            max_connections=1,
+            max_keepalive_connections=1,
+            keepalive_expiry=None,
+        ),
+    )
+    headers = {"x-user-agent": "my-app/0.0.1"}
+    http_client = SyncClient(transport=transport, headers=headers)
+    return SyncPostgrestClient(
+        base_url=REST_URL,
+        http_client=http_client,
+    )

tests/_sync/test_client.py

@@ -1,10 +1,19 @@
 from unittest.mock import patch
 
 import pytest
-from httpx import BasicAuth, Headers, Request, Response
+from httpx import (
+    BasicAuth,
+    Headers,
+    HTTPTransport,
+    Limits,
+    Request,
+    Response,
+    Timeout,
+)
 
 from postgrest import SyncPostgrestClient
 from postgrest.exceptions import APIError
+from postgrest.utils import SyncClient
 
 
 @pytest.fixture
@@ -45,6 +54,32 @@ def test_custom_headers(self):
             assert session.headers.items() >= headers.items()
 
 
+class TestHttpxClientConstructor:
+
+    def test_custom_httpx_client(self):
+        transport = HTTPTransport(
+            retries=10,
+            limits=Limits(
+                max_connections=1,
+                max_keepalive_connections=1,
+                keepalive_expiry=None,
+            ),
+        )
+        headers = {"x-user-agent": "my-app/0.0.1"}
+        http_client = SyncClient(transport=transport, headers=headers)
+        with SyncPostgrestClient(
+            "https://example.com", http_client=http_client, timeout=20.0
+        ) as client:
+            session = client.session
+
+            assert session.base_url == "https://example.com"
+            assert session.timeout == Timeout(
+                timeout=5.0
+            )  # Should be the default 5 since we use custom httpx client
+            assert session.headers.get("x-user-agent") == "my-app/0.0.1"
+            assert isinstance(session, SyncClient)
+
+
 class TestAuth:
     def test_auth_token(self, postgrest_client: SyncPostgrestClient):
         postgrest_client.auth("s3cr3t")

tests/_sync/test_filter_request_builder_integration.py

@@ -1,11 +1,30 @@
-from .client import rest_client
+from postgrest import CountMethod
+
+from .client import rest_client, rest_client_httpx
+
+
+def test_multivalued_param_httpx():
+    res = (
+        rest_client_httpx()
+        .from_("countries")
+        .select("country_name, iso", count=CountMethod.exact)
+        .lte("numcode", 8)
+        .gte("numcode", 4)
+        .execute()
+    )
+
+    assert res.count == 2
+    assert res.data == [
+        {"country_name": "AFGHANISTAN", "iso": "AF"},
+        {"country_name": "ALBANIA", "iso": "AL"},
+    ]
 
 
 def test_multivalued_param():
     res = (
         rest_client()
         .from_("countries")
-        .select("country_name, iso", count="exact")
+        .select("country_name, iso", count=CountMethod.exact)
         .lte("numcode", 8)
         .gte("numcode", 4)
         .execute()
@@ -499,7 +518,12 @@ def test_rpc_get_with_args():
 def test_rpc_get_with_count():
     res = (
         rest_client()
-        .rpc("search_countries_by_name", {"search_name": "Al"}, get=True, count="exact")
+        .rpc(
+            "search_countries_by_name",
+            {"search_name": "Al"},
+            get=True,
+            count=CountMethod.exact,
+        )
         .select("nicename")
         .execute()
     )
@@ -510,7 +534,12 @@ def test_rpc_get_with_count():
 def test_rpc_head_count():
     res = (
         rest_client()
-        .rpc("search_countries_by_name", {"search_name": "Al"}, head=True, count="exact")
+        .rpc(
+            "search_countries_by_name",
+            {"search_name": "Al"},
+            head=True,
+            count=CountMethod.exact,
+        )
         .execute()
     )