diff --git a/.stats.yml b/.stats.yml index 69d1c49..ef8559f 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/opencode%2Fopencode-b4a3f35e4a44e5a5034508ced15d7b44c1924000062e0f5293797413d26ee412.yml openapi_spec_hash: f17b1091020f90126e6cefc2d38ff85f -config_hash: 1156f6f6fb7245e7b021daddf23153e3 +config_hash: e2d21e779cfc4e26a99b9e4e75de3f50 diff --git a/README.md b/README.md index 5066f50..47fa0b6 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,32 @@ async def main() -> None: asyncio.run(main()) ``` +## Streaming responses + +We provide support for streaming responses using Server Side Events (SSE). + +```python +from opencode_ai import Opencode + +client = Opencode() + +stream = client.event.list() +for events in stream: + print(events) +``` + +The async client uses the exact same interface. + +```python +from opencode_ai import AsyncOpencode + +client = AsyncOpencode() + +stream = await client.event.list() +async for events in stream: + print(events) +``` + ## Using types Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like: diff --git a/src/opencode_ai/_client.py b/src/opencode_ai/_client.py index 0271192..c97685d 100644 --- a/src/opencode_ai/_client.py +++ b/src/opencode_ai/_client.py @@ -92,6 +92,8 @@ class Opencode(SyncAPIClient): _strict_response_validation=_strict_response_validation, ) + self._default_stream_cls = Stream + self.event = event.EventResource(self) self.app = app.AppResource(self) self.file = file.FileResource(self) @@ -247,6 +249,8 @@ class AsyncOpencode(AsyncAPIClient): _strict_response_validation=_strict_response_validation, ) + self._default_stream_cls = AsyncStream + self.event = event.AsyncEventResource(self) self.app = app.AsyncAppResource(self) self.file = file.AsyncFileResource(self) diff --git a/src/opencode_ai/resources/event.py b/src/opencode_ai/resources/event.py index 2025eb3..3e9baa3 100644 --- a/src/opencode_ai/resources/event.py +++ b/src/opencode_ai/resources/event.py @@ -15,6 +15,7 @@ from .._response import ( async_to_raw_response_wrapper, async_to_streamed_response_wrapper, ) +from .._streaming import Stream, AsyncStream from .._base_client import make_request_options from ..types.event_list_response import EventListResponse @@ -50,17 +51,16 @@ class EventResource(SyncAPIResource): extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, - ) -> EventListResponse: + ) -> Stream[EventListResponse]: """Get events""" - return cast( - EventListResponse, - self._get( - "/event", - options=make_request_options( - extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout - ), - cast_to=cast(Any, EventListResponse), # Union types cannot be passed in as arguments in the type system + return self._get( + "/event", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), + cast_to=cast(Any, EventListResponse), # Union types cannot be passed in as arguments in the type system + stream=True, + stream_cls=Stream[EventListResponse], ) @@ -93,17 +93,16 @@ class AsyncEventResource(AsyncAPIResource): extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, - ) -> EventListResponse: + ) -> AsyncStream[EventListResponse]: """Get events""" - return cast( - EventListResponse, - await self._get( - "/event", - options=make_request_options( - extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout - ), - cast_to=cast(Any, EventListResponse), # Union types cannot be passed in as arguments in the type system + return await self._get( + "/event", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), + cast_to=cast(Any, EventListResponse), # Union types cannot be passed in as arguments in the type system + stream=True, + stream_cls=AsyncStream[EventListResponse], ) diff --git a/tests/api_resources/test_event.py b/tests/api_resources/test_event.py index 21c167c..ec909e9 100644 --- a/tests/api_resources/test_event.py +++ b/tests/api_resources/test_event.py @@ -8,8 +8,6 @@ from typing import Any, cast import pytest from opencode_ai import Opencode, AsyncOpencode -from tests.utils import assert_matches_type -from opencode_ai.types import EventListResponse base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") @@ -20,18 +18,17 @@ class TestEvent: @pytest.mark.skip() @parametrize def test_method_list(self, client: Opencode) -> None: - event = client.event.list() - assert_matches_type(EventListResponse, event, path=["response"]) + event_stream = client.event.list() + event_stream.response.close() @pytest.mark.skip() @parametrize def test_raw_response_list(self, client: Opencode) -> None: response = client.event.with_raw_response.list() - assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" - event = response.parse() - assert_matches_type(EventListResponse, event, path=["response"]) + stream = response.parse() + stream.close() @pytest.mark.skip() @parametrize @@ -40,8 +37,8 @@ class TestEvent: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" - event = response.parse() - assert_matches_type(EventListResponse, event, path=["response"]) + stream = response.parse() + stream.close() assert cast(Any, response.is_closed) is True @@ -54,18 +51,17 @@ class TestAsyncEvent: @pytest.mark.skip() @parametrize async def test_method_list(self, async_client: AsyncOpencode) -> None: - event = await async_client.event.list() - assert_matches_type(EventListResponse, event, path=["response"]) + event_stream = await async_client.event.list() + await event_stream.response.aclose() @pytest.mark.skip() @parametrize async def test_raw_response_list(self, async_client: AsyncOpencode) -> None: response = await async_client.event.with_raw_response.list() - assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" - event = await response.parse() - assert_matches_type(EventListResponse, event, path=["response"]) + stream = await response.parse() + await stream.close() @pytest.mark.skip() @parametrize @@ -74,7 +70,7 @@ class TestAsyncEvent: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" - event = await response.parse() - assert_matches_type(EventListResponse, event, path=["response"]) + stream = await response.parse() + await stream.close() assert cast(Any, response.is_closed) is True diff --git a/tests/test_client.py b/tests/test_client.py index 0e900dd..0cf7c41 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -24,6 +24,7 @@ from pydantic import ValidationError from opencode_ai import Opencode, AsyncOpencode, APIResponseValidationError from opencode_ai._types import Omit from opencode_ai._models import BaseModel, FinalRequestOptions +from opencode_ai._streaming import Stream, AsyncStream from opencode_ai._exceptions import APIStatusError, APITimeoutError, APIResponseValidationError from opencode_ai._base_client import ( DEFAULT_TIMEOUT, @@ -624,6 +625,17 @@ class TestOpencode: with pytest.raises(TypeError, match=r"max_retries cannot be None"): Opencode(base_url=base_url, _strict_response_validation=True, max_retries=cast(Any, None)) + @pytest.mark.respx(base_url=base_url) + def test_default_stream_cls(self, respx_mock: MockRouter) -> None: + class Model(BaseModel): + name: str + + respx_mock.post("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + stream = self.client.post("/foo", cast_to=Model, stream=True, stream_cls=Stream[Model]) + assert isinstance(stream, Stream) + stream.response.close() + @pytest.mark.respx(base_url=base_url) def test_received_text_for_expected_json(self, respx_mock: MockRouter) -> None: class Model(BaseModel): @@ -1390,6 +1402,18 @@ class TestAsyncOpencode: with pytest.raises(TypeError, match=r"max_retries cannot be None"): AsyncOpencode(base_url=base_url, _strict_response_validation=True, max_retries=cast(Any, None)) + @pytest.mark.respx(base_url=base_url) + @pytest.mark.asyncio + async def test_default_stream_cls(self, respx_mock: MockRouter) -> None: + class Model(BaseModel): + name: str + + respx_mock.post("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"})) + + stream = await self.client.post("/foo", cast_to=Model, stream=True, stream_cls=AsyncStream[Model]) + assert isinstance(stream, AsyncStream) + await stream.response.aclose() + @pytest.mark.respx(base_url=base_url) @pytest.mark.asyncio async def test_received_text_for_expected_json(self, respx_mock: MockRouter) -> None: