opencode-python-sdk 0.1.0__py3-none-any.whl

opencode/_constants.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+import httpx
+
+DEFAULT_TIMEOUT = httpx.Timeout(timeout=600.0, connect=10.0)
+"""Ten minutes overall with a ten second connect timeout. Agent operations can run for a long time."""
+
+DEFAULT_MAX_RETRIES = 2
+INITIAL_RETRY_DELAY = 0.5
+MAX_RETRY_DELAY = 8.0
+MAX_RETRY_AFTER = 60.0
+"""A ``Retry-After`` above this many seconds is not honored; the request fails instead of stalling."""
+
+DEFAULT_CONNECTION_LIMITS = httpx.Limits(max_connections=100, max_keepalive_connections=20, keepalive_expiry=30.0)
+
+DEFAULT_USERNAME = "opencode"
+"""The Basic auth user name the OpenCode server expects."""
+
+BASE_URL_ENV = "OPENCODE_BASE_URL"
+PASSWORD_ENVS = ("OPENCODE_PASSWORD", "OPENCODE_SERVER_PASSWORD")
+"""Password variables, in the order the OpenCode CLI reads them."""
+
+IDEMPOTENT_METHODS = frozenset({"GET", "HEAD", "OPTIONS", "PUT", "DELETE"})
+RETRYABLE_STATUSES = frozenset({408, 429, 500, 502, 503, 504})
+"""Statuses retried for idempotent requests."""
+RETRYABLE_STATUSES_UNSAFE = frozenset({429, 503})
+"""Statuses retried for non-idempotent requests: the server refused the request before acting on it."""

opencode/_errors.py

@@ -0,0 +1,547 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""Errors the OpenCode server declares, keyed by their ``_tag``."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ._exceptions import (
+    APIStatusError,
+    AuthenticationError,
+    BadRequestError,
+    ConflictError,
+    ContentTooLargeError,
+    InternalServerError,
+    NotFoundError,
+    NotImplementedServerError,
+    PermissionDeniedError,
+    ServiceUnavailableError,
+)
+
+if TYPE_CHECKING:
+    from .types import (
+        AgentNotFoundErrorBody,
+        CommandExecutionErrorBody,
+        CommandNotFoundErrorBody,
+        FileNotFoundErrorBody,
+        ForbiddenErrorBody,
+        FormAlreadySettledErrorBody,
+        FormInvalidAnswerErrorBody,
+        FormNotFoundErrorBody,
+        InstructionEntryValueTooLargeErrorBody,
+        IntegrationAttemptNotFoundErrorBody,
+        IntegrationMethodNotFoundErrorBody,
+        IntegrationNotFoundErrorBody,
+        InvalidCursorErrorBody,
+        InvalidRequestErrorBody,
+        LocationNotFoundErrorBody,
+        McpServerNotFoundErrorBody,
+        MessageNotFoundErrorBody,
+        PermissionNotFoundErrorBody,
+        PermissionSavedNotFoundErrorBody,
+        ProjectNotFoundErrorBody,
+        ProviderNotFoundErrorBody,
+        PtyNotFoundErrorBody,
+        RpcErrorBody,
+        RpcInternalErrorBody,
+        SessionBusyErrorBody,
+        SessionNotFoundErrorBody,
+        ShellNotFoundErrorBody,
+        SkillNotFoundErrorBody,
+        UnauthorizedErrorBody,
+        UnknownErrorBody,
+        VcsInitNotSupportedErrorBody,
+        WorktreeErrorBody,
+    )
+
+__all__ = [
+    "TAGGED_ERRORS",
+    "AgentNotFoundError",
+    "CommandExecutionError",
+    "CommandNotFoundError",
+    "RemoteFileNotFoundError",
+    "ForbiddenError",
+    "FormAlreadySettledError",
+    "FormInvalidAnswerError",
+    "FormNotFoundError",
+    "InstructionEntryValueTooLargeError",
+    "IntegrationAttemptNotFoundError",
+    "IntegrationMethodNotFoundError",
+    "IntegrationNotFoundError",
+    "InvalidCursorError",
+    "InvalidRequestError",
+    "LocationNotFoundError",
+    "McpServerNotFoundError",
+    "MessageNotFoundError",
+    "PermissionNotFoundError",
+    "PermissionSavedNotFoundError",
+    "ProjectNotFoundError",
+    "ProviderNotFoundError",
+    "PtyNotFoundError",
+    "RpcError",
+    "RpcInternalError",
+    "SessionBusyError",
+    "SessionNotFoundError",
+    "ShellNotFoundError",
+    "SkillNotFoundError",
+    "UnauthorizedError",
+    "UnknownError",
+    "VcsInitNotSupportedError",
+    "WorktreeError",
+]
+
+
+class AgentNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``AgentNotFoundError``."""
+
+    tag = "AgentNotFoundError"
+
+    @property
+    def error(self) -> AgentNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import AgentNotFoundErrorBody
+
+        return self._typed_body(AgentNotFoundErrorBody)
+
+
+class CommandExecutionError(InternalServerError):
+    """The server answered 500 with ``_tag`` ``CommandExecutionError``."""
+
+    tag = "CommandExecutionError"
+
+    @property
+    def error(self) -> CommandExecutionErrorBody:
+        """The error body as a typed model."""
+        from .types import CommandExecutionErrorBody
+
+        return self._typed_body(CommandExecutionErrorBody)
+
+
+class CommandNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``CommandNotFoundError``."""
+
+    tag = "CommandNotFoundError"
+
+    @property
+    def error(self) -> CommandNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import CommandNotFoundErrorBody
+
+        return self._typed_body(CommandNotFoundErrorBody)
+
+
+class RemoteFileNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``FileNotFoundError``."""
+
+    tag = "FileNotFoundError"
+
+    @property
+    def error(self) -> FileNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import FileNotFoundErrorBody
+
+        return self._typed_body(FileNotFoundErrorBody)
+
+
+class ForbiddenError(PermissionDeniedError):
+    """The server answered 403 with ``_tag`` ``ForbiddenError``."""
+
+    tag = "ForbiddenError"
+
+    @property
+    def error(self) -> ForbiddenErrorBody:
+        """The error body as a typed model."""
+        from .types import ForbiddenErrorBody
+
+        return self._typed_body(ForbiddenErrorBody)
+
+
+class FormAlreadySettledError(ConflictError):
+    """The server answered 409 with ``_tag`` ``FormAlreadySettledError``."""
+
+    tag = "FormAlreadySettledError"
+
+    @property
+    def error(self) -> FormAlreadySettledErrorBody:
+        """The error body as a typed model."""
+        from .types import FormAlreadySettledErrorBody
+
+        return self._typed_body(FormAlreadySettledErrorBody)
+
+
+class FormInvalidAnswerError(BadRequestError):
+    """The server answered 400 with ``_tag`` ``FormInvalidAnswerError``."""
+
+    tag = "FormInvalidAnswerError"
+
+    @property
+    def error(self) -> FormInvalidAnswerErrorBody:
+        """The error body as a typed model."""
+        from .types import FormInvalidAnswerErrorBody
+
+        return self._typed_body(FormInvalidAnswerErrorBody)
+
+
+class FormNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``FormNotFoundError``."""
+
+    tag = "FormNotFoundError"
+
+    @property
+    def error(self) -> FormNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import FormNotFoundErrorBody
+
+        return self._typed_body(FormNotFoundErrorBody)
+
+
+class InstructionEntryValueTooLargeError(ContentTooLargeError):
+    """The server answered 413 with ``_tag`` ``InstructionEntryValueTooLargeError``."""
+
+    tag = "InstructionEntryValueTooLargeError"
+
+    @property
+    def error(self) -> InstructionEntryValueTooLargeErrorBody:
+        """The error body as a typed model."""
+        from .types import InstructionEntryValueTooLargeErrorBody
+
+        return self._typed_body(InstructionEntryValueTooLargeErrorBody)
+
+
+class IntegrationAttemptNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``IntegrationAttemptNotFoundError``."""
+
+    tag = "IntegrationAttemptNotFoundError"
+
+    @property
+    def error(self) -> IntegrationAttemptNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import IntegrationAttemptNotFoundErrorBody
+
+        return self._typed_body(IntegrationAttemptNotFoundErrorBody)
+
+
+class IntegrationMethodNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``IntegrationMethodNotFoundError``."""
+
+    tag = "IntegrationMethodNotFoundError"
+
+    @property
+    def error(self) -> IntegrationMethodNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import IntegrationMethodNotFoundErrorBody
+
+        return self._typed_body(IntegrationMethodNotFoundErrorBody)
+
+
+class IntegrationNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``IntegrationNotFoundError``."""
+
+    tag = "IntegrationNotFoundError"
+
+    @property
+    def error(self) -> IntegrationNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import IntegrationNotFoundErrorBody
+
+        return self._typed_body(IntegrationNotFoundErrorBody)
+
+
+class InvalidCursorError(BadRequestError):
+    """The server answered 400 with ``_tag`` ``InvalidCursorError``."""
+
+    tag = "InvalidCursorError"
+
+    @property
+    def error(self) -> InvalidCursorErrorBody:
+        """The error body as a typed model."""
+        from .types import InvalidCursorErrorBody
+
+        return self._typed_body(InvalidCursorErrorBody)
+
+
+class InvalidRequestError(BadRequestError):
+    """The server answered 400 with ``_tag`` ``InvalidRequestError``."""
+
+    tag = "InvalidRequestError"
+
+    @property
+    def error(self) -> InvalidRequestErrorBody:
+        """The error body as a typed model."""
+        from .types import InvalidRequestErrorBody
+
+        return self._typed_body(InvalidRequestErrorBody)
+
+
+class LocationNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``LocationNotFoundError``."""
+
+    tag = "LocationNotFoundError"
+
+    @property
+    def error(self) -> LocationNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import LocationNotFoundErrorBody
+
+        return self._typed_body(LocationNotFoundErrorBody)
+
+
+class McpServerNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``McpServerNotFoundError``."""
+
+    tag = "McpServerNotFoundError"
+
+    @property
+    def error(self) -> McpServerNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import McpServerNotFoundErrorBody
+
+        return self._typed_body(McpServerNotFoundErrorBody)
+
+
+class MessageNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``MessageNotFoundError``."""
+
+    tag = "MessageNotFoundError"
+
+    @property
+    def error(self) -> MessageNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import MessageNotFoundErrorBody
+
+        return self._typed_body(MessageNotFoundErrorBody)
+
+
+class PermissionNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``PermissionNotFoundError``."""
+
+    tag = "PermissionNotFoundError"
+
+    @property
+    def error(self) -> PermissionNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import PermissionNotFoundErrorBody
+
+        return self._typed_body(PermissionNotFoundErrorBody)
+
+
+class PermissionSavedNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``PermissionSavedNotFoundError``."""
+
+    tag = "PermissionSavedNotFoundError"
+
+    @property
+    def error(self) -> PermissionSavedNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import PermissionSavedNotFoundErrorBody
+
+        return self._typed_body(PermissionSavedNotFoundErrorBody)
+
+
+class ProjectNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``ProjectNotFoundError``."""
+
+    tag = "ProjectNotFoundError"
+
+    @property
+    def error(self) -> ProjectNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import ProjectNotFoundErrorBody
+
+        return self._typed_body(ProjectNotFoundErrorBody)
+
+
+class ProviderNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``ProviderNotFoundError``."""
+
+    tag = "ProviderNotFoundError"
+
+    @property
+    def error(self) -> ProviderNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import ProviderNotFoundErrorBody
+
+        return self._typed_body(ProviderNotFoundErrorBody)
+
+
+class PtyNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``PtyNotFoundError``."""
+
+    tag = "PtyNotFoundError"
+
+    @property
+    def error(self) -> PtyNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import PtyNotFoundErrorBody
+
+        return self._typed_body(PtyNotFoundErrorBody)
+
+
+class RpcError(BadRequestError):
+    """The server answered 400 with ``_tag`` ``RpcError``."""
+
+    tag = "RpcError"
+
+    @property
+    def error(self) -> RpcErrorBody:
+        """The error body as a typed model."""
+        from .types import RpcErrorBody
+
+        return self._typed_body(RpcErrorBody)
+
+
+class RpcInternalError(InternalServerError):
+    """The server answered 500 with ``_tag`` ``RpcInternalError``."""
+
+    tag = "RpcInternalError"
+
+    @property
+    def error(self) -> RpcInternalErrorBody:
+        """The error body as a typed model."""
+        from .types import RpcInternalErrorBody
+
+        return self._typed_body(RpcInternalErrorBody)
+
+
+class SessionBusyError(ConflictError):
+    """The server answered 409 with ``_tag`` ``SessionBusyError``."""
+
+    tag = "SessionBusyError"
+
+    @property
+    def error(self) -> SessionBusyErrorBody:
+        """The error body as a typed model."""
+        from .types import SessionBusyErrorBody
+
+        return self._typed_body(SessionBusyErrorBody)
+
+
+class SessionNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``SessionNotFoundError``."""
+
+    tag = "SessionNotFoundError"
+
+    @property
+    def error(self) -> SessionNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import SessionNotFoundErrorBody
+
+        return self._typed_body(SessionNotFoundErrorBody)
+
+
+class ShellNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``ShellNotFoundError``."""
+
+    tag = "ShellNotFoundError"
+
+    @property
+    def error(self) -> ShellNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import ShellNotFoundErrorBody
+
+        return self._typed_body(ShellNotFoundErrorBody)
+
+
+class SkillNotFoundError(NotFoundError):
+    """The server answered 404 with ``_tag`` ``SkillNotFoundError``."""
+
+    tag = "SkillNotFoundError"
+
+    @property
+    def error(self) -> SkillNotFoundErrorBody:
+        """The error body as a typed model."""
+        from .types import SkillNotFoundErrorBody
+
+        return self._typed_body(SkillNotFoundErrorBody)
+
+
+class UnauthorizedError(AuthenticationError):
+    """The server answered 401 with ``_tag`` ``UnauthorizedError``."""
+
+    tag = "UnauthorizedError"
+
+    @property
+    def error(self) -> UnauthorizedErrorBody:
+        """The error body as a typed model."""
+        from .types import UnauthorizedErrorBody
+
+        return self._typed_body(UnauthorizedErrorBody)
+
+
+class UnknownError(InternalServerError):
+    """The server answered 500 with ``_tag`` ``UnknownError``."""
+
+    tag = "UnknownError"
+
+    @property
+    def error(self) -> UnknownErrorBody:
+        """The error body as a typed model."""
+        from .types import UnknownErrorBody
+
+        return self._typed_body(UnknownErrorBody)
+
+
+class VcsInitNotSupportedError(NotImplementedServerError):
+    """The server answered 501 with ``_tag`` ``VcsInitNotSupportedError``."""
+
+    tag = "VcsInitNotSupportedError"
+
+    @property
+    def error(self) -> VcsInitNotSupportedErrorBody:
+        """The error body as a typed model."""
+        from .types import VcsInitNotSupportedErrorBody
+
+        return self._typed_body(VcsInitNotSupportedErrorBody)
+
+
+class WorktreeError(BadRequestError):
+    """The server answered 400 with ``_tag`` ``WorktreeError``."""
+
+    tag = "WorktreeError"
+
+    @property
+    def error(self) -> WorktreeErrorBody:
+        """The error body as a typed model."""
+        from .types import WorktreeErrorBody
+
+        return self._typed_body(WorktreeErrorBody)
+
+
+TAGGED_ERRORS: dict[str, type[APIStatusError]] = {
+    "AgentNotFoundError": AgentNotFoundError,
+    "CommandExecutionError": CommandExecutionError,
+    "CommandNotFoundError": CommandNotFoundError,
+    "ConflictError": ConflictError,
+    "FileNotFoundError": RemoteFileNotFoundError,
+    "ForbiddenError": ForbiddenError,
+    "FormAlreadySettledError": FormAlreadySettledError,
+    "FormInvalidAnswerError": FormInvalidAnswerError,
+    "FormNotFoundError": FormNotFoundError,
+    "InstructionEntryValueTooLargeError": InstructionEntryValueTooLargeError,
+    "IntegrationAttemptNotFoundError": IntegrationAttemptNotFoundError,
+    "IntegrationMethodNotFoundError": IntegrationMethodNotFoundError,
+    "IntegrationNotFoundError": IntegrationNotFoundError,
+    "InvalidCursorError": InvalidCursorError,
+    "InvalidRequestError": InvalidRequestError,
+    "LocationNotFoundError": LocationNotFoundError,
+    "McpServerNotFoundError": McpServerNotFoundError,
+    "MessageNotFoundError": MessageNotFoundError,
+    "PermissionNotFoundError": PermissionNotFoundError,
+    "PermissionSavedNotFoundError": PermissionSavedNotFoundError,
+    "ProjectNotFoundError": ProjectNotFoundError,
+    "ProviderNotFoundError": ProviderNotFoundError,
+    "PtyNotFoundError": PtyNotFoundError,
+    "RpcError": RpcError,
+    "RpcInternalError": RpcInternalError,
+    "ServiceUnavailableError": ServiceUnavailableError,
+    "SessionBusyError": SessionBusyError,
+    "SessionNotFoundError": SessionNotFoundError,
+    "ShellNotFoundError": ShellNotFoundError,
+    "SkillNotFoundError": SkillNotFoundError,
+    "UnauthorizedError": UnauthorizedError,
+    "UnknownError": UnknownError,
+    "VcsInitNotSupportedError": VcsInitNotSupportedError,
+    "WorktreeError": WorktreeError,
+}