modal 1.1.1.dev30__tar.gz → 1.1.1.dev32__tar.gz

{modal-1.1.1.dev30 → modal-1.1.1.dev32}/PKG-INFO

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

{modal-1.1.1.dev30 → modal-1.1.1.dev32}/modal/client.pyi

@@ -33,7 +33,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.1.dev30",
+        version: str = "1.1.1.dev32",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -164,7 +164,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.1.dev30",
+        version: str = "1.1.1.dev32",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.1.1.dev30 → modal-1.1.1.dev32}/modal/image.py

@@ -1561,7 +1561,7 @@ class _Image(_Object, type_prefix="im"):
         self,
         entrypoint_commands: list[str],
     ) -> "_Image":
-        """Set the entrypoint for the image."""
+        """Set the ENTRYPOINT for the image."""
         if not isinstance(entrypoint_commands, list) or not all(isinstance(x, str) for x in entrypoint_commands):
             raise InvalidError("entrypoint_commands must be a list of strings.")
         args_str = _flatten_str_args("entrypoint", "entrypoint_commands", entrypoint_commands)
@@ -2237,7 +2237,9 @@ class _Image(_Object, type_prefix="im"):
         )
 
     def cmd(self, cmd: list[str]) -> "_Image":
-        """Set the default entrypoint argument (`CMD`) for the image.
+        """Set the default command (`CMD`) to run when a container is started.
+
+        Used with `modal.Sandbox`. Has no effect on `modal.Function`.
 
         **Example**
 

{modal-1.1.1.dev30 → modal-1.1.1.dev32}/modal/image.pyi

@@ -584,7 +584,7 @@ class _Image(modal._object._Object):
         ...
 
     def entrypoint(self, entrypoint_commands: list[str]) -> _Image:
-        """Set the entrypoint for the image."""
+        """Set the ENTRYPOINT for the image."""
         ...
 
     def shell(self, shell_commands: list[str]) -> _Image:
@@ -912,7 +912,9 @@ class _Image(modal._object._Object):
         ...
 
     def cmd(self, cmd: list[str]) -> _Image:
-        """Set the default entrypoint argument (`CMD`) for the image.
+        """Set the default command (`CMD`) to run when a container is started.
+
+        Used with `modal.Sandbox`. Has no effect on `modal.Function`.
 
         **Example**
 
@@ -1424,7 +1426,7 @@ class Image(modal.object.Object):
         ...
 
     def entrypoint(self, entrypoint_commands: list[str]) -> Image:
-        """Set the entrypoint for the image."""
+        """Set the ENTRYPOINT for the image."""
         ...
 
     def shell(self, shell_commands: list[str]) -> Image:
@@ -1752,7 +1754,9 @@ class Image(modal.object.Object):
         ...
 
     def cmd(self, cmd: list[str]) -> Image:
-        """Set the default entrypoint argument (`CMD`) for the image.
+        """Set the default command (`CMD`) to run when a container is started.
+
+        Used with `modal.Sandbox`. Has no effect on `modal.Function`.
 
         **Example**
 

{modal-1.1.1.dev30 → modal-1.1.1.dev32}/modal/sandbox.py

@@ -60,15 +60,15 @@ if TYPE_CHECKING:
     import modal.app
 
 
-def _validate_exec_args(entrypoint_args: Sequence[str]) -> None:
+def _validate_exec_args(args: Sequence[str]) -> None:
     # Entrypoint args must be strings.
-    if not all(isinstance(arg, str) for arg in entrypoint_args):
+    if not all(isinstance(arg, str) for arg in args):
         raise InvalidError("All entrypoint arguments must be strings")
     # Avoid "[Errno 7] Argument list too long" errors.
-    total_arg_len = sum(len(arg) for arg in entrypoint_args)
+    total_arg_len = sum(len(arg) for arg in args)
     if total_arg_len > ARG_MAX_BYTES:
         raise InvalidError(
-            f"Total length of entrypoint arguments must be less than {ARG_MAX_BYTES} bytes (ARG_MAX). "
+            f"Total length of CMD arguments must be less than {ARG_MAX_BYTES} bytes (ARG_MAX). "
             f"Got {total_arg_len} bytes."
         )
 
@@ -104,7 +104,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
     @staticmethod
     def _new(
-        entrypoint_args: Sequence[str],
+        args: Sequence[str],
         image: _Image,
         secrets: Sequence[_Secret],
         name: Optional[str] = None,
@@ -208,7 +208,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
             ephemeral_disk = None  # Ephemeral disk requests not supported on Sandboxes.
             definition = api_pb2.Sandbox(
-                entrypoint_args=entrypoint_args,
+                entrypoint_args=args,
                 image_id=image.object_id,
                 mount_ids=[mount.object_id for mount in mounts] + [mount.object_id for mount in image._mount_layers],
                 secret_ids=[secret.object_id for secret in secrets],
@@ -250,7 +250,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
     @staticmethod
     async def create(
-        *entrypoint_args: str,
+        *args: str,  # Set the CMD of the Sandbox, overriding any CMD of the container image.
         # Associate the sandbox with an app. Required unless creating from a container.
         app: Optional["modal.app._App"] = None,
         name: Optional[str] = None,  # Optionally give the sandbox a name. Unique within an app.
@@ -316,7 +316,7 @@ class _Sandbox(_Object, type_prefix="sb"):
             )
 
         return await _Sandbox._create(
-            *entrypoint_args,
+            *args,
             app=app,
             name=name,
             image=image,
@@ -346,7 +346,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
     @staticmethod
     async def _create(
-        *entrypoint_args: str,
+        *args: str,  # Set the CMD of the Sandbox, overriding any CMD of the container image.
         # Associate the sandbox with an app. Required unless creating from a container.
         app: Optional["modal.app._App"] = None,
         name: Optional[str] = None,  # Optionally give the sandbox a name. Unique within an app.
@@ -395,11 +395,11 @@ class _Sandbox(_Object, type_prefix="sb"):
         # sandbox that runs the shell session
         from .app import _App
 
-        _validate_exec_args(entrypoint_args)
+        _validate_exec_args(args)
 
         # TODO(erikbern): Get rid of the `_new` method and create an already-hydrated object
         obj = _Sandbox._new(
-            entrypoint_args,
+            args,
             image=image or _default_image,
             secrets=secrets,
             name=name,
@@ -648,7 +648,7 @@ class _Sandbox(_Object, type_prefix="sb"):
     @overload
     async def exec(
         self,
-        *cmds: str,
+        *args: str,
         pty_info: Optional[api_pb2.PTYInfo] = None,
         stdout: StreamType = StreamType.PIPE,
         stderr: StreamType = StreamType.PIPE,
@@ -663,7 +663,7 @@ class _Sandbox(_Object, type_prefix="sb"):
     @overload
     async def exec(
         self,
-        *cmds: str,
+        *args: str,
         pty_info: Optional[api_pb2.PTYInfo] = None,
         stdout: StreamType = StreamType.PIPE,
         stderr: StreamType = StreamType.PIPE,
@@ -677,7 +677,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
     async def exec(
         self,
-        *cmds: str,
+        *args: str,
         pty_info: Optional[api_pb2.PTYInfo] = None,  # Deprecated: internal use only
         stdout: StreamType = StreamType.PIPE,
         stderr: StreamType = StreamType.PIPE,
@@ -713,7 +713,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
         if workdir is not None and not workdir.startswith("/"):
             raise InvalidError(f"workdir must be an absolute path, got: {workdir}")
-        _validate_exec_args(cmds)
+        _validate_exec_args(args)
 
         # Force secret resolution so we can pass the secret IDs to the backend.
         secret_coros = [secret.hydrate(client=self._client) for secret in secrets]
@@ -722,7 +722,7 @@ class _Sandbox(_Object, type_prefix="sb"):
         task_id = await self._get_task_id()
         req = api_pb2.ContainerExecRequest(
             task_id=task_id,
-            command=cmds,
+            command=args,
             pty_info=_pty_info or pty_info,
             runtime_debug=config.get("function_runtime_debug"),
             timeout_secs=timeout or 0,

{modal-1.1.1.dev30 → modal-1.1.1.dev32}/modal/sandbox.pyi

@@ -25,7 +25,7 @@ import os
 import typing
 import typing_extensions
 
-def _validate_exec_args(entrypoint_args: collections.abc.Sequence[str]) -> None: ...
+def _validate_exec_args(args: collections.abc.Sequence[str]) -> None: ...
 
 class DefaultSandboxNameOverride(str):
     """A singleton class that represents the default sandbox name override.
@@ -55,7 +55,7 @@ class _Sandbox(modal._object._Object):
 
     @staticmethod
     def _new(
-        entrypoint_args: collections.abc.Sequence[str],
+        args: collections.abc.Sequence[str],
         image: modal.image._Image,
         secrets: collections.abc.Sequence[modal.secret._Secret],
         name: typing.Optional[str] = None,
@@ -89,7 +89,7 @@ class _Sandbox(modal._object._Object):
 
     @staticmethod
     async def create(
-        *entrypoint_args: str,
+        *args: str,
         app: typing.Optional[modal.app._App] = None,
         name: typing.Optional[str] = None,
         image: typing.Optional[modal.image._Image] = None,
@@ -136,7 +136,7 @@ class _Sandbox(modal._object._Object):
 
     @staticmethod
     async def _create(
-        *entrypoint_args: str,
+        *args: str,
         app: typing.Optional[modal.app._App] = None,
         name: typing.Optional[str] = None,
         image: typing.Optional[modal.image._Image] = None,
@@ -244,7 +244,7 @@ class _Sandbox(modal._object._Object):
     @typing.overload
     async def exec(
         self,
-        *cmds: str,
+        *args: str,
         pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
         stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
         stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
@@ -258,7 +258,7 @@ class _Sandbox(modal._object._Object):
     @typing.overload
     async def exec(
         self,
-        *cmds: str,
+        *args: str,
         pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
         stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
         stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
@@ -364,7 +364,7 @@ class Sandbox(modal.object.Object):
 
     @staticmethod
     def _new(
-        entrypoint_args: collections.abc.Sequence[str],
+        args: collections.abc.Sequence[str],
         image: modal.image.Image,
         secrets: collections.abc.Sequence[modal.secret.Secret],
         name: typing.Optional[str] = None,
@@ -399,7 +399,7 @@ class Sandbox(modal.object.Object):
         def __call__(
             self,
             /,
-            *entrypoint_args: str,
+            *args: str,
             app: typing.Optional[modal.app.App] = None,
             name: typing.Optional[str] = None,
             image: typing.Optional[modal.image.Image] = None,
@@ -449,7 +449,7 @@ class Sandbox(modal.object.Object):
         async def aio(
             self,
             /,
-            *entrypoint_args: str,
+            *args: str,
             app: typing.Optional[modal.app.App] = None,
             name: typing.Optional[str] = None,
             image: typing.Optional[modal.image.Image] = None,
@@ -502,7 +502,7 @@ class Sandbox(modal.object.Object):
         def __call__(
             self,
             /,
-            *entrypoint_args: str,
+            *args: str,
             app: typing.Optional[modal.app.App] = None,
             name: typing.Optional[str] = None,
             image: typing.Optional[modal.image.Image] = None,
@@ -538,7 +538,7 @@ class Sandbox(modal.object.Object):
         async def aio(
             self,
             /,
-            *entrypoint_args: str,
+            *args: str,
             app: typing.Optional[modal.app.App] = None,
             name: typing.Optional[str] = None,
             image: typing.Optional[modal.image.Image] = None,
@@ -758,7 +758,7 @@ class Sandbox(modal.object.Object):
         def __call__(
             self,
             /,
-            *cmds: str,
+            *args: str,
             pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
             stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
             stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
@@ -773,7 +773,7 @@ class Sandbox(modal.object.Object):
         def __call__(
             self,
             /,
-            *cmds: str,
+            *args: str,
             pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
             stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
             stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
@@ -788,7 +788,7 @@ class Sandbox(modal.object.Object):
         async def aio(
             self,
             /,
-            *cmds: str,
+            *args: str,
             pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
             stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
             stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
@@ -803,7 +803,7 @@ class Sandbox(modal.object.Object):
         async def aio(
             self,
             /,
-            *cmds: str,
+            *args: str,
             pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
             stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
             stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,

{modal-1.1.1.dev30 → modal-1.1.1.dev32}/modal.egg-info/PKG-INFO

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

{modal-1.1.1.dev30 → modal-1.1.1.dev32}/modal_proto/api.proto

@@ -1140,15 +1140,19 @@ message DictLenResponse {
 
 message DictListRequest {
   string environment_name = 1;
+  ListPagination pagination = 2;
 }
 
 message DictListResponse {
   message DictInfo {
     string name = 1;
-    double created_at = 2;
+    double created_at = 2;  // Superseded by metadata, used by clients up to 1.1.1
+    string dict_id = 3;
+    DictMetadata metadata = 4;
   }
 
   repeated DictInfo dicts = 1;
+  string environment_name = 2;
 }
 
 message DictMetadata {
@@ -2093,6 +2097,11 @@ message InputInfo {
   bool task_first_input = 7;
 }
 
+message ListPagination {
+  int32 max_objects = 1;
+  double created_before = 2;
+}
+
 message MapAwaitRequest {
   string function_call_id = 1;
   string last_entry_id = 2;
@@ -2441,19 +2450,22 @@ message QueueLenResponse {
 
 message QueueListRequest {
   string environment_name = 1;
-  // Allow client to report a bounded total size to reduce the number of partitions that need to be checked
-  int32 total_size_limit = 2;
+  int32 total_size_limit = 2;  // Limit on "number of partitions" reported, since checking them is costly
+  ListPagination pagination = 3;
 }
 
 message QueueListResponse {
   message QueueInfo {
     string name = 1;
-    double created_at = 2;
+    double created_at = 2;  // Superseded by metadata, used by clients up to 1.1.1
     int32 num_partitions = 3;
     int32 total_size = 4;
+    string queue_id = 5;
+    QueueMetadata metadata = 6;
   }
 
   repeated QueueInfo queues = 1;
+  string environment_name = 2;
 }
 
 message QueueMetadata {
@@ -2861,19 +2873,21 @@ message SecretGetOrCreateResponse {
 
 message SecretListItem {
   string label = 1;
-  double created_at = 2;
+  double created_at = 2;  // Superseded by metadata, used by clients up to 1.1.1
   double last_used_at = 3;
-  string environment_name = 4;
+  string environment_name = 4;  // Unused by client
   string secret_id = 5;
+  SecretMetadata metadata = 6;
 }
 
 message SecretListRequest {
-  string environment_name = 1; // leaving empty will assume a singular environment
+  string environment_name = 1;
+  ListPagination pagination = 2;
 }
 
 message SecretListResponse {
   repeated SecretListItem items = 1;
-  string environment_name = 2; // the environment that was listed (useful when relying on "default" logic)
+  string environment_name = 2;
 }
 
 message SecretMetadata {
@@ -3225,11 +3239,13 @@ message VolumeListFilesResponse {
 message VolumeListItem {
   string label = 1;  // app name of object entity app
   string volume_id = 2;
-  double created_at = 3;
+  double created_at = 3;  // Superseded by metadata, used by clients up to 1.1.1
+  VolumeMetadata metadata = 4;
 }
 
 message VolumeListRequest {
   string environment_name = 1;
+  ListPagination pagination = 2;
 }
 
 message VolumeListResponse {