modal 1.1.1.dev41__py3-none-any.whl → 1.1.2__py3-none-any.whl

modal/sandbox.pyi

@@ -59,7 +59,7 @@ class _Sandbox(modal._object._Object):
         image: modal.image._Image,
         secrets: collections.abc.Sequence[modal.secret._Secret],
         name: typing.Optional[str] = None,
-        timeout: typing.Optional[int] = None,
+        timeout: int = 300,
         workdir: typing.Optional[str] = None,
         gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
         cloud: typing.Optional[str] = None,
@@ -95,7 +95,7 @@ class _Sandbox(modal._object._Object):
         image: typing.Optional[modal.image._Image] = None,
         secrets: collections.abc.Sequence[modal.secret._Secret] = (),
         network_file_systems: dict[typing.Union[str, os.PathLike], modal.network_file_system._NetworkFileSystem] = {},
-        timeout: typing.Optional[int] = None,
+        timeout: int = 300,
         workdir: typing.Optional[str] = None,
         gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
         cloud: typing.Optional[str] = None,
@@ -120,8 +120,9 @@ class _Sandbox(modal._object._Object):
         client: typing.Optional[modal.client._Client] = None,
         environment_name: typing.Optional[str] = None,
     ) -> _Sandbox:
-        """Create a new Sandbox to run untrusted, arbitrary code. The Sandbox's corresponding container
-        will be created asynchronously.
+        """Create a new Sandbox to run untrusted, arbitrary code.
+
+        The Sandbox's corresponding container will be created asynchronously.
 
         **Usage**
 
@@ -143,7 +144,7 @@ class _Sandbox(modal._object._Object):
         secrets: collections.abc.Sequence[modal.secret._Secret] = (),
         mounts: collections.abc.Sequence[modal.mount._Mount] = (),
         network_file_systems: dict[typing.Union[str, os.PathLike], modal.network_file_system._NetworkFileSystem] = {},
-        timeout: typing.Optional[int] = None,
+        timeout: int = 300,
         workdir: typing.Optional[str] = None,
         gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
         cloud: typing.Optional[str] = None,
@@ -368,7 +369,7 @@ class Sandbox(modal.object.Object):
         image: modal.image.Image,
         secrets: collections.abc.Sequence[modal.secret.Secret],
         name: typing.Optional[str] = None,
-        timeout: typing.Optional[int] = None,
+        timeout: int = 300,
         workdir: typing.Optional[str] = None,
         gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
         cloud: typing.Optional[str] = None,
@@ -407,7 +408,7 @@ class Sandbox(modal.object.Object):
             network_file_systems: dict[
                 typing.Union[str, os.PathLike], modal.network_file_system.NetworkFileSystem
             ] = {},
-            timeout: typing.Optional[int] = None,
+            timeout: int = 300,
             workdir: typing.Optional[str] = None,
             gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
             cloud: typing.Optional[str] = None,
@@ -432,8 +433,9 @@ class Sandbox(modal.object.Object):
             client: typing.Optional[modal.client.Client] = None,
             environment_name: typing.Optional[str] = None,
         ) -> Sandbox:
-            """Create a new Sandbox to run untrusted, arbitrary code. The Sandbox's corresponding container
-            will be created asynchronously.
+            """Create a new Sandbox to run untrusted, arbitrary code.
+
+            The Sandbox's corresponding container will be created asynchronously.
 
             **Usage**
 
@@ -457,7 +459,7 @@ class Sandbox(modal.object.Object):
             network_file_systems: dict[
                 typing.Union[str, os.PathLike], modal.network_file_system.NetworkFileSystem
             ] = {},
-            timeout: typing.Optional[int] = None,
+            timeout: int = 300,
             workdir: typing.Optional[str] = None,
             gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
             cloud: typing.Optional[str] = None,
@@ -482,8 +484,9 @@ class Sandbox(modal.object.Object):
             client: typing.Optional[modal.client.Client] = None,
             environment_name: typing.Optional[str] = None,
         ) -> Sandbox:
-            """Create a new Sandbox to run untrusted, arbitrary code. The Sandbox's corresponding container
-            will be created asynchronously.
+            """Create a new Sandbox to run untrusted, arbitrary code.
+
+            The Sandbox's corresponding container will be created asynchronously.
 
             **Usage**
 
@@ -511,7 +514,7 @@ class Sandbox(modal.object.Object):
             network_file_systems: dict[
                 typing.Union[str, os.PathLike], modal.network_file_system.NetworkFileSystem
             ] = {},
-            timeout: typing.Optional[int] = None,
+            timeout: int = 300,
             workdir: typing.Optional[str] = None,
             gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
             cloud: typing.Optional[str] = None,
@@ -547,7 +550,7 @@ class Sandbox(modal.object.Object):
             network_file_systems: dict[
                 typing.Union[str, os.PathLike], modal.network_file_system.NetworkFileSystem
             ] = {},
-            timeout: typing.Optional[int] = None,
+            timeout: int = 300,
             workdir: typing.Optional[str] = None,
             gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
             cloud: typing.Optional[str] = None,

modal/secret.py

@@ -6,6 +6,7 @@ from typing import Optional, Union
 
 from google.protobuf.message import Message
 from grpclib import GRPCError, Status
+from synchronicity import classproperty
 
 from modal_proto import api_pb2
 
@@ -16,9 +17,9 @@ from ._utils.async_utils import 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 timestamp_to_localized_dt
+from ._utils.time_utils import as_timestamp, timestamp_to_localized_dt
 from .client import _Client
-from .exception import InvalidError, NotFoundError
+from .exception import AlreadyExistsError, InvalidError, NotFoundError
 
 ENV_DICT_WRONG_TYPE_ERR = "the env_dict argument to Secret has to be a dict[str, Union[str, None]]"
 
@@ -35,6 +36,176 @@ class SecretInfo:
     created_by: Optional[str]
 
 
+class _SecretManager:
+    """Namespace with methods for managing named Secret objects."""
+
+    @staticmethod
+    async def create(
+        name: str,  # Name to use for the new Secret
+        env_dict: dict[str, str],  # Key-value pairs to set in the Secret
+        *,
+        allow_existing: bool = False,  # If True, no-op when the Secret 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 Secret object.
+
+        **Examples:**
+
+        ```python notest
+        contents = {"MY_KEY": "my-value", "MY_OTHER_KEY": "my-other-value"}
+        modal.Secret.objects.create("my-secret", contents)
+        ```
+
+        Secrets will be created in the active environment, or another one can be specified:
+
+        ```python notest
+        modal.Secret.objects.create("my-secret", contents, environment_name="dev")
+        ```
+
+        By default, an error will be raised if the Secret already exists, but passing
+        `allow_existing=True` will make the creation attempt a no-op in this case.
+        If the `env_dict` data differs from the existing Secret, it will be ignored.
+
+        ```python notest
+        modal.Secret.objects.create("my-secret", contents, allow_existing=True)
+        ```
+
+        Note that this method does not return a local instance of the Secret. You can use
+        `modal.Secret.from_name` to perform a lookup after creation.
+
+        Added in v1.1.2.
+
+        """
+        check_object_name(name, "Secret")
+        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.SecretGetOrCreateRequest(
+            deployment_name=name,
+            environment_name=_get_environment_name(environment_name),
+            object_creation_type=object_creation_type,
+            env_dict=env_dict,
+        )
+        try:
+            await retry_transient_errors(client.stub.SecretGetOrCreate, 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 requests 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["_Secret"]:
+        """Return a list of hydrated Secret objects.
+
+        **Examples:**
+
+        ```python
+        secrets = modal.Secret.objects.list()
+        print([s.name for s in secrets])
+        ```
+
+        Secrets will be retreived from the active environment, or another one can be specified:
+
+        ```python notest
+        dev_secrets = modal.Secret.objects.list(environment_name="dev")
+        ```
+
+        By default, all named Secrets are returned, newest to oldest. It's also possible to limit the
+        number of results and to filter by creation date:
+
+        ```python
+        secrets = modal.Secret.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.SecretListItem] = []
+
+        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.SecretListRequest(
+                environment_name=_get_environment_name(environment_name), pagination=pagination
+            )
+            resp = await retry_transient_errors(client.stub.SecretList, req)
+            items.extend(resp.items)
+            finished = (len(resp.items) < 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)
+
+        secrets = [
+            _Secret._new_hydrated(
+                item.secret_id,
+                client,
+                item.metadata,
+                is_another_app=True,
+                rep=_Secret._repr(item.label, environment_name),
+            )
+            for item in items
+        ]
+        return secrets[:max_objects] if max_objects is not None else secrets
+
+    @staticmethod
+    async def delete(
+        name: str,  # Name of the Secret to delete
+        *,
+        allow_missing: bool = False,  # If True, don't raise an error if the Secret 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 Secret.
+
+        Warning: Deletion is irreversible and will affect any Apps currently using the Secret.
+
+        **Examples:**
+
+        ```python notest
+        await modal.Secret.objects.delete("my-secret")
+        ```
+
+        Secrets will be deleted from the active environment, or another one can be specified:
+
+        ```python notest
+        await modal.Secret.objects.delete("my-secret", environment_name="dev")
+        ```
+
+        Added in v1.1.2.
+
+        """
+        try:
+            obj = await _Secret.from_name(name, environment_name=environment_name).hydrate(client)
+        except NotFoundError:
+            if not allow_missing:
+                raise
+        else:
+            req = api_pb2.SecretDeleteRequest(secret_id=obj.object_id)
+            await retry_transient_errors(obj._client.stub.SecretDelete, req)
+
+
+SecretManager = synchronize_api(_SecretManager)
+
+
 class _Secret(_Object, type_prefix="st"):
     """Secrets provide a dictionary of environment variables for images.
 
@@ -47,6 +218,10 @@ class _Secret(_Object, type_prefix="st"):
 
     _metadata: Optional[api_pb2.SecretMetadata] = None
 
+    @classproperty
+    def objects(cls) -> _SecretManager:
+        return _SecretManager
+
     @property
     def name(self) -> Optional[str]:
         return self._name
@@ -234,7 +409,8 @@ class _Secret(_Object, type_prefix="st"):
                     raise
             self._hydrate(response.secret_id, resolver.client, response.metadata)
 
-        return _Secret._from_loader(_load, "Secret()", hydrate_lazily=True, name=name)
+        rep = _Secret._repr(name, environment_name)
+        return _Secret._from_loader(_load, rep, hydrate_lazily=True, name=name)
 
     @staticmethod
     async def lookup(
@@ -273,6 +449,23 @@ class _Secret(_Object, type_prefix="st"):
         client: Optional[_Client] = None,
         environment_name: Optional[str] = None,
         overwrite: bool = False,
+    ) -> str:
+        """mdmd:hidden"""
+        deprecation_warning(
+            (2025, 8, 13),
+            "The undocumented `modal.Secret.create_deployed` method is deprecated and will be removed "
+            "in a future release. It can be replaced with `modal.Secret.objects.create`.",
+        )
+        return await _Secret._create_deployed(deployment_name, env_dict, namespace, client, environment_name, overwrite)
+
+    @staticmethod
+    async def _create_deployed(
+        deployment_name: str,
+        env_dict: dict[str, str],
+        namespace=None,  # mdmd:line-hidden
+        client: Optional[_Client] = None,
+        environment_name: Optional[str] = None,
+        overwrite: bool = False,
     ) -> str:
         """mdmd:hidden"""
         warn_if_passing_namespace(namespace, "modal.Secret.create_deployed")