fix: remove reliance on SyncClient and use Client directly from httpx (#607)

- fix: add deprecation warnings for SyncClient
- test: update to use Client instead of SyncClient
- chore: remove deprecated classes Client and GetRequestBuilder

Author: silentworks

Makefile

@@ -36,11 +36,11 @@ build_sync: run_unasync remove_pytest_asyncio_from_sync
 remove_pytest_asyncio_from_sync:
 	sed -i 's/@pytest.mark.asyncio//g' tests/_sync/test_client.py
 	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/Async/Sync/g' postgrest/_sync/request_builder.py tests/_sync/test_client.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
+	sed -i 's/SyncHTTPTransport/HTTPTransport/g' tests/_sync/**.py
+	sed -i 's/SyncClient/Client/g' postgrest/_sync/**.py tests/_sync/**.py
+	sed -i 's/self\.session\.aclose/self\.session\.close/g' postgrest/_sync/client.py
 
 sleep:
 	sleep 2

postgrest/__init__.py

@@ -24,8 +24,6 @@
 )
 from .base_request_builder import APIResponse
 from .constants import DEFAULT_POSTGREST_CLIENT_HEADERS
-from .deprecated_client import Client, PostgrestClient
-from .deprecated_get_request_builder import GetRequestBuilder
 from .exceptions import APIError
 from .types import (
     CountMethod,
@@ -54,9 +52,6 @@
     "SyncSingleRequestBuilder",
     "APIResponse",
     "DEFAULT_POSTGREST_CLIENT_HEADERS",
-    "Client",
-    "PostgrestClient",
-    "GetRequestBuilder",
     "APIError",
     "CountMethod",
     "Filters",

postgrest/_async/client.py

@@ -4,15 +4,14 @@
 from warnings import warn
 
 from deprecation import deprecated
-from httpx import Headers, QueryParams, Timeout
+from httpx import AsyncClient, Headers, QueryParams, Timeout
 
 from ..base_client import BasePostgrestClient
 from ..constants import (
     DEFAULT_POSTGREST_CLIENT_HEADERS,
     DEFAULT_POSTGREST_CLIENT_TIMEOUT,
 )
 from ..types import CountMethod
-from ..utils import AsyncClient
 from ..version import __version__
 from .request_builder import AsyncRequestBuilder, AsyncRPCFilterRequestBuilder
 

postgrest/_async/request_builder.py

@@ -2,7 +2,7 @@
 
 from typing import Any, Generic, Optional, TypeVar, Union
 
-from httpx import Headers, QueryParams
+from httpx import AsyncClient, Headers, QueryParams
 from pydantic import ValidationError
 
 from ..base_request_builder import (
@@ -20,7 +20,7 @@
 )
 from ..exceptions import APIError, APIErrorFromJSON, generate_default_error_message
 from ..types import ReturnMethod
-from ..utils import AsyncClient, get_origin_and_cast
+from ..utils import get_origin_and_cast
 
 _ReturnT = TypeVar("_ReturnT")
 

postgrest/_sync/client.py

@@ -4,15 +4,14 @@
 from warnings import warn
 
 from deprecation import deprecated
-from httpx import Headers, QueryParams, Timeout
+from httpx import Client, Headers, QueryParams, Timeout
 
 from ..base_client import BasePostgrestClient
 from ..constants import (
     DEFAULT_POSTGREST_CLIENT_HEADERS,
     DEFAULT_POSTGREST_CLIENT_TIMEOUT,
 )
 from ..types import CountMethod
-from ..utils import SyncClient
 from ..version import __version__
 from .request_builder import SyncRequestBuilder, SyncRPCFilterRequestBuilder
 
@@ -31,7 +30,7 @@ def __init__(
         timeout: Union[int, float, Timeout, None] = None,
         verify: Optional[bool] = None,
         proxy: Optional[str] = None,
-        http_client: Optional[SyncClient] = None,
+        http_client: Optional[Client] = None,
     ) -> None:
         if timeout is not None:
             warn(
@@ -73,7 +72,7 @@ def __init__(
             proxy=proxy,
             http_client=http_client,
         )
-        self.session = cast(SyncClient, self.session)
+        self.session = cast(Client, self.session)
 
     def create_session(
         self,
@@ -82,17 +81,17 @@ def create_session(
         timeout: Union[int, float, Timeout],
         verify: bool = True,
         proxy: Optional[str] = None,
-    ) -> SyncClient:
+    ) -> Client:
         http_client = None
-        if isinstance(self.http_client, SyncClient):
+        if isinstance(self.http_client, Client):
             http_client = self.http_client
 
         if http_client is not None:
             http_client.base_url = base_url
             http_client.headers.update({**headers})
             return http_client
 
-        return SyncClient(
+        return Client(
             base_url=base_url,
             headers=headers,
             timeout=timeout,
@@ -121,7 +120,7 @@ def __exit__(self, exc_type, exc, tb) -> None:
 
     def aclose(self) -> None:
         """Close the underlying HTTP connections."""
-        self.session.aclose()
+        self.session.close()
 
     def from_(self, table: str) -> SyncRequestBuilder[_TableT]:
         """Perform a table operation.

postgrest/_sync/request_builder.py

@@ -2,7 +2,7 @@
 
 from typing import Any, Generic, Optional, TypeVar, Union
 
-from httpx import Headers, QueryParams
+from httpx import Client, Headers, QueryParams
 from pydantic import ValidationError
 
 from ..base_request_builder import (
@@ -20,15 +20,15 @@
 )
 from ..exceptions import APIError, APIErrorFromJSON, generate_default_error_message
 from ..types import ReturnMethod
-from ..utils import SyncClient, get_origin_and_cast
+from ..utils import get_origin_and_cast
 
 _ReturnT = TypeVar("_ReturnT")
 
 
 class SyncQueryRequestBuilder(Generic[_ReturnT]):
     def __init__(
         self,
-        session: SyncClient,
+        session: Client,
         path: str,
         http_method: str,
         headers: Headers,
@@ -83,7 +83,7 @@ def execute(self) -> APIResponse[_ReturnT]:
 class SyncSingleRequestBuilder(Generic[_ReturnT]):
     def __init__(
         self,
-        session: SyncClient,
+        session: Client,
         path: str,
         http_method: str,
         headers: Headers,
@@ -152,7 +152,7 @@ def execute(self) -> Optional[SingleAPIResponse[_ReturnT]]:
 class SyncFilterRequestBuilder(BaseFilterRequestBuilder[_ReturnT], SyncQueryRequestBuilder[_ReturnT]):  # type: ignore
     def __init__(
         self,
-        session: SyncClient,
+        session: Client,
         path: str,
         http_method: str,
         headers: Headers,
@@ -173,7 +173,7 @@ class SyncRPCFilterRequestBuilder(
 ):
     def __init__(
         self,
-        session: SyncClient,
+        session: Client,
         path: str,
         http_method: str,
         headers: Headers,
@@ -192,7 +192,7 @@ def __init__(
 class SyncSelectRequestBuilder(BaseSelectRequestBuilder[_ReturnT], SyncQueryRequestBuilder[_ReturnT]):  # type: ignore
     def __init__(
         self,
-        session: SyncClient,
+        session: Client,
         path: str,
         http_method: str,
         headers: Headers,
@@ -271,7 +271,7 @@ def csv(self) -> SyncSingleRequestBuilder[str]:
 
 
 class SyncRequestBuilder(Generic[_ReturnT]):
-    def __init__(self, session: SyncClient, path: str) -> None:
+    def __init__(self, session: Client, path: str) -> None:
         self.session = session
         self.path = path
 

postgrest/base_client.py

@@ -3,9 +3,9 @@
 from abc import ABC, abstractmethod
 from typing import Dict, Optional, Union
 
-from httpx import BasicAuth, Timeout
+from httpx import AsyncClient, BasicAuth, Client, Timeout
 
-from .utils import AsyncClient, SyncClient, is_http_url, is_valid_jwt
+from .utils import is_http_url, is_valid_jwt
 
 
 class BasePostgrestClient(ABC):
@@ -20,7 +20,7 @@ def __init__(
         timeout: Union[int, float, Timeout],
         verify: bool = True,
         proxy: Optional[str] = None,
-        http_client: Union[SyncClient, AsyncClient, None] = None,
+        http_client: Union[Client, AsyncClient, None] = None,
     ) -> None:
         if not is_http_url(base_url):
             ValueError("base_url must be a valid HTTP URL string")
@@ -51,7 +51,7 @@ def create_session(
         timeout: Union[int, float, Timeout],
         verify: bool = True,
         proxy: Optional[str] = None,
-    ) -> Union[SyncClient, AsyncClient]:
+    ) -> Union[Client, AsyncClient]:
         raise NotImplementedError()
 
     def auth(

postgrest/base_request_builder.py

@@ -18,7 +18,7 @@
     Union,
 )
 
-from httpx import Headers, QueryParams
+from httpx import AsyncClient, Client, Headers, QueryParams
 from httpx import Response as RequestResponse
 from pydantic import BaseModel
 
@@ -35,7 +35,7 @@
     from pydantic import validator as field_validator
 
 from .types import CountMethod, Filters, RequestMethod, ReturnMethod
-from .utils import AsyncClient, SyncClient, get_origin_and_cast, sanitize_param
+from .utils import get_origin_and_cast, sanitize_param
 
 
 class QueryArgs(NamedTuple):
@@ -255,7 +255,7 @@ def from_dict(cls: Type[Self], dict: Dict[str, Any]) -> Self:
 class BaseFilterRequestBuilder(Generic[_ReturnT]):
     def __init__(
         self,
-        session: Union[AsyncClient, SyncClient],
+        session: Union[AsyncClient, Client],
         headers: Headers,
         params: QueryParams,
     ) -> None:
@@ -530,7 +530,7 @@ def match(self: Self, query: Dict[str, Any]) -> Self:
 class BaseSelectRequestBuilder(BaseFilterRequestBuilder[_ReturnT]):
     def __init__(
         self,
-        session: Union[AsyncClient, SyncClient],
+        session: Union[AsyncClient, Client],
         headers: Headers,
         params: QueryParams,
     ) -> None:
@@ -636,7 +636,7 @@ def range(
 class BaseRPCRequestBuilder(BaseSelectRequestBuilder[_ReturnT]):
     def __init__(
         self,
-        session: Union[AsyncClient, SyncClient],
+        session: Union[AsyncClient, Client],
         headers: Headers,
         params: QueryParams,
     ) -> None:

postgrest/deprecated_client.py

@@ -4,13 +4,28 @@
 from typing import Any, Type, TypeVar, cast, get_origin
 from urllib.parse import urlparse
 
+from deprecation import deprecated
 from httpx import AsyncClient  # noqa: F401
 from httpx import Client as BaseClient  # noqa: F401
 
+from .version import __version__
+
 BASE64URL_REGEX = r"^([a-z0-9_-]{4})*($|[a-z0-9_-]{3}$|[a-z0-9_-]{2}$)$"
 
 
 class SyncClient(BaseClient):
+    @deprecated(
+        "1.0.2", "1.3.0", __version__, "Use `Client` from the httpx package instead"
+    )
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+
+    @deprecated(
+        "1.0.2",
+        "1.3.0",
+        __version__,
+        "Use `close` method from `Client` in the httpx package instead",
+    )
     def aclose(self) -> None:
         self.close()
 

postgrest/deprecated_get_request_builder.py

@@ -1,7 +1,6 @@
-from httpx import AsyncHTTPTransport, Limits
+from httpx import AsyncClient, AsyncHTTPTransport, Limits
 
 from postgrest import AsyncPostgrestClient
-from postgrest.utils import AsyncClient
 
 REST_URL = "http://127.0.0.1:3000"
 

postgrest/utils.py

@@ -2,6 +2,7 @@
 
 import pytest
 from httpx import (
+    AsyncClient,
     AsyncHTTPTransport,
     BasicAuth,
     Headers,
@@ -13,7 +14,6 @@
 
 from postgrest import AsyncPostgrestClient
 from postgrest.exceptions import APIError
-from postgrest.utils import AsyncClient
 
 
 @pytest.fixture

tests/_async/client.py

@@ -1,8 +1,7 @@
 import pytest
-from httpx import Headers, QueryParams
+from httpx import AsyncClient, Headers, QueryParams
 
 from postgrest import AsyncFilterRequestBuilder
-from postgrest.utils import AsyncClient
 
 
 @pytest.fixture

tests/_async/test_client.py

@@ -1,8 +1,7 @@
 import pytest
-from httpx import Headers, QueryParams
+from httpx import AsyncClient, Headers, QueryParams
 
 from postgrest import AsyncQueryRequestBuilder
-from postgrest.utils import AsyncClient
 
 
 @pytest.fixture