modal 1.0.5.dev29__tar.gz → 1.0.5.dev31__tar.gz

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/PKG-INFO

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

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal/_functions.py

@@ -854,6 +854,7 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
                         mount_path=path,
                         volume_id=volume.object_id,
                         allow_background_commits=True,
+                        read_only=volume._read_only,
                     )
                     for path, volume in validated_volumes_no_cloud_buckets
                 ]
@@ -1107,6 +1108,7 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
                         mount_path=path,
                         volume_id=volume.object_id,
                         allow_background_commits=True,
+                        read_only=volume._read_only,
                     )
                     for path, volume in options.validated_volumes
                 ]

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal/client.pyi

@@ -31,7 +31,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.0.5.dev29",
+        version: str = "1.0.5.dev31",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -160,7 +160,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.0.5.dev29",
+        version: str = "1.0.5.dev31",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal/functions.pyi

@@ -428,7 +428,7 @@ class Function(
 
     _call_generator: ___call_generator_spec[typing_extensions.Self]
 
-    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
+    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
         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."""
             ...
@@ -437,7 +437,7 @@ class Function(
             """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
             ...
 
-    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
+    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
 
     class __remote_gen_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -464,7 +464,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
+    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
         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.
 
@@ -488,7 +488,7 @@ class Function(
             ...
 
     _experimental_spawn: ___experimental_spawn_spec[
-        modal._functions.P, modal._functions.ReturnType, typing_extensions.Self
+        modal._functions.ReturnType, modal._functions.P, typing_extensions.Self
     ]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER, SUPERSELF]):
@@ -497,7 +497,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P, typing_extensions.Self]
 
-    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
+    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
         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.
 
@@ -518,7 +518,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
+    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function."""

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal/sandbox.py

@@ -151,6 +151,7 @@ class _Sandbox(_Object, type_prefix="sb"):
                     mount_path=path,
                     volume_id=volume.object_id,
                     allow_background_commits=True,
+                    read_only=volume._read_only,
                 )
                 for path, volume in validated_volumes
             ]

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal/volume.py

@@ -135,6 +135,34 @@ class _Volume(_Object, type_prefix="vo"):
 
     _lock: Optional[asyncio.Lock] = None
     _metadata: "typing.Optional[api_pb2.VolumeMetadata]"
+    _read_only: bool = False
+
+    def read_only(self) -> "_Volume":
+        """Configure Volume to mount as read-only.
+
+        **Example**
+
+        ```python
+        import modal
+
+        volume = modal.Volume.from_name("my-volume", create_if_missing=True)
+
+        @app.function(volumes={"/mnt/items": volume.read_only()})
+        def f():
+            with open("/mnt/items/my-file.txt") as f:
+                return f.read()
+        ```
+
+        The Volume is mounted as a read-only volume in a function. Any file system write operation into the
+        mounted volume will result in an error.
+        """
+
+        async def _load(new_volume: _Volume, resolver: Resolver, existing_object_id: Optional[str]):
+            new_volume._initialize_from_other(self)
+            new_volume._read_only = True
+
+        obj = _Volume._from_loader(_load, "Volume()", hydrate_lazily=True, deps=lambda: [self])
+        return obj
 
     async def _get_lock(self):
         # To (mostly*) prevent multiple concurrent operations on the same volume, which can cause problems under
@@ -495,6 +523,9 @@ class _Volume(_Object, type_prefix="vo"):
     @live_method
     async def remove_file(self, path: str, recursive: bool = False) -> None:
         """Remove a file or directory from a volume."""
+        if self._read_only:
+            raise InvalidError("Read-only Volume can not be written to")
+
         if self._is_v1:
             req = api_pb2.VolumeRemoveFileRequest(volume_id=self.object_id, path=path, recursive=recursive)
             await retry_transient_errors(self._client.stub.VolumeRemoveFile, req)
@@ -527,6 +558,9 @@ class _Volume(_Object, type_prefix="vo"):
         like `os.rename()` and then `commit()` the volume. The `copy_files()` method is useful when you don't have
         the volume mounted as a filesystem, e.g. when running a script on your local computer.
         """
+        if self._read_only:
+            raise InvalidError("Read-only Volume can not be written to")
+
         if self._is_v1:
             if recursive:
                 raise ValueError("`recursive` is not supported for V1 volumes")
@@ -560,6 +594,9 @@ class _Volume(_Object, type_prefix="vo"):
             batch.put_file(io.BytesIO(b"some data"), "/foobar")
         ```
         """
+        if self._read_only:
+            raise InvalidError("Read-only Volume can not be written to")
+
         return _AbstractVolumeUploadContextManager.resolve(
             self._metadata.version, self.object_id, self._client, force=force
         )

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal/volume.pyi

@@ -101,6 +101,28 @@ class _Volume(modal._object._Object):
 
     _lock: typing.Optional[asyncio.locks.Lock]
     _metadata: typing.Optional[modal_proto.api_pb2.VolumeMetadata]
+    _read_only: bool
+
+    def read_only(self) -> _Volume:
+        """Configure Volume to mount as read-only.
+
+        **Example**
+
+        ```python
+        import modal
+
+        volume = modal.Volume.from_name("my-volume", create_if_missing=True)
+
+        @app.function(volumes={"/mnt/items": volume.read_only()})
+        def f():
+            with open("/mnt/items/my-file.txt") as f:
+                return f.read()
+        ```
+
+        The Volume is mounted as a read-only volume in a function. Any file system write operation into the
+        mounted volume will result in an error.
+        """
+        ...
 
     async def _get_lock(self): ...
     @staticmethod
@@ -371,11 +393,33 @@ class Volume(modal.object.Object):
 
     _lock: typing.Optional[asyncio.locks.Lock]
     _metadata: typing.Optional[modal_proto.api_pb2.VolumeMetadata]
+    _read_only: bool
 
     def __init__(self, *args, **kwargs):
         """mdmd:hidden"""
         ...
 
+    def read_only(self) -> Volume:
+        """Configure Volume to mount as read-only.
+
+        **Example**
+
+        ```python
+        import modal
+
+        volume = modal.Volume.from_name("my-volume", create_if_missing=True)
+
+        @app.function(volumes={"/mnt/items": volume.read_only()})
+        def f():
+            with open("/mnt/items/my-file.txt") as f:
+                return f.read()
+        ```
+
+        The Volume is mounted as a read-only volume in a function. Any file system write operation into the
+        mounted volume will result in an error.
+        """
+        ...
+
     class ___get_lock_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /): ...
         async def aio(self, /): ...

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal.egg-info/PKG-INFO

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

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal_proto/api.proto

@@ -1246,8 +1246,21 @@ message FlashContainerDeregisterRequest {
   string service_name = 1;
 }
 
+message FlashContainerListRequest {
+  string function_id = 1;
+}
+
+message FlashContainerListResponse {
+  message Container {
+    string task_id = 1;
+    string host = 2;
+    uint32 port = 3;
+  }
+  repeated Container containers = 1;
+}
+
 message FlashContainerRegisterRequest {
-  string service_name = 1;
+  string service_name = 1;  // not used?
   uint32 priority = 2;
   uint32 weight = 3;
   string host = 4;
@@ -3294,6 +3307,7 @@ service ModalClient {
 
   // Modal Flash (experimental)
   rpc FlashContainerDeregister(FlashContainerDeregisterRequest) returns (google.protobuf.Empty);
+  rpc FlashContainerList(FlashContainerListRequest) returns (FlashContainerListResponse);
   rpc FlashContainerRegister(FlashContainerRegisterRequest) returns (FlashContainerRegisterResponse);
 
   // Functions

{modal-1.0.5.dev29 → modal-1.0.5.dev31}/modal_proto/api_grpc.py

@@ -246,6 +246,10 @@ class ModalClientBase(abc.ABC):
     async def FlashContainerDeregister(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.FlashContainerDeregisterRequest, google.protobuf.empty_pb2.Empty]') -> None:
         pass
 
+    @abc.abstractmethod
+    async def FlashContainerList(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.FlashContainerListRequest, modal_proto.api_pb2.FlashContainerListResponse]') -> None:
+        pass
+
     @abc.abstractmethod
     async def FlashContainerRegister(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.FlashContainerRegisterRequest, modal_proto.api_pb2.FlashContainerRegisterResponse]') -> None:
         pass
@@ -982,6 +986,12 @@ class ModalClientBase(abc.ABC):
                 modal_proto.api_pb2.FlashContainerDeregisterRequest,
                 google.protobuf.empty_pb2.Empty,
             ),
+            '/modal.client.ModalClient/FlashContainerList': grpclib.const.Handler(
+                self.FlashContainerList,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.FlashContainerListRequest,
+                modal_proto.api_pb2.FlashContainerListResponse,
+            ),
             '/modal.client.ModalClient/FlashContainerRegister': grpclib.const.Handler(
                 self.FlashContainerRegister,
                 grpclib.const.Cardinality.UNARY_UNARY,
@@ -1918,6 +1928,12 @@ class ModalClientStub:
             modal_proto.api_pb2.FlashContainerDeregisterRequest,
             google.protobuf.empty_pb2.Empty,
         )
+        self.FlashContainerList = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/FlashContainerList',
+            modal_proto.api_pb2.FlashContainerListRequest,
+            modal_proto.api_pb2.FlashContainerListResponse,
+        )
         self.FlashContainerRegister = grpclib.client.UnaryUnaryMethod(
             channel,
             '/modal.client.ModalClient/FlashContainerRegister',