archil-openapi 0.0.65__tar.gz → 0.0.67__tar.gz

{archil_openapi-0.0.65 → archil_openapi-0.0.67}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: archil-openapi
-Version: 0.0.65
+Version: 0.0.67
 Summary: Generated low-level Python client for the Archil control plane API
 Keywords: archil,openapi
 Author: Archil, Inc.

{archil_openapi-0.0.65 → archil_openapi-0.0.67}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "archil-openapi"
-version = "0.0.65"
+version = "0.0.67"
 description = "Generated low-level Python client for the Archil control plane API"
 readme = "README.md"
 license = { file = "LICENSE" }

archil_openapi-0.0.67/src/archil_openapi/api/disks/prefetch_disk.py

@@ -0,0 +1,229 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_response_prefetch import ApiResponsePrefetch
+from ...models.error_response import ErrorResponse
+from ...models.prefetch_request import PrefetchRequest
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+    *,
+    body: PrefetchRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/disks/{id}/prefetch".format(
+            id=id,
+        ),
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ApiResponsePrefetch, ErrorResponse]]:
+    if response.status_code == 200:
+        response_200 = ApiResponsePrefetch.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+
+    if response.status_code == 503:
+        response_503 = ErrorResponse.from_dict(response.json())
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ApiResponsePrefetch, ErrorResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+    body: PrefetchRequest,
+) -> Response[Union[ApiResponsePrefetch, ErrorResponse]]:
+    """Prefetch file ranges
+
+     Warms byte ranges of files on a disk into Archil's cache, so later reads from any client are served
+    without going to object storage. Each range names one file and an optional offset and length; a file
+    may appear in several ranges. The response reports each range in request order and may arrive before
+    the data is fully fetched. Paths are relative to the disk root. A path that does not exist reports
+    `found: false`; a path that is not a regular file is found but warms nothing. If the disk is not
+    mounted anywhere, prefetching loads it.
+
+    Args:
+        id (str):  Example: dsk-0123456789abcdef.
+        body (PrefetchRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ApiResponsePrefetch, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+    body: PrefetchRequest,
+) -> Optional[Union[ApiResponsePrefetch, ErrorResponse]]:
+    """Prefetch file ranges
+
+     Warms byte ranges of files on a disk into Archil's cache, so later reads from any client are served
+    without going to object storage. Each range names one file and an optional offset and length; a file
+    may appear in several ranges. The response reports each range in request order and may arrive before
+    the data is fully fetched. Paths are relative to the disk root. A path that does not exist reports
+    `found: false`; a path that is not a regular file is found but warms nothing. If the disk is not
+    mounted anywhere, prefetching loads it.
+
+    Args:
+        id (str):  Example: dsk-0123456789abcdef.
+        body (PrefetchRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ApiResponsePrefetch, ErrorResponse]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+    body: PrefetchRequest,
+) -> Response[Union[ApiResponsePrefetch, ErrorResponse]]:
+    """Prefetch file ranges
+
+     Warms byte ranges of files on a disk into Archil's cache, so later reads from any client are served
+    without going to object storage. Each range names one file and an optional offset and length; a file
+    may appear in several ranges. The response reports each range in request order and may arrive before
+    the data is fully fetched. Paths are relative to the disk root. A path that does not exist reports
+    `found: false`; a path that is not a regular file is found but warms nothing. If the disk is not
+    mounted anywhere, prefetching loads it.
+
+    Args:
+        id (str):  Example: dsk-0123456789abcdef.
+        body (PrefetchRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ApiResponsePrefetch, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+    body: PrefetchRequest,
+) -> Optional[Union[ApiResponsePrefetch, ErrorResponse]]:
+    """Prefetch file ranges
+
+     Warms byte ranges of files on a disk into Archil's cache, so later reads from any client are served
+    without going to object storage. Each range names one file and an optional offset and length; a file
+    may appear in several ranges. The response reports each range in request order and may arrive before
+    the data is fully fetched. Paths are relative to the disk root. A path that does not exist reports
+    `found: false`; a path that is not a regular file is found but warms nothing. If the disk is not
+    mounted anywhere, prefetching loads it.
+
+    Args:
+        id (str):  Example: dsk-0123456789abcdef.
+        body (PrefetchRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ApiResponsePrefetch, ErrorResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            body=body,
+        )
+    ).parsed

{archil_openapi-0.0.65 → archil_openapi-0.0.67}/src/archil_openapi/api/sandboxes/create_sandbox_connection.py

@@ -76,9 +76,12 @@ def sync_detailed(
 ) -> Response[Union[ApiResponseSandboxConnection, ErrorResponse]]:
     """Create a sandbox process connection
 
-     Returns a short-lived WebSocket URL used by the sandbox process API.
-    The URL contains a signed token that expires at `expires_at`; an open
-    WebSocket can remain connected after the token expires.
+     Returns a short-lived, single-use credential for one WebSocket to the
+    sandbox process API. Connect to `endpoint`, offering the subprotocols
+    `archil.connect.v1` and `archil.token.<token>`; the server selects
+    `archil.connect.v1`. `url` carries the same token in its query string
+    for older clients. The token opens one WebSocket before `expires_at`;
+    an open WebSocket can remain connected after the token expires.
 
     Args:
         sid (UUID):
@@ -109,9 +112,12 @@ def sync(
 ) -> Optional[Union[ApiResponseSandboxConnection, ErrorResponse]]:
     """Create a sandbox process connection
 
-     Returns a short-lived WebSocket URL used by the sandbox process API.
-    The URL contains a signed token that expires at `expires_at`; an open
-    WebSocket can remain connected after the token expires.
+     Returns a short-lived, single-use credential for one WebSocket to the
+    sandbox process API. Connect to `endpoint`, offering the subprotocols
+    `archil.connect.v1` and `archil.token.<token>`; the server selects
+    `archil.connect.v1`. `url` carries the same token in its query string
+    for older clients. The token opens one WebSocket before `expires_at`;
+    an open WebSocket can remain connected after the token expires.
 
     Args:
         sid (UUID):
@@ -137,9 +143,12 @@ async def asyncio_detailed(
 ) -> Response[Union[ApiResponseSandboxConnection, ErrorResponse]]:
     """Create a sandbox process connection
 
-     Returns a short-lived WebSocket URL used by the sandbox process API.
-    The URL contains a signed token that expires at `expires_at`; an open
-    WebSocket can remain connected after the token expires.
+     Returns a short-lived, single-use credential for one WebSocket to the
+    sandbox process API. Connect to `endpoint`, offering the subprotocols
+    `archil.connect.v1` and `archil.token.<token>`; the server selects
+    `archil.connect.v1`. `url` carries the same token in its query string
+    for older clients. The token opens one WebSocket before `expires_at`;
+    an open WebSocket can remain connected after the token expires.
 
     Args:
         sid (UUID):
@@ -168,9 +177,12 @@ async def asyncio(
 ) -> Optional[Union[ApiResponseSandboxConnection, ErrorResponse]]:
     """Create a sandbox process connection
 
-     Returns a short-lived WebSocket URL used by the sandbox process API.
-    The URL contains a signed token that expires at `expires_at`; an open
-    WebSocket can remain connected after the token expires.
+     Returns a short-lived, single-use credential for one WebSocket to the
+    sandbox process API. Connect to `endpoint`, offering the subprotocols
+    `archil.connect.v1` and `archil.token.<token>`; the server selects
+    `archil.connect.v1`. `url` carries the same token in its query string
+    for older clients. The token opens one WebSocket before `expires_at`;
+    an open WebSocket can remain connected after the token expires.
 
     Args:
         sid (UUID):

{archil_openapi-0.0.65 → archil_openapi-0.0.67}/src/archil_openapi/models/__init__.py

@@ -41,6 +41,8 @@ from .api_response_grep_disk import ApiResponseGrepDisk
 from .api_response_image import ApiResponseImage
 from .api_response_message import ApiResponseMessage
 from .api_response_message_data import ApiResponseMessageData
+from .api_response_prefetch import ApiResponsePrefetch
+from .api_response_prefetch_data import ApiResponsePrefetchData
 from .api_response_sandbox import ApiResponseSandbox
 from .api_response_sandbox_connection import ApiResponseSandboxConnection
 from .api_response_sandbox_list import ApiResponseSandboxList
@@ -202,6 +204,10 @@ from .mount_response_access_mode import MountResponseAccessMode
 from .mount_response_authorization_type import MountResponseAuthorizationType
 from .mount_response_connection_status import MountResponseConnectionStatus
 from .mount_response_type import MountResponseType
+from .prefetch_range import PrefetchRange
+from .prefetch_range_result import PrefetchRangeResult
+from .prefetch_range_result_error import PrefetchRangeResultError
+from .prefetch_request import PrefetchRequest
 from .registry_auth import RegistryAuth
 from .remove_disk_user_user_type import RemoveDiskUserUserType
 from .revoke_delegation_request import RevokeDelegationRequest
@@ -278,6 +284,8 @@ __all__ = (
     "ApiResponseImage",
     "ApiResponseMessage",
     "ApiResponseMessageData",
+    "ApiResponsePrefetch",
+    "ApiResponsePrefetchData",
     "ApiResponseSandbox",
     "ApiResponseSandboxConnection",
     "ApiResponseSandboxList",
@@ -439,6 +447,10 @@ __all__ = (
     "MountResponseAuthorizationType",
     "MountResponseConnectionStatus",
     "MountResponseType",
+    "PrefetchRange",
+    "PrefetchRangeResult",
+    "PrefetchRangeResultError",
+    "PrefetchRequest",
     "RegistryAuth",
     "RemoveDiskUserUserType",
     "RevokeDelegationRequest",

archil_openapi-0.0.67/src/archil_openapi/models/api_response_prefetch.py

@@ -0,0 +1,73 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ..models.api_response_prefetch_data import ApiResponsePrefetchData
+
+
+T = TypeVar("T", bound="ApiResponsePrefetch")
+
+
+@_attrs_define
+class ApiResponsePrefetch:
+    """
+    Attributes:
+        success (bool):  Example: True.
+        data (ApiResponsePrefetchData):
+    """
+
+    success: bool
+    data: "ApiResponsePrefetchData"
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        success = self.success
+
+        data = self.data.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "success": success,
+                "data": data,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.api_response_prefetch_data import ApiResponsePrefetchData
+
+        d = dict(src_dict)
+        success = d.pop("success")
+
+        data = ApiResponsePrefetchData.from_dict(d.pop("data"))
+
+        api_response_prefetch = cls(
+            success=success,
+            data=data,
+        )
+
+        api_response_prefetch.additional_properties = d
+        return api_response_prefetch
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

archil_openapi-0.0.67/src/archil_openapi/models/api_response_prefetch_data.py

@@ -0,0 +1,73 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ..models.prefetch_range_result import PrefetchRangeResult
+
+
+T = TypeVar("T", bound="ApiResponsePrefetchData")
+
+
+@_attrs_define
+class ApiResponsePrefetchData:
+    """
+    Attributes:
+        results (list['PrefetchRangeResult']): One result per requested range, in request order.
+    """
+
+    results: list["PrefetchRangeResult"]
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        results = []
+        for results_item_data in self.results:
+            results_item = results_item_data.to_dict()
+            results.append(results_item)
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "results": results,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.prefetch_range_result import PrefetchRangeResult
+
+        d = dict(src_dict)
+        results = []
+        _results = d.pop("results")
+        for results_item_data in _results:
+            results_item = PrefetchRangeResult.from_dict(results_item_data)
+
+            results.append(results_item)
+
+        api_response_prefetch_data = cls(
+            results=results,
+        )
+
+        api_response_prefetch_data.additional_properties = d
+        return api_response_prefetch_data
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

archil_openapi-0.0.67/src/archil_openapi/models/prefetch_range.py

@@ -0,0 +1,60 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar, Union
+
+from attrs import define as _attrs_define
+
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="PrefetchRange")
+
+
+@_attrs_define
+class PrefetchRange:
+    """
+    Attributes:
+        path (str): File path relative to the disk root. Example: models/weights.bin.
+        offset (Union[Unset, int]): First byte to warm. Defaults to 0.
+        length (Union[Unset, int]): Bytes to warm from `offset`. Defaults to the end of the file.
+    """
+
+    path: str
+    offset: Union[Unset, int] = UNSET
+    length: Union[Unset, int] = UNSET
+
+    def to_dict(self) -> dict[str, Any]:
+        path = self.path
+
+        offset = self.offset
+
+        length = self.length
+
+        field_dict: dict[str, Any] = {}
+
+        field_dict.update(
+            {
+                "path": path,
+            }
+        )
+        if offset is not UNSET:
+            field_dict["offset"] = offset
+        if length is not UNSET:
+            field_dict["length"] = length
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        path = d.pop("path")
+
+        offset = d.pop("offset", UNSET)
+
+        length = d.pop("length", UNSET)
+
+        prefetch_range = cls(
+            path=path,
+            offset=offset,
+            length=length,
+        )
+
+        return prefetch_range

archil_openapi-0.0.67/src/archil_openapi/models/prefetch_range_result.py

@@ -0,0 +1,95 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar, Union
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.prefetch_range_result_error import PrefetchRangeResultError
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="PrefetchRangeResult")
+
+
+@_attrs_define
+class PrefetchRangeResult:
+    """
+    Attributes:
+        found (bool): Whether the path exists.
+        bytes_requested (int): Bytes of the range being warmed, including bytes that were already cached.
+        bytes_warmed (int): Of `bytesRequested`, the bytes fetched (or still being fetched) from object storage.
+        error (Union[Unset, PrefetchRangeResultError]): Set when this range was not warmed: `retry` for a transient
+            failure worth retrying, `failed` otherwise. Other ranges in the request are unaffected.
+    """
+
+    found: bool
+    bytes_requested: int
+    bytes_warmed: int
+    error: Union[Unset, PrefetchRangeResultError] = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        found = self.found
+
+        bytes_requested = self.bytes_requested
+
+        bytes_warmed = self.bytes_warmed
+
+        error: Union[Unset, str] = UNSET
+        if not isinstance(self.error, Unset):
+            error = self.error.value
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "found": found,
+                "bytesRequested": bytes_requested,
+                "bytesWarmed": bytes_warmed,
+            }
+        )
+        if error is not UNSET:
+            field_dict["error"] = error
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        found = d.pop("found")
+
+        bytes_requested = d.pop("bytesRequested")
+
+        bytes_warmed = d.pop("bytesWarmed")
+
+        _error = d.pop("error", UNSET)
+        error: Union[Unset, PrefetchRangeResultError]
+        if isinstance(_error, Unset):
+            error = UNSET
+        else:
+            error = PrefetchRangeResultError(_error)
+
+        prefetch_range_result = cls(
+            found=found,
+            bytes_requested=bytes_requested,
+            bytes_warmed=bytes_warmed,
+            error=error,
+        )
+
+        prefetch_range_result.additional_properties = d
+        return prefetch_range_result
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

archil_openapi-0.0.67/src/archil_openapi/models/prefetch_range_result_error.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class PrefetchRangeResultError(str, Enum):
+    FAILED = "failed"
+    RETRY = "retry"
+
+    def __str__(self) -> str:
+        return str(self.value)