modAL 1.4.4.dev6__py3-none-any.whl → 1.4.4.dev8__py3-none-any.whl

modal/_runtime/asgi.py

@@ -285,7 +285,7 @@ def wait_for_web_server(host: str, port: int, *, timeout: float) -> None:
     start_time = time.monotonic()
     while True:
         try:
-            with socket.create_connection((host, port), timeout=timeout):
+            with socket.create_connection((host, port), timeout=min(timeout, 1.0)):
                 break
         except OSError as ex:
             time.sleep(0.01)

modal/cli/shell.py

@@ -2,7 +2,7 @@
 import platform
 import shlex
 from pathlib import Path, PurePosixPath
-from typing import Any, Callable, Iterable, Optional
+from typing import Any, Callable, Iterable, Optional, Union
 
 import click
 from click import ClickException
@@ -10,12 +10,13 @@ from click import ClickException
 from .._environments import ensure_env
 from .._functions import _FunctionSpec
 from ..app import App
+from ..container_process import ContainerProcess
 from ..exception import InvalidError, NotFoundError
 from ..functions import Function
 from ..image import Image
 from ..mount import _Mount
 from ..runner import interactive_shell
-from ..sandbox import Sandbox
+from ..sandbox import _MAIN_CONTAINER_NAME, Sandbox
 from ..secret import Secret
 from ..stream_type import StreamType
 from ..volume import Volume
@@ -105,8 +106,8 @@ def _is_running_container_ref(ref: Optional[str]) -> bool:
     return _is_valid_modal_id(sandbox_id, "sb-") or _is_valid_modal_id(ref, "ta-")
 
 
-def _start_shell_in_sandbox_container(sandbox_id: str, container_name: str, cmd: str, pty: bool) -> None:
-    """Shell into a named container within a sandbox."""
+def _start_shell_in_sidecar_container(sandbox_id: str, container_name: str, cmd: str, pty: bool) -> None:
+    """Shell into a sidecar container within a sandbox."""
     try:
         sandbox = Sandbox.from_id(sandbox_id)
     except NotFoundError:
@@ -115,18 +116,19 @@ def _start_shell_in_sandbox_container(sandbox_id: str, container_name: str, cmd:
         raise ClickException(f"Error connecting to Sandbox '{sandbox_id}': {str(e)}")
 
     try:
-        sandbox_container = sandbox._experimental_containers.get(name=container_name)
+        sandbox_container = sandbox._experimental_sidecars.get(name=container_name)
+        process: Union[ContainerProcess[bytes], ContainerProcess[str]]
         if pty:
             # PTY output is raw terminal bytes, not text; strict UTF-8 decode
             # crashes on the first non-UTF-8 byte (e.g. vim drawing a Latin-1
             # file under LC_CTYPE=C). See the matching call in `_exec_impl`.
-            process = sandbox_container.exec(*shlex.split(cmd), pty=pty, text=False)
+            process = sandbox_container.exec(*shlex.split(cmd), pty=True, text=False)
             process.attach()
         else:
             process = sandbox_container.exec(
-                *shlex.split(cmd), pty=pty, stdout=StreamType.STDOUT, stderr=StreamType.STDOUT
+                *shlex.split(cmd), pty=False, text=False, stdout=StreamType.STDOUT, stderr=StreamType.STDOUT
             )
-            process.wait()
+            _ = process.wait()
     except NotFoundError:
         raise ClickException(f"Container '{container_name}' not found in Sandbox '{sandbox_id}'.")
     except Exception as e:
@@ -136,8 +138,8 @@ def _start_shell_in_sandbox_container(sandbox_id: str, container_name: str, cmd:
 def _start_shell_in_running_container(ref: str, cmd: str, pty: bool) -> None:
     sandbox_id, container_name = _parse_sandbox_container_ref(ref)
 
-    if container_name is not None:
-        return _start_shell_in_sandbox_container(sandbox_id, container_name, cmd, pty)
+    if container_name is not None and container_name != _MAIN_CONTAINER_NAME:
+        return _start_shell_in_sidecar_container(sandbox_id, container_name, cmd, pty)
 
     if _is_valid_modal_id(sandbox_id, "sb-"):
         try:

modal/client.pyi

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

modal/io_streams.py

@@ -501,7 +501,7 @@ class _StreamReader(Generic[T]):
 MAX_BUFFER_SIZE = 2 * 1024 * 1024
 # Larger buffer limit for the exec path via the task command router.
 # This applies only to task_exec_stdin_write; sandbox stdin via the server keeps MAX_BUFFER_SIZE.
-TASK_COMMAND_ROUTER_MAX_BUFFER_SIZE = 16 * 1024 * 1024
+TASK_COMMAND_ROUTER_MAX_BUFFER_SIZE: int = 16 * 1024 * 1024
 
 
 @dataclass(frozen=True)

modal/io_streams.pyi

@@ -589,3 +589,5 @@ class StreamWriter:
             ...
 
     drain: __drain_spec
+
+TASK_COMMAND_ROUTER_MAX_BUFFER_SIZE: int

modal/sandbox.py

@@ -5,6 +5,7 @@ import enum
 import json
 import os
 import time
+import typing
 import uuid
 from collections.abc import AsyncGenerator, Collection, Sequence
 from dataclasses import dataclass
@@ -1385,10 +1386,10 @@ class _Sandbox(_Object, type_prefix="sb"):
         return self._command_router_client
 
     @property
-    def _experimental_containers(self) -> "_SandboxContainerManager":
-        """Manage additional containers running in this Sandbox."""
+    def _experimental_sidecars(self) -> "_SidecarManager":
+        """Manage sidecar containers running in this Sandbox."""
         self._ensure_attached()
-        return _SandboxContainerManager(self)
+        return _SidecarManager(self)
 
     @overload
     async def exec(
@@ -1853,10 +1854,11 @@ class _Sandbox(_Object, type_prefix="sb"):
             before_timestamp = resp.sandboxes[-1].created_at
 
 
-class _SandboxContainer:
+class _SidecarContainer:
     """Handle to an additional container running in a Sandbox."""
 
     _result: Optional[api_pb2.GenericResult]
+    _filesystem: Optional[_SandboxFilesystem]
 
     def __init__(
         self,
@@ -1869,6 +1871,7 @@ class _SandboxContainer:
         self._container_id = container_id
         self._container_name = container_name
         self._result = result
+        self._filesystem = None
 
     @property
     def object_id(self) -> str:
@@ -1879,9 +1882,9 @@ class _SandboxContainer:
         return self._container_name
 
     @staticmethod
-    def _from_container_info(sandbox: "_Sandbox", container_info: sr_pb2.TaskContainerInfo) -> "_SandboxContainer":
+    def _from_container_info(sandbox: "_Sandbox", container_info: sr_pb2.TaskContainerInfo) -> "_SidecarContainer":
         result = container_info.result if container_info.HasField("result") else None
-        return _SandboxContainer(sandbox, container_info.container_id, container_info.container_name, result)
+        return _SidecarContainer(sandbox, container_info.container_id, container_info.container_name, result)
 
     async def _get_command_router(self) -> tuple[str, "TaskCommandRouterClient"]:
         """Get task ID and command router client."""
@@ -1889,6 +1892,40 @@ class _SandboxContainer:
         command_router_client = await self._sandbox._get_command_router_client(task_id)
         return task_id, command_router_client
 
+    @typing.overload
+    async def exec(
+        self,
+        *args: str,
+        stdout: StreamType = StreamType.PIPE,
+        stderr: StreamType = StreamType.PIPE,
+        timeout: Optional[int] = None,
+        workdir: Optional[str] = None,
+        env: Optional[dict[str, Optional[str]]] = None,
+        secrets: Optional[Collection[_Secret]] = None,
+        text: Literal[True] = True,
+        bufsize: Literal[-1, 1] = -1,
+        # Enable a PTY for the command. When enabled, all output (stdout and stderr from the
+        # process) is multiplexed into stdout, and the stderr stream is effectively empty.
+        pty: bool = False,
+    ) -> _ContainerProcess[str]: ...
+
+    @typing.overload
+    async def exec(
+        self,
+        *args: str,
+        stdout: StreamType = StreamType.PIPE,
+        stderr: StreamType = StreamType.PIPE,
+        timeout: Optional[int] = None,
+        workdir: Optional[str] = None,
+        env: Optional[dict[str, Optional[str]]] = None,
+        secrets: Optional[Collection[_Secret]] = None,
+        text: Literal[False],
+        bufsize: Literal[-1, 1] = -1,
+        # Enable a PTY for the command. When enabled, all output (stdout and stderr from the
+        # process) is multiplexed into stdout, and the stderr stream is effectively empty.
+        pty: bool = False,
+    ) -> _ContainerProcess[bytes]: ...
+
     async def exec(
         self,
         *args: str,
@@ -1919,6 +1956,13 @@ class _SandboxContainer:
             container_id=self._container_id,
         )
 
+    @property
+    def filesystem(self) -> _SandboxFilesystem:
+        """Namespace for filesystem APIs."""
+        if self._filesystem is None:
+            self._filesystem = _SandboxFilesystem(self)
+        return self._filesystem
+
     async def wait(self, raise_on_termination: bool = True) -> None:
         if self._result is not None and self._result.status != api_pb2.GenericResult.GENERIC_STATUS_UNSPECIFIED:
             if self._result.status == api_pb2.GenericResult.GENERIC_STATUS_TERMINATED and raise_on_termination:
@@ -1987,8 +2031,11 @@ class _SandboxContainer:
             return _result_returncode(self._result)
 
 
-class _SandboxContainerManager:
-    """Creates and manages additional containers in a Sandbox."""
+_MAIN_CONTAINER_NAME: str = "main"
+
+
+class _SidecarManager:
+    """Creates and manages sidecar containers in a Sandbox."""
 
     def __init__(self, sandbox: _Sandbox) -> None:
         self._sandbox = sandbox
@@ -2007,22 +2054,24 @@ class _SandboxContainerManager:
         env: Optional[dict[str, str]] = None,
         secrets: Optional[Collection[_Secret]] = None,
         workdir: Optional[str] = None,
-    ) -> _SandboxContainer:
+    ) -> _SidecarContainer:
+        if name == _MAIN_CONTAINER_NAME:
+            raise InvalidError(f"The name {_MAIN_CONTAINER_NAME!r} is reserved for the sandbox's main container.")
         if workdir is not None and not workdir.startswith("/"):
             raise InvalidError(f"workdir must be an absolute path, got: {workdir}")
         _validate_exec_args(args)
 
         if image._mount_layers:
             raise InvalidError(
-                "Sandbox._experimental_containers.create(image=...) only supports pre-built images. "
+                "Sandbox._experimental_sidecars.create(image=...) only supports pre-built images. "
                 "When using `add_local*` methods, specify `copy=True` and call `.build()` before passing "
-                "the image to `._experimental_containers.create()`:\n\nE.g.\n"
+                "the image to `._experimental_sidecars.create()`:\n\nE.g.\n"
                 'img = modal.Image.debian_slim().add_local_file("foo", "/foo", copy=True).build(app)\n'
-                'sandbox._experimental_containers.create(name="worker", image=img)'
+                'sandbox._experimental_sidecars.create(name="worker", image=img)'
             )
         if not image._object_id:
             raise InvalidError(
-                "Sandbox._experimental_containers.create(image=...) currently only supports Images that are "
+                "Sandbox._experimental_sidecars.create(image=...) currently only supports Images that are "
                 "either:\n"
                 "- prebuilt using `image.build()`\n"
                 "- referenced by id, e.g. `Image.from_id()`\n"
@@ -2048,9 +2097,14 @@ class _SandboxContainerManager:
         create_resp = await command_router_client.container_create(create_req)
         container_id = create_resp.container_id
         container_name = create_resp.container_name or name
-        return _SandboxContainer(self._sandbox, container_id, container_name)
+        return _SidecarContainer(self._sandbox, container_id, container_name)
 
-    async def get(self, *, name: str, include_terminated: bool = False) -> "_SandboxContainer":
+    async def get(self, *, name: str, include_terminated: bool = False) -> "_SidecarContainer":
+        if name == _MAIN_CONTAINER_NAME:
+            raise InvalidError(
+                "Cannot get the main sandbox container through the sidecars API. "
+                "Use Sandbox methods directly to interact with the main container."
+            )
         task_id, command_router_client = await self._get_command_router()
         resp = await command_router_client.container_get(
             sr_pb2.TaskContainerGetRequest(
@@ -2059,16 +2113,20 @@ class _SandboxContainerManager:
                 include_terminated=include_terminated,
             )
         )
-        return _SandboxContainer._from_container_info(self._sandbox, resp.container)
+        return _SidecarContainer._from_container_info(self._sandbox, resp.container)
 
-    async def list(self, include_terminated: bool = False) -> builtins.list[_SandboxContainer]:
+    async def list(self, include_terminated: bool = False) -> builtins.list[_SidecarContainer]:
         task_id, command_router_client = await self._get_command_router()
         resp = await command_router_client.container_list(
             sr_pb2.TaskContainerListRequest(task_id=task_id, include_terminated=include_terminated)
         )
-        return [_SandboxContainer._from_container_info(self._sandbox, container) for container in resp.containers]
+        return [
+            _SidecarContainer._from_container_info(self._sandbox, container)
+            for container in resp.containers
+            if container.container_name != _MAIN_CONTAINER_NAME
+        ]
 
 
-SandboxContainer = synchronize_api(_SandboxContainer)
-SandboxContainerManager = synchronize_api(_SandboxContainerManager)
+SidecarContainer = synchronize_api(_SidecarContainer)
+SidecarManager = synchronize_api(_SidecarManager)
 Sandbox = synchronize_api(_Sandbox)

modal/sandbox.pyi

@@ -533,8 +533,8 @@ class _Sandbox(modal._object._Object):
         self, task_id: str
     ) -> modal._utils.task_command_router_client.TaskCommandRouterClient: ...
     @property
-    def _experimental_containers(self) -> _SandboxContainerManager:
-        """Manage additional containers running in this Sandbox."""
+    def _experimental_sidecars(self) -> _SidecarManager:
+        """Manage sidecar containers running in this Sandbox."""
         ...
 
     @typing.overload
@@ -697,10 +697,11 @@ class _Sandbox(modal._object._Object):
         """
         ...
 
-class _SandboxContainer:
+class _SidecarContainer:
     """Handle to an additional container running in a Sandbox."""
 
     _result: typing.Optional[modal_proto.api_pb2.GenericResult]
+    _filesystem: typing.Optional[modal.sandbox_fs._SandboxFilesystem]
 
     def __init__(
         self,
@@ -719,11 +720,12 @@ class _SandboxContainer:
     @staticmethod
     def _from_container_info(
         sandbox: _Sandbox, container_info: modal_proto.task_command_router_pb2.TaskContainerInfo
-    ) -> _SandboxContainer: ...
+    ) -> _SidecarContainer: ...
     async def _get_command_router(self) -> tuple[str, modal._utils.task_command_router_client.TaskCommandRouterClient]:
         """Get task ID and command router client."""
         ...
 
+    @typing.overload
     async def exec(
         self,
         *args: str,
@@ -733,12 +735,29 @@ class _SandboxContainer:
         workdir: typing.Optional[str] = None,
         env: typing.Optional[dict[str, typing.Optional[str]]] = None,
         secrets: typing.Optional[collections.abc.Collection[modal.secret._Secret]] = None,
-        text: bool = True,
+        text: typing.Literal[True] = True,
+        bufsize: typing.Literal[-1, 1] = -1,
+        pty: bool = False,
+    ) -> modal.container_process._ContainerProcess[str]: ...
+    @typing.overload
+    async def exec(
+        self,
+        *args: str,
+        stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+        stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+        timeout: typing.Optional[int] = None,
+        workdir: typing.Optional[str] = None,
+        env: typing.Optional[dict[str, typing.Optional[str]]] = None,
+        secrets: typing.Optional[collections.abc.Collection[modal.secret._Secret]] = None,
+        text: typing.Literal[False],
         bufsize: typing.Literal[-1, 1] = -1,
         pty: bool = False,
-    ) -> typing.Union[
-        modal.container_process._ContainerProcess[bytes], modal.container_process._ContainerProcess[str]
-    ]: ...
+    ) -> modal.container_process._ContainerProcess[bytes]: ...
+    @property
+    def filesystem(self) -> modal.sandbox_fs._SandboxFilesystem:
+        """Namespace for filesystem APIs."""
+        ...
+
     async def wait(self, raise_on_termination: bool = True) -> None: ...
     async def poll(self) -> typing.Optional[int]: ...
     @typing.overload
@@ -746,8 +765,8 @@ class _SandboxContainer:
     @typing.overload
     async def terminate(self, *, wait: typing.Literal[False] = False) -> None: ...
 
-class _SandboxContainerManager:
-    """Creates and manages additional containers in a Sandbox."""
+class _SidecarManager:
+    """Creates and manages sidecar containers in a Sandbox."""
     def __init__(self, sandbox: _Sandbox) -> None:
         """Initialize self.  See help(type(self)) for accurate signature."""
         ...
@@ -764,14 +783,15 @@ class _SandboxContainerManager:
         env: typing.Optional[dict[str, str]] = None,
         secrets: typing.Optional[collections.abc.Collection[modal.secret._Secret]] = None,
         workdir: typing.Optional[str] = None,
-    ) -> _SandboxContainer: ...
-    async def get(self, *, name: str, include_terminated: bool = False) -> _SandboxContainer: ...
-    async def list(self, include_terminated: bool = False) -> list[_SandboxContainer]: ...
+    ) -> _SidecarContainer: ...
+    async def get(self, *, name: str, include_terminated: bool = False) -> _SidecarContainer: ...
+    async def list(self, include_terminated: bool = False) -> list[_SidecarContainer]: ...
 
-class SandboxContainer:
+class SidecarContainer:
     """Handle to an additional container running in a Sandbox."""
 
     _result: typing.Optional[modal_proto.api_pb2.GenericResult]
+    _filesystem: typing.Optional[modal.sandbox_fs.SandboxFilesystem]
 
     def __init__(
         self,
@@ -787,7 +807,7 @@ class SandboxContainer:
     @staticmethod
     def _from_container_info(
         sandbox: Sandbox, container_info: modal_proto.task_command_router_pb2.TaskContainerInfo
-    ) -> SandboxContainer: ...
+    ) -> SidecarContainer: ...
 
     class ___get_command_router_spec(typing_extensions.Protocol):
         def __call__(self, /) -> tuple[str, modal._utils.task_command_router_client.TaskCommandRouterClient]:
@@ -801,6 +821,7 @@ class SandboxContainer:
     _get_command_router: ___get_command_router_spec
 
     class __exec_spec(typing_extensions.Protocol):
+        @typing.overload
         def __call__(
             self,
             /,
@@ -811,12 +832,26 @@ class SandboxContainer:
             workdir: typing.Optional[str] = None,
             env: typing.Optional[dict[str, typing.Optional[str]]] = None,
             secrets: typing.Optional[collections.abc.Collection[modal.secret.Secret]] = None,
-            text: bool = True,
+            text: typing.Literal[True] = True,
             bufsize: typing.Literal[-1, 1] = -1,
             pty: bool = False,
-        ) -> typing.Union[
-            modal.container_process.ContainerProcess[bytes], modal.container_process.ContainerProcess[str]
-        ]: ...
+        ) -> modal.container_process.ContainerProcess[str]: ...
+        @typing.overload
+        def __call__(
+            self,
+            /,
+            *args: str,
+            stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            timeout: typing.Optional[int] = None,
+            workdir: typing.Optional[str] = None,
+            env: typing.Optional[dict[str, typing.Optional[str]]] = None,
+            secrets: typing.Optional[collections.abc.Collection[modal.secret.Secret]] = None,
+            text: typing.Literal[False],
+            bufsize: typing.Literal[-1, 1] = -1,
+            pty: bool = False,
+        ) -> modal.container_process.ContainerProcess[bytes]: ...
+        @typing.overload
         async def aio(
             self,
             /,
@@ -827,15 +862,33 @@ class SandboxContainer:
             workdir: typing.Optional[str] = None,
             env: typing.Optional[dict[str, typing.Optional[str]]] = None,
             secrets: typing.Optional[collections.abc.Collection[modal.secret.Secret]] = None,
-            text: bool = True,
+            text: typing.Literal[True] = True,
             bufsize: typing.Literal[-1, 1] = -1,
             pty: bool = False,
-        ) -> typing.Union[
-            modal.container_process.ContainerProcess[bytes], modal.container_process.ContainerProcess[str]
-        ]: ...
+        ) -> modal.container_process.ContainerProcess[str]: ...
+        @typing.overload
+        async def aio(
+            self,
+            /,
+            *args: str,
+            stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            timeout: typing.Optional[int] = None,
+            workdir: typing.Optional[str] = None,
+            env: typing.Optional[dict[str, typing.Optional[str]]] = None,
+            secrets: typing.Optional[collections.abc.Collection[modal.secret.Secret]] = None,
+            text: typing.Literal[False],
+            bufsize: typing.Literal[-1, 1] = -1,
+            pty: bool = False,
+        ) -> modal.container_process.ContainerProcess[bytes]: ...
 
     exec: __exec_spec
 
+    @property
+    def filesystem(self) -> modal.sandbox_fs.SandboxFilesystem:
+        """Namespace for filesystem APIs."""
+        ...
+
     class __wait_spec(typing_extensions.Protocol):
         def __call__(self, /, raise_on_termination: bool = True) -> None: ...
         async def aio(self, /, raise_on_termination: bool = True) -> None: ...
@@ -860,8 +913,8 @@ class SandboxContainer:
 
     terminate: __terminate_spec
 
-class SandboxContainerManager:
-    """Creates and manages additional containers in a Sandbox."""
+class SidecarManager:
+    """Creates and manages sidecar containers in a Sandbox."""
     def __init__(self, sandbox: Sandbox) -> None: ...
 
     class ___get_command_router_spec(typing_extensions.Protocol):
@@ -885,7 +938,7 @@ class SandboxContainerManager:
             env: typing.Optional[dict[str, str]] = None,
             secrets: typing.Optional[collections.abc.Collection[modal.secret.Secret]] = None,
             workdir: typing.Optional[str] = None,
-        ) -> SandboxContainer: ...
+        ) -> SidecarContainer: ...
         async def aio(
             self,
             /,
@@ -895,19 +948,19 @@ class SandboxContainerManager:
             env: typing.Optional[dict[str, str]] = None,
             secrets: typing.Optional[collections.abc.Collection[modal.secret.Secret]] = None,
             workdir: typing.Optional[str] = None,
-        ) -> SandboxContainer: ...
+        ) -> SidecarContainer: ...
 
     create: __create_spec
 
     class __get_spec(typing_extensions.Protocol):
-        def __call__(self, /, *, name: str, include_terminated: bool = False) -> SandboxContainer: ...
-        async def aio(self, /, *, name: str, include_terminated: bool = False) -> SandboxContainer: ...
+        def __call__(self, /, *, name: str, include_terminated: bool = False) -> SidecarContainer: ...
+        async def aio(self, /, *, name: str, include_terminated: bool = False) -> SidecarContainer: ...
 
     get: __get_spec
 
     class __list_spec(typing_extensions.Protocol):
-        def __call__(self, /, include_terminated: bool = False) -> list[SandboxContainer]: ...
-        async def aio(self, /, include_terminated: bool = False) -> list[SandboxContainer]: ...
+        def __call__(self, /, include_terminated: bool = False) -> list[SidecarContainer]: ...
+        async def aio(self, /, include_terminated: bool = False) -> list[SidecarContainer]: ...
 
     list: __list_spec
 
@@ -1707,8 +1760,8 @@ class Sandbox(modal.object.Object):
     _get_command_router_client: ___get_command_router_client_spec
 
     @property
-    def _experimental_containers(self) -> SandboxContainerManager:
-        """Manage additional containers running in this Sandbox."""
+    def _experimental_sidecars(self) -> SidecarManager:
+        """Manage sidecar containers running in this Sandbox."""
         ...
 
     class __exec_spec(typing_extensions.Protocol):
@@ -2060,3 +2113,5 @@ class Sandbox(modal.object.Object):
     list: typing.ClassVar[__list_spec]
 
 _default_image: modal.image._Image
+
+_MAIN_CONTAINER_NAME: str

modal/sandbox_fs.py

@@ -9,7 +9,10 @@ import time
 import weakref
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Union, cast
+from typing import TYPE_CHECKING, Union, cast
+
+if TYPE_CHECKING:
+    import modal.sandbox
 
 from ._utils.async_utils import synchronize_api
 from ._utils.logger import logger
@@ -84,14 +87,14 @@ class _SandboxFilesystem:
     """mdmd:namespace
     Namespace for Sandbox filesystem APIs."""
 
-    def __init__(self, sandbox):
+    _container: Union["modal.sandbox._Sandbox", "modal.sandbox._SidecarContainer"]
+
+    def __init__(self, container: Union["modal.sandbox._Sandbox", "modal.sandbox._SidecarContainer"]) -> None:
         """mdmd:hidden"""
-        from modal.sandbox import _Sandbox
+        from modal.sandbox import _Sandbox, _SidecarContainer
 
-        # inv type-stubs does not work with importing _Sandbox with TYPE_CHECKING,
-        # so we'll use `cast` as a workaround.
-        # Use a weakref proxy to avoid circular references between Sandbox and SandboxFilesystem.
-        self._sandbox = cast(_Sandbox, weakref.proxy(sandbox))
+        # Use a weakref proxy to avoid circular references between Sandbox/SidecarContainer and SandboxFilesystem.
+        self._container = cast(Union[_Sandbox, _SidecarContainer], weakref.proxy(container))
 
     async def copy_from_local(self, local_path: Union[str, os.PathLike], remote_path: str) -> None:
         """Copy a local file into the Sandbox.
@@ -127,7 +130,7 @@ class _SandboxFilesystem:
         total_bytes = 0
         with open(local_path, "rb") as file_obj:
             with translate_exec_errors("copy_from_local", remote_path):
-                process = await self._sandbox.exec(_SANDBOX_FS_TOOLS_PATH, make_write_file_command(remote_path))
+                process = await self._container.exec(_SANDBOX_FS_TOOLS_PATH, make_write_file_command(remote_path))
                 try:
                     while True:
                         # TODO(saltzm): If this fails, the ContainerProcess will remain alive indefinitely since
@@ -190,7 +193,7 @@ class _SandboxFilesystem:
         t0 = time.monotonic()
         try:
             with translate_exec_errors("copy_to_local", remote_path):
-                process = await self._sandbox.exec(
+                process = await self._container.exec(
                     _SANDBOX_FS_TOOLS_PATH, make_read_file_command(remote_path), text=False
                 )
 
@@ -243,7 +246,7 @@ class _SandboxFilesystem:
 
         t0 = time.monotonic()
         with translate_exec_errors("list_files", remote_path):
-            process = await self._sandbox.exec(_SANDBOX_FS_TOOLS_PATH, make_list_files_command(remote_path))
+            process = await self._container.exec(_SANDBOX_FS_TOOLS_PATH, make_list_files_command(remote_path))
             stdout, stderr, returncode = await asyncio.gather(
                 process.stdout.read(), process.stderr.read(), process.wait()
             )
@@ -299,7 +302,7 @@ class _SandboxFilesystem:
         validate_absolute_remote_path(remote_path, "make_directory")
 
         with translate_exec_errors("make_directory", remote_path):
-            process = await self._sandbox.exec(
+            process = await self._container.exec(
                 _SANDBOX_FS_TOOLS_PATH, make_make_directory_command(remote_path, create_parents)
             )
             stderr, returncode = await asyncio.gather(process.stderr.read(), process.wait())
@@ -331,7 +334,9 @@ class _SandboxFilesystem:
 
         t0 = time.monotonic()
         with translate_exec_errors("read_bytes", remote_path):
-            process = await self._sandbox.exec(_SANDBOX_FS_TOOLS_PATH, make_read_file_command(remote_path), text=False)
+            process = await self._container.exec(
+                _SANDBOX_FS_TOOLS_PATH, make_read_file_command(remote_path), text=False
+            )
             stdout, stderr, returncode = await asyncio.gather(
                 process.stdout.read(), process.stderr.read(), process.wait()
             )
@@ -367,7 +372,7 @@ class _SandboxFilesystem:
 
         t0 = time.monotonic()
         with translate_exec_errors("read_text", remote_path):
-            process = await self._sandbox.exec(_SANDBOX_FS_TOOLS_PATH, make_read_file_command(remote_path))
+            process = await self._container.exec(_SANDBOX_FS_TOOLS_PATH, make_read_file_command(remote_path))
             stdout, stderr, returncode = await asyncio.gather(
                 process.stdout.read(), process.stderr.read(), process.wait()
             )
@@ -421,7 +426,7 @@ class _SandboxFilesystem:
         validate_absolute_remote_path(remote_path, "remove")
 
         with translate_exec_errors("remove", remote_path):
-            process = await self._sandbox.exec(_SANDBOX_FS_TOOLS_PATH, make_remove_command(remote_path, recursive))
+            process = await self._container.exec(_SANDBOX_FS_TOOLS_PATH, make_remove_command(remote_path, recursive))
             stderr, returncode = await asyncio.gather(process.stderr.read(), process.wait())
 
         if returncode != 0:
@@ -452,7 +457,7 @@ class _SandboxFilesystem:
 
         t0 = time.monotonic()
         with translate_exec_errors("stat", remote_path):
-            process = await self._sandbox.exec(_SANDBOX_FS_TOOLS_PATH, make_stat_command(remote_path))
+            process = await self._container.exec(_SANDBOX_FS_TOOLS_PATH, make_stat_command(remote_path))
             stdout, stderr, returncode = await asyncio.gather(
                 process.stdout.read(), process.stderr.read(), process.wait()
             )
@@ -504,7 +509,7 @@ class _SandboxFilesystem:
 
         t0 = time.monotonic()
         with translate_exec_errors("write_bytes", remote_path):
-            process = await self._sandbox.exec(_SANDBOX_FS_TOOLS_PATH, make_write_file_command(remote_path))
+            process = await self._container.exec(_SANDBOX_FS_TOOLS_PATH, make_write_file_command(remote_path))
             try:
                 for offset in range(0, max(len(data), 1), TASK_COMMAND_ROUTER_MAX_BUFFER_SIZE):
                     process.stdin.write(data[offset : offset + TASK_COMMAND_ROUTER_MAX_BUFFER_SIZE])

modal/sandbox_fs.pyi

@@ -1,4 +1,5 @@
 import enum
+import modal.sandbox
 import os
 import typing
 import typing_extensions
@@ -78,7 +79,10 @@ class _SandboxFilesystem:
     """mdmd:namespace
     Namespace for Sandbox filesystem APIs.
     """
-    def __init__(self, sandbox):
+
+    _container: typing.Union[modal.sandbox._Sandbox, modal.sandbox._SidecarContainer]
+
+    def __init__(self, container: typing.Union[modal.sandbox._Sandbox, modal.sandbox._SidecarContainer]) -> None:
         """mdmd:hidden"""
         ...
 
@@ -341,7 +345,10 @@ class SandboxFilesystem:
     """mdmd:namespace
     Namespace for Sandbox filesystem APIs.
     """
-    def __init__(self, sandbox):
+
+    _container: typing.Union[modal.sandbox.Sandbox, modal.sandbox.SidecarContainer]
+
+    def __init__(self, container: typing.Union[modal.sandbox.Sandbox, modal.sandbox.SidecarContainer]) -> None:
         """mdmd:hidden"""
         ...
 

{modal-1.4.4.dev6.dist-info → modal-1.4.4.dev8.dist-info}/METADATA

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

{modal-1.4.4.dev6.dist-info → modal-1.4.4.dev8.dist-info}/RECORD

@@ -28,7 +28,7 @@ modal/app.pyi,sha256=KgYfkXXrwF31zvS0U-O3gpLCyPf-aenwOg_g97eMSoA,54010
 modal/billing.py,sha256=B2zXa7KeMnpqi2AQINycEk-KSXVYaLTTTAQTtuf2Gfs,257
 modal/call_graph.py,sha256=1g2DGcMIJvRy-xKicuf63IVE98gJSnQsr8R_NVMptNc,2581
 modal/client.py,sha256=jjT4eLFHGcvIF6Xw4kPptIx-VmExtphRN8XJ1JA7fWI,15502
-modal/client.pyi,sha256=rE07eh5q4iJ6X_9YzNiQSBmCKOMVIsDwGZfsjO7u4Ss,15701
+modal/client.pyi,sha256=WUA0I1OfCbHYE9Au3nuKfYoNfTEvM58qCcnSXowZsPg,15701
 modal/cloud_bucket_mount.py,sha256=KkaJVy5vpO_u2NtDYtv1JM-M3y4J0UtWBapTDKpQRcA,6034
 modal/cloud_bucket_mount.pyi,sha256=mGDeEd1XvxGpCE6O5jRBSfIvMXvZ5AtIybea5k-0w9w,7560
 modal/cls.py,sha256=UTtp9W3SuFIbkYEE2D94SUzKiMXM5BYgfHGzBQD6CEk,38304
@@ -48,8 +48,8 @@ modal/functions.py,sha256=EZRcHFfnoYbvawUJnAHF5nIvoo9GX2Djy7mUmOCXmXc,258
 modal/functions.pyi,sha256=oQbuXhpMhPmOvDK5YvDaC19iGqa_gbtPG8yTe8MOhz4,37940
 modal/image.py,sha256=1iHT8KmdWtvIfusupTf_AJGBMUI4PQuAciBp-f_uYL0,113221
 modal/image.pyi,sha256=FUAY23rnaUmpRBVazrzh3Z3b9tYTMikbyk2SbuIpihI,81004
-modal/io_streams.py,sha256=15dSqTktIFvqANRDO8pjFjuwgybGAdRBorEM-3ag-fw,25000
-modal/io_streams.pyi,sha256=xCXvb8MxXwytsh2cKXQ3ZUizOOYlXJbEc_2qRiB8DZw,19232
+modal/io_streams.py,sha256=_rxW4ZfypqTKCCZkfONOsKxO6PY-e95iqR6r08moKiw,25005
+modal/io_streams.pyi,sha256=LerhD5XhMqSWXbPDrUhrX7YSko9DzhvPSlEzyOtaX5s,19274
 modal/mount.py,sha256=rJq9925KwmSYaojWOnG4XD1vpSjSKBclpx-75C58rBU,34746
 modal/mount.pyi,sha256=HVNPL8po23Hulaj7Kdl5goakZbirN0ADv2nkLc8Hpn4,15748
 modal/network_file_system.py,sha256=uyBdVuCLARJrxmD-EsQfzv5gmQxFUXnp65qesPKULvs,13331
@@ -70,10 +70,10 @@ modal/retries.py,sha256=vPWWKP-FRolJwTBuLPXdWqHV7aJfSQFgEW7vhlBBXRQ,5067
 modal/runner.py,sha256=GLx_JwZ2hpA5yuHMY2b2Gt8Ri-KxJZHF2Zp1N_qVLD4,30144
 modal/runner.pyi,sha256=7QHbZawq1P5N9DiSrrEYtXtBCDAWlRibNonBO0q6MdM,9570
 modal/running_app.py,sha256=v61mapYNV1-O-Uaho5EfJlryMLvIT9We0amUOSvSGx8,1188
-modal/sandbox.py,sha256=ZKNeS57PYMVRcD2rGqiXQnO_0HSK4DSJMTSgQkbvKpA,87234
-modal/sandbox.pyi,sha256=YOyxH1Nd4zC_KucEdT6L6bxuOM31j14FL0CCPCey6ew,88734
-modal/sandbox_fs.py,sha256=3EGten2nvZ7H451FnH0gbFXcdLvQtQNVX-7qI0TtT3c,22472
-modal/sandbox_fs.pyi,sha256=01VyLN0AIplD45qh8F6NJXYj5YxGPaqRETMp4rDLZcQ,35036
+modal/sandbox.py,sha256=eKNQJ6iRnsGnJHgnNA785H9a8-05qS4R648r4eAuz88,89397
+modal/sandbox.pyi,sha256=vXEcf0TVoS-5NfQMVxxdJf_psCAKY4ZtDNP_TH0UcX8,91119
+modal/sandbox_fs.py,sha256=RmkXSRI27PA-xoUeYgg31oDsIIRctUIVwzjjM76mvIY,22677
+modal/sandbox_fs.pyi,sha256=ATdPtiJTCU-qaS8X59zJQc36fOL6-m14599E1UL8Zz0,35391
 modal/schedule.py,sha256=ng0g0AqNY5GQI9KhkXZQ5Wam5G42glbkqVQsNpBtbDE,3078
 modal/scheduler_placement.py,sha256=BAREdOY5HzHpzSBqt6jDVR6YC_jYfHMVqOzkyqQfngU,1235
 modal/secret.py,sha256=iQKigzV6tI8K7IlsVF4yF4A376fyovN11v_8ej2wsHc,18649
@@ -95,7 +95,7 @@ modal/_output/pty.py,sha256=wniYe_MW9_pEhCjDgRyrruYJNNtZoAJ0MuOOl3UrGI0,10174
 modal/_output/rich.py,sha256=5x4NJlH0gtnVC4HvCp63P7wKcubS53WyRRSZM6QDlrg,31818
 modal/_output/status.py,sha256=WrYh60v6pUQ-Z2SM_lIpYtK4CFyA40kvYrkTBQuZUp8,4524
 modal/_runtime/__init__.py,sha256=MIEP8jhXUeGq_eCjYFcqN5b1bxBM4fdk0VESpjWR0fc,28
-modal/_runtime/asgi.py,sha256=1d6PG6pxQAOg1FZTeB6YW_86zAw4OxnY-uOjaaGzyxA,22808
+modal/_runtime/asgi.py,sha256=qaw2A6NykgTIGp7BUysXlIU-v_cI1ByqbR8A76kNBIQ,22818
 modal/_runtime/container_io_manager.py,sha256=KoIe2z0F4LLOH6LO45-SUxrn2neDKhILs3HUmd_XWwQ,51901
 modal/_runtime/container_io_manager.pyi,sha256=7dSzbTp7lnO4q0sBoOHuC76nnofLowehkq8n1jb1yos,22082
 modal/_runtime/execution_context.py,sha256=vanzJeaTpknTB2-DJQIpPjCJGTfn8gqiQlqGOfkxn2g,3665
@@ -167,7 +167,7 @@ modal/cli/queues.py,sha256=Nz_gkmlz8c2DqbL3GZnIcdmaHjC8Sj5wl55qq17kty4,6565
 modal/cli/run.py,sha256=aTfa5P44_W2LbUVdjYND4kvr8-G1qLHCSYUNilHkLwA,22656
 modal/cli/secret.py,sha256=_YEeQ0HSRXXZgf7Bx990D4B7kzRamNDLlEd92uqK6O4,8252
 modal/cli/selector.py,sha256=OJr9Ua3K_l-qu3N3-I8z8oVq8lBakws2-XgfheR5p-c,4741
-modal/cli/shell.py,sha256=2oD_MtbkazowubdryGWfhHqO44Sa3Lv7bpENmF68ghc,16132
+modal/cli/shell.py,sha256=qS941iX1XPQuM7-Lsj7SlF8dGw-9ZFRu70Gljbb_i0o,16343
 modal/cli/token.py,sha256=Km7V7pHXsNKyjOCEdioQT8-o04Rh2-PzmNpiL1_i8tw,4352
 modal/cli/utils.py,sha256=CUNFXLcV8EJymZCTXettHDJTDBJi73uHMywayr0ytow,6305
 modal/cli/volume.py,sha256=pP1yqWCwzy1IP-_BbUKZKysdx7sMI5RT5jZUkj1DPsc,11514
@@ -178,7 +178,7 @@ modal/experimental/__init__.py,sha256=Wb1YoAKAnNxH_0c2wA0T12I7bSu9PSO2nS_LuLska7
 modal/experimental/flash.py,sha256=3k7Co0JrrVMjUQxTmi1VPXJX4jgRWetlAJnwm_kxhqg,34301
 modal/experimental/flash.pyi,sha256=lpTqJFZRMGWscw0xpYZVdBMnAYjj16asXE4_64A6itQ,17774
 modal/experimental/ipython.py,sha256=TrCfmol9LGsRZMeDoeMPx3Hv3BFqQhYnmD_iH0pqdhk,2904
-modal-1.4.4.dev6.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+modal-1.4.4.dev8.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
 modal_docs/__init__.py,sha256=svYKtV8HDwDCN86zbdWqyq5T8sMdGDj0PVlzc2tIxDM,28
 modal_docs/gen_cli_docs.py,sha256=bfUSLscHfoQoKkKjIqJvQMe3fURzqcQK7gF1h9WQLtM,3742
 modal_docs/gen_cli_docs_main.py,sha256=UPGr7O1DYTIRLwfINe2rbdh89J3cPVTU1OWL-SjxnOQ,198
@@ -200,10 +200,10 @@ modal_proto/task_command_router_pb2.py,sha256=-K4H-C7N-ILpdvFyM4PQMZcGZvXV1J89mf
 modal_proto/task_command_router_pb2.pyi,sha256=KNM7lPtngiv0_Ni_1zRg1rl65ynyjN8vpzd3XISxMGo,37281
 modal_proto/task_command_router_pb2_grpc.py,sha256=368j8b_h19L7bidFTRGSdSG4bK0zU9Y_Oq46_B2ACDg,34666
 modal_proto/task_command_router_pb2_grpc.pyi,sha256=PbzkCj-uSlN1inYSdhncPQ1-04vhBnj3Wzvb-D2pLHY,11226
-modal_version/__init__.py,sha256=pvMRSo2CWYOh6XoMNIkPMCZlh9JXYhUIobV_Cx9nCDI,120
+modal_version/__init__.py,sha256=-QYB0OB3-MFO-bxkFMDgdqFdDY6mByoO9cgSi26Y1HU,120
 modal_version/__main__.py,sha256=nLUbubxKx7GXNzJIkTB7M7_u8080LyLM0IS0rzFkC_c,119
-modal-1.4.4.dev6.dist-info/METADATA,sha256=MDtMpVsTLWMu52D8diKPyf47sZeivXekoyY5TBWFJoI,2338
-modal-1.4.4.dev6.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-modal-1.4.4.dev6.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
-modal-1.4.4.dev6.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
-modal-1.4.4.dev6.dist-info/RECORD,,
+modal-1.4.4.dev8.dist-info/METADATA,sha256=0txUaxhuST31P84xhfU-vPLoLhjvX4WKK2V_6vjcgP8,2338
+modal-1.4.4.dev8.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+modal-1.4.4.dev8.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
+modal-1.4.4.dev8.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
+modal-1.4.4.dev8.dist-info/RECORD,,

modal_version/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Modal Labs 2026
 """Supplies the current version of the modal client library."""
 
-__version__ = "1.4.4.dev6"
+__version__ = "1.4.4.dev8"