contextbase-base-client 0.5.0__py3-none-any.whl

base_client/sync_state/client.py

@@ -0,0 +1,206 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.binding_state_response import BindingStateResponse
+from .raw_client import AsyncRawSyncStateClient, RawSyncStateClient
+from .types.sync_state_input_bindings_value import SyncStateInputBindingsValue
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SyncStateClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawSyncStateClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawSyncStateClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSyncStateClient
+        """
+        return self._raw_client
+
+    def get_sync_state(
+        self, base_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> BindingStateResponse:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BindingStateResponse
+            Per-binding sync state.
+
+        Examples
+        --------
+        from base_client import BaseAPIClient
+
+        client = BaseAPIClient(
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.sync_state.get_sync_state(
+            base_id="base_id",
+        )
+        """
+        _response = self._raw_client.get_sync_state(base_id, request_options=request_options)
+        return _response.data
+
+    def report_sync_state(
+        self,
+        base_id: str,
+        *,
+        bindings: typing.Dict[str, SyncStateInputBindingsValue],
+        version: float,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        bindings : typing.Dict[str, SyncStateInputBindingsValue]
+
+        version : float
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from base_client import BaseAPIClient
+        from base_client.sync_state import SyncStateInputBindingsValue
+
+        client = BaseAPIClient(
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.sync_state.report_sync_state(
+            base_id="base_id",
+            bindings={"key": SyncStateInputBindingsValue()},
+            version=1.1,
+        )
+        """
+        _response = self._raw_client.report_sync_state(
+            base_id, bindings=bindings, version=version, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncSyncStateClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawSyncStateClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawSyncStateClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSyncStateClient
+        """
+        return self._raw_client
+
+    async def get_sync_state(
+        self, base_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> BindingStateResponse:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BindingStateResponse
+            Per-binding sync state.
+
+        Examples
+        --------
+        import asyncio
+
+        from base_client import AsyncBaseAPIClient
+
+        client = AsyncBaseAPIClient(
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.sync_state.get_sync_state(
+                base_id="base_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_sync_state(base_id, request_options=request_options)
+        return _response.data
+
+    async def report_sync_state(
+        self,
+        base_id: str,
+        *,
+        bindings: typing.Dict[str, SyncStateInputBindingsValue],
+        version: float,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        bindings : typing.Dict[str, SyncStateInputBindingsValue]
+
+        version : float
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from base_client import AsyncBaseAPIClient
+        from base_client.sync_state import SyncStateInputBindingsValue
+
+        client = AsyncBaseAPIClient(
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.sync_state.report_sync_state(
+                base_id="base_id",
+                bindings={"key": SyncStateInputBindingsValue()},
+                version=1.1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.report_sync_state(
+            base_id, bindings=bindings, version=version, request_options=request_options
+        )
+        return _response.data

base_client/sync_state/raw_client.py

@@ -0,0 +1,280 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import encode_path_param
+from ..core.parse_error import ParsingError
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..errors.bad_request_error import BadRequestError
+from ..errors.forbidden_error import ForbiddenError
+from ..types.binding_state_response import BindingStateResponse
+from ..types.error import Error
+from .types.sync_state_input_bindings_value import SyncStateInputBindingsValue
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawSyncStateClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_sync_state(
+        self, base_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[BindingStateResponse]:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[BindingStateResponse]
+            Per-binding sync state.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"base/bases/{encode_path_param(base_id)}/sync-state",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    BindingStateResponse,
+                    parse_obj_as(
+                        type_=BindingStateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def report_sync_state(
+        self,
+        base_id: str,
+        *,
+        bindings: typing.Dict[str, SyncStateInputBindingsValue],
+        version: float,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[None]:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        bindings : typing.Dict[str, SyncStateInputBindingsValue]
+
+        version : float
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[None]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"base/bases/{encode_path_param(base_id)}/sync-state",
+            method="POST",
+            json={
+                "bindings": convert_and_respect_annotation_metadata(
+                    object_=bindings, annotation=typing.Dict[str, SyncStateInputBindingsValue], direction="write"
+                ),
+                "version": version,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return HttpResponse(response=_response, data=None)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawSyncStateClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_sync_state(
+        self, base_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[BindingStateResponse]:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[BindingStateResponse]
+            Per-binding sync state.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"base/bases/{encode_path_param(base_id)}/sync-state",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    BindingStateResponse,
+                    parse_obj_as(
+                        type_=BindingStateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def report_sync_state(
+        self,
+        base_id: str,
+        *,
+        bindings: typing.Dict[str, SyncStateInputBindingsValue],
+        version: float,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[None]:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        bindings : typing.Dict[str, SyncStateInputBindingsValue]
+
+        version : float
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[None]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"base/bases/{encode_path_param(base_id)}/sync-state",
+            method="POST",
+            json={
+                "bindings": convert_and_respect_annotation_metadata(
+                    object_=bindings, annotation=typing.Dict[str, SyncStateInputBindingsValue], direction="write"
+                ),
+                "version": version,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return AsyncHttpResponse(response=_response, data=None)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

base_client/sync_state/types/__init__.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .sync_state_input_bindings_value import SyncStateInputBindingsValue
+_dynamic_imports: typing.Dict[str, str] = {"SyncStateInputBindingsValue": ".sync_state_input_bindings_value"}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["SyncStateInputBindingsValue"]

base_client/sync_state/types/sync_state_input_bindings_value.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...types.run_status import RunStatus
+
+
+class SyncStateInputBindingsValue(UniversalBaseModel):
+    frontier: typing.Optional[dt.datetime] = None
+    last_run: typing.Optional[dt.datetime] = None
+    last_run_status: typing.Optional[RunStatus] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

base_client/tests/conftest.py

@@ -0,0 +1,21 @@
+import pytest
+
+
+def _has_httpx_aiohttp() -> bool:
+    """Check if httpx_aiohttp is importable."""
+    try:
+        import httpx_aiohttp  # type: ignore[import-not-found]  # noqa: F401
+
+        return True
+    except ImportError:
+        return False
+
+
+def pytest_collection_modifyitems(config: pytest.Config, items: list) -> None:
+    """Auto-skip @pytest.mark.aiohttp tests when httpx_aiohttp is not installed."""
+    if _has_httpx_aiohttp():
+        return
+    skip_aiohttp = pytest.mark.skip(reason="httpx_aiohttp not installed")
+    for item in items:
+        if "aiohttp" in item.keywords:
+            item.add_marker(skip_aiohttp)

base_client/tests/test_aiohttp_autodetect.py

@@ -0,0 +1,113 @@
+import importlib
+import sys
+import unittest
+from unittest import mock
+
+import httpx
+import pytest
+
+
+class TestMakeDefaultAsyncClientWithoutAiohttp(unittest.TestCase):
+    """Tests for _make_default_async_client when httpx_aiohttp is NOT installed."""
+
+    def test_returns_httpx_async_client(self) -> None:
+        """When httpx_aiohttp is not installed, returns plain httpx.AsyncClient."""
+        with mock.patch.dict(sys.modules, {"httpx_aiohttp": None}):
+            from base_client.client import _make_default_async_client
+
+            client = _make_default_async_client(timeout=60, follow_redirects=True)
+            self.assertIsInstance(client, httpx.AsyncClient)
+            self.assertEqual(client.timeout.read, 60)
+            self.assertTrue(client.follow_redirects)
+
+    def test_follow_redirects_none(self) -> None:
+        """When follow_redirects is None, omits it from httpx.AsyncClient."""
+        with mock.patch.dict(sys.modules, {"httpx_aiohttp": None}):
+            from base_client.client import _make_default_async_client
+
+            client = _make_default_async_client(timeout=60, follow_redirects=None)
+            self.assertIsInstance(client, httpx.AsyncClient)
+            self.assertFalse(client.follow_redirects)
+
+    def test_explicit_httpx_client_bypasses_autodetect(self) -> None:
+        """When user passes httpx_client explicitly, _make_default_async_client is not called."""
+
+        explicit_client = httpx.AsyncClient(timeout=120)
+        with mock.patch("base_client.client._make_default_async_client") as mock_make:
+            # Replicate the generated conditional: httpx_client if httpx_client is not None else _make_default_async_client(...)
+            result = explicit_client if explicit_client is not None else mock_make(timeout=60, follow_redirects=True)
+            mock_make.assert_not_called()
+        self.assertIs(result, explicit_client)
+
+
+@pytest.mark.aiohttp
+class TestMakeDefaultAsyncClientWithAiohttp(unittest.TestCase):
+    """Tests for _make_default_async_client when httpx_aiohttp IS installed."""
+
+    def test_returns_aiohttp_client(self) -> None:
+        """When httpx_aiohttp is installed, returns HttpxAiohttpClient."""
+        import httpx_aiohttp  # type: ignore[import-not-found]
+        from base_client.client import _make_default_async_client
+
+        client = _make_default_async_client(timeout=60, follow_redirects=True)
+        self.assertIsInstance(client, httpx_aiohttp.HttpxAiohttpClient)
+        self.assertEqual(client.timeout.read, 60)
+        self.assertTrue(client.follow_redirects)
+
+    def test_follow_redirects_none(self) -> None:
+        """When httpx_aiohttp is installed and follow_redirects is None, omits it."""
+        import httpx_aiohttp  # type: ignore[import-not-found]
+        from base_client.client import _make_default_async_client
+
+        client = _make_default_async_client(timeout=60, follow_redirects=None)
+        self.assertIsInstance(client, httpx_aiohttp.HttpxAiohttpClient)
+        self.assertFalse(client.follow_redirects)
+
+
+class TestDefaultClientsWithoutAiohttp(unittest.TestCase):
+    """Tests for _default_clients.py convenience classes (no aiohttp)."""
+
+    def test_default_async_httpx_client_defaults(self) -> None:
+        """DefaultAsyncHttpxClient applies SDK defaults."""
+        from base_client._default_clients import SDK_DEFAULT_TIMEOUT, DefaultAsyncHttpxClient
+
+        client = DefaultAsyncHttpxClient()
+        self.assertIsInstance(client, httpx.AsyncClient)
+        self.assertEqual(client.timeout.read, SDK_DEFAULT_TIMEOUT)
+        self.assertTrue(client.follow_redirects)
+
+    def test_default_async_httpx_client_overrides(self) -> None:
+        """DefaultAsyncHttpxClient allows overriding defaults."""
+        from base_client._default_clients import DefaultAsyncHttpxClient
+
+        client = DefaultAsyncHttpxClient(timeout=30, follow_redirects=False)
+        self.assertEqual(client.timeout.read, 30)
+        self.assertFalse(client.follow_redirects)
+
+    def test_default_aiohttp_client_raises_without_package(self) -> None:
+        """DefaultAioHttpClient raises RuntimeError when httpx_aiohttp not installed."""
+        import base_client._default_clients
+
+        with mock.patch.dict(sys.modules, {"httpx_aiohttp": None}):
+            importlib.reload(base_client._default_clients)
+
+            with self.assertRaises(RuntimeError) as ctx:
+                base_client._default_clients.DefaultAioHttpClient()
+            self.assertIn("pip install base_client[aiohttp]", str(ctx.exception))
+
+        importlib.reload(base_client._default_clients)
+
+
+@pytest.mark.aiohttp
+class TestDefaultClientsWithAiohttp(unittest.TestCase):
+    """Tests for _default_clients.py when httpx_aiohttp IS installed."""
+
+    def test_default_aiohttp_client_defaults(self) -> None:
+        """DefaultAioHttpClient works when httpx_aiohttp is installed."""
+        import httpx_aiohttp  # type: ignore[import-not-found]
+        from base_client._default_clients import SDK_DEFAULT_TIMEOUT, DefaultAioHttpClient
+
+        client = DefaultAioHttpClient()
+        self.assertIsInstance(client, httpx_aiohttp.HttpxAiohttpClient)
+        self.assertEqual(client.timeout.read, SDK_DEFAULT_TIMEOUT)
+        self.assertTrue(client.follow_redirects)