feat: add timeout as a parameter of clients (#75)

* feat: add timeout as a parameter of clients

This feature is for evicting the use of the default timeout of httpx.

* feat: use union and constants default value for timeout

Author: leynier

postgrest_py/__init__.py

@@ -2,6 +2,8 @@
 
 __version__ = "0.7.1"
 
+from httpx import Timeout
+
 from ._async.client import AsyncPostgrestClient
 from ._async.request_builder import (
     AsyncFilterRequestBuilder,

postgrest_py/_async/client.py

@@ -1,12 +1,16 @@
 from __future__ import annotations
 
-from typing import Dict, cast
+from typing import Dict, Union, cast
 
 from deprecation import deprecated
-from httpx import Response
+from httpx import Response, Timeout
 
 from .. import __version__
-from ..base_client import DEFAULT_POSTGREST_CLIENT_HEADERS, BasePostgrestClient
+from ..base_client import (
+    DEFAULT_POSTGREST_CLIENT_HEADERS,
+    DEFAULT_POSTGREST_CLIENT_TIMEOUT,
+    BasePostgrestClient,
+)
 from ..utils import AsyncClient
 from .request_builder import AsyncRequestBuilder
 
@@ -20,16 +24,28 @@ def __init__(
         *,
         schema: str = "public",
         headers: Dict[str, str] = DEFAULT_POSTGREST_CLIENT_HEADERS,
+        timeout: Union[int, float, Timeout] = DEFAULT_POSTGREST_CLIENT_TIMEOUT,
     ) -> None:
-        BasePostgrestClient.__init__(self, base_url, schema=schema, headers=headers)
+        BasePostgrestClient.__init__(
+            self,
+            base_url,
+            schema=schema,
+            headers=headers,
+            timeout=timeout,
+        )
         self.session = cast(AsyncClient, self.session)
 
     def create_session(
         self,
         base_url: str,
         headers: Dict[str, str],
+        timeout: Union[int, float, Timeout],
     ) -> AsyncClient:
-        return AsyncClient(base_url=base_url, headers=headers)
+        return AsyncClient(
+            base_url=base_url,
+            headers=headers,
+            timeout=timeout,
+        )
 
     async def __aenter__(self) -> "AsyncPostgrestClient":
         return self
@@ -44,7 +60,7 @@ def from_(self, table: str) -> AsyncRequestBuilder:
         """Perform a table operation."""
         base_url = str(self.session.base_url)
         headers = dict(self.session.headers.items())
-        session = self.create_session(base_url, headers)
+        session = self.create_session(base_url, headers, self.session.timeout)
         session.auth = self.session.auth
         return AsyncRequestBuilder(session, f"/{table}")
 

postgrest_py/_sync/client.py

@@ -1,12 +1,16 @@
 from __future__ import annotations
 
-from typing import Dict, cast
+from typing import Dict, Union, cast
 
 from deprecation import deprecated
-from httpx import Response
+from httpx import Response, Timeout
 
 from .. import __version__
-from ..base_client import DEFAULT_POSTGREST_CLIENT_HEADERS, BasePostgrestClient
+from ..base_client import (
+    DEFAULT_POSTGREST_CLIENT_HEADERS,
+    DEFAULT_POSTGREST_CLIENT_TIMEOUT,
+    BasePostgrestClient,
+)
 from ..utils import SyncClient
 from .request_builder import SyncRequestBuilder
 
@@ -20,16 +24,28 @@ def __init__(
         *,
         schema: str = "public",
         headers: Dict[str, str] = DEFAULT_POSTGREST_CLIENT_HEADERS,
+        timeout: Union[int, float, Timeout] = DEFAULT_POSTGREST_CLIENT_TIMEOUT,
     ) -> None:
-        BasePostgrestClient.__init__(self, base_url, schema=schema, headers=headers)
+        BasePostgrestClient.__init__(
+            self,
+            base_url,
+            schema=schema,
+            headers=headers,
+            timeout=timeout,
+        )
         self.session = cast(SyncClient, self.session)
 
     def create_session(
         self,
         base_url: str,
         headers: Dict[str, str],
+        timeout: Union[int, float, Timeout],
     ) -> SyncClient:
-        return SyncClient(base_url=base_url, headers=headers)
+        return SyncClient(
+            base_url=base_url,
+            headers=headers,
+            timeout=timeout,
+        )
 
     def __enter__(self) -> SyncPostgrestClient:
         return self
@@ -44,7 +60,7 @@ def from_(self, table: str) -> SyncRequestBuilder:
         """Perform a table operation."""
         base_url = str(self.session.base_url)
         headers = dict(self.session.headers.items())
-        session = self.create_session(base_url, headers)
+        session = self.create_session(base_url, headers, self.session.timeout)
         session.auth = self.session.auth
         return SyncRequestBuilder(session, f"/{table}")
 

postgrest_py/base_client.py

@@ -3,7 +3,7 @@
 from abc import ABC, abstractmethod
 from typing import Dict, Optional, Union
 
-from httpx import BasicAuth
+from httpx import BasicAuth, Timeout
 
 from .utils import AsyncClient, SyncClient
 
@@ -12,23 +12,33 @@
     "Content-Type": "application/json",
 }
 
+DEFAULT_POSTGREST_CLIENT_TIMEOUT: int = 5
+
 
 class BasePostgrestClient(ABC):
     """Base PostgREST client."""
 
-    def __init__(self, base_url: str, *, schema: str, headers: Dict[str, str]) -> None:
+    def __init__(
+        self,
+        base_url: str,
+        *,
+        schema: str,
+        headers: Dict[str, str],
+        timeout: Union[int, float, Timeout],
+    ) -> None:
         headers = {
             **headers,
             "Accept-Profile": schema,
             "Content-Profile": schema,
         }
-        self.session = self.create_session(base_url, headers)
+        self.session = self.create_session(base_url, headers, timeout)
 
     @abstractmethod
     def create_session(
         self,
         base_url: str,
         headers: Dict[str, str],
+        timeout: Union[int, float, Timeout],
     ) -> Union[SyncClient, AsyncClient]:
         raise NotImplementedError()