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

opencode/resources/experimental.py

@@ -11,6 +11,7 @@ from functools import cached_property
 from typing import cast
 
 from .._base_client import RequestOptions
+from .._pty import AsyncPersistentPtyAttachMixin, PersistentPtyAttachMixin
 from .._qs import encode_path_segment
 from .._resource import AsyncAPIResource, SyncAPIResource
 from .._types import NOT_GIVEN, Body, Headers, NotGiven, Query, Timeout
@@ -30,7 +31,7 @@ from ..types import (
 __all__ = ["ExperimentalResource", "AsyncExperimentalResource"]
 
 
-class ExperimentalPersistentPtyResource(SyncAPIResource):
+class ExperimentalPersistentPtyResource(PersistentPtyAttachMixin):
     """Operations under ``client.experimental.persistent_pty`` (OpenCode ``experimental.persistentPty``)."""
 
     def read(
@@ -50,9 +51,9 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/experimental/session/:sessionID/terminal/read``
         """
@@ -85,9 +86,9 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/experimental/session/:sessionID/terminal``
         """
@@ -125,9 +126,9 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/session/:sessionID/terminal``
         """
@@ -159,9 +160,9 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/persistent-pty/shutdown``
         """
@@ -188,9 +189,9 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/persistent-pty/handoff``
         """
@@ -221,10 +222,10 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/experimental/persistent-pty/:ptyID``
         """
@@ -258,10 +259,10 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``PUT /api/experimental/persistent-pty/:ptyID``
         """
@@ -294,10 +295,10 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/experimental/persistent-pty/:ptyID/snapshot``
         """
@@ -329,10 +330,10 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``DELETE /api/experimental/persistent-pty/:ptyID``
         """
@@ -361,11 +362,11 @@ class ExperimentalPersistentPtyResource(SyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ForbiddenError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ForbiddenError: The server answered 403.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/persistent-pty/:ptyID/connect-token``
         """
@@ -392,10 +393,11 @@ class ExperimentalResource(SyncAPIResource):
 
     @cached_property
     def persistent_pty(self) -> ExperimentalPersistentPtyResource:
+        """Operations under ``client.experimental.persistent_pty``."""
         return ExperimentalPersistentPtyResource(self._client)
 
 
-class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
+class AsyncExperimentalPersistentPtyResource(AsyncPersistentPtyAttachMixin):
     """Operations under ``client.experimental.persistent_pty`` (OpenCode ``experimental.persistentPty``)."""
 
     async def read(
@@ -415,9 +417,9 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/experimental/session/:sessionID/terminal/read``
         """
@@ -450,9 +452,9 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/experimental/session/:sessionID/terminal``
         """
@@ -490,9 +492,9 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/session/:sessionID/terminal``
         """
@@ -524,9 +526,9 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/persistent-pty/shutdown``
         """
@@ -553,9 +555,9 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/persistent-pty/handoff``
         """
@@ -586,10 +588,10 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/experimental/persistent-pty/:ptyID``
         """
@@ -623,10 +625,10 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``PUT /api/experimental/persistent-pty/:ptyID``
         """
@@ -659,10 +661,10 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/experimental/persistent-pty/:ptyID/snapshot``
         """
@@ -694,10 +696,10 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``DELETE /api/experimental/persistent-pty/:ptyID``
         """
@@ -726,11 +728,11 @@ class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
         """This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ForbiddenError
-          PtyNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ForbiddenError: The server answered 403.
+          PtyNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/persistent-pty/:ptyID/connect-token``
         """
@@ -757,4 +759,5 @@ class AsyncExperimentalResource(AsyncAPIResource):
 
     @cached_property
     def persistent_pty(self) -> AsyncExperimentalPersistentPtyResource:
+        """Operations under ``client.experimental.persistent_pty``."""
         return AsyncExperimentalPersistentPtyResource(self._client)

opencode/resources/file.py

@@ -39,10 +39,10 @@ class FileResource(SyncAPIResource):
         Stream one file relative to the requested location with ETag, Last-Modified, and single-range HTTP Range support (206 Partial Content, 416 Range Not Satisfiable, and 304 Not Modified; multi-range and malformed Range headers fall back to 200).
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          RemoteFileNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          RemoteFileNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/fs/read/*``
         """
@@ -80,10 +80,10 @@ class FileResource(SyncAPIResource):
           path: An absolute path or a path relative to the requested location. Defaults to the location directory.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          RemoteFileNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          RemoteFileNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/fs/list``
         """
@@ -120,9 +120,9 @@ class FileResource(SyncAPIResource):
         Find recursively ranked filesystem entries relative to the requested location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/fs/find``
         """
@@ -163,9 +163,9 @@ class FileResource(SyncAPIResource):
           path: An absolute path or a path relative to the requested location. Missing parent directories are created.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/experimental/fs/write``
         """
@@ -205,10 +205,10 @@ class AsyncFileResource(AsyncAPIResource):
         Stream one file relative to the requested location with ETag, Last-Modified, and single-range HTTP Range support (206 Partial Content, 416 Range Not Satisfiable, and 304 Not Modified; multi-range and malformed Range headers fall back to 200).
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          RemoteFileNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          RemoteFileNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/fs/read/*``
         """
@@ -246,10 +246,10 @@ class AsyncFileResource(AsyncAPIResource):
           path: An absolute path or a path relative to the requested location. Defaults to the location directory.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          RemoteFileNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          RemoteFileNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/fs/list``
         """
@@ -286,9 +286,9 @@ class AsyncFileResource(AsyncAPIResource):
         Find recursively ranked filesystem entries relative to the requested location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/fs/find``
         """
@@ -329,9 +329,9 @@ class AsyncFileResource(AsyncAPIResource):
           path: An absolute path or a path relative to the requested location. Missing parent directories are created.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/experimental/fs/write``
         """

opencode/resources/form.py

@@ -35,9 +35,9 @@ class FormResource(SyncAPIResource):
         Retrieve pending forms for a location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/form``
         """
@@ -75,9 +75,9 @@ class AsyncFormResource(AsyncAPIResource):
         Retrieve pending forms for a location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/form``
         """

opencode/resources/generate.py

@@ -38,10 +38,10 @@ class GenerateResource(SyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/generate``
         """
@@ -83,10 +83,10 @@ class AsyncGenerateResource(AsyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/experimental/generate``
         """