fix: remove reliance on SyncClient and use Client directly from httpx

fix: add deprecation warnings for SyncClient
test: update to use Client instead of SyncClient

Author: silentworks

Makefile

@@ -19,6 +19,7 @@ build_sync:
 	poetry run unasync supabase_functions tests
 	sed -i '0,/SyncMock, /{s/SyncMock, //}' tests/_sync/test_function_client.py
 	sed -i 's/SyncMock/Mock/g' tests/_sync/test_function_client.py
+	sed -i 's/SyncClient/Client/g' supabase_functions/_sync/functions_client.py tests/_sync/test_function_client.py
 
 
 rename_project: rename_package_dir rename_package

supabase_functions/__init__.py

@@ -1,12 +1,17 @@
 from __future__ import annotations
 
-from typing import Literal, Optional, Union, overload
+from typing import Literal, Union, overload
 
 from ._async.functions_client import AsyncFunctionsClient
 from ._sync.functions_client import SyncFunctionsClient
 from .utils import FunctionRegion
 
-__all__ = ["create_client"]
+__all__ = [
+    "create_client",
+    "FunctionRegion",
+    "AsyncFunctionsClient",
+    "SyncFunctionsClient",
+]
 
 
 @overload

supabase_functions/_async/functions_client.py

@@ -1,11 +1,10 @@
 from typing import Any, Dict, Literal, Optional, Union
 from warnings import warn
 
-from httpx import HTTPError, Response
+from httpx import AsyncClient, HTTPError, Response
 
 from ..errors import FunctionsHttpError, FunctionsRelayError
 from ..utils import (
-    AsyncClient,
     FunctionRegion,
     is_http_url,
     is_valid_jwt,

supabase_functions/_sync/functions_client.py

@@ -1,12 +1,11 @@
 from typing import Any, Dict, Literal, Optional, Union
 from warnings import warn
 
-from httpx import HTTPError, Response
+from httpx import Client, HTTPError, Response
 
 from ..errors import FunctionsHttpError, FunctionsRelayError
 from ..utils import (
     FunctionRegion,
-    SyncClient,
     is_http_url,
     is_valid_jwt,
     is_valid_str_arg,
@@ -22,7 +21,7 @@ def __init__(
         timeout: Optional[int] = None,
         verify: Optional[bool] = None,
         proxy: Optional[str] = None,
-        http_client: Optional[SyncClient] = None,
+        http_client: Optional[Client] = None,
     ):
         if not is_http_url(url):
             raise ValueError("url must be a valid HTTP URL string")
@@ -59,7 +58,7 @@ def __init__(
             http_client.headers.update({**self.headers})
             self._client = http_client
         else:
-            self._client = SyncClient(
+            self._client = Client(
                 base_url=self.url,
                 headers=self.headers,
                 verify=self.verify,

supabase_functions/utils.py

@@ -1,6 +1,7 @@
 import re
 import sys
 from urllib.parse import urlparse
+from warnings import warn
 
 from httpx import AsyncClient as AsyncClient  # noqa: F401
 from httpx import Client as BaseClient
@@ -34,7 +35,21 @@ class FunctionRegion(StrEnum):
 
 
 class SyncClient(BaseClient):
+    def __init__(self, *args, **kwargs):
+        warn(
+            "The 'SyncClient' class is deprecated. Please use `Client` from the httpx package instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+        super().__init__(*args, **kwargs)
+
     def aclose(self) -> None:
+        warn(
+            "The 'aclose' method is deprecated. Please use `close` method from `Client` in the httpx package instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         self.close()
 
 

tests/_async/test_function_client.py

@@ -1,12 +1,12 @@
 from unittest.mock import AsyncMock, Mock, patch
 
 import pytest
-from httpx import HTTPError, Response, Timeout
+from httpx import AsyncClient, HTTPError, Response, Timeout
 
 # Import the class to test
 from supabase_functions import AsyncFunctionsClient
 from supabase_functions.errors import FunctionsHttpError, FunctionsRelayError
-from supabase_functions.utils import AsyncClient, FunctionRegion
+from supabase_functions.utils import FunctionRegion
 from supabase_functions.version import __version__
 
 

tests/_sync/test_function_client.py

@@ -1,12 +1,12 @@
 from unittest.mock import Mock, patch
 
 import pytest
-from httpx import HTTPError, Response, Timeout
+from httpx import Client, HTTPError, Response, Timeout
 
 # Import the class to test
 from supabase_functions import SyncFunctionsClient
 from supabase_functions.errors import FunctionsHttpError, FunctionsRelayError
-from supabase_functions.utils import FunctionRegion, SyncClient
+from supabase_functions.utils import FunctionRegion
 from supabase_functions.version import __version__
 
 
@@ -186,7 +186,7 @@ def test_invoke_with_json_body(client: SyncFunctionsClient):
 def test_init_with_httpx_client():
     # Create a custom httpx client with specific options
     headers = {"x-user-agent": "my-app/0.0.1"}
-    custom_client = SyncClient(
+    custom_client = Client(
         timeout=Timeout(30), follow_redirects=True, max_redirects=5, headers=headers
     )
 

tests/test_client.py

@@ -42,8 +42,8 @@ def test_type_hints():
 
     hints = get_type_hints(create_client)
 
-    assert hints["url"] == str
+    assert hints["url"] is str
     assert hints["headers"] == dict[str, str]
-    assert hints["is_async"] == bool
-    assert hints["verify"] == bool
+    assert hints["is_async"] is bool
+    assert hints["verify"] is bool
     assert hints["return"] == Union[AsyncFunctionsClient, SyncFunctionsClient]