opencode-python-sdk 0.1.3__tar.gz → 0.2.0__tar.gz

{opencode_python_sdk-0.1.3 → opencode_python_sdk-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: opencode-python-sdk
-Version: 0.1.3
+Version: 0.2.0
 Summary: Typed Python client for the OpenCode 2.x server API
 Project-URL: Homepage, https://github.com/shrijayan/opencode-python-sdk
 Project-URL: Documentation, https://shrijayan.github.io/opencode-python-sdk/
@@ -350,6 +350,55 @@ client.session.get("ses_...", timeout=5.0)  # per call
 
 The default timeout is 10 minutes with a 10 second connect timeout.
 
+## Running an agent headless
+
+`client.session.run` does the usual "prompt an agent and wait" round trip in one call: it creates a session (or
+reuses `session_id`), sends the prompt, blocks until the session is idle, and returns the new messages with the
+final text and usage. `client.wait_until_ready` waits until agents and MCP servers have loaded, which happens
+asynchronously after the server boots. Both have async versions on `AsyncOpencode`.
+
+```python
+from opencode import Opencode
+from opencode.types import ModelRef, PromptInputFileAttachment
+
+with Opencode("http://127.0.0.1:4096", password="...") as client:
+    client.wait_until_ready(agents=["reviewer"], mcp_servers=["github"], timeout=60)
+    result = client.session.run(
+        "Review the attached diff",
+        agent="reviewer",
+        model=ModelRef(provider_id="anthropic", id="claude-sonnet-5-5"),  # set it with the agent
+        files=[PromptInputFileAttachment(uri="data:text/plain;base64,...", name="diff.patch")],
+        timeout=600,
+    )
+    print(result.outcome, result.text)
+    print(result.cost, result.tokens.input, result.tokens.output)  # this run; result.session has the totals
+```
+
+If the wait ends early (Ctrl-C, task cancellation, `timeout`, a connection error), `run` interrupts the session
+on the server before re-raising, so the agent does not keep running unattended.
+
+## Testing your code
+
+`opencode.testing.FakeServer` is an in-process fake of the server: an `httpx` transport that keeps sessions,
+messages and events in memory and answers with the same payloads as the real server. No process, no model.
+
+```python
+from opencode import Opencode
+from opencode.testing import FakeServer
+
+
+def test_summarize() -> None:
+    fake = FakeServer(reply=lambda prompt: f"summary of {prompt!r}")
+    client = Opencode.fake(fake)  # same as Opencode(transport=fake)
+
+    assert client.session.run("README").text == "summary of 'README'"
+    assert fake.prompts == ["README"]
+```
+
+`fake.fail(method, path_regex, status=..., exception=...)` injects errors, `fake.add_agent(..., after_polls=n)`
+and `fake.set_mcp_status(...)` simulate slow boots, and `fake.requests` records every request. Routes the fake
+does not implement answer `404`.
+
 ## Running a server
 
 `OpencodeServer` runs `opencode serve` as a child process on a free local port with a random password:

{opencode_python_sdk-0.1.3 → opencode_python_sdk-0.2.0}/README.md

@@ -313,6 +313,55 @@ client.session.get("ses_...", timeout=5.0)  # per call
 
 The default timeout is 10 minutes with a 10 second connect timeout.
 
+## Running an agent headless
+
+`client.session.run` does the usual "prompt an agent and wait" round trip in one call: it creates a session (or
+reuses `session_id`), sends the prompt, blocks until the session is idle, and returns the new messages with the
+final text and usage. `client.wait_until_ready` waits until agents and MCP servers have loaded, which happens
+asynchronously after the server boots. Both have async versions on `AsyncOpencode`.
+
+```python
+from opencode import Opencode
+from opencode.types import ModelRef, PromptInputFileAttachment
+
+with Opencode("http://127.0.0.1:4096", password="...") as client:
+    client.wait_until_ready(agents=["reviewer"], mcp_servers=["github"], timeout=60)
+    result = client.session.run(
+        "Review the attached diff",
+        agent="reviewer",
+        model=ModelRef(provider_id="anthropic", id="claude-sonnet-5-5"),  # set it with the agent
+        files=[PromptInputFileAttachment(uri="data:text/plain;base64,...", name="diff.patch")],
+        timeout=600,
+    )
+    print(result.outcome, result.text)
+    print(result.cost, result.tokens.input, result.tokens.output)  # this run; result.session has the totals
+```
+
+If the wait ends early (Ctrl-C, task cancellation, `timeout`, a connection error), `run` interrupts the session
+on the server before re-raising, so the agent does not keep running unattended.
+
+## Testing your code
+
+`opencode.testing.FakeServer` is an in-process fake of the server: an `httpx` transport that keeps sessions,
+messages and events in memory and answers with the same payloads as the real server. No process, no model.
+
+```python
+from opencode import Opencode
+from opencode.testing import FakeServer
+
+
+def test_summarize() -> None:
+    fake = FakeServer(reply=lambda prompt: f"summary of {prompt!r}")
+    client = Opencode.fake(fake)  # same as Opencode(transport=fake)
+
+    assert client.session.run("README").text == "summary of 'README'"
+    assert fake.prompts == ["README"]
+```
+
+`fake.fail(method, path_regex, status=..., exception=...)` injects errors, `fake.add_agent(..., after_polls=n)`
+and `fake.set_mcp_status(...)` simulate slow boots, and `fake.requests` records every request. Routes the fake
+does not implement answer `404`.
+
 ## Running a server
 
 `OpencodeServer` runs `opencode serve` as a child process on a free local port with a random password:

{opencode_python_sdk-0.1.3 → opencode_python_sdk-0.2.0}/src/opencode/__init__.py

@@ -14,7 +14,8 @@ Quick start::
 
 from __future__ import annotations
 
-from . import types
+from typing import TYPE_CHECKING, Any
+
 from ._client import AsyncOpencode, Opencode
 
 # <generated:error-imports>
@@ -108,6 +109,9 @@ from ._rpc import (
     rpc_method,
 )
 
+if TYPE_CHECKING:
+    from . import types
+
 # <generated:api-version>
 API_VERSION = "2.1.2"
 """The OpenCode server version this client was generated from."""
@@ -206,3 +210,12 @@ __all__ = [
     "WorktreeError",
     # </generated:error-exports>
 ]
+
+
+def __getattr__(name: str) -> Any:
+    # `opencode.types` builds several hundred models, so it is imported on first use rather than with the package.
+    if name == "types":
+        import importlib
+
+        return importlib.import_module(".types", __name__)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

{opencode_python_sdk-0.1.3 → opencode_python_sdk-0.2.0}/src/opencode/_base_client.py

@@ -7,6 +7,7 @@ transient failures, and turns responses into typed values or errors.
 from __future__ import annotations
 
 import base64
+import builtins
 import email.utils
 import functools
 import json
@@ -60,8 +61,18 @@ def _cached_adapter(tp: Any) -> pydantic.TypeAdapter[Any]:
     return pydantic.TypeAdapter(tp)
 
 
+@functools.cache
+def _resolve_type(expr: str) -> Any:
+    # Generated resources name their response types as strings, so `import opencode` does not build every model.
+    from . import types
+
+    return eval(expr, {**vars(types), "builtins": builtins})  # expressions come from the generator
+
+
 def type_adapter(tp: Any) -> pydantic.TypeAdapter[Any]:
-    """Returns a cached ``TypeAdapter`` for a response type."""
+    """Returns a cached ``TypeAdapter`` for a response type, or for a type expression over ``opencode.types``."""
+    if isinstance(tp, str):
+        tp = _resolve_type(tp)
     try:
         return _cached_adapter(tp)
     except TypeError:  # unhashable type expression
@@ -307,6 +318,7 @@ class SyncAPIClient(_BaseClient):
         default_headers: Mapping[str, str] | None,
         default_query: Mapping[str, object] | None,
         http_client: httpx.Client | None,
+        transport: httpx.BaseTransport | None = None,
     ) -> None:
         super().__init__(
             base_url=base_url,
@@ -319,7 +331,11 @@ class SyncAPIClient(_BaseClient):
             default_query=default_query,
         )
         self._owns_http = http_client is None
-        self._http = http_client or httpx.Client(limits=constants.DEFAULT_CONNECTION_LIMITS, follow_redirects=True)
+        if http_client is not None and transport is not None:
+            raise ValueError("Pass either http_client or transport, not both")
+        self._http = http_client or httpx.Client(
+            limits=constants.DEFAULT_CONNECTION_LIMITS, follow_redirects=True, transport=transport
+        )
 
     def close(self) -> None:
         """Closes the connection pool, unless it was passed in by the caller."""
@@ -421,6 +437,7 @@ class AsyncAPIClient(_BaseClient):
         default_headers: Mapping[str, str] | None,
         default_query: Mapping[str, object] | None,
         http_client: httpx.AsyncClient | None,
+        transport: httpx.AsyncBaseTransport | None = None,
     ) -> None:
         super().__init__(
             base_url=base_url,
@@ -433,7 +450,11 @@ class AsyncAPIClient(_BaseClient):
             default_query=default_query,
         )
         self._owns_http = http_client is None
-        self._http = http_client or httpx.AsyncClient(limits=constants.DEFAULT_CONNECTION_LIMITS, follow_redirects=True)
+        if http_client is not None and transport is not None:
+            raise ValueError("Pass either http_client or transport, not both")
+        self._http = http_client or httpx.AsyncClient(
+            limits=constants.DEFAULT_CONNECTION_LIMITS, follow_redirects=True, transport=transport
+        )
 
     async def close(self) -> None:
         """Closes the connection pool, unless it was passed in by the caller."""

{opencode_python_sdk-0.1.3 → opencode_python_sdk-0.2.0}/src/opencode/_client.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from typing_extensions import Self
 
@@ -14,12 +14,17 @@ from .resources import AsyncResources, SyncResources
 
 if TYPE_CHECKING:
     import os
-    from collections.abc import Mapping
+    from collections.abc import Iterable, Mapping
 
     import httpx
 
+    from .testing import FakeServer
+
 __all__ = ["AsyncOpencode", "Opencode"]
 
+FAKE_BASE_URL = "http://opencode.fake"
+"""Base URL of clients made by ``Opencode.fake()``."""
+
 
 class Opencode(SyncAPIClient, SyncResources):
     """Synchronous client for an OpenCode server.
@@ -38,6 +43,8 @@ class Opencode(SyncAPIClient, SyncResources):
         default_query: Query parameters sent with every request.
         http_client: A preconfigured ``httpx.Client`` (proxies, custom transports, event hooks). The caller keeps
             ownership and must close it.
+        transport: An ``httpx`` transport for the client's own connection pool, such as
+            :class:`opencode.testing.FakeServer`. Cannot be combined with ``http_client``.
 
     Example::
 
@@ -60,6 +67,7 @@ class Opencode(SyncAPIClient, SyncResources):
         default_headers: Mapping[str, str] | None = None,
         default_query: Mapping[str, object] | None = None,
         http_client: httpx.Client | None = None,
+        transport: httpx.BaseTransport | None = None,
     ) -> None:
         super().__init__(
             base_url=base_url,
@@ -71,6 +79,7 @@ class Opencode(SyncAPIClient, SyncResources):
             default_headers=default_headers,
             default_query=default_query,
             http_client=http_client,
+            transport=transport,
         )
 
     @cached_property
@@ -83,6 +92,33 @@ class Opencode(SyncAPIClient, SyncResources):
         """Plugin RPC calls: ``client.rpc.call(...)``, or ``client.rpc(Definition)`` for typed access."""
         return TypedRpcResource(self)
 
+    @classmethod
+    def fake(cls, server: FakeServer | None = None, **kwargs: Any) -> Self:
+        """Returns a client wired to an in-process :class:`opencode.testing.FakeServer`, for tests.
+
+        Pass your own ``server`` to configure replies and inspect requests; other arguments go to the constructor.
+        """
+        from .testing import FakeServer
+
+        kwargs.setdefault("password", "")
+        return cls(FAKE_BASE_URL, transport=server if server is not None else FakeServer(), **kwargs)
+
+    def wait_until_ready(
+        self, *, agents: Iterable[str] = (), mcp_servers: Iterable[str] = (), timeout: float = 60
+    ) -> None:
+        """Blocks until the server answers, the named ``agents`` are listed and the named ``mcp_servers`` are
+        connected.
+
+        Agents load asynchronously after the server starts, so call this before creating sessions on a freshly
+        booted server. Connection errors and 503s while the server boots count as not ready yet.
+
+        Raises:
+          TimeoutError: Something was still missing after ``timeout`` seconds. The message names it.
+        """
+        from .lib._ready import wait_until_ready
+
+        wait_until_ready(self, agents=agents, mcp_servers=mcp_servers, timeout=timeout)
+
     def with_options(
         self,
         *,
@@ -138,6 +174,7 @@ class AsyncOpencode(AsyncAPIClient, AsyncResources):
         default_headers: Mapping[str, str] | None = None,
         default_query: Mapping[str, object] | None = None,
         http_client: httpx.AsyncClient | None = None,
+        transport: httpx.AsyncBaseTransport | None = None,
     ) -> None:
         super().__init__(
             base_url=base_url,
@@ -149,6 +186,7 @@ class AsyncOpencode(AsyncAPIClient, AsyncResources):
             default_headers=default_headers,
             default_query=default_query,
             http_client=http_client,
+            transport=transport,
         )
 
     @cached_property
@@ -161,6 +199,33 @@ class AsyncOpencode(AsyncAPIClient, AsyncResources):
         """Plugin RPC calls: ``client.rpc.call(...)``, or ``client.rpc(Definition)`` for typed access."""
         return AsyncTypedRpcResource(self)
 
+    @classmethod
+    def fake(cls, server: FakeServer | None = None, **kwargs: Any) -> Self:
+        """Returns a client wired to an in-process :class:`opencode.testing.FakeServer`, for tests.
+
+        Pass your own ``server`` to configure replies and inspect requests; other arguments go to the constructor.
+        """
+        from .testing import FakeServer
+
+        kwargs.setdefault("password", "")
+        return cls(FAKE_BASE_URL, transport=server if server is not None else FakeServer(), **kwargs)
+
+    async def wait_until_ready(
+        self, *, agents: Iterable[str] = (), mcp_servers: Iterable[str] = (), timeout: float = 60
+    ) -> None:
+        """Blocks until the server answers, the named ``agents`` are listed and the named ``mcp_servers`` are
+        connected.
+
+        Agents load asynchronously after the server starts, so call this before creating sessions on a freshly
+        booted server. Connection errors and 503s while the server boots count as not ready yet.
+
+        Raises:
+          TimeoutError: Something was still missing after ``timeout`` seconds. The message names it.
+        """
+        from .lib._ready import async_wait_until_ready
+
+        await async_wait_until_ready(self, agents=agents, mcp_servers=mcp_servers, timeout=timeout)
+
     def with_options(
         self,
         *,

{opencode_python_sdk-0.1.3 → opencode_python_sdk-0.2.0}/src/opencode/_events.py

@@ -31,7 +31,6 @@ import anyio
 from typing_extensions import Self
 
 from ._exceptions import APIConnectionError, APIStatusError, OpencodeError
-from .types import ServerConnectedEvent
 
 if TYPE_CHECKING:
     from collections.abc import AsyncIterator, Awaitable, Callable, Iterator
@@ -39,7 +38,7 @@ if TYPE_CHECKING:
 
     from ._client import AsyncOpencode, Opencode
     from ._streaming import AsyncStream, Stream
-    from .types import Event
+    from .types import Event, ServerConnectedEvent
 
 __all__ = [
     "SUBSCRIBER_CAPACITY",
@@ -302,6 +301,8 @@ class EventHub:
 
     def _read(self, connection: _SyncConnection) -> None:
         """Reads one connection until it ends, setting ``connection.delivered`` once an event arrives."""
+        from .types import ServerConnectedEvent
+
         stream = self._client.event.subscribe()
         with self._lock:
             connection.stream = stream
@@ -605,6 +606,8 @@ class AsyncEventHub:
 
     async def _read(self, connection: _AsyncConnection) -> None:
         """Reads one connection until it ends, setting ``connection.delivered`` once an event arrives."""
+        from .types import ServerConnectedEvent
+
         stream: AsyncStream[Event] = await self._client.event.subscribe()
         try:
             stream.on_activity = connection.activity

{opencode_python_sdk-0.1.3 → opencode_python_sdk-0.2.0}/src/opencode/_rpc.py

@@ -44,7 +44,6 @@ from ._errors import RpcError, RpcInternalError
 from ._exceptions import OpencodeError, validation_summary
 from ._types import NOT_GIVEN, NotGiven
 from .resources.rpc import AsyncRpcResource, RpcResource
-from .types import RpcEvent
 
 if TYPE_CHECKING:
     from collections.abc import Mapping
@@ -53,7 +52,7 @@ if TYPE_CHECKING:
     from ._client import AsyncOpencode, Opencode
     from ._events import AsyncSubscription, Subscription
     from ._types import Headers, Timeout
-    from .types import Location
+    from .types import Location, RpcEvent
 
 __all__ = [
     "AsyncRpcClient",
@@ -327,11 +326,15 @@ class RpcClient(Generic[_D]):
 
     def events(self) -> Subscription[RpcEvent]:
         """Subscribes to every event of this RPC, as raw events, on the client's shared event stream."""
+        from .types import RpcEvent
+
         prefix = f"rpc.{self.definition.id}."
         return self._client.events.of_type(RpcEvent).where(lambda event: event.type.startswith(prefix))
 
     def subscribe(self, event: RpcEventDefinition[_T]) -> RpcEvents[_T]:
         """Subscribes to one event of this RPC, with validated data, on the client's shared event stream."""
+        from .types import RpcEvent
+
         _check_event(self.definition, event)
         wire = self.definition.event_type(event)
         return RpcEvents(self._client.events.of_type(RpcEvent).where(lambda raw: raw.type == wire), event)
@@ -396,11 +399,15 @@ class AsyncRpcClient(Generic[_D]):
 
     def events(self) -> AsyncSubscription[RpcEvent]:
         """Subscribes to every event of this RPC, as raw events, on the client's shared event stream."""
+        from .types import RpcEvent
+
         prefix = f"rpc.{self.definition.id}."
         return self._client.events.of_type(RpcEvent).where(lambda event: event.type.startswith(prefix))
 
     def subscribe(self, event: RpcEventDefinition[_T]) -> AsyncRpcEvents[_T]:
         """Subscribes to one event of this RPC, with validated data, on the client's shared event stream."""
+        from .types import RpcEvent
+
         _check_event(self.definition, event)
         wire = self.definition.event_type(event)
         return AsyncRpcEvents(self._client.events.of_type(RpcEvent).where(lambda raw: raw.type == wire), event)

opencode_python_sdk-0.2.0/src/opencode/lib/__init__.py

@@ -0,0 +1,5 @@
+"""Hand-written helpers layered over the generated client."""
+
+from ._session import RunResult
+
+__all__ = ["RunResult"]

opencode_python_sdk-0.2.0/src/opencode/lib/_ready.py

@@ -0,0 +1,91 @@
+"""``client.wait_until_ready``: poll until agents and MCP servers have loaded.
+
+OpenCode loads agents and connects MCP servers in the background after it starts listening, so a freshly booted
+server can answer requests before the agent a caller needs exists.
+"""
+
+from __future__ import annotations
+
+import time
+from typing import TYPE_CHECKING
+
+import anyio
+
+from .._exceptions import APIConnectionError, ServiceUnavailableError
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+    from .._client import AsyncOpencode, Opencode
+    from ..types import AgentListResponse, McpListResponse
+
+__all__ = ["POLL_INTERVAL", "async_wait_until_ready", "wait_until_ready"]
+
+POLL_INTERVAL = 0.25
+"""Seconds between polls."""
+
+_TRANSIENT = (APIConnectionError, ServiceUnavailableError)
+
+
+def _missing(
+    agents: frozenset[str],
+    mcp_servers: frozenset[str],
+    agent_list: AgentListResponse | None,
+    mcp_list: McpListResponse | None,
+) -> list[str]:
+    missing: list[str] = []
+    if agents:
+        present = {agent.id for agent in agent_list.data} if agent_list is not None else set[str]()
+        missing += [f"agent {name!r}" for name in sorted(agents - present)]
+    if mcp_servers:
+        connected = (
+            {server.name for server in mcp_list.data if server.status.status == "connected"}
+            if mcp_list is not None
+            else set[str]()
+        )
+        missing += [f"MCP server {name!r}" for name in sorted(mcp_servers - connected)]
+    return missing
+
+
+def wait_until_ready(
+    client: Opencode, *, agents: Iterable[str] = (), mcp_servers: Iterable[str] = (), timeout: float = 60
+) -> None:
+    wanted_agents, wanted_mcp = frozenset(agents), frozenset(mcp_servers)
+    deadline = time.monotonic() + timeout
+    while True:
+        agent_list = mcp_list = None
+        missing = ["server"]
+        try:
+            client.server.info()
+            agent_list = client.agent.list() if wanted_agents else None
+            mcp_list = client.mcp.list() if wanted_mcp else None
+            missing = _missing(wanted_agents, wanted_mcp, agent_list, mcp_list)
+        except _TRANSIENT:
+            pass
+        if not missing:
+            return
+        if time.monotonic() >= deadline:
+            raise TimeoutError(f"OpenCode not ready after {timeout}s; still waiting for {', '.join(missing)}")
+        time.sleep(POLL_INTERVAL)
+
+
+async def async_wait_until_ready(
+    client: AsyncOpencode, *, agents: Iterable[str] = (), mcp_servers: Iterable[str] = (), timeout: float = 60
+) -> None:
+    wanted_agents, wanted_mcp = frozenset(agents), frozenset(mcp_servers)
+    deadline = time.monotonic() + timeout
+    while True:
+        agent_list = mcp_list = None
+        missing = ["server"]
+        try:
+            await client.server.info()
+            agent_list = await client.agent.list() if wanted_agents else None
+            mcp_list = await client.mcp.list() if wanted_mcp else None
+            missing = _missing(wanted_agents, wanted_mcp, agent_list, mcp_list)
+        except _TRANSIENT:
+            pass
+        if not missing:
+            return
+        if time.monotonic() >= deadline:
+            raise TimeoutError(f"OpenCode not ready after {timeout}s; still waiting for {', '.join(missing)}")
+        await anyio.sleep(POLL_INTERVAL)