modal 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

modal/dict.pyi

@@ -1,13 +1,37 @@
 import collections.abc
+import datetime
+import google.protobuf.message
 import modal._object
 import modal.client
 import modal.object
+import modal_proto.api_pb2
 import synchronicity.combined_types
 import typing
 import typing_extensions
 
 def _serialize_dict(data): ...
 
+class DictInfo:
+    """Information about the Dict object."""
+
+    name: typing.Optional[str]
+    created_at: datetime.datetime
+    created_by: typing.Optional[str]
+
+    def __init__(
+        self, name: typing.Optional[str], created_at: datetime.datetime, created_by: typing.Optional[str]
+    ) -> None:
+        """Initialize self.  See help(type(self)) for accurate signature."""
+        ...
+
+    def __repr__(self):
+        """Return repr(self)."""
+        ...
+
+    def __eq__(self, other):
+        """Return self==value."""
+        ...
+
 class _Dict(modal._object._Object):
     """Distributed dictionary for storage in Modal apps.
 
@@ -49,10 +73,18 @@ class _Dict(modal._object._Object):
 
     For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-dicts).
     """
+
+    _name: typing.Optional[str]
+    _metadata: typing.Optional[modal_proto.api_pb2.DictMetadata]
+
     def __init__(self, data={}):
         """mdmd:hidden"""
         ...
 
+    @property
+    def name(self) -> typing.Optional[str]: ...
+    def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
+    def _get_metadata(self) -> modal_proto.api_pb2.DictMetadata: ...
     @classmethod
     def ephemeral(
         cls: type[_Dict],
@@ -131,6 +163,10 @@ class _Dict(modal._object._Object):
         client: typing.Optional[modal.client._Client] = None,
         environment_name: typing.Optional[str] = None,
     ): ...
+    async def info(self) -> DictInfo:
+        """Return information about the Dict object."""
+        ...
+
     async def clear(self) -> None:
         """Remove all items from the Dict."""
         ...
@@ -264,10 +300,18 @@ class Dict(modal.object.Object):
 
     For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-dicts).
     """
+
+    _name: typing.Optional[str]
+    _metadata: typing.Optional[modal_proto.api_pb2.DictMetadata]
+
     def __init__(self, data={}):
         """mdmd:hidden"""
         ...
 
+    @property
+    def name(self) -> typing.Optional[str]: ...
+    def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
+    def _get_metadata(self) -> modal_proto.api_pb2.DictMetadata: ...
     @classmethod
     def ephemeral(
         cls: type[Dict],
@@ -388,6 +432,17 @@ class Dict(modal.object.Object):
 
     delete: __delete_spec
 
+    class __info_spec(typing_extensions.Protocol[SUPERSELF]):
+        def __call__(self, /) -> DictInfo:
+            """Return information about the Dict object."""
+            ...
+
+        async def aio(self, /) -> DictInfo:
+            """Return information about the Dict object."""
+            ...
+
+    info: __info_spec[typing_extensions.Self]
+
     class __clear_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /) -> None:
             """Remove all items from the Dict."""

modal/exception.py

@@ -26,6 +26,10 @@ class Error(Exception):
     """
 
 
+class AlreadyExistsError(Error):
+    """Raised when a resource creation conflicts with an existing resource."""
+
+
 class RemoteError(Error):
     """Raised when an error occurs on the Modal server."""
 

modal/experimental/__init__.py

@@ -20,7 +20,7 @@ from ..cls import _Cls, _Obj
 from ..exception import InvalidError
 from ..image import DockerfileSpec, ImageBuilderVersion, _Image, _ImageRegistryConfig
 from ..secret import _Secret
-from .flash import flash_forward, flash_prometheus_autoscaler  # noqa: F401
+from .flash import flash_forward, flash_get_containers, flash_prometheus_autoscaler  # noqa: F401
 
 
 def stop_fetching_inputs():

modal/experimental/flash.py

@@ -51,7 +51,7 @@ class _FlashManager:
                     timeout=10,
                 )
                 if first_registration:
-                    logger.warning(f"[Modal Flash] Listening at {resp.url}")
+                    logger.warning(f"[Modal Flash] Listening at {resp.url} over {self.tunnel.url}")
                     first_registration = False
             except asyncio.CancelledError:
                 logger.warning("[Modal Flash] Shutting down...")
@@ -225,7 +225,6 @@ class _FlashPrometheusAutoscaler:
 
                 await self.cls.update_autoscaler(
                     min_containers=actual_target_containers,
-                    max_containers=actual_target_containers,
                 )
 
                 if time.time() - autoscaling_time < self.autoscaling_interval_seconds:
@@ -447,3 +446,20 @@ async def flash_prometheus_autoscaler(
     )
     await autoscaler.start()
     return autoscaler
+
+
+@synchronizer.create_blocking
+async def flash_get_containers(app_name: str, cls_name: str) -> list[dict[str, Any]]:
+    """
+    Return a list of flash containers for a deployed Flash service.
+
+    This is a highly experimental method that can break or be removed at any time without warning.
+    Do not use this method unless explicitly instructed to do so by Modal support.
+    """
+    client = await _Client.from_env()
+    fn = _Cls.from_name(app_name, cls_name)._class_service_function
+    assert fn is not None
+    await fn.hydrate(client=client)
+    req = api_pb2.FlashContainerListRequest(function_id=fn.object_id)
+    resp = await retry_transient_errors(client.stub.FlashContainerList, req)
+    return resp.containers

modal/experimental/flash.pyi

@@ -250,3 +250,22 @@ class __flash_prometheus_autoscaler_spec(typing_extensions.Protocol):
         ...
 
 flash_prometheus_autoscaler: __flash_prometheus_autoscaler_spec
+
+class __flash_get_containers_spec(typing_extensions.Protocol):
+    def __call__(self, /, app_name: str, cls_name: str) -> list[dict[str, typing.Any]]:
+        """Return a list of flash containers for a deployed Flash service.
+
+        This is a highly experimental method that can break or be removed at any time without warning.
+        Do not use this method unless explicitly instructed to do so by Modal support.
+        """
+        ...
+
+    async def aio(self, /, app_name: str, cls_name: str) -> list[dict[str, typing.Any]]:
+        """Return a list of flash containers for a deployed Flash service.
+
+        This is a highly experimental method that can break or be removed at any time without warning.
+        Do not use this method unless explicitly instructed to do so by Modal support.
+        """
+        ...
+
+flash_get_containers: __flash_get_containers_spec

modal/functions.pyi

@@ -109,7 +109,6 @@ class Function(
         experimental_options: typing.Optional[dict[str, str]] = None,
         _experimental_proxy_ip: typing.Optional[str] = None,
         _experimental_custom_scaling_factor: typing.Optional[float] = None,
-        _experimental_enable_gpu_snapshot: bool = False,
     ) -> Function:
         """mdmd:hidden"""
         ...

modal/image.py

@@ -71,7 +71,7 @@ SUPPORTED_PYTHON_SERIES: dict[ImageBuilderVersion, list[str]] = {
     "2023.12": ["3.9", "3.10", "3.11", "3.12"],
 }
 
-LOCAL_REQUIREMENTS_DIR = Path(__file__).parent / "requirements"
+LOCAL_REQUIREMENTS_DIR = Path(__file__).parent / "builder"
 CONTAINER_REQUIREMENTS_PATH = "/modal_requirements.txt"
 
 
@@ -658,7 +658,13 @@ class _Image(_Object, type_prefix="im"):
                         msg += " (Hint: Use `modal.enable_output()` to see logs from the process building the Image.)"
                     raise RemoteError(msg)
             elif result.status == api_pb2.GenericResult.GENERIC_STATUS_TERMINATED:
-                raise RemoteError(f"Image build for {image_id} terminated due to external shut-down. Please try again.")
+                msg = f"Image build for {image_id} terminated due to external shut-down. Please try again."
+                if result.exception:
+                    msg = (
+                        f"Image build for {image_id} terminated due to external shut-down with the exception:\n"
+                        f"{result.exception}"
+                    )
+                raise RemoteError(msg)
             elif result.status == api_pb2.GenericResult.GENERIC_STATUS_TIMEOUT:
                 raise RemoteError(
                     f"Image build for {image_id} timed out. Please try again with a larger `timeout` parameter."
@@ -1183,11 +1189,11 @@ class _Image(_Object, type_prefix="im"):
             else:
                 commands.append(f"COPY --from=ghcr.io/astral-sh/uv:{uv_version} /uv {UV_ROOT}/uv")
 
-            # NOTE: Using `which python` assumes:
+            # NOTE: Using $(command -v python) assumes:
             # - python is on the PATH and uv is installing into the first python in the PATH
-            # - the shell supports backticks for substitution
-            # - `which` command is on the PATH
-            uv_pip_args = ["--python `which python`", "--compile-bytecode"]
+            # - the shell supports $() for substitution
+            # - `command` command is on the PATH
+            uv_pip_args = ["--python $(command -v python)", "--compile-bytecode"]
             context_files = {}
 
             if find_links:
@@ -1350,6 +1356,8 @@ class _Image(_Object, type_prefix="im"):
         image = modal.Image.debian_slim().uv_sync()
         ```
 
+        The `pyproject.toml` and `uv.lock` in `uv_project_dir` are automatically added to the build context.
+
         Added in v1.1.0.
         """
 
@@ -1385,7 +1393,13 @@ class _Image(_Object, type_prefix="im"):
                 # a requirement in `uv.lock`
                 return
 
-            dependencies = pyproject_toml_content["project"]["dependencies"]
+            try:
+                dependencies = pyproject_toml_content["project"]["dependencies"]
+            except KeyError as e:
+                raise InvalidError(
+                    f"Invalid pyproject.toml file: missing key {e} in {pyproject_toml}. "
+                    "See https://packaging.python.org/en/latest/guides/writing-pyproject-toml for guidelines."
+                )
 
             for group in groups:
                 if (
@@ -1451,7 +1465,7 @@ class _Image(_Object, type_prefix="im"):
                 commands.append(f"COPY /.uv.lock {UV_ROOT}/uv.lock")
 
                 if frozen:
-                    # Do not update `uv.lock` when we have one when `frozen=True`. This it ehd efault because this
+                    # Do not update `uv.lock` when we have one when `frozen=True`. This is the default because this
                     # ensures that the runtime environment matches the local `uv.lock`.
                     #
                     # If `frozen=False`, then `uv sync` will update the the dependencies in the `uv.lock` file
@@ -1555,7 +1569,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)
@@ -2231,7 +2245,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/image.pyi

@@ -524,6 +524,8 @@ class _Image(modal._object._Object):
         image = modal.Image.debian_slim().uv_sync()
         ```
 
+        The `pyproject.toml` and `uv.lock` in `uv_project_dir` are automatically added to the build context.
+
         Added in v1.1.0.
         """
         ...
@@ -584,7 +586,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 +914,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**
 
@@ -1364,6 +1368,8 @@ class Image(modal.object.Object):
         image = modal.Image.debian_slim().uv_sync()
         ```
 
+        The `pyproject.toml` and `uv.lock` in `uv_project_dir` are automatically added to the build context.
+
         Added in v1.1.0.
         """
         ...
@@ -1424,7 +1430,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 +1758,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/mount.py

@@ -882,7 +882,7 @@ async def _create_single_client_dependency_mount(
 
     with tempfile.TemporaryDirectory(ignore_cleanup_errors=True) as tmpd:
         print(f"📦 Building {mount_name}.")
-        requirements = os.path.join(os.path.dirname(__file__), f"requirements/{builder_version}.txt")
+        requirements = os.path.join(os.path.dirname(__file__), f"builder/{builder_version}.txt")
         cmd = " ".join(
             [
                 "uv",

modal/object.pyi

@@ -31,6 +31,7 @@ class Object:
     _client: typing.Optional[modal.client.Client]
     _is_hydrated: bool
     _is_rehydrated: bool
+    _name: typing.Optional[str]
 
     def __init__(self, *args, **kwargs):
         """mdmd:hidden"""
@@ -54,6 +55,7 @@ class Object:
             hydrate_lazily: bool = False,
             deps: typing.Optional[collections.abc.Callable[..., collections.abc.Sequence[Object]]] = None,
             deduplication_key: typing.Optional[collections.abc.Callable[[], collections.abc.Hashable]] = None,
+            name: typing.Optional[str] = None,
         ): ...
         def aio(
             self,
@@ -75,6 +77,7 @@ class Object:
             deduplication_key: typing.Optional[
                 collections.abc.Callable[[], collections.abc.Awaitable[collections.abc.Hashable]]
             ] = None,
+            name: typing.Optional[str] = None,
         ): ...
 
     _init: ___init_spec[typing_extensions.Self]
@@ -107,6 +110,7 @@ class Object:
         hydrate_lazily: bool = False,
         deps: typing.Optional[collections.abc.Callable[..., collections.abc.Sequence[Object]]] = None,
         deduplication_key: typing.Optional[collections.abc.Callable[[], collections.abc.Hashable]] = None,
+        name: typing.Optional[str] = None,
     ): ...
     @staticmethod
     def _get_type_from_id(object_id: str) -> type[Object]: ...