modal 0.72.50__py3-none-any.whl → 0.72.52__py3-none-any.whl

modal/__init__.py

@@ -31,6 +31,7 @@ try:
     from .schedule import Cron, Period
     from .scheduler_placement import SchedulerPlacement
     from .secret import Secret
+    from .snapshot import SandboxSnapshot
     from .volume import Volume
 except Exception:
     print()
@@ -60,6 +61,7 @@ __all__ = [
     "Retries",
     "CloudBucketMount",
     "Sandbox",
+    "SandboxSnapshot",
     "SchedulerPlacement",
     "Secret",
     "Stub",

modal/client.pyi

@@ -27,7 +27,7 @@ class _Client:
     _snapshotted: bool
 
     def __init__(
-        self, server_url: str, client_type: int, credentials: typing.Optional[tuple[str, str]], version: str = "0.72.50"
+        self, server_url: str, client_type: int, credentials: typing.Optional[tuple[str, str]], version: str = "0.72.52"
     ): ...
     def is_closed(self) -> bool: ...
     @property
@@ -85,7 +85,7 @@ class Client:
     _snapshotted: bool
 
     def __init__(
-        self, server_url: str, client_type: int, credentials: typing.Optional[tuple[str, str]], version: str = "0.72.50"
+        self, server_url: str, client_type: int, credentials: typing.Optional[tuple[str, str]], version: str = "0.72.52"
     ): ...
     def is_closed(self) -> bool: ...
     @property

modal/sandbox.py

@@ -36,6 +36,7 @@ from .network_file_system import _NetworkFileSystem, network_file_system_mount_p
 from .proxy import _Proxy
 from .scheduler_placement import SchedulerPlacement
 from .secret import _Secret
+from .snapshot import _SandboxSnapshot
 from .stream_type import StreamType
 
 _default_image: _Image = _Image.debian_slim()
@@ -58,6 +59,7 @@ class _Sandbox(_Object, type_prefix="sb"):
     _stdin: _StreamWriter
     _task_id: Optional[str] = None
     _tunnels: Optional[dict[int, Tunnel]] = None
+    _enable_snapshot: bool = False
 
     @staticmethod
     def _new(
@@ -81,6 +83,7 @@ class _Sandbox(_Object, type_prefix="sb"):
         unencrypted_ports: Sequence[int] = [],
         proxy: Optional[_Proxy] = None,
         _experimental_scheduler_placement: Optional[SchedulerPlacement] = None,
+        enable_snapshot: bool = False,
     ) -> "_Sandbox":
         """mdmd:hidden"""
 
@@ -177,6 +180,7 @@ class _Sandbox(_Object, type_prefix="sb"):
                 open_ports=api_pb2.PortSpecs(ports=open_ports),
                 network_access=network_access,
                 proxy_id=(proxy.object_id if proxy else None),
+                enable_snapshot=enable_snapshot,
             )
 
             # Note - `resolver.app_id` will be `None` for app-less sandboxes
@@ -224,6 +228,8 @@ class _Sandbox(_Object, type_prefix="sb"):
         unencrypted_ports: Sequence[int] = [],
         # Reference to a Modal Proxy to use in front of this Sandbox.
         proxy: Optional[_Proxy] = None,
+        # Enable memory snapshots.
+        _experimental_enable_snapshot: bool = False,
         _experimental_scheduler_placement: Optional[
             SchedulerPlacement
         ] = None,  # Experimental controls over fine-grained scheduling (alpha).
@@ -261,7 +267,9 @@ class _Sandbox(_Object, type_prefix="sb"):
             unencrypted_ports=unencrypted_ports,
             proxy=proxy,
             _experimental_scheduler_placement=_experimental_scheduler_placement,
+            enable_snapshot=_experimental_enable_snapshot,
         )
+        obj._enable_snapshot = _experimental_enable_snapshot
 
         app_id: Optional[str] = None
         app_client: Optional[_Client] = None
@@ -534,6 +542,54 @@ class _Sandbox(_Object, type_prefix="sb"):
         by_line = bufsize == 1
         return _ContainerProcess(resp.exec_id, self._client, stdout=stdout, stderr=stderr, text=text, by_line=by_line)
 
+    async def _experimental_snapshot(self) -> _SandboxSnapshot:
+        if not self._enable_snapshot:
+            raise ValueError(
+                "Memory snapshots are not supported for this sandbox. To enable memory snapshots, "
+                "set `_experimental_enable_snapshot=True` when creating the sandbox."
+            )
+        await self._get_task_id()
+        snap_req = api_pb2.SandboxSnapshotRequest(sandbox_id=self.object_id)
+        snap_resp = await retry_transient_errors(self._client.stub.SandboxSnapshot, snap_req)
+
+        snapshot_id = snap_resp.snapshot_id
+
+        # wait for the snapshot to succeed. this is implemented as a second idempotent rpc
+        # because the snapshot itself may take a while to complete.
+        wait_req = api_pb2.SandboxSnapshotWaitRequest(snapshot_id=snapshot_id, timeout=55.0)
+        wait_resp = await retry_transient_errors(self._client.stub.SandboxSnapshotWait, wait_req)
+        if wait_resp.result.status != api_pb2.GenericResult.GENERIC_STATUS_SUCCESS:
+            raise ExecutionError(wait_resp.result.exception)
+
+        async def _load(self: _SandboxSnapshot, resolver: Resolver, existing_object_id: Optional[str]):
+            # we eagerly hydrate the sandbox snapshot below
+            pass
+
+        rep = "SandboxSnapshot()"
+        obj = _SandboxSnapshot._from_loader(_load, rep, hydrate_lazily=True)
+        obj._hydrate(snapshot_id, self._client, None)
+
+        return obj
+
+    @staticmethod
+    async def _experimental_from_snapshot(snapshot: _SandboxSnapshot, client: Optional[_Client] = None):
+        client = client or await _Client.from_env()
+
+        restore_req = api_pb2.SandboxRestoreRequest(snapshot_id=snapshot.object_id)
+        restore_resp: api_pb2.SandboxRestoreResponse = await retry_transient_errors(
+            client.stub.SandboxRestore, restore_req
+        )
+        sandbox = await _Sandbox.from_id(restore_resp.sandbox_id, client)
+
+        task_id_req = api_pb2.SandboxGetTaskIdRequest(sandbox_id=restore_resp.sandbox_id)
+        resp = await retry_transient_errors(client.stub.SandboxGetTaskId, task_id_req)
+        if resp.task_result.status not in [
+            api_pb2.GenericResult.GENERIC_STATUS_UNSPECIFIED,
+            api_pb2.GenericResult.GENERIC_STATUS_SUCCESS,
+        ]:
+            raise ExecutionError(resp.task_result.exception)
+        return sandbox
+
     @overload
     async def open(
         self,

modal/sandbox.pyi

@@ -17,6 +17,7 @@ import modal.object
 import modal.proxy
 import modal.scheduler_placement
 import modal.secret
+import modal.snapshot
 import modal.stream_type
 import modal.volume
 import modal_proto.api_pb2
@@ -31,6 +32,7 @@ class _Sandbox(modal._object._Object):
     _stdin: modal.io_streams._StreamWriter
     _task_id: typing.Optional[str]
     _tunnels: typing.Optional[dict[int, modal._tunnel.Tunnel]]
+    _enable_snapshot: bool
 
     @staticmethod
     def _new(
@@ -57,6 +59,7 @@ class _Sandbox(modal._object._Object):
         unencrypted_ports: collections.abc.Sequence[int] = [],
         proxy: typing.Optional[modal.proxy._Proxy] = None,
         _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
+        enable_snapshot: bool = False,
     ) -> _Sandbox: ...
     @staticmethod
     async def create(
@@ -84,6 +87,7 @@ class _Sandbox(modal._object._Object):
         encrypted_ports: collections.abc.Sequence[int] = [],
         unencrypted_ports: collections.abc.Sequence[int] = [],
         proxy: typing.Optional[modal.proxy._Proxy] = None,
+        _experimental_enable_snapshot: bool = False,
         _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
         client: typing.Optional[modal.client._Client] = None,
     ) -> _Sandbox: ...
@@ -125,6 +129,11 @@ class _Sandbox(modal._object._Object):
         bufsize: typing.Literal[-1, 1] = -1,
         _pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
     ) -> modal.container_process._ContainerProcess[bytes]: ...
+    async def _experimental_snapshot(self) -> modal.snapshot._SandboxSnapshot: ...
+    @staticmethod
+    async def _experimental_from_snapshot(
+        snapshot: modal.snapshot._SandboxSnapshot, client: typing.Optional[modal.client._Client] = None
+    ): ...
     @typing.overload
     async def open(self, path: str, mode: _typeshed.OpenTextMode) -> modal.file_io._FileIO[str]: ...
     @typing.overload
@@ -164,6 +173,7 @@ class Sandbox(modal.object.Object):
     _stdin: modal.io_streams.StreamWriter
     _task_id: typing.Optional[str]
     _tunnels: typing.Optional[dict[int, modal._tunnel.Tunnel]]
+    _enable_snapshot: bool
 
     def __init__(self, *args, **kwargs): ...
     @staticmethod
@@ -190,6 +200,7 @@ class Sandbox(modal.object.Object):
         unencrypted_ports: collections.abc.Sequence[int] = [],
         proxy: typing.Optional[modal.proxy.Proxy] = None,
         _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
+        enable_snapshot: bool = False,
     ) -> Sandbox: ...
 
     class __create_spec(typing_extensions.Protocol):
@@ -221,6 +232,7 @@ class Sandbox(modal.object.Object):
             encrypted_ports: collections.abc.Sequence[int] = [],
             unencrypted_ports: collections.abc.Sequence[int] = [],
             proxy: typing.Optional[modal.proxy.Proxy] = None,
+            _experimental_enable_snapshot: bool = False,
             _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
             client: typing.Optional[modal.client.Client] = None,
         ) -> Sandbox: ...
@@ -252,6 +264,7 @@ class Sandbox(modal.object.Object):
             encrypted_ports: collections.abc.Sequence[int] = [],
             unencrypted_ports: collections.abc.Sequence[int] = [],
             proxy: typing.Optional[modal.proxy.Proxy] = None,
+            _experimental_enable_snapshot: bool = False,
             _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
             client: typing.Optional[modal.client.Client] = None,
         ) -> Sandbox: ...
@@ -368,6 +381,22 @@ class Sandbox(modal.object.Object):
 
     exec: __exec_spec[typing_extensions.Self]
 
+    class ___experimental_snapshot_spec(typing_extensions.Protocol[SUPERSELF]):
+        def __call__(self) -> modal.snapshot.SandboxSnapshot: ...
+        async def aio(self) -> modal.snapshot.SandboxSnapshot: ...
+
+    _experimental_snapshot: ___experimental_snapshot_spec[typing_extensions.Self]
+
+    class ___experimental_from_snapshot_spec(typing_extensions.Protocol):
+        def __call__(
+            self, snapshot: modal.snapshot.SandboxSnapshot, client: typing.Optional[modal.client.Client] = None
+        ): ...
+        async def aio(
+            self, snapshot: modal.snapshot.SandboxSnapshot, client: typing.Optional[modal.client.Client] = None
+        ): ...
+
+    _experimental_from_snapshot: ___experimental_from_snapshot_spec
+
     class __open_spec(typing_extensions.Protocol[SUPERSELF]):
         @typing.overload
         def __call__(self, path: str, mode: _typeshed.OpenTextMode) -> modal.file_io.FileIO[str]: ...

modal/snapshot.py

@@ -0,0 +1,36 @@
+# Copyright Modal Labs 2024
+from typing import Optional
+
+from modal_proto import api_pb2
+
+from ._object import _Object
+from ._resolver import Resolver
+from ._utils.async_utils import synchronize_api
+from ._utils.grpc_utils import retry_transient_errors
+from .client import _Client
+
+
+class _SandboxSnapshot(_Object, type_prefix="sn"):
+    """A `SandboxSnapshot` object lets you interact with a stored Sandbox snapshot that was created by calling
+    .snapshot() on a Sandbox instance. This includes both the filesystem and memory state of the original Sandbox at the
+    time the snapshot was taken.
+    """
+
+    @staticmethod
+    async def from_id(sandbox_snapshot_id: str, client: Optional[_Client] = None):
+        if client is None:
+            client = await _Client.from_env()
+
+        async def _load(self: _SandboxSnapshot, resolver: Resolver, existing_object_id: Optional[str]):
+            await retry_transient_errors(
+                client.stub.SandboxSnapshotGet, api_pb2.SandboxSnapshotGetRequest(snapshot_id=sandbox_snapshot_id)
+            )
+
+        rep = "SandboxSnapshot()"
+        obj = _SandboxSnapshot._from_loader(_load, rep)
+        obj._hydrate(sandbox_snapshot_id, client, None)
+
+        return obj
+
+
+SandboxSnapshot = synchronize_api(_SandboxSnapshot)

modal/snapshot.pyi

@@ -0,0 +1,18 @@
+import modal._object
+import modal.client
+import modal.object
+import typing
+import typing_extensions
+
+class _SandboxSnapshot(modal._object._Object):
+    @staticmethod
+    async def from_id(sandbox_snapshot_id: str, client: typing.Optional[modal.client._Client] = None): ...
+
+class SandboxSnapshot(modal.object.Object):
+    def __init__(self, *args, **kwargs): ...
+
+    class __from_id_spec(typing_extensions.Protocol):
+        def __call__(self, sandbox_snapshot_id: str, client: typing.Optional[modal.client.Client] = None): ...
+        async def aio(self, sandbox_snapshot_id: str, client: typing.Optional[modal.client.Client] = None): ...
+
+    from_id: __from_id_spec

{modal-0.72.50.dist-info → modal-0.72.52.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: modal
-Version: 0.72.50
+Version: 0.72.52
 Summary: Python client library for Modal
 Author: Modal Labs
 Author-email: support@modal.com

{modal-0.72.50.dist-info → modal-0.72.52.dist-info}/RECORD

@@ -1,4 +1,4 @@
-modal/__init__.py,sha256=3NJLLHb0TRc2tc68kf8NHzORx38GbtbZvPEWDWrQ6N4,2234
+modal/__init__.py,sha256=df6aKAigSPFXnmIohWySf_1zZ9Gzgrb7-oprSbopD4w,2299
 modal/__main__.py,sha256=scYhGFqh8OJcVDo-VOxIT6CCwxOgzgflYWMnIZiMRqE,2871
 modal/_clustered_functions.py,sha256=kTf-9YBXY88NutC1akI-gCbvf01RhMPCw-zoOI_YIUE,2700
 modal/_clustered_functions.pyi,sha256=vllkegc99A0jrUOWa8mdlSbdp6uz36TsHhGxysAOpaQ,771
@@ -20,7 +20,7 @@ modal/app.py,sha256=KNfzLlkI2dJPl9LY8AgW76whZpwIvYKi2E2p9u4F3N4,43659
 modal/app.pyi,sha256=vnQhENaQBhJO6el-ieOcw3NEeYQ314SFXRDtjij4DM8,25324
 modal/call_graph.py,sha256=1g2DGcMIJvRy-xKicuf63IVE98gJSnQsr8R_NVMptNc,2581
 modal/client.py,sha256=8SQawr7P1PNUCq1UmJMUQXG2jIo4Nmdcs311XqrNLRE,15276
-modal/client.pyi,sha256=hI5zTvONMCzXLOTBTEGfXaj1_47IqxNkc-Xh0DzoM2Q,7593
+modal/client.pyi,sha256=HDGFNW_BAgaraMYdEEDJS-_bDgPhZJ6sSoiyqR39kiQ,7593
 modal/cloud_bucket_mount.py,sha256=YOe9nnvSr4ZbeCn587d7_VhE9IioZYRvF9VYQTQux08,5914
 modal/cloud_bucket_mount.pyi,sha256=30T3K1a89l6wzmEJ_J9iWv9SknoGqaZDx59Xs-ZQcmk,1607
 modal/cls.py,sha256=7Czu5ff8Sezzl4ayHyI9nMgB0el3401_uHvyZU4vbhc,32206
@@ -65,14 +65,16 @@ modal/retries.py,sha256=HKR2Q9aNPWkMjQ5nwobqYTuZaSuw0a8lI2zrtY5IW98,5230
 modal/runner.py,sha256=0SCMgKO8lZ9W1C7le1EcgViKERMXpi_-QBd6PF_MH0Q,24450
 modal/runner.pyi,sha256=YmP4EOCNjjkwSIPi2Gl6hF_ji_ytkxz9dw3iB9KXaOI,5275
 modal/running_app.py,sha256=v61mapYNV1-O-Uaho5EfJlryMLvIT9We0amUOSvSGx8,1188
-modal/sandbox.py,sha256=h5bgvt98iFmQs4aBu_d2aR6qP5UM5QVdP3wgm_P7RgE,29014
-modal/sandbox.pyi,sha256=XtiDHYa4HOooyuEPmKFwEqO58AJBJVTceO_1HQyDwII,21343
+modal/sandbox.py,sha256=D5Qs3FkatZ7Gbny22edGA2Rty7scPmKyLV_bmOFJISY,31750
+modal/sandbox.pyi,sha256=qncEvzK76h_ehrs03vlroQyLThWiMsjKhD0DnCNc6zI,22663
 modal/schedule.py,sha256=0ZFpKs1bOxeo5n3HZjoL7OE2ktsb-_oGtq-WJEPO4tY,2615
 modal/scheduler_placement.py,sha256=BAREdOY5HzHpzSBqt6jDVR6YC_jYfHMVqOzkyqQfngU,1235
 modal/secret.py,sha256=XTqrpR4rnkuUb-bth3qM_xxPqqEWorSoN9qDwjWRcXo,10118
 modal/secret.pyi,sha256=W4g_BOSxafYm-K9PvFc7-li3a-rsCFNkYgHTZXr1AFA,2974
 modal/serving.py,sha256=MnVuTsimN05LfNPxuJZ4sr5s1_BPUkIsOP_VC-bkp78,4464
 modal/serving.pyi,sha256=ncV-9jY_vZYFnGs5ZnMb3ffrX8LmcLdIMHBC56xRbtE,1711
+modal/snapshot.py,sha256=6rQvDP3iX9hdiAudKTy0-m0JESt4kk0q2gusXbaRA-8,1279
+modal/snapshot.pyi,sha256=Ypd4NKsjOTnnnqXyTGGLKq5lkocRrUURYjY5Pi67_qA,670
 modal/stream_type.py,sha256=A6320qoAAWhEfwOCZfGtymQTu5AfLfJXXgARqooTPvY,417
 modal/token_flow.py,sha256=LcgSce_MSQ2p7j55DPwpVRpiAtCDe8GRSEwzO7muNR8,6774
 modal/token_flow.pyi,sha256=0XV3d-9CGQL3qjPdw3RgwIFVqqxo8Z-u044_mkgAM3o,2064
@@ -167,10 +169,10 @@ modal_proto/options_pb2_grpc.pyi,sha256=CImmhxHsYnF09iENPoe8S4J-n93jtgUYD2JPAc0y
 modal_proto/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 modal_version/__init__.py,sha256=kGya2ZlItX2zB7oHORs-wvP4PG8lg_mtbi1QIK3G6SQ,470
 modal_version/__main__.py,sha256=2FO0yYQQwDTh6udt1h-cBnGd1c4ZyHnHSI4BksxzVac,105
-modal_version/_version_generated.py,sha256=m3uPcEhi0LYAEy2o0qMhVj7x8_1ffVAO3G7_vc6jNYg,149
-modal-0.72.50.dist-info/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
-modal-0.72.50.dist-info/METADATA,sha256=IBmHUniLrQ90IbIsSaAiNKKfrHh38r4H6xhuG48lGzY,2329
-modal-0.72.50.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-modal-0.72.50.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
-modal-0.72.50.dist-info/top_level.txt,sha256=1nvYbOSIKcmU50fNrpnQnrrOpj269ei3LzgB6j9xGqg,64
-modal-0.72.50.dist-info/RECORD,,
+modal_version/_version_generated.py,sha256=XmFBa8biwTGGximrbyv2QEzak1dJNJxC1EXdL5FMTcQ,149
+modal-0.72.52.dist-info/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+modal-0.72.52.dist-info/METADATA,sha256=3NhsiuuaszkQV6xnPMO3aqYEMxCCMiEFL04guni-2d0,2329
+modal-0.72.52.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+modal-0.72.52.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
+modal-0.72.52.dist-info/top_level.txt,sha256=1nvYbOSIKcmU50fNrpnQnrrOpj269ei3LzgB6j9xGqg,64
+modal-0.72.52.dist-info/RECORD,,

modal_version/_version_generated.py

@@ -1,4 +1,4 @@
 # Copyright Modal Labs 2025
 
 # Note: Reset this value to -1 whenever you make a minor `0.X` release of the client.
-build_number = 50  # git: 02c0966
+build_number = 52  # git: fc4738b