Skip to content

Commit 6539e16

Browse files
silentworkssilentworks
authored
feat: allow injection of httpx client (#1117)
1 parent cde2056 commit 6539e16

File tree

9 files changed

+368
-56
lines changed

9 files changed

+368
-56
lines changed

‎Makefile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,7 @@ build_sync:
2121
sed -i 's/asynch/synch/g' supabase/_sync/auth_client.py
2222
sed -i 's/Async/Sync/g' supabase/_sync/auth_client.py
2323
sed -i 's/Async/Sync/g' supabase/_sync/client.py
24+
sed -i 's/create_async_client/create_client/g' tests/_sync/test_client.py
25+
sed -i 's/SyncClient/Client/gi' tests/_sync/test_client.py
26+
sed -i 's/SyncHTTPTransport/HTTPTransport/g' tests/_sync/test_client.py
27+
sed -i 's/SyncMock/Mock/g' tests/_sync/test_client.py

‎supabase/__init__.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@
2020
from ._async.client import AsyncClient as AClient
2121
from ._async.client import AsyncStorageClient as ASupabaseStorageClient
2222
from ._async.client import SupabaseException as ASupabaseException
23+
from ._async.client import SupabaseException as AsyncSupabaseException
2324
from ._async.client import create_client as acreate_client
2425
from ._async.client import create_client as create_async_client
2526

2627
# Sync Client
2728
from ._sync.auth_client import SyncSupabaseAuthClient as SupabaseAuthClient
2829
from ._sync.client import SupabaseException
30+
from ._sync.client import SupabaseException as SyncSupabaseException
2931
from ._sync.client import SyncClient as Client
3032
from ._sync.client import SyncStorageClient as SupabaseStorageClient
3133
from ._sync.client import create_client
@@ -71,4 +73,6 @@
7173
"NotConnectedError",
7274
"SupabaseException",
7375
"ASupabaseException",
76+
"AsyncSupabaseException",
77+
"SyncSupabaseException",
7478
)

‎supabase/_async/client.py‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
from supafunc import AsyncFunctionsClient
1818

1919
from ..lib.client_options import AsyncClientOptions as ClientOptions
20+
from ..lib.client_options import AsyncHttpxClient
2021
from .auth_client import AsyncSupabaseAuthClient
2122

2223

@@ -174,6 +175,7 @@ def postgrest(self):
174175
headers=self.options.headers,
175176
schema=self.options.schema,
176177
timeout=self.options.postgrest_client_timeout,
178+
http_client=self.options.httpx_client,
177179
)
178180

179181
return self._postgrest
@@ -185,16 +187,22 @@ def storage(self):
185187
storage_url=self.storage_url,
186188
headers=self.options.headers,
187189
storage_client_timeout=self.options.storage_client_timeout,
190+
http_client=self.options.httpx_client,
188191
)
189192
return self._storage
190193

191194
@property
192195
def functions(self):
193196
if self._functions is None:
194197
self._functions = AsyncFunctionsClient(
195-
self.functions_url,
196-
self.options.headers,
197-
self.options.function_client_timeout,
198+
url=self.functions_url,
199+
headers=self.options.headers,
200+
timeout=(
201+
self.options.function_client_timeout
202+
if self.options.httpx_client is None
203+
else None
204+
),
205+
http_client=self.options.httpx_client,
198206
)
199207
return self._functions
200208

@@ -232,9 +240,23 @@ def _init_storage_client(
232240
storage_client_timeout: int = DEFAULT_STORAGE_CLIENT_TIMEOUT,
233241
verify: bool = True,
234242
proxy: Optional[str] = None,
243+
http_client: Union[AsyncHttpxClient, None] = None,
235244
) -> AsyncStorageClient:
245+
if http_client is not None:
246+
# If an http client is provided, use it
247+
kwargs = {"http_client": http_client}
248+
else:
249+
kwargs = {
250+
"timeout": storage_client_timeout,
251+
"verify": verify,
252+
"proxy": proxy,
253+
"http_client": None,
254+
}
255+
236256
return AsyncStorageClient(
237-
storage_url, headers, storage_client_timeout, verify, proxy
257+
url=storage_url,
258+
headers=headers,
259+
**kwargs,
238260
)
239261

240262
@staticmethod
@@ -254,6 +276,7 @@ def _init_supabase_auth_client(
254276
flow_type=client_options.flow_type,
255277
verify=verify,
256278
proxy=proxy,
279+
http_client=client_options.httpx_client,
257280
)
258281

259282
@staticmethod
@@ -264,15 +287,25 @@ def _init_postgrest_client(
264287
timeout: Union[int, float, Timeout] = DEFAULT_POSTGREST_CLIENT_TIMEOUT,
265288
verify: bool = True,
266289
proxy: Optional[str] = None,
290+
http_client: Union[AsyncHttpxClient, None] = None,
267291
) -> AsyncPostgrestClient:
268292
"""Private helper for creating an instance of the Postgrest client."""
293+
if http_client is not None:
294+
# If an http client is provided, use it
295+
kwargs = {"http_client": http_client}
296+
else:
297+
kwargs = {
298+
"timeout": timeout,
299+
"verify": verify,
300+
"proxy": proxy,
301+
"http_client": None,
302+
}
303+
269304
return AsyncPostgrestClient(
270305
rest_url,
271306
headers=headers,
272307
schema=schema,
273-
timeout=timeout,
274-
verify=verify,
275-
proxy=proxy,
308+
**kwargs,
276309
)
277310

278311
def _create_auth_header(self, token: str):

‎supabase/_sync/client.py‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
from supafunc import SyncFunctionsClient
1717

1818
from ..lib.client_options import SyncClientOptions as ClientOptions
19+
from ..lib.client_options import SyncHttpxClient
1920
from .auth_client import SyncSupabaseAuthClient
2021

2122

@@ -173,6 +174,7 @@ def postgrest(self):
173174
headers=self.options.headers,
174175
schema=self.options.schema,
175176
timeout=self.options.postgrest_client_timeout,
177+
http_client=self.options.httpx_client,
176178
)
177179

178180
return self._postgrest
@@ -184,16 +186,22 @@ def storage(self):
184186
storage_url=self.storage_url,
185187
headers=self.options.headers,
186188
storage_client_timeout=self.options.storage_client_timeout,
189+
http_client=self.options.httpx_client,
187190
)
188191
return self._storage
189192

190193
@property
191194
def functions(self):
192195
if self._functions is None:
193196
self._functions = SyncFunctionsClient(
194-
self.functions_url,
195-
self.options.headers,
196-
self.options.function_client_timeout,
197+
url=self.functions_url,
198+
headers=self.options.headers,
199+
timeout=(
200+
self.options.function_client_timeout
201+
if self.options.httpx_client is None
202+
else None
203+
),
204+
http_client=self.options.httpx_client,
197205
)
198206
return self._functions
199207

@@ -231,9 +239,23 @@ def _init_storage_client(
231239
storage_client_timeout: int = DEFAULT_STORAGE_CLIENT_TIMEOUT,
232240
verify: bool = True,
233241
proxy: Optional[str] = None,
242+
http_client: Union[SyncHttpxClient, None] = None,
234243
) -> SyncStorageClient:
244+
if http_client is not None:
245+
# If an http client is provided, use it
246+
kwargs = {"http_client": http_client}
247+
else:
248+
kwargs = {
249+
"timeout": storage_client_timeout,
250+
"verify": verify,
251+
"proxy": proxy,
252+
"http_client": None,
253+
}
254+
235255
return SyncStorageClient(
236-
storage_url, headers, storage_client_timeout, verify, proxy
256+
url=storage_url,
257+
headers=headers,
258+
**kwargs,
237259
)
238260

239261
@staticmethod
@@ -253,6 +275,7 @@ def _init_supabase_auth_client(
253275
flow_type=client_options.flow_type,
254276
verify=verify,
255277
proxy=proxy,
278+
http_client=client_options.httpx_client,
256279
)
257280

258281
@staticmethod
@@ -263,15 +286,25 @@ def _init_postgrest_client(
263286
timeout: Union[int, float, Timeout] = DEFAULT_POSTGREST_CLIENT_TIMEOUT,
264287
verify: bool = True,
265288
proxy: Optional[str] = None,
289+
http_client: Union[SyncHttpxClient, None] = None,
266290
) -> SyncPostgrestClient:
267291
"""Private helper for creating an instance of the Postgrest client."""
292+
if http_client is not None:
293+
# If an http client is provided, use it
294+
kwargs = {"http_client": http_client}
295+
else:
296+
kwargs = {
297+
"timeout": timeout,
298+
"verify": verify,
299+
"proxy": proxy,
300+
"http_client": None,
301+
}
302+
268303
return SyncPostgrestClient(
269304
rest_url,
270305
headers=headers,
271306
schema=schema,
272-
timeout=timeout,
273-
verify=verify,
274-
proxy=proxy,
307+
**kwargs,
275308
)
276309

277310
def _create_auth_header(self, token: str):

‎supabase/lib/client_options.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
SyncMemoryStorage,
99
SyncSupportedStorage,
1010
)
11+
from httpx import AsyncClient as AsyncHttpxClient
12+
from httpx import Client as SyncHttpxClient
1113
from httpx import Timeout
1214
from postgrest.constants import DEFAULT_POSTGREST_CLIENT_TIMEOUT
1315
from storage3.constants import DEFAULT_TIMEOUT as DEFAULT_STORAGE_CLIENT_TIMEOUT
@@ -43,6 +45,9 @@ class ClientOptions:
4345
realtime: Optional[RealtimeClientOptions] = None
4446
"""Options passed to the realtime-py instance"""
4547

48+
httpx_client: Optional[SyncHttpxClient] = None
49+
"""httpx client instance to be used by the PostgREST, functions, auth and storage clients."""
50+
4651
postgrest_client_timeout: Union[int, float, Timeout] = (
4752
DEFAULT_POSTGREST_CLIENT_TIMEOUT
4853
)
@@ -67,6 +72,7 @@ def replace(
6772
persist_session: Optional[bool] = None,
6873
storage: Optional[SyncSupportedStorage] = None,
6974
realtime: Optional[RealtimeClientOptions] = None,
75+
httpx_client: Optional[SyncHttpxClient] = None,
7076
postgrest_client_timeout: Union[
7177
int, float, Timeout
7278
] = DEFAULT_POSTGREST_CLIENT_TIMEOUT,
@@ -85,6 +91,7 @@ def replace(
8591
client_options.persist_session = persist_session or self.persist_session
8692
client_options.storage = storage or self.storage
8793
client_options.realtime = realtime or self.realtime
94+
client_options.httpx_client = httpx_client or self.httpx_client
8895
client_options.postgrest_client_timeout = (
8996
postgrest_client_timeout or self.postgrest_client_timeout
9097
)
@@ -100,6 +107,9 @@ class AsyncClientOptions(ClientOptions):
100107
storage: AsyncSupportedStorage = field(default_factory=AsyncMemoryStorage)
101108
"""A storage provider. Used to store the logged in session."""
102109

110+
httpx_client: Optional[AsyncHttpxClient] = None
111+
"""httpx client instance to be used by the PostgREST, functions, auth and storage clients."""
112+
103113
def replace(
104114
self,
105115
schema: Optional[str] = None,
@@ -108,6 +118,7 @@ def replace(
108118
persist_session: Optional[bool] = None,
109119
storage: Optional[AsyncSupportedStorage] = None,
110120
realtime: Optional[RealtimeClientOptions] = None,
121+
httpx_client: Optional[AsyncHttpxClient] = None,
111122
postgrest_client_timeout: Union[
112123
int, float, Timeout
113124
] = DEFAULT_POSTGREST_CLIENT_TIMEOUT,
@@ -126,6 +137,7 @@ def replace(
126137
client_options.persist_session = persist_session or self.persist_session
127138
client_options.storage = storage or self.storage
128139
client_options.realtime = realtime or self.realtime
140+
client_options.httpx_client = httpx_client or self.httpx_client
129141
client_options.postgrest_client_timeout = (
130142
postgrest_client_timeout or self.postgrest_client_timeout
131143
)
@@ -146,6 +158,7 @@ def replace(
146158
persist_session: Optional[bool] = None,
147159
storage: Optional[SyncSupportedStorage] = None,
148160
realtime: Optional[RealtimeClientOptions] = None,
161+
httpx_client: Optional[SyncHttpxClient] = None,
149162
postgrest_client_timeout: Union[
150163
int, float, Timeout
151164
] = DEFAULT_POSTGREST_CLIENT_TIMEOUT,
@@ -164,6 +177,7 @@ def replace(
164177
client_options.persist_session = persist_session or self.persist_session
165178
client_options.storage = storage or self.storage
166179
client_options.realtime = realtime or self.realtime
180+
client_options.httpx_client = httpx_client or self.httpx_client
167181
client_options.postgrest_client_timeout = (
168182
postgrest_client_timeout or self.postgrest_client_timeout
169183
)

‎tests/_async/__init__.py‎

Whitespace-only changes.

0 commit comments

Comments
 (0)