modAL 1.5.3.dev10__tar.gz → 1.5.3.dev11__tar.gz

{modal-1.5.3.dev10 → modal-1.5.3.dev11}/PKG-INFO

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

{modal-1.5.3.dev10 → modal-1.5.3.dev11}/modal/client.pyi

@@ -37,7 +37,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.5.3.dev10",
+        version: str = "1.5.3.dev11",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -207,7 +207,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.5.3.dev10",
+        version: str = "1.5.3.dev11",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.5.3.dev10 → modal-1.5.3.dev11}/modal/exception.py

@@ -188,6 +188,10 @@ class SandboxTimeoutError(TimeoutError):
     """Raised when a Sandbox exceeds its execution duration limit and times out."""
 
 
+class SnapshotCreationError(Error):
+    """Raised when a Sandbox fails to create an exit snapshot."""
+
+
 class ExecTimeoutError(TimeoutError):
     """Raised when a container process exceeds its execution duration limit and times out."""
 

{modal-1.5.3.dev10 → modal-1.5.3.dev11}/modal/functions.pyi

@@ -493,7 +493,7 @@ class Function(
 
     _call_generator: ___call_generator_spec
 
-    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> ReturnType_INNER:
             """Calls the function remotely, executing it with the given arguments and returning the execution's result.
 
@@ -518,7 +518,7 @@ class Function(
             """
             ...
 
-    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P]
+    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType]
 
     class __remote_gen_spec(typing_extensions.Protocol):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -568,7 +568,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
             """[Experimental] Calls the function with the given arguments, without waiting for the results.
 
@@ -601,7 +601,7 @@ class Function(
             """
             ...
 
-    _experimental_spawn: ___experimental_spawn_spec[modal._functions.ReturnType, modal._functions.P]
+    _experimental_spawn: ___experimental_spawn_spec[modal._functions.P, modal._functions.ReturnType]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> None: ...
@@ -609,7 +609,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P]
 
-    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
             """Calls the function with the given arguments, without waiting for the results.
 
@@ -642,7 +642,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P]
+    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function.

{modal-1.5.3.dev10 → modal-1.5.3.dev11}/modal/sandbox.py

@@ -52,10 +52,13 @@ from .exception import (
     ClientClosed,
     ConflictError,
     ExecutionError,
+    InternalError,
     InvalidError,
     NotFoundError,
     SandboxTerminatedError,
     SandboxTimeoutError,
+    SnapshotCreationError,
+    TimeoutError,
 )
 from .file_io import _FileIO, ls, mkdir, rm, watch
 from .io_streams import (
@@ -77,6 +80,8 @@ from .stream_type import StreamType
 from .types import FileWatchEvent, FileWatchEventType, SandboxConnectCredentials
 
 _default_image: _Image = _Image.debian_slim()
+_EXIT_SNAPSHOT_POLL_INTERVAL_SECONDS = 1.0
+_EXIT_SNAPSHOT_NOT_FOUND_ERROR_CODES = frozenset((api_pb2.SandboxGetExitSnapshotResponse.ERROR_CODE_TIMEOUT,))
 
 
 async def _gather_load_with_timings(
@@ -1410,6 +1415,68 @@ class _Sandbox(_Object, type_prefix="sb"):
         req = sr_pb2.TaskSetNetworkAccessRequest(task_id=task_id, network_access=network_access)
         await command_router_client.set_network_access(req)
 
+    async def _experimental_get_exit_snapshot(self, timeout: float | None = 60) -> _Image:
+        """Get the exit filesystem snapshot image.
+
+        Args:
+            timeout: Client-side deadline in seconds (default 60). Use `None` to
+                poll until the snapshot reaches a terminal state. Use `0` to
+                perform an immediate check.
+
+        Returns:
+            The exit snapshot Image.
+
+        Raises:
+            InvalidError: If `timeout` is negative, or if exit snapshot is not
+                enabled for the sandbox.
+            TimeoutError: If `timeout` elapses before the snapshot reaches a
+                terminal state. This includes `timeout=0` when the snapshot is
+                still pending.
+            SnapshotCreationError: If no exit snapshot image will be produced.
+            NotFoundError: If the sandbox does not exist.
+            PermissionDeniedError: If the caller cannot access the sandbox.
+            InternalError: If persisted snapshot state is malformed.
+            ServiceError: If a transient client/server communication failure occurs.
+        """
+        if timeout is not None and timeout < 0:
+            raise InvalidError("timeout must be non-negative or None")
+
+        deadline = None if timeout is None else time.monotonic() + timeout
+        timeout_message = f"timed out waiting for exit snapshot for Sandbox {self.object_id}"
+
+        while True:
+            resp: api_pb2.SandboxGetExitSnapshotResponse = await self._client.stub.SandboxGetExitSnapshot(
+                api_pb2.SandboxGetExitSnapshotRequest(sandbox_id=self.object_id)
+            )
+            outcome = resp.WhichOneof("outcome")
+
+            if outcome == "success":
+                if not resp.success.image_id:
+                    raise InternalError("Exit snapshot result is missing image ID")
+                return _Image._new_hydrated(resp.success.image_id, self._client, None)
+
+            if outcome == "error":
+                if resp.error.error_code in _EXIT_SNAPSHOT_NOT_FOUND_ERROR_CODES:
+                    message = resp.error.message or "No exit snapshot image will be produced"
+                    raise SnapshotCreationError(message)
+                message = resp.error.message or "Exit snapshot state is malformed"
+                raise InternalError(message)
+
+            if outcome != "pending":
+                raise InternalError("Exit snapshot response is missing an outcome")
+
+            sleep_for = _EXIT_SNAPSHOT_POLL_INTERVAL_SECONDS
+            if deadline is not None:
+                remaining = deadline - time.monotonic()
+                if remaining <= 0:
+                    raise TimeoutError(timeout_message)
+                sleep_for = min(sleep_for, remaining)
+
+            await asyncio.sleep(sleep_for)
+
+            if deadline is not None and time.monotonic() >= deadline:
+                raise TimeoutError(timeout_message)
+
     async def snapshot_filesystem(
         self,
         timeout: int = 55,

{modal-1.5.3.dev10 → modal-1.5.3.dev11}/modal/sandbox.pyi

@@ -573,6 +573,31 @@ class _Sandbox(modal._object._Object):
         """
         ...
 
+    async def _experimental_get_exit_snapshot(self, timeout: typing.Optional[float] = 60) -> modal._image._Image:
+        """Get the exit filesystem snapshot image.
+
+        Args:
+            timeout: Client-side deadline in seconds (default 60). Use `None` to
+                poll until the snapshot reaches a terminal state. Use `0` to
+                perform an immediate check.
+
+        Returns:
+            The exit snapshot Image.
+
+        Raises:
+            InvalidError: If `timeout` is negative, or if exit snapshot is not
+                enabled for the sandbox.
+            TimeoutError: If `timeout` elapses before the snapshot reaches a
+                terminal state. This includes `timeout=0` when the snapshot is
+                still pending.
+            SnapshotCreationError: If no exit snapshot image will be produced.
+            NotFoundError: If the sandbox does not exist.
+            PermissionDeniedError: If the caller cannot access the sandbox.
+            InternalError: If persisted snapshot state is malformed.
+            ServiceError: If a transient client/server communication failure occurs.
+        """
+        ...
+
     async def snapshot_filesystem(
         self, timeout: int = 55, *, ttl: typing.Optional[int] = 2592000
     ) -> modal._image._Image:
@@ -2198,6 +2223,59 @@ class Sandbox(modal.object.Object):
 
     _experimental_set_outbound_network_policy: ___experimental_set_outbound_network_policy_spec
 
+    class ___experimental_get_exit_snapshot_spec(typing_extensions.Protocol):
+        def __call__(self, /, timeout: typing.Optional[float] = 60) -> modal.image.Image:
+            """Get the exit filesystem snapshot image.
+
+            Args:
+                timeout: Client-side deadline in seconds (default 60). Use `None` to
+                    poll until the snapshot reaches a terminal state. Use `0` to
+                    perform an immediate check.
+
+            Returns:
+                The exit snapshot Image.
+
+            Raises:
+                InvalidError: If `timeout` is negative, or if exit snapshot is not
+                    enabled for the sandbox.
+                TimeoutError: If `timeout` elapses before the snapshot reaches a
+                    terminal state. This includes `timeout=0` when the snapshot is
+                    still pending.
+                SnapshotCreationError: If no exit snapshot image will be produced.
+                NotFoundError: If the sandbox does not exist.
+                PermissionDeniedError: If the caller cannot access the sandbox.
+                InternalError: If persisted snapshot state is malformed.
+                ServiceError: If a transient client/server communication failure occurs.
+            """
+            ...
+
+        async def aio(self, /, timeout: typing.Optional[float] = 60) -> modal.image.Image:
+            """Get the exit filesystem snapshot image.
+
+            Args:
+                timeout: Client-side deadline in seconds (default 60). Use `None` to
+                    poll until the snapshot reaches a terminal state. Use `0` to
+                    perform an immediate check.
+
+            Returns:
+                The exit snapshot Image.
+
+            Raises:
+                InvalidError: If `timeout` is negative, or if exit snapshot is not
+                    enabled for the sandbox.
+                TimeoutError: If `timeout` elapses before the snapshot reaches a
+                    terminal state. This includes `timeout=0` when the snapshot is
+                    still pending.
+                SnapshotCreationError: If no exit snapshot image will be produced.
+                NotFoundError: If the sandbox does not exist.
+                PermissionDeniedError: If the caller cannot access the sandbox.
+                InternalError: If persisted snapshot state is malformed.
+                ServiceError: If a transient client/server communication failure occurs.
+            """
+            ...
+
+    _experimental_get_exit_snapshot: ___experimental_get_exit_snapshot_spec
+
     class __snapshot_filesystem_spec(typing_extensions.Protocol):
         def __call__(self, /, timeout: int = 55, *, ttl: typing.Optional[int] = 2592000) -> modal.image.Image:
             """Snapshot the filesystem of the Sandbox.

{modal-1.5.3.dev10 → modal-1.5.3.dev11}/modal.egg-info/PKG-INFO

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

{modal-1.5.3.dev10 → modal-1.5.3.dev11}/modal_proto/api_grpc.py

@@ -595,6 +595,10 @@ class ModalClientBase(abc.ABC):
     async def SandboxGetCommandRouterAccess(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxGetCommandRouterAccessRequest, modal_proto.api_pb2.SandboxGetCommandRouterAccessResponse]') -> None:
         pass
 
+    @abc.abstractmethod
+    async def SandboxGetExitSnapshot(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxGetExitSnapshotRequest, modal_proto.api_pb2.SandboxGetExitSnapshotResponse]') -> None:
+        pass
+
     @abc.abstractmethod
     async def SandboxGetFromName(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxGetFromNameRequest, modal_proto.api_pb2.SandboxGetFromNameResponse]') -> None:
         pass
@@ -1813,6 +1817,12 @@ class ModalClientBase(abc.ABC):
                 modal_proto.api_pb2.SandboxGetCommandRouterAccessRequest,
                 modal_proto.api_pb2.SandboxGetCommandRouterAccessResponse,
             ),
+            '/modal.client.ModalClient/SandboxGetExitSnapshot': grpclib.const.Handler(
+                self.SandboxGetExitSnapshot,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.SandboxGetExitSnapshotRequest,
+                modal_proto.api_pb2.SandboxGetExitSnapshotResponse,
+            ),
             '/modal.client.ModalClient/SandboxGetFromName': grpclib.const.Handler(
                 self.SandboxGetFromName,
                 grpclib.const.Cardinality.UNARY_UNARY,
@@ -3211,6 +3221,12 @@ class ModalClientStub:
             modal_proto.api_pb2.SandboxGetCommandRouterAccessRequest,
             modal_proto.api_pb2.SandboxGetCommandRouterAccessResponse,
         )
+        self.SandboxGetExitSnapshot = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/SandboxGetExitSnapshot',
+            modal_proto.api_pb2.SandboxGetExitSnapshotRequest,
+            modal_proto.api_pb2.SandboxGetExitSnapshotResponse,
+        )
         self.SandboxGetFromName = grpclib.client.UnaryUnaryMethod(
             channel,
             '/modal.client.ModalClient/SandboxGetFromName',