modal 1.5.2.dev20__tar.gz → 1.5.2.dev22__tar.gz

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.5.2.dev20
+Version: 1.5.2.dev22
 Summary: Python client library for Modal
 Author-email: Modal Labs <support@modal.com>
 License-Expression: Apache-2.0

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/_utils/task_command_router_client.py

@@ -1,6 +1,7 @@
 # Copyright Modal Labs 2025
 import asyncio
 import base64
+import io
 import json
 import socket
 import ssl
@@ -8,9 +9,9 @@ import time
 import typing
 import urllib.parse
 import weakref
-from collections.abc import AsyncGenerator, Callable
+from collections.abc import AsyncGenerator, AsyncIterable, Callable
 from contextlib import suppress
-from typing import TypeVar
+from typing import BinaryIO, TypeVar
 
 import grpclib.client
 import grpclib.config
@@ -18,7 +19,7 @@ from grpclib import GRPCError, Status
 from grpclib.exceptions import StreamTerminatedError
 
 from modal.config import logger
-from modal.exception import ExecTimeoutError, TimeoutError as ModalTimeoutError
+from modal.exception import AuthError, ExecTimeoutError, InternalError, ServiceError, TimeoutError as ModalTimeoutError
 from modal_proto import api_pb2, task_command_router_pb2 as sr_pb2
 from modal_proto.task_command_router_grpc import TaskCommandRouterStub
 
@@ -27,6 +28,17 @@ from .._utils.grpc_utils import ModalChannel
 from .async_utils import aclosing, retry
 from .grpc_utils import RETRYABLE_GRPC_STATUS_CODES
 
+STREAMING_STDIN_CHUNK_SIZE = 256 * 1024
+
+_STREAMING_STDIN_RESUMABLE_EXCEPTIONS = (
+    AuthError,
+    InternalError,
+    ServiceError,
+    StreamTerminatedError,
+    OSError,
+    asyncio.TimeoutError,
+)
+
 
 @retry(n_attempts=34, base_delay=1, max_delay=10, attempt_timeout=10, total_timeout=310)
 async def _connect_channel(channel: grpclib.client.Channel):
@@ -472,6 +484,118 @@ class TaskCommandRouterClient:
                 lambda: self._call_with_auth_retry(self._stub.TaskExecStdinWrite, request)
             )
 
+    async def exec_stdin_write_stream(
+        self,
+        task_id: str,
+        exec_id: str,
+        source: BinaryIO,
+        chunk_size: int = STREAMING_STDIN_CHUNK_SIZE,
+        max_resume_attempts: int = 9,
+    ) -> int:
+        """Stream `source` into the exec's stdin, with bounded resume on transient failures.
+
+        Streams the full contents of `source` in one client-streaming RPC and
+        closes stdin (EOF) on success. On a resumable error, queries
+        `exec_stdin_status` for the server's canonical offset, seeks `source`
+        to that point, and reopens the stream.
+
+        Args:
+            task_id: The task ID of the task running the exec'd command.
+            exec_id: The execution ID of the command to write to.
+            source: A seekable byte source (file, BytesIO, etc.).
+            chunk_size: Bytes per outbound message.
+            max_resume_attempts: Upper bound on resume retries before giving up.
+
+        Returns:
+            The total number of bytes streamed into the exec's stdin.
+        """
+        offset = 0
+        attempt = 0
+        while True:
+
+            async def _chunks():
+                while True:
+                    chunk = source.read(chunk_size)
+                    if not chunk:
+                        return
+                    yield chunk
+
+            try:
+                source.seek(offset)
+                await self._exec_stdin_write_stream(task_id, exec_id, offset, _chunks())
+                return source.tell()
+            except (*_STREAMING_STDIN_RESUMABLE_EXCEPTIONS, AttributeError) as e:
+                # StreamTerminatedError surfaces as AttributeError in grpclib<=0.4.7;
+                # see call_with_retries_on_transient_errors.
+                if isinstance(e, AttributeError) and "_write_appdata" not in str(e):
+                    raise
+                attempt += 1
+                if attempt > max_resume_attempts:
+                    raise
+                status = await self.exec_stdin_status(task_id=task_id, exec_id=exec_id)
+                if status.closed:
+                    pos = source.tell()
+                    if status.num_bytes_written == pos and source.seek(0, io.SEEK_END) == pos:
+                        logger.debug(f"exec_stdin_write_stream completed but response was lost: {e}")
+                        return pos
+                    raise
+                offset = status.num_bytes_written
+                logger.debug(f"exec_stdin_write_stream resuming from offset {offset} after error: {e}")
+
+    async def _exec_stdin_write_stream(
+        self,
+        task_id: str,
+        exec_id: str,
+        start_offset: int,
+        chunks: AsyncIterable[bytes],
+    ) -> sr_pb2.TaskExecStdinWriteStreamResponse | None:
+        """Single client-streaming attempt: Start, Data chunks, then End (EOF).
+
+        Does not retry; `exec_stdin_write_stream` owns resume.
+        """
+        with grpc_error_converter():
+            stream = self._stub.TaskExecStdinWriteStream.open(metadata=self._get_metadata())
+            async with stream as s:
+                start = sr_pb2.TaskExecStdinWriteStreamRequest(
+                    start=sr_pb2.TaskExecStdinWriteStreamStart(
+                        task_id=task_id,
+                        exec_id=exec_id,
+                        offset=start_offset,
+                    ),
+                )
+                await s.send_message(start)
+                async for data in chunks:
+                    if not data:
+                        continue
+                    await s.send_message(sr_pb2.TaskExecStdinWriteStreamRequest(data=data))
+                # The server closes stdin only on this explicit End message. A
+                # stream that breaks before it leaves stdin open for resume.
+                await s.send_message(
+                    sr_pb2.TaskExecStdinWriteStreamRequest(end=sr_pb2.TaskExecStdinWriteStreamEnd()),
+                    end=True,
+                )
+                return await s.recv_message()
+
+    async def exec_stdin_status(self, task_id: str, exec_id: str) -> sr_pb2.TaskExecStdinStatusResponse:
+        """Read the current stdin write status for an exec'd command, to support retries from the right offset.
+
+        Used by streaming clients to find the resume offset after a stream
+        failure. Evicts any in-flight stdin stream for the exec, so it is not
+        safe to call for read-only observability.
+
+        Args:
+            task_id: The task ID of the task running the exec'd command.
+            exec_id: The execution ID of the command to query.
+        Raises:
+            Other errors: If retries are exhausted on transient errors or if there's an error
+              from the RPC itself.
+        """
+        request = sr_pb2.TaskExecStdinStatusRequest(task_id=task_id, exec_id=exec_id)
+        with grpc_error_converter():
+            return await call_with_retries_on_transient_errors(
+                lambda: self._call_with_auth_retry(self._stub.TaskExecStdinStatus, request)
+            )
+
     async def sandbox_stdin_write_v2(
         self, task_id: str, offset: int, data: bytes, eof: bool
     ) -> sr_pb2.SandboxStdinWriteV2Response:

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/cli/_help.py

@@ -70,7 +70,13 @@ def _option_label(param: click.Parameter, ctx: click.Context) -> Text:
             text.append(opt, style=_OPTION_FLAG_STYLE)
     if not getattr(param, "is_flag", False) and not getattr(param, "count", False):
         text.append(" ")
-        text.append(param.make_metavar(ctx), style=_OPTION_METAVAR_STYLE)
+        if "ctx" in inspect.signature(click.Parameter.make_metavar).parameters:
+            # click >= 8.2.0
+            metavar = param.make_metavar(ctx)
+        else:
+            # backwards compatibility
+            metavar = param.make_metavar()  # type: ignore[call-arg]
+        text.append(metavar, style=_OPTION_METAVAR_STYLE)
     return text
 
 

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/cli/container.py

@@ -269,15 +269,23 @@ async def _exec_impl(
     pty: bool | None = None,
     container_id: str = "",
     command: tuple[str, ...] = (),
+    object_id_for_v2: str | None = None,
 ):
-    """Execute a command in a container (implementation)."""
+    """Execute a command in a container (implementation).
+
+    For tasks belonging to V2 sandboxes, `object_id_for_v2` must be set to the
+    sandbox ID.
+    """
 
     if pty is None:
         pty = is_tty()
 
     client = await _Client.from_env()
 
-    command_router_client = await TaskCommandRouterClient.init(client, container_id)
+    if object_id_for_v2 is not None:
+        command_router_client = await TaskCommandRouterClient.init_v2(client, object_id_for_v2, container_id)
+    else:
+        command_router_client = await TaskCommandRouterClient.init(client, container_id)
 
     process_id = str(uuid.uuid4())
 

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/cli/curl.py

@@ -117,10 +117,12 @@ async def curl(curl_args: tuple[str, ...]):
     All arguments are passed directly to `curl`, which must be installed locally.
 
     Examples:
-        ```bash
-        modal curl https://user--my-app.us-west.modal.direct
-        modal curl -X GET https://user--my-app.us-west.modal.direct
-        ```
+
+    ```bash
+    modal curl https://user--my-app.us-west.modal.direct
+    modal curl -X GET https://user--my-app.us-west.modal.direct
+    ```
+
     """
     url = find_url(curl_args)
     if url is None:

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/cli/shell.py

@@ -17,7 +17,7 @@ from ..functions import Function
 from ..image import Image
 from ..mount import _Mount
 from ..runner import interactive_shell
-from ..sandbox import _MAIN_CONTAINER_NAME, Sandbox
+from ..sandbox import _MAIN_CONTAINER_NAME, Sandbox, _is_v2_sandbox_id
 from ..secret import Secret
 from ..stream_type import StreamType
 from ..volume import Volume
@@ -135,6 +135,8 @@ def _start_shell_in_running_container(ref: str, cmd: str, pty: bool) -> None:
     if container_name is not None and container_name != _MAIN_CONTAINER_NAME:
         return _start_shell_in_sidecar_container(sandbox_id, container_name, cmd, pty)
 
+    object_id_for_v2: str | None = None
+
     if _is_valid_modal_id(sandbox_id, "sb-"):
         try:
             sandbox = Sandbox.from_id(sandbox_id)
@@ -143,10 +145,12 @@ def _start_shell_in_running_container(ref: str, cmd: str, pty: bool) -> None:
             raise ClickException(f"Sandbox '{sandbox_id}' not found (is it still running?)")
         except Exception as e:
             raise ClickException(f"Error connecting to Sandbox '{sandbox_id}': {str(e)}")
+        if _is_v2_sandbox_id(sandbox_id):
+            object_id_for_v2 = sandbox_id
 
     assert _is_valid_modal_id(ref, "ta-")
     try:
-        _exec_impl(container_id=ref, command=shlex.split(cmd), pty=pty)
+        _exec_impl(container_id=ref, command=shlex.split(cmd), pty=pty, object_id_for_v2=object_id_for_v2)
     except NotFoundError:
         raise ClickException(f"Container '{ref}' not found (is it still running?)")
     except Exception as e:

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/client.pyi

@@ -35,7 +35,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.5.2.dev20",
+        version: str = "1.5.2.dev22",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -205,7 +205,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.5.2.dev20",
+        version: str = "1.5.2.dev22",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/container_process.py

@@ -1,7 +1,7 @@
 # Copyright Modal Labs 2024
 import asyncio
 import platform
-from typing import Generic, TypeVar
+from typing import BinaryIO, Generic, TypeVar
 
 from modal_proto import api_pb2
 
@@ -117,6 +117,18 @@ class _ContainerProcess(Generic[T]):
             )
         return self._returncode
 
+    async def _stdin_write_stream(self, source: BinaryIO) -> int:
+        """mdmd:hidden
+        Stream `source` into the process's stdin and close it (EOF) on success.
+
+        Returns the total bytes streamed.
+        """
+        return await self._command_router_client.exec_stdin_write_stream(
+            task_id=self._task_id,
+            exec_id=self._process_id,
+            source=source,
+        )
+
     async def poll(self) -> int | None:
         """Check if the container process has finished running.
 

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/container_process.pyi

@@ -53,6 +53,14 @@ class _ContainerProcess(typing.Generic[T]):
 
     @property
     def returncode(self) -> int: ...
+    async def _stdin_write_stream(self, source: typing.BinaryIO) -> int:
+        """mdmd:hidden
+        Stream `source` into the process's stdin and close it (EOF) on success.
+
+        Returns the total bytes streamed.
+        """
+        ...
+
     async def poll(self) -> typing.Optional[int]:
         """Check if the container process has finished running.
 
@@ -105,6 +113,25 @@ class ContainerProcess(typing.Generic[T]):
     @property
     def returncode(self) -> int: ...
 
+    class ___stdin_write_stream_spec(typing_extensions.Protocol):
+        def __call__(self, /, source: typing.BinaryIO) -> int:
+            """mdmd:hidden
+            Stream `source` into the process's stdin and close it (EOF) on success.
+
+            Returns the total bytes streamed.
+            """
+            ...
+
+        async def aio(self, /, source: typing.BinaryIO) -> int:
+            """mdmd:hidden
+            Stream `source` into the process's stdin and close it (EOF) on success.
+
+            Returns the total bytes streamed.
+            """
+            ...
+
+    _stdin_write_stream: ___stdin_write_stream_spec
+
     class __poll_spec(typing_extensions.Protocol):
         def __call__(self, /) -> typing.Optional[int]:
             """Check if the container process has finished running.

{modal-1.5.2.dev20 → modal-1.5.2.dev22}/modal/sandbox.py

@@ -816,6 +816,7 @@ class _Sandbox(_Object, type_prefix="sb"):
         *args: str,
         app: "modal.app._App | None" = None,
         name: str | None = None,
+        tags: dict[str, str] | None = None,
         image: _Image | None = None,
         env: dict[str, str | None] | None = None,
         secrets: Collection[_Secret] | None = None,
@@ -851,7 +852,7 @@ class _Sandbox(_Object, type_prefix="sb"):
         `secret=...` or `oidc_auth_role_arn`), OIDC identity tokens, proxies, and
         filesystem snapshots.
 
-        Features like tags, memory snapshots, network file systems, GPUs, and custom
+        Features like memory snapshots, network file systems, GPUs, and custom
         domains are not supported.
 
         Set `i6pn=True` to enable private IPv6 networking so sandboxes in the same
@@ -861,9 +862,10 @@ class _Sandbox(_Object, type_prefix="sb"):
         (e.g. `region="us-east-1"`).
 
         V2 sandboxes created with this method are not currently returned by
-        `Sandbox.list()` and cannot be looked up with `Sandbox.from_name()`.
-        Store `sandbox.object_id` if you need to retrieve the sandbox later, and
-        use `Sandbox.from_id(sandbox.object_id)` to reattach.
+        `Sandbox.list()`. A named sandbox can be looked up with
+        `Sandbox._experimental_from_name(app_name, name)`; otherwise store
+        `sandbox.object_id` and use `Sandbox.from_id(sandbox.object_id)` to
+        reattach.
         """
         from .app import _App
 
@@ -992,10 +994,12 @@ class _Sandbox(_Object, type_prefix="sb"):
                 ),
             )
 
+            tag_protos = [api_pb2.SandboxTag(tag_name=k, tag_value=v) for k, v in tags.items()] if tags else []
             create_req = api_pb2.SandboxCreateV2Request(
                 app_id=load_context.app_id,
                 definition=definition,
                 ephemeral_secrets=api_pb2.StringMap(contents=env_dict) if env_dict else None,
+                tags=tag_protos,
             )
             assert load_context.client._auth_token_manager
             auth_token = await load_context.client._auth_token_manager.get_token()
@@ -1186,6 +1190,44 @@ class _Sandbox(_Object, type_prefix="sb"):
         resp = await client.stub.SandboxGetFromName(req)
         return _Sandbox._new_hydrated(resp.sandbox_id, client, None)
 
+    @staticmethod
+    async def _experimental_from_name(
+        app_name: str,
+        name: str,
+        *,
+        environment_name: str | None = None,
+        client: _Client | None = None,
+    ) -> "_Sandbox":
+        """Get a running V2 Sandbox by name from a deployed App.
+
+        This looks up V2 sandboxes, ie sandboxes created via `modal.Sandbox._experimental_create`.
+
+        Args:
+            app_name: Name of the deployed app to look up the sandbox under.
+            name: Sandbox name to resolve.
+            environment_name: Optional environment name for the lookup; defaults to the configured environment.
+            client: Modal client to use for the RPC; defaults to `Client.from_env()` when omitted.
+
+        Returns:
+            A `Sandbox` handle for the running sandbox.
+
+        Raises:
+            NotFoundError: If no running sandbox exists with the given name.
+        """
+        if client is None:
+            client = await _Client.from_env()
+        env_name = _get_environment_name(environment_name)
+
+        req = api_pb2.SandboxGetFromNameRequest(sandbox_name=name, app_name=app_name, environment_name=env_name)
+        assert client._auth_token_manager
+        auth_token = await client._auth_token_manager.get_token()
+        resp = await client.stub.SandboxGetFromNameV2(req, metadata=[("x-modal-auth-token", auth_token)])
+
+        obj = _Sandbox._new_hydrated(resp.sandbox_id, client, None)
+        obj._is_v2 = True
+        obj._hydrate_metadata_v2()
+        return obj
+
     @staticmethod
     async def from_id(sandbox_id: str, client: _Client | None = None) -> "_Sandbox":
         """Construct a Sandbox from an id and look up the Sandbox result.
@@ -1228,22 +1270,27 @@ class _Sandbox(_Object, type_prefix="sb"):
         Returns:
             Tags as a map from tag name to tag value.
         """
-        self._ensure_v1("get_tags")
         req = api_pb2.SandboxTagsGetRequest(sandbox_id=self.object_id)
-        resp = await self._client.stub.SandboxTagsGet(req)
+        stub = self._client.stub
+        if self._is_v2:
+            assert self._client._auth_token_manager
+            auth_token = await self._client._auth_token_manager.get_token()
+            resp = await stub.SandboxTagsGetV2(req, metadata=[("x-modal-auth-token", auth_token)])
+        else:
+            resp = await stub.SandboxTagsGet(req)
 
         return {tag.tag_name: tag.tag_value for tag in resp.tags}
 
     async def set_tags(self, tags: dict[str, str], *, client: _Client | None = None) -> None:
         """Set tags (key-value pairs) on the Sandbox. Tags can be used to filter results in `Sandbox.list`.
 
+        Setting tags replaces the Sandbox's entire tag set; passing an empty dict clears all tags.
+
         Args:
             tags: Tag names and values to set on this sandbox.
             client: Deprecated. Prefer setting the client when creating or re-attaching to the sandbox.
 
         """
-        self._ensure_v1("set_tags")
-        environment_name = _get_environment_name()
         if client is not None:
             deprecation_warning(
                 (2025, 9, 18),
@@ -1252,13 +1299,19 @@ class _Sandbox(_Object, type_prefix="sb"):
             )
 
         tags_list = [api_pb2.SandboxTag(tag_name=name, tag_value=value) for name, value in tags.items()]
-
-        req = api_pb2.SandboxTagsSetRequest(
-            environment_name=environment_name,
-            sandbox_id=self.object_id,
-            tags=tags_list,
-        )
-        await self._client.stub.SandboxTagsSet(req)
+        stub = self._client.stub
+        if self._is_v2:
+            assert self._client._auth_token_manager
+            auth_token = await self._client._auth_token_manager.get_token()
+            req = api_pb2.SandboxTagsSetRequest(sandbox_id=self.object_id, tags=tags_list)
+            await stub.SandboxTagsSetV2(req, metadata=[("x-modal-auth-token", auth_token)])
+        else:
+            req = api_pb2.SandboxTagsSetRequest(
+                environment_name=_get_environment_name(),
+                sandbox_id=self.object_id,
+                tags=tags_list,
+            )
+            await stub.SandboxTagsSet(req)
 
     async def _experimental_set_outbound_network_policy(
         self,
@@ -2279,15 +2332,15 @@ class _Sandbox(_Object, type_prefix="sb"):
 
     @staticmethod
     async def _experimental_list(
-        *, app_id: str | None = None, client: _Client | None = None
+        *, app_id: str | None = None, tags: dict[str, str] | None = None, client: _Client | None = None
     ) -> AsyncGenerator["_Sandbox", None]:
         """List v2 Sandboxes in an App.
 
         This function lists v2 sandboxes, ie sandboxes created via modal.Sandbox._experimental_create.
-        Filtering based on tags is not yet supported.
 
         Args:
             app_id: The App to list Sandboxes under.
+            tags: If set, only sandboxes containing at least these tags are returned.
             client: Optional client to use for the session.
 
         Yields:
@@ -2304,12 +2357,15 @@ class _Sandbox(_Object, type_prefix="sb"):
         if client is None:
             client = await _Client.from_env()
 
+        tags_list = [api_pb2.SandboxTag(tag_name=name, tag_value=value) for name, value in tags.items()] if tags else []
+
         assert client._auth_token_manager
         while True:
             req = api_pb2.SandboxListRequest(
                 app_id=app_id,
                 before_timestamp=before_timestamp,
                 include_finished=False,
+                tags=tags_list,
             )
 
             # Fetches a batch of sandboxes. SandboxListV2 authenticates via the