opencode-python-sdk 0.0.1.dev1__py3-none-any.whl

opencode/_unions.py

@@ -0,0 +1,46 @@
+"""Runtime support for discriminated unions in the generated models."""
+
+from __future__ import annotations
+
+import re
+from typing import TYPE_CHECKING, Any, cast
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, Iterable
+
+__all__ = ["UNKNOWN_TAG", "discriminator"]
+
+UNKNOWN_TAG = "__unknown__"
+"""Tag of the fallback member that receives variants this client version does not know."""
+
+
+def discriminator(
+    key: str,
+    attribute: str,
+    tags: Iterable[str],
+    patterns: Iterable[tuple[str, str]] = (),
+) -> Callable[[Any], str]:
+    """Builds a ``pydantic.Discriminator`` function.
+
+    ``key`` is the wire field and ``attribute`` the model attribute that hold the tag. The tag selects a member by
+    exact value, then by regular expression. Anything else selects the ``UNKNOWN_TAG`` member, so a newer server can
+    add variants without breaking older clients.
+    """
+    known = frozenset(tags)
+    compiled = [(re.compile(pattern), member) for pattern, member in patterns]
+
+    def select(value: Any) -> str:
+        tag: object = (
+            cast("dict[str, Any]", value).get(key) if isinstance(value, dict) else getattr(value, attribute, None)
+        )
+        if isinstance(tag, bool):
+            tag = "true" if tag else "false"
+        if isinstance(tag, str):
+            if tag in known:
+                return tag
+            for pattern, member in compiled:
+                if pattern.search(tag):
+                    return member
+        return UNKNOWN_TAG
+
+    return select

opencode/_version.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("opencode-python-sdk")
+except PackageNotFoundError:  # running from a source tree that is not installed
+    __version__ = "0.0.0"

opencode/lib/__init__.py

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

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)

opencode/lib/_session.py

@@ -0,0 +1,231 @@
+"""``client.session.run``: create or reuse a session, prompt it, wait until idle, and collect the result.
+
+The generated ``SessionResource`` / ``AsyncSessionResource`` inherit from the classes here (see
+``codegen/render.py``, ``HELPER_BASES``), so these methods sit next to the generated ones.
+"""
+
+from __future__ import annotations
+
+import contextlib
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING, cast
+
+import anyio
+
+from .._resource import AsyncAPIResource, SyncAPIResource
+from .._types import NOT_GIVEN, NotGiven, Timeout
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+    from ..resources.session import AsyncSessionResource, SessionResource
+    from ..types import (
+        AgentID,
+        ModelRef,
+        PromptInputFileAttachment,
+        SessionID,
+        SessionInfo,
+        SessionMessageAssistant,
+        SessionMessageInfo,
+        SessionStructuredError,
+        TokenUsageInfo,
+    )
+
+__all__ = ["AsyncSessionHelpers", "RunResult", "SessionHelpers"]
+
+
+@dataclass
+class RunResult:
+    """What :meth:`SessionHelpers.run` returns."""
+
+    session: SessionInfo
+    """The session as it was after the run. ``session.cost`` and ``session.tokens`` cover the whole session."""
+    messages: list[SessionMessageInfo] = field(default_factory=list)  # pyright: ignore[reportUnknownVariableType]
+    """Messages this run added, oldest first, starting with the prompt."""
+
+    @property
+    def assistant_messages(self) -> list[SessionMessageAssistant]:
+        """The assistant messages of this run, oldest first."""
+        from ..types import SessionMessageAssistant
+
+        return [message for message in self.messages if isinstance(message, SessionMessageAssistant)]
+
+    @property
+    def text(self) -> str:
+        """Text of the last assistant message, or ``""`` when the agent produced none."""
+        from ..types import SessionMessageAssistantText
+
+        for message in reversed(self.assistant_messages):
+            parts = [item.text for item in message.content if isinstance(item, SessionMessageAssistantText)]
+            if parts:
+                return "".join(parts)
+        return ""
+
+    @property
+    def outcome(self) -> str | None:
+        """``succeeded``, ``failed`` or ``interrupted``, from the run's idle marker or the session."""
+        from ..types import SessionMessageIdle
+
+        for message in reversed(self.messages):
+            if isinstance(message, SessionMessageIdle):
+                return message.outcome
+        return self.session.outcome
+
+    @property
+    def error(self) -> SessionStructuredError | None:
+        """Why the run failed, from its idle marker or last assistant message, or ``None``."""
+        from ..types import SessionMessageAssistant, SessionMessageIdle
+
+        for message in reversed(self.messages):
+            if isinstance(message, (SessionMessageIdle, SessionMessageAssistant)) and message.error is not None:
+                return message.error
+        return None
+
+    @property
+    def cost(self) -> float:
+        """Cost of this run in USD, summed over its assistant messages."""
+        return sum(message.cost or 0.0 for message in self.assistant_messages)
+
+    @property
+    def tokens(self) -> TokenUsageInfo:
+        """Token usage of this run, summed over its assistant messages."""
+        from ..types import TokenUsageInfo, TokenUsageInfoCache
+
+        total = TokenUsageInfo(input=0, output=0, reasoning=0, cache=TokenUsageInfoCache(read=0, write=0))
+        for message in self.assistant_messages:
+            usage = message.tokens
+            if usage is None:
+                continue
+            total.input += usage.input
+            total.output += usage.output
+            total.reasoning += usage.reasoning
+            total.cache.read += usage.cache.read
+            total.cache.write += usage.cache.write
+        return total
+
+
+def _new_messages(newest_first: list[SessionMessageInfo], marker: str | None) -> list[SessionMessageInfo]:
+    from ..types import SessionMessageUser
+
+    collected: list[SessionMessageInfo] = []
+    for message in newest_first:
+        if marker is not None and message.id == marker:
+            break
+        collected.append(message)
+    collected.reverse()
+    # Drop anything that was already queued before our prompt.
+    for index, message in enumerate(collected):
+        if isinstance(message, SessionMessageUser):
+            return collected[index:]
+    return collected
+
+
+class SessionHelpers(SyncAPIResource):
+    """Hand-written helpers on ``client.session``."""
+
+    def run(
+        self,
+        text: str,
+        *,
+        agent: AgentID | None = None,
+        model: ModelRef | None = None,
+        files: Sequence[PromptInputFileAttachment] | NotGiven = NOT_GIVEN,
+        session_id: SessionID | None = None,
+        timeout: Timeout = None,
+    ) -> RunResult:
+        """Runs one prompt to completion and returns what the agent produced.
+
+        Creates a session with ``agent`` and ``model`` (or reuses ``session_id``, switching its agent and model when
+        given), sends ``text``, blocks until the session is idle, and reads back the new messages and the session's
+        usage.
+
+        If the wait is interrupted (``KeyboardInterrupt``, a timeout, or any other error), the session is
+        interrupted on the server before the error propagates, so no agent keeps running unattended.
+
+        Args:
+          text: The prompt.
+          agent: Agent for a new session, or to switch an existing one to.
+          model: Model for a new session, or to switch an existing one to. Set it with ``agent`` so the session
+            does not start on another model.
+          files: File attachments; images can be ``data:`` URLs.
+          session_id: Continue this session instead of creating one.
+          timeout: Seconds to wait for the session to become idle. ``None`` waits forever.
+
+        Example::
+
+            result = client.session.run("Summarize README.md", agent="build")
+            print(result.text, result.cost)
+        """
+        resource = cast("SessionResource", self)
+        if session_id is None:
+            session = resource.create(agent=agent or NOT_GIVEN, model=model or NOT_GIVEN)
+            session_id = session.id
+            marker = None
+        else:
+            if agent is not None:
+                resource.switch_agent(session_id, agent=agent)
+            if model is not None:
+                resource.switch_model(session_id, model=model)
+            latest = self._client.message.list(session_id, order="desc", limit=1).data
+            marker = latest[0].id if latest else None
+
+        resource.prompt(session_id, text=text, files=files)
+        try:
+            resource.wait(session_id, timeout=timeout)
+        except BaseException:
+            with contextlib.suppress(Exception):
+                resource.interrupt(session_id)
+            raise
+
+        newest_first: list[SessionMessageInfo] = []
+        for message in self._client.message.list(session_id, order="desc"):
+            if marker is not None and message.id == marker:
+                break
+            newest_first.append(message)
+        return RunResult(session=resource.get(session_id), messages=_new_messages(newest_first, marker))
+
+
+class AsyncSessionHelpers(AsyncAPIResource):
+    """Hand-written helpers on ``client.session`` of :class:`opencode.AsyncOpencode`."""
+
+    async def run(
+        self,
+        text: str,
+        *,
+        agent: AgentID | None = None,
+        model: ModelRef | None = None,
+        files: Sequence[PromptInputFileAttachment] | NotGiven = NOT_GIVEN,
+        session_id: SessionID | None = None,
+        timeout: Timeout = None,
+    ) -> RunResult:
+        """Runs one prompt to completion. See :meth:`SessionHelpers.run`.
+
+        Cancelling the task interrupts the session on the server before the cancellation propagates.
+        """
+        resource = cast("AsyncSessionResource", self)
+        if session_id is None:
+            session = await resource.create(agent=agent or NOT_GIVEN, model=model or NOT_GIVEN)
+            session_id = session.id
+            marker = None
+        else:
+            if agent is not None:
+                await resource.switch_agent(session_id, agent=agent)
+            if model is not None:
+                await resource.switch_model(session_id, model=model)
+            latest = (await self._client.message.list(session_id, order="desc", limit=1)).data
+            marker = latest[0].id if latest else None
+
+        await resource.prompt(session_id, text=text, files=files)
+        try:
+            await resource.wait(session_id, timeout=timeout)
+        except BaseException:
+            with anyio.CancelScope(shield=True), contextlib.suppress(Exception):
+                await resource.interrupt(session_id)
+            raise
+
+        newest_first: list[SessionMessageInfo] = []
+        async for message in self._client.message.list(session_id, order="desc"):
+            if marker is not None and message.id == marker:
+                break
+            newest_first.append(message)
+        return RunResult(session=await resource.get(session_id), messages=_new_messages(newest_first, marker))