modal 1.4.4.dev7__tar.gz → 1.4.4.dev9__tar.gz

{modal-1.4.4.dev7 → modal-1.4.4.dev9}/PKG-INFO

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

{modal-1.4.4.dev7 → modal-1.4.4.dev9}/modal/cli/shell.py

@@ -16,7 +16,7 @@ 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
@@ -106,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:
@@ -116,7 +116,7 @@ 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
@@ -138,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-1.4.4.dev7 → modal-1.4.4.dev9}/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.dev7",
+        version: str = "1.4.4.dev9",
     ):
         """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.dev7",
+        version: str = "1.4.4.dev9",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.4.4.dev7 → modal-1.4.4.dev9}/modal/sandbox.py

@@ -695,7 +695,7 @@ class _Sandbox(_Object, type_prefix="sb"):
         cloud: Optional[str] = None,
         region: Optional[Union[str, Sequence[str]]] = None,
         block_network: bool = False,
-        cidr_allowlist: Optional[Sequence[str]] = None,
+        outbound_cidr_allowlist: Optional[Sequence[str]] = None,
         inbound_cidr_allowlist: Optional[Sequence[str]] = None,
         volumes: dict[Union[str, os.PathLike], Union[_Volume, _CloudBucketMount]] = {},
         pty: bool = False,
@@ -773,21 +773,21 @@ class _Sandbox(_Object, type_prefix="sb"):
         )
 
         if block_network:
-            if cidr_allowlist is not None:
-                raise InvalidError("`cidr_allowlist` cannot be used when `block_network` is enabled")
+            if outbound_cidr_allowlist is not None:
+                raise InvalidError("`outbound_cidr_allowlist` cannot be used when `block_network` is enabled")
             if inbound_cidr_allowlist is not None:
                 raise InvalidError("`inbound_cidr_allowlist` cannot be used when `block_network` is enabled")
             network_access = api_pb2.NetworkAccess(
                 network_access_type=api_pb2.NetworkAccess.NetworkAccessType.BLOCKED,
             )
-        elif cidr_allowlist is None:
+        elif outbound_cidr_allowlist is None:
             network_access = api_pb2.NetworkAccess(
                 network_access_type=api_pb2.NetworkAccess.NetworkAccessType.OPEN,
             )
         else:
             network_access = api_pb2.NetworkAccess(
                 network_access_type=api_pb2.NetworkAccess.NetworkAccessType.ALLOWLIST,
-                allowed_cidrs=cidr_allowlist,
+                allowed_cidrs=outbound_cidr_allowlist,
             )
 
         async def _load(
@@ -1386,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(
@@ -1661,6 +1661,10 @@ class _Sandbox(_Object, type_prefix="sb"):
                 sandbox_name_override=name,
                 sandbox_name_override_type=api_pb2.SandboxRestoreRequest.SANDBOX_NAME_OVERRIDE_TYPE_STRING,
             )
+        # Pin the restored Sandbox to a specific worker when MODAL_WORKER_ID is
+        # set.
+        if worker_id := config.get("worker_id"):
+            restore_req.worker_id = worker_id
         restore_resp: api_pb2.SandboxRestoreResponse = await client.stub.SandboxRestore(restore_req)
 
         sandbox = await _Sandbox.from_id(restore_resp.sandbox_id, client)
@@ -1854,7 +1858,7 @@ 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]
@@ -1882,9 +1886,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."""
@@ -2031,8 +2035,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
@@ -2051,22 +2058,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"
@@ -2092,9 +2101,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(
@@ -2103,16 +2117,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-1.4.4.dev7 → modal-1.4.4.dev9}/modal/sandbox.pyi

@@ -323,7 +323,7 @@ class _Sandbox(modal._object._Object):
         cloud: typing.Optional[str] = None,
         region: typing.Union[str, collections.abc.Sequence[str], None] = None,
         block_network: bool = False,
-        cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
+        outbound_cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
         inbound_cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
         volumes: dict[
             typing.Union[str, os.PathLike],
@@ -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,7 +697,7 @@ 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]
@@ -720,7 +720,7 @@ 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."""
         ...
@@ -765,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."""
         ...
@@ -783,11 +783,11 @@ 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]
@@ -807,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]:
@@ -913,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):
@@ -938,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,
             /,
@@ -948,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
 
@@ -1272,7 +1272,7 @@ class Sandbox(modal.object.Object):
             cloud: typing.Optional[str] = None,
             region: typing.Union[str, collections.abc.Sequence[str], None] = None,
             block_network: bool = False,
-            cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
+            outbound_cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
             inbound_cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
             volumes: dict[
                 typing.Union[str, os.PathLike],
@@ -1320,7 +1320,7 @@ class Sandbox(modal.object.Object):
             cloud: typing.Optional[str] = None,
             region: typing.Union[str, collections.abc.Sequence[str], None] = None,
             block_network: bool = False,
-            cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
+            outbound_cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
             inbound_cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
             volumes: dict[
                 typing.Union[str, os.PathLike],
@@ -1760,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):
@@ -2113,3 +2113,5 @@ class Sandbox(modal.object.Object):
     list: typing.ClassVar[__list_spec]
 
 _default_image: modal.image._Image
+
+_MAIN_CONTAINER_NAME: str

{modal-1.4.4.dev7 → modal-1.4.4.dev9}/modal/sandbox_fs.py

@@ -87,14 +87,14 @@ class _SandboxFilesystem:
     """mdmd:namespace
     Namespace for Sandbox filesystem APIs."""
 
-    _container: Union["modal.sandbox._Sandbox", "modal.sandbox._SandboxContainer"]
+    _container: Union["modal.sandbox._Sandbox", "modal.sandbox._SidecarContainer"]
 
-    def __init__(self, container: Union["modal.sandbox._Sandbox", "modal.sandbox._SandboxContainer"]) -> None:
+    def __init__(self, container: Union["modal.sandbox._Sandbox", "modal.sandbox._SidecarContainer"]) -> None:
         """mdmd:hidden"""
-        from modal.sandbox import _Sandbox, _SandboxContainer
+        from modal.sandbox import _Sandbox, _SidecarContainer
 
-        # Use a weakref proxy to avoid circular references between Sandbox/SandboxContainer and SandboxFilesystem.
-        self._container = cast(Union[_Sandbox, _SandboxContainer], weakref.proxy(container))
+        # 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.

{modal-1.4.4.dev7 → modal-1.4.4.dev9}/modal/sandbox_fs.pyi

@@ -80,9 +80,9 @@ class _SandboxFilesystem:
     Namespace for Sandbox filesystem APIs.
     """
 
-    _container: typing.Union[modal.sandbox._Sandbox, modal.sandbox._SandboxContainer]
+    _container: typing.Union[modal.sandbox._Sandbox, modal.sandbox._SidecarContainer]
 
-    def __init__(self, container: typing.Union[modal.sandbox._Sandbox, modal.sandbox._SandboxContainer]) -> None:
+    def __init__(self, container: typing.Union[modal.sandbox._Sandbox, modal.sandbox._SidecarContainer]) -> None:
         """mdmd:hidden"""
         ...
 
@@ -346,9 +346,9 @@ class SandboxFilesystem:
     Namespace for Sandbox filesystem APIs.
     """
 
-    _container: typing.Union[modal.sandbox.Sandbox, modal.sandbox.SandboxContainer]
+    _container: typing.Union[modal.sandbox.Sandbox, modal.sandbox.SidecarContainer]
 
-    def __init__(self, container: typing.Union[modal.sandbox.Sandbox, modal.sandbox.SandboxContainer]) -> None:
+    def __init__(self, container: typing.Union[modal.sandbox.Sandbox, modal.sandbox.SidecarContainer]) -> None:
         """mdmd:hidden"""
         ...
 

{modal-1.4.4.dev7 → modal-1.4.4.dev9}/modal.egg-info/PKG-INFO

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