modal 1.0.6.dev58__py3-none-any.whl → 1.2.3.dev7__py3-none-any.whl

modal/dict.py

@@ -1,28 +1,227 @@
 # Copyright Modal Labs 2022
 from collections.abc import AsyncIterator, Mapping
-from typing import Any, Optional
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Optional, Union
 
-from grpclib import GRPCError
+from google.protobuf.message import Message
+from grpclib import GRPCError, Status
+from synchronicity import classproperty
 from synchronicity.async_wrap import asynccontextmanager
 
+from modal._utils.grpc_utils import Retry
 from modal_proto import api_pb2
 
-from ._object import EPHEMERAL_OBJECT_HEARTBEAT_SLEEP, _get_environment_name, _Object, live_method, live_method_gen
+from ._load_context import LoadContext
+from ._object import (
+    EPHEMERAL_OBJECT_HEARTBEAT_SLEEP,
+    _get_environment_name,
+    _Object,
+    live_method,
+    live_method_gen,
+)
 from ._resolver import Resolver
 from ._serialization import deserialize, serialize
 from ._utils.async_utils import TaskContext, synchronize_api
 from ._utils.deprecation import deprecation_warning, warn_if_passing_namespace
-from ._utils.grpc_utils import retry_transient_errors
 from ._utils.name_utils import check_object_name
+from ._utils.time_utils import as_timestamp, timestamp_to_localized_dt
 from .client import _Client
 from .config import logger
-from .exception import RequestSizeError
+from .exception import AlreadyExistsError, InvalidError, NotFoundError, RequestSizeError
+
+
+class _NoDefaultSentinel:
+    def __repr__(self) -> str:
+        return "..."
+
+
+_NO_DEFAULT = _NoDefaultSentinel()
 
 
 def _serialize_dict(data):
     return [api_pb2.DictEntry(key=serialize(k), value=serialize(v)) for k, v in data.items()]
 
 
+@dataclass
+class DictInfo:
+    """Information about a Dict object."""
+
+    # This dataclass should be limited to information that is unchanging over the lifetime of the Dict,
+    # since it is transmitted from the server when the object is hydrated and could be stale when accessed.
+
+    name: Optional[str]
+    created_at: datetime
+    created_by: Optional[str]
+
+
+class _DictManager:
+    """Namespace with methods for managing named Dict objects."""
+
+    @staticmethod
+    async def create(
+        name: str,  # Name to use for the new Dict
+        *,
+        allow_existing: bool = False,  # If True, no-op when the Dict already exists
+        environment_name: Optional[str] = None,  # Uses active environment if not specified
+        client: Optional[_Client] = None,  # Optional client with Modal credentials
+    ) -> None:
+        """Create a new Dict object.
+
+        **Examples:**
+
+        ```python notest
+        modal.Dict.objects.create("my-dict")
+        ```
+
+        Dicts will be created in the active environment, or another one can be specified:
+
+        ```python notest
+        modal.Dict.objects.create("my-dict", environment_name="dev")
+        ```
+
+        By default, an error will be raised if the Dict already exists, but passing
+        `allow_existing=True` will make the creation attempt a no-op in this case.
+
+        ```python notest
+        modal.Dict.objects.create("my-dict", allow_existing=True)
+        ```
+
+        Note that this method does not return a local instance of the Dict. You can use
+        `modal.Dict.from_name` to perform a lookup after creation.
+
+        Added in v1.1.2.
+
+        """
+        check_object_name(name, "Dict")
+        client = await _Client.from_env() if client is None else client
+        object_creation_type = (
+            api_pb2.OBJECT_CREATION_TYPE_CREATE_IF_MISSING
+            if allow_existing
+            else api_pb2.OBJECT_CREATION_TYPE_CREATE_FAIL_IF_EXISTS
+        )
+        req = api_pb2.DictGetOrCreateRequest(
+            deployment_name=name,
+            environment_name=_get_environment_name(environment_name),
+            object_creation_type=object_creation_type,
+        )
+        try:
+            await client.stub.DictGetOrCreate(req)
+        except GRPCError as exc:
+            if exc.status == Status.ALREADY_EXISTS and not allow_existing:
+                raise AlreadyExistsError(exc.message)
+            else:
+                raise
+
+    @staticmethod
+    async def list(
+        *,
+        max_objects: Optional[int] = None,  # Limit results to this size
+        created_before: Optional[Union[datetime, str]] = None,  # Limit based on creation date
+        environment_name: str = "",  # Uses active environment if not specified
+        client: Optional[_Client] = None,  # Optional client with Modal credentials
+    ) -> list["_Dict"]:
+        """Return a list of hydrated Dict objects.
+
+        **Examples:**
+
+        ```python
+        dicts = modal.Dict.objects.list()
+        print([d.name for d in dicts])
+        ```
+
+        Dicts will be retreived from the active environment, or another one can be specified:
+
+        ```python notest
+        dev_dicts = modal.Dict.objects.list(environment_name="dev")
+        ```
+
+        By default, all named Dict are returned, newest to oldest. It's also possible to limit the
+        number of results and to filter by creation date:
+
+        ```python
+        dicts = modal.Dict.objects.list(max_objects=10, created_before="2025-01-01")
+        ```
+
+        Added in v1.1.2.
+
+        """
+        client = await _Client.from_env() if client is None else client
+        if max_objects is not None and max_objects < 0:
+            raise InvalidError("max_objects cannot be negative")
+
+        items: list[api_pb2.DictListResponse.DictInfo] = []
+
+        async def retrieve_page(created_before: float) -> bool:
+            max_page_size = 100 if max_objects is None else min(100, max_objects - len(items))
+            pagination = api_pb2.ListPagination(max_objects=max_page_size, created_before=created_before)
+            req = api_pb2.DictListRequest(
+                environment_name=_get_environment_name(environment_name), pagination=pagination
+            )
+            resp = await client.stub.DictList(req)
+            items.extend(resp.dicts)
+            finished = (len(resp.dicts) < max_page_size) or (max_objects is not None and len(items) >= max_objects)
+            return finished
+
+        finished = await retrieve_page(as_timestamp(created_before))
+        while True:
+            if finished:
+                break
+            finished = await retrieve_page(items[-1].metadata.creation_info.created_at)
+
+        dicts = [
+            _Dict._new_hydrated(
+                item.dict_id,
+                client,
+                item.metadata,
+                is_another_app=True,
+                rep=_Dict._repr(item.name, environment_name),
+            )
+            for item in items
+        ]
+        return dicts[:max_objects] if max_objects is not None else dicts
+
+    @staticmethod
+    async def delete(
+        name: str,  # Name of the Dict to delete
+        *,
+        allow_missing: bool = False,  # If True, don't raise an error if the Dict doesn't exist
+        environment_name: Optional[str] = None,  # Uses active environment if not specified
+        client: Optional[_Client] = None,  # Optional client with Modal credentials
+    ):
+        """Delete a named Dict.
+
+        Warning: This deletes an *entire Dict*, not just a specific key.
+        Deletion is irreversible and will affect any Apps currently using the Dict.
+
+        **Examples:**
+
+        ```python notest
+        await modal.Dict.objects.delete("my-dict")
+        ```
+
+        Dicts will be deleted from the active environment, or another one can be specified:
+
+        ```python notest
+        await modal.Dict.objects.delete("my-dict", environment_name="dev")
+        ```
+
+        Added in v1.1.2.
+
+        """
+        try:
+            obj = await _Dict.from_name(name, environment_name=environment_name).hydrate(client)
+        except NotFoundError:
+            if not allow_missing:
+                raise
+        else:
+            req = api_pb2.DictDeleteRequest(dict_id=obj.object_id)
+            await obj._client.stub.DictDelete(req)
+
+
+DictManager = synchronize_api(_DictManager)
+
+
 class _Dict(_Object, type_prefix="di"):
     """Distributed dictionary for storage in Modal apps.
 
@@ -65,12 +264,33 @@ class _Dict(_Object, type_prefix="di"):
     For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-dicts).
     """
 
+    _name: Optional[str] = None
+    _metadata: Optional[api_pb2.DictMetadata] = None
+
     def __init__(self, data={}):
         """mdmd:hidden"""
         raise RuntimeError(
             "`Dict(...)` constructor is not allowed. Please use `Dict.from_name` or `Dict.ephemeral` instead"
         )
 
+    @classproperty
+    def objects(cls) -> _DictManager:
+        return _DictManager
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    def _hydrate_metadata(self, metadata: Optional[Message]):
+        if metadata:
+            assert isinstance(metadata, api_pb2.DictMetadata)
+            self._metadata = metadata
+            self._name = metadata.name
+
+    def _get_metadata(self) -> api_pb2.DictMetadata:
+        assert self._metadata
+        return self._metadata
+
     @classmethod
     @asynccontextmanager
     async def ephemeral(
@@ -78,7 +298,7 @@ class _Dict(_Object, type_prefix="di"):
         data: Optional[dict] = None,  # DEPRECATED
         client: Optional[_Client] = None,
         environment_name: Optional[str] = None,
-        _heartbeat_sleep: float = EPHEMERAL_OBJECT_HEARTBEAT_SLEEP,
+        _heartbeat_sleep: float = EPHEMERAL_OBJECT_HEARTBEAT_SLEEP,  # mdmd:line-hidden
     ) -> AsyncIterator["_Dict"]:
         """Creates a new ephemeral Dict within a context manager:
 
@@ -108,11 +328,17 @@ class _Dict(_Object, type_prefix="di"):
             environment_name=_get_environment_name(environment_name),
             data=serialized,
         )
-        response = await retry_transient_errors(client.stub.DictGetOrCreate, request, total_timeout=10.0)
+        response = await client.stub.DictGetOrCreate(request, retry=Retry(total_timeout=10.0))
         async with TaskContext() as tc:
             request = api_pb2.DictHeartbeatRequest(dict_id=response.dict_id)
             tc.infinite_loop(lambda: client.stub.DictHeartbeat(request), sleep=_heartbeat_sleep)
-            yield cls._new_hydrated(response.dict_id, client, None, is_another_app=True)
+            yield cls._new_hydrated(
+                response.dict_id,
+                client,
+                response.metadata,
+                is_another_app=True,
+                rep="modal.Dict.ephemeral()",
+            )
 
     @staticmethod
     def from_name(
@@ -122,6 +348,7 @@ class _Dict(_Object, type_prefix="di"):
         namespace=None,  # mdmd:line-hidden
         environment_name: Optional[str] = None,
         create_if_missing: bool = False,
+        client: Optional[_Client] = None,
     ) -> "_Dict":
         """Reference a named Dict, creating if necessary.
 
@@ -143,77 +370,64 @@ class _Dict(_Object, type_prefix="di"):
                 "Passing data to `modal.Dict.from_name` is deprecated and will stop working in a future release.",
             )
 
-        async def _load(self: _Dict, resolver: Resolver, existing_object_id: Optional[str]):
+        async def _load(self: _Dict, resolver: Resolver, load_context: LoadContext, existing_object_id: Optional[str]):
             serialized = _serialize_dict(data if data is not None else {})
             req = api_pb2.DictGetOrCreateRequest(
                 deployment_name=name,
-                environment_name=_get_environment_name(environment_name, resolver),
+                environment_name=load_context.environment_name,
                 object_creation_type=(api_pb2.OBJECT_CREATION_TYPE_CREATE_IF_MISSING if create_if_missing else None),
                 data=serialized,
             )
-            response = await resolver.client.stub.DictGetOrCreate(req)
+            response = await load_context.client.stub.DictGetOrCreate(req)
             logger.debug(f"Created dict with id {response.dict_id}")
-            self._hydrate(response.dict_id, resolver.client, None)
-
-        return _Dict._from_loader(_load, "Dict()", is_another_app=True, hydrate_lazily=True)
+            self._hydrate(response.dict_id, load_context.client, response.metadata)
+
+        rep = _Dict._repr(name, environment_name)
+        return _Dict._from_loader(
+            _load,
+            rep,
+            is_another_app=True,
+            hydrate_lazily=True,
+            name=name,
+            load_context_overrides=LoadContext(environment_name=environment_name, client=client),
+        )
 
     @staticmethod
-    async def lookup(
+    async def delete(
         name: str,
-        data: Optional[dict] = None,
-        namespace=None,  # mdmd:line-hidden
+        *,
         client: Optional[_Client] = None,
         environment_name: Optional[str] = None,
-        create_if_missing: bool = False,
-    ) -> "_Dict":
+    ):
         """mdmd:hidden
-        Lookup a named Dict.
-
-        DEPRECATED: This method is deprecated in favor of `modal.Dict.from_name`.
+        Delete a named Dict object.
 
-        In contrast to `modal.Dict.from_name`, this is an eager method
-        that will hydrate the local object with metadata from Modal servers.
+        Warning: This deletes an *entire Dict*, not just a specific key.
+        Deletion is irreversible and will affect any Apps currently using the Dict.
 
-        ```python
-        d = modal.Dict.from_name("my-dict")
-        d["xyz"] = 123
-        ```
+        DEPRECATED: This method is deprecated; we recommend using `modal.Dict.objects.delete` instead.
         """
         deprecation_warning(
-            (2025, 1, 27),
-            "`modal.Dict.lookup` is deprecated and will be removed in a future release."
-            " It can be replaced with `modal.Dict.from_name`."
-            "\n\nSee https://modal.com/docs/guide/modal-1-0-migration for more information.",
-        )
-        warn_if_passing_namespace(namespace, "modal.Dict.lookup")
-        obj = _Dict.from_name(
-            name,
-            data=data,
-            environment_name=environment_name,
-            create_if_missing=create_if_missing,
+            (2025, 8, 6), "`modal.Dict.delete` is deprecated; we recommend using `modal.Dict.objects.delete` instead."
         )
-        if client is None:
-            client = await _Client.from_env()
-        resolver = Resolver(client=client)
-        await resolver.load(obj)
-        return obj
+        await _Dict.objects.delete(name, environment_name=environment_name, client=client)
 
-    @staticmethod
-    async def delete(
-        name: str,
-        *,
-        client: Optional[_Client] = None,
-        environment_name: Optional[str] = None,
-    ):
-        obj = await _Dict.from_name(name, environment_name=environment_name).hydrate(client)
-        req = api_pb2.DictDeleteRequest(dict_id=obj.object_id)
-        await retry_transient_errors(obj._client.stub.DictDelete, req)
+    @live_method
+    async def info(self) -> DictInfo:
+        """Return information about the Dict object."""
+        metadata = self._get_metadata()
+        creation_info = metadata.creation_info
+        return DictInfo(
+            name=metadata.name or None,
+            created_at=timestamp_to_localized_dt(creation_info.created_at),
+            created_by=creation_info.created_by or None,
+        )
 
     @live_method
     async def clear(self) -> None:
         """Remove all items from the Dict."""
         req = api_pb2.DictClearRequest(dict_id=self.object_id)
-        await retry_transient_errors(self._client.stub.DictClear, req)
+        await self._client.stub.DictClear(req)
 
     @live_method
     async def get(self, key: Any, default: Optional[Any] = None) -> Any:
@@ -222,7 +436,7 @@ class _Dict(_Object, type_prefix="di"):
         Returns `default` if key does not exist.
         """
         req = api_pb2.DictGetRequest(dict_id=self.object_id, key=serialize(key))
-        resp = await retry_transient_errors(self._client.stub.DictGet, req)
+        resp = await self._client.stub.DictGet(req)
         if not resp.found:
             return default
         return deserialize(resp.value, self._client)
@@ -231,7 +445,7 @@ class _Dict(_Object, type_prefix="di"):
     async def contains(self, key: Any) -> bool:
         """Return if a key is present."""
         req = api_pb2.DictContainsRequest(dict_id=self.object_id, key=serialize(key))
-        resp = await retry_transient_errors(self._client.stub.DictContains, req)
+        resp = await self._client.stub.DictContains(req)
         return resp.found
 
     @live_method
@@ -241,7 +455,7 @@ class _Dict(_Object, type_prefix="di"):
         Note: This is an expensive operation and will return at most 100,000.
         """
         req = api_pb2.DictLenRequest(dict_id=self.object_id)
-        resp = await retry_transient_errors(self._client.stub.DictLen, req)
+        resp = await self._client.stub.DictLen(req)
         return resp.len
 
     @live_method
@@ -270,7 +484,7 @@ class _Dict(_Object, type_prefix="di"):
         serialized = _serialize_dict(contents)
         req = api_pb2.DictUpdateRequest(dict_id=self.object_id, updates=serialized)
         try:
-            await retry_transient_errors(self._client.stub.DictUpdate, req)
+            await self._client.stub.DictUpdate(req)
         except GRPCError as exc:
             if "status = '413'" in exc.message:
                 raise RequestSizeError("Dict.update request is too large") from exc
@@ -288,7 +502,7 @@ class _Dict(_Object, type_prefix="di"):
         serialized = _serialize_dict(updates)
         req = api_pb2.DictUpdateRequest(dict_id=self.object_id, updates=serialized, if_not_exists=skip_if_exists)
         try:
-            resp = await retry_transient_errors(self._client.stub.DictUpdate, req)
+            resp = await self._client.stub.DictUpdate(req)
             return resp.created
         except GRPCError as exc:
             if "status = '413'" in exc.message:
@@ -305,11 +519,16 @@ class _Dict(_Object, type_prefix="di"):
         return await self.put(key, value)
 
     @live_method
-    async def pop(self, key: Any) -> Any:
-        """Remove a key from the Dict, returning the value if it exists."""
+    async def pop(self, key: Any, default: Any = _NO_DEFAULT) -> Any:
+        """Remove a key from the Dict, returning the value if it exists.
+
+        If key is not found, return default if provided, otherwise raise KeyError.
+        """
         req = api_pb2.DictPopRequest(dict_id=self.object_id, key=serialize(key))
-        resp = await retry_transient_errors(self._client.stub.DictPop, req)
+        resp = await self._client.stub.DictPop(req)
         if not resp.found:
+            if default is not _NO_DEFAULT:
+                return default
             raise KeyError(f"{key} not in dict {self.object_id}")
         return deserialize(resp.value, self._client)