modal 1.1.1.dev26__py3-none-any.whl → 1.1.1.dev28__py3-none-any.whl

modal/_object.py

@@ -48,6 +48,10 @@ class _Object:
     _is_hydrated: bool
     _is_rehydrated: bool
 
+    # Not all object subclasses have a meaningful "name" concept
+    # So whether they expose this is a matter of having a name property
+    _name: Optional[str]
+
     @classmethod
     def __init_subclass__(cls, type_prefix: Optional[str] = None):
         super().__init_subclass__()
@@ -68,6 +72,7 @@ class _Object:
         hydrate_lazily: bool = False,
         deps: Optional[Callable[..., Sequence["_Object"]]] = None,
         deduplication_key: Optional[Callable[[], Awaitable[Hashable]]] = None,
+        name: Optional[str] = None,
     ):
         self._local_uuid = str(uuid.uuid4())
         self._load = load
@@ -83,6 +88,8 @@ class _Object:
         self._is_hydrated = False
         self._is_rehydrated = False
 
+        self._name = name
+
         self._initialize_from_empty()
 
     def _unhydrate(self):
@@ -163,10 +170,11 @@ class _Object:
         hydrate_lazily: bool = False,
         deps: Optional[Callable[..., Sequence["_Object"]]] = None,
         deduplication_key: Optional[Callable[[], Awaitable[Hashable]]] = None,
+        name: Optional[str] = None,
     ):
         # TODO(erikbern): flip the order of the two first arguments
         obj = _Object.__new__(cls)
-        obj._init(rep, load, is_another_app, preload, hydrate_lazily, deps, deduplication_key)
+        obj._init(rep, load, is_another_app, preload, hydrate_lazily, deps, deduplication_key, name)
         return obj
 
     @staticmethod

modal/_output.py

@@ -72,25 +72,6 @@ class FunctionQueuingColumn(ProgressColumn):
         return Text(str(delta), style="progress.elapsed")
 
 
-def download_progress_bar() -> Progress:
-    """
-    Returns a progress bar suitable for showing file download progress.
-    Requires passing a `path: str` data field for rendering.
-    """
-    return Progress(
-        TextColumn("[bold white]{task.fields[path]}", justify="right"),
-        BarColumn(bar_width=None),
-        "[progress.percentage]{task.percentage:>3.1f}%",
-        "•",
-        DownloadColumn(),
-        "•",
-        TransferSpeedColumn(),
-        "•",
-        TimeRemainingColumn(),
-        transient=True,
-    )
-
-
 class LineBufferedOutput:
     """Output stream that buffers lines and passes them to a callback."""
 

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.dev26",
+        version: str = "1.1.1.dev28",
     ):
         """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.dev26",
+        version: str = "1.1.1.dev28",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

modal/dict.py

@@ -1,7 +1,10 @@
 # Copyright Modal Labs 2022
 from collections.abc import AsyncIterator, Mapping
+from dataclasses import dataclass
+from datetime import datetime
 from typing import Any, Optional
 
+from google.protobuf.message import Message
 from grpclib import GRPCError
 from synchronicity.async_wrap import asynccontextmanager
 
@@ -23,6 +26,18 @@ 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 the 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 _Dict(_Object, type_prefix="di"):
     """Distributed dictionary for storage in Modal apps.
 
@@ -65,12 +80,29 @@ 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"
         )
 
+    @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(
@@ -112,7 +144,7 @@ class _Dict(_Object, type_prefix="di"):
         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)
 
     @staticmethod
     def from_name(
@@ -155,7 +187,7 @@ class _Dict(_Object, type_prefix="di"):
             logger.debug(f"Created dict with id {response.dict_id}")
             self._hydrate(response.dict_id, resolver.client, response.metadata)
 
-        return _Dict._from_loader(_load, "Dict()", is_another_app=True, hydrate_lazily=True)
+        return _Dict._from_loader(_load, "Dict()", is_another_app=True, hydrate_lazily=True, name=name)
 
     @staticmethod
     async def lookup(
@@ -209,6 +241,17 @@ class _Dict(_Object, type_prefix="di"):
         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=datetime.fromtimestamp(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."""

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/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]: ...

modal/queue.py

@@ -3,8 +3,11 @@ import queue  # The system library
 import time
 import warnings
 from collections.abc import AsyncGenerator, AsyncIterator
+from dataclasses import dataclass
+from datetime import datetime
 from typing import Any, Optional
 
+from google.protobuf.message import Message
 from grpclib import GRPCError, Status
 from synchronicity.async_wrap import asynccontextmanager
 
@@ -21,6 +24,18 @@ from .client import _Client
 from .exception import InvalidError, RequestSizeError
 
 
+@dataclass
+class QueueInfo:
+    """Information about the Queue object."""
+
+    # This dataclass should be limited to information that is unchanging over the lifetime of the Queue,
+    # 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 _Queue(_Object, type_prefix="qu"):
     """Distributed, FIFO queue for data flow in Modal apps.
 
@@ -94,10 +109,26 @@ class _Queue(_Object, type_prefix="qu"):
     Partition keys must be non-empty and must not exceed 64 bytes.
     """
 
+    _metadata: Optional[api_pb2.QueueMetadata] = None
+
     def __init__(self):
         """mdmd:hidden"""
         raise RuntimeError("Queue() is not allowed. Please use `Queue.from_name(...)` or `Queue.ephemeral()` instead.")
 
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    def _hydrate_metadata(self, metadata: Optional[Message]):
+        if metadata:
+            assert isinstance(metadata, api_pb2.QueueMetadata)
+            self._metadata = metadata
+            self._name = metadata.name
+
+    def _get_metadata(self) -> api_pb2.QueueMetadata:
+        assert self._metadata
+        return self._metadata
+
     @staticmethod
     def validate_partition_key(partition: Optional[str]) -> bytes:
         if partition is not None:
@@ -142,7 +173,7 @@ class _Queue(_Object, type_prefix="qu"):
         async with TaskContext() as tc:
             request = api_pb2.QueueHeartbeatRequest(queue_id=response.queue_id)
             tc.infinite_loop(lambda: client.stub.QueueHeartbeat(request), sleep=_heartbeat_sleep)
-            yield cls._new_hydrated(response.queue_id, client, None, is_another_app=True)
+            yield cls._new_hydrated(response.queue_id, client, response.metadata, is_another_app=True)
 
     @staticmethod
     def from_name(
@@ -175,7 +206,7 @@ class _Queue(_Object, type_prefix="qu"):
             response = await resolver.client.stub.QueueGetOrCreate(req)
             self._hydrate(response.queue_id, resolver.client, response.metadata)
 
-        return _Queue._from_loader(_load, "Queue()", is_another_app=True, hydrate_lazily=True)
+        return _Queue._from_loader(_load, "Queue()", is_another_app=True, hydrate_lazily=True, name=name)
 
     @staticmethod
     async def lookup(
@@ -222,6 +253,17 @@ class _Queue(_Object, type_prefix="qu"):
         req = api_pb2.QueueDeleteRequest(queue_id=obj.object_id)
         await retry_transient_errors(obj._client.stub.QueueDelete, req)
 
+    @live_method
+    async def info(self) -> QueueInfo:
+        """Return information about the Queue object."""
+        metadata = self._get_metadata()
+        creation_info = metadata.creation_info
+        return QueueInfo(
+            name=metadata.name or None,
+            created_at=datetime.fromtimestamp(creation_info.created_at),
+            created_by=creation_info.created_by or None,
+        )
+
     async def _get_nonblocking(self, partition: Optional[str], n_values: int) -> list[Any]:
         request = api_pb2.QueueGetRequest(
             queue_id=self.object_id,

modal/queue.pyi

@@ -1,11 +1,35 @@
 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
 
+class QueueInfo:
+    """Information about the Queue 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 _Queue(modal._object._Object):
     """Distributed, FIFO queue for data flow in Modal apps.
 
@@ -78,10 +102,17 @@ class _Queue(modal._object._Object):
 
     Partition keys must be non-empty and must not exceed 64 bytes.
     """
+
+    _metadata: typing.Optional[modal_proto.api_pb2.QueueMetadata]
+
     def __init__(self):
         """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.QueueMetadata: ...
     @staticmethod
     def validate_partition_key(partition: typing.Optional[str]) -> bytes: ...
     @classmethod
@@ -155,6 +186,10 @@ class _Queue(modal._object._Object):
         client: typing.Optional[modal.client._Client] = None,
         environment_name: typing.Optional[str] = None,
     ): ...
+    async def info(self) -> QueueInfo:
+        """Return information about the Queue object."""
+        ...
+
     async def _get_nonblocking(self, partition: typing.Optional[str], n_values: int) -> list[typing.Any]: ...
     async def _get_blocking(
         self, partition: typing.Optional[str], timeout: typing.Optional[float], n_values: int
@@ -335,10 +370,17 @@ class Queue(modal.object.Object):
 
     Partition keys must be non-empty and must not exceed 64 bytes.
     """
+
+    _metadata: typing.Optional[modal_proto.api_pb2.QueueMetadata]
+
     def __init__(self):
         """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.QueueMetadata: ...
     @staticmethod
     def validate_partition_key(partition: typing.Optional[str]) -> bytes: ...
     @classmethod
@@ -453,6 +495,17 @@ class Queue(modal.object.Object):
 
     delete: __delete_spec
 
+    class __info_spec(typing_extensions.Protocol[SUPERSELF]):
+        def __call__(self, /) -> QueueInfo:
+            """Return information about the Queue object."""
+            ...
+
+        async def aio(self, /) -> QueueInfo:
+            """Return information about the Queue object."""
+            ...
+
+    info: __info_spec[typing_extensions.Self]
+
     class ___get_nonblocking_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, partition: typing.Optional[str], n_values: int) -> list[typing.Any]: ...
         async def aio(self, /, partition: typing.Optional[str], n_values: int) -> list[typing.Any]: ...

modal/secret.py

@@ -1,12 +1,15 @@
 # Copyright Modal Labs 2022
 import os
+from dataclasses import dataclass
+from datetime import datetime
 from typing import Optional, Union
 
+from google.protobuf.message import Message
 from grpclib import GRPCError, Status
 
 from modal_proto import api_pb2
 
-from ._object import _get_environment_name, _Object
+from ._object import _get_environment_name, _Object, live_method
 from ._resolver import Resolver
 from ._runtime.execution_context import is_local
 from ._utils.async_utils import synchronize_api
@@ -19,6 +22,18 @@ from .exception import InvalidError, NotFoundError
 ENV_DICT_WRONG_TYPE_ERR = "the env_dict argument to Secret has to be a dict[str, Union[str, None]]"
 
 
+@dataclass
+class SecretInfo:
+    """Information about the Secret object."""
+
+    # This dataclass should be limited to information that is unchanging over the lifetime of the Secret,
+    # 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 _Secret(_Object, type_prefix="st"):
     """Secrets provide a dictionary of environment variables for images.
 
@@ -29,6 +44,22 @@ class _Secret(_Object, type_prefix="st"):
     See [the secrets guide page](https://modal.com/docs/guide/secrets) for more information.
     """
 
+    _metadata: Optional[api_pb2.SecretMetadata] = None
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    def _hydrate_metadata(self, metadata: Optional[Message]):
+        if metadata:
+            assert isinstance(metadata, api_pb2.SecretMetadata)
+            self._metadata = metadata
+            self._name = metadata.name
+
+    def _get_metadata(self) -> api_pb2.SecretMetadata:
+        assert self._metadata
+        return self._metadata
+
     @staticmethod
     def from_dict(
         env_dict: dict[
@@ -202,7 +233,7 @@ 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)
+        return _Secret._from_loader(_load, "Secret()", hydrate_lazily=True, name=name)
 
     @staticmethod
     async def lookup(
@@ -261,5 +292,16 @@ class _Secret(_Object, type_prefix="st"):
         resp = await retry_transient_errors(client.stub.SecretGetOrCreate, request)
         return resp.secret_id
 
+    @live_method
+    async def info(self) -> SecretInfo:
+        """Return information about the Secret object."""
+        metadata = self._get_metadata()
+        creation_info = metadata.creation_info
+        return SecretInfo(
+            name=metadata.name or None,
+            created_at=datetime.fromtimestamp(creation_info.created_at),
+            created_by=creation_info.created_by or None,
+        )
+
 
 Secret = synchronize_api(_Secret)

modal/secret.pyi

@@ -1,9 +1,33 @@
+import datetime
+import google.protobuf.message
 import modal._object
 import modal.client
 import modal.object
+import modal_proto.api_pb2
 import typing
 import typing_extensions
 
+class SecretInfo:
+    """Information about the Secret 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 _Secret(modal._object._Object):
     """Secrets provide a dictionary of environment variables for images.
 
@@ -13,6 +37,13 @@ class _Secret(modal._object._Object):
 
     See [the secrets guide page](https://modal.com/docs/guide/secrets) for more information.
     """
+
+    _metadata: typing.Optional[modal_proto.api_pb2.SecretMetadata]
+
+    @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.SecretMetadata: ...
     @staticmethod
     def from_dict(env_dict: dict[str, typing.Optional[str]] = {}) -> _Secret:
         """Create a secret from a str-str dictionary. Values can also be `None`, which is ignored.
@@ -104,6 +135,12 @@ class _Secret(modal._object._Object):
         """mdmd:hidden"""
         ...
 
+    async def info(self) -> SecretInfo:
+        """Return information about the Secret object."""
+        ...
+
+SUPERSELF = typing.TypeVar("SUPERSELF", covariant=True)
+
 class Secret(modal.object.Object):
     """Secrets provide a dictionary of environment variables for images.
 
@@ -113,10 +150,17 @@ class Secret(modal.object.Object):
 
     See [the secrets guide page](https://modal.com/docs/guide/secrets) for more information.
     """
+
+    _metadata: typing.Optional[modal_proto.api_pb2.SecretMetadata]
+
     def __init__(self, *args, **kwargs):
         """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.SecretMetadata: ...
     @staticmethod
     def from_dict(env_dict: dict[str, typing.Optional[str]] = {}) -> Secret:
         """Create a secret from a str-str dictionary. Values can also be `None`, which is ignored.
@@ -240,3 +284,14 @@ class Secret(modal.object.Object):
             ...
 
     create_deployed: __create_deployed_spec
+
+    class __info_spec(typing_extensions.Protocol[SUPERSELF]):
+        def __call__(self, /) -> SecretInfo:
+            """Return information about the Secret object."""
+            ...
+
+        async def aio(self, /) -> SecretInfo:
+            """Return information about the Secret object."""
+            ...
+
+    info: __info_spec[typing_extensions.Self]

modal/volume.py

@@ -11,6 +11,7 @@ import time
 import typing
 from collections.abc import AsyncGenerator, AsyncIterator, Generator, Sequence
 from dataclasses import dataclass
+from datetime import datetime
 from io import BytesIO
 from pathlib import Path, PurePosixPath
 from typing import (
@@ -92,6 +93,18 @@ class FileEntry:
         )
 
 
+@dataclass
+class VolumeInfo:
+    """Information about the Volume object."""
+
+    # This dataclass should be limited to information that is unchanging over the lifetime of the Volume,
+    # 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 _Volume(_Object, type_prefix="vo"):
     """A writeable volume that can be used to share files between one or more Modal functions.
 
@@ -167,6 +180,19 @@ class _Volume(_Object, type_prefix="vo"):
         obj = _Volume._from_loader(_load, "Volume()", hydrate_lazily=True, deps=lambda: [self])
         return obj
 
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    def _hydrate_metadata(self, metadata: Optional[Message]):
+        if metadata:
+            assert isinstance(metadata, api_pb2.VolumeMetadata)
+            self._metadata = metadata
+            self._name = metadata.name
+
+    def _get_metadata(self) -> Optional[Message]:
+        return self._metadata
+
     async def _get_lock(self):
         # To (mostly*) prevent multiple concurrent operations on the same volume, which can cause problems under
         # some unlikely circumstances.
@@ -181,6 +207,14 @@ class _Volume(_Object, type_prefix="vo"):
             self._lock = asyncio.Lock()
         return self._lock
 
+    @property
+    def _is_v1(self) -> bool:
+        return self._metadata.version in [
+            None,
+            api_pb2.VolumeFsVersion.VOLUME_FS_VERSION_UNSPECIFIED,
+            api_pb2.VolumeFsVersion.VOLUME_FS_VERSION_V1,
+        ]
+
     @staticmethod
     def from_name(
         name: str,
@@ -220,24 +254,7 @@ class _Volume(_Object, type_prefix="vo"):
             response = await resolver.client.stub.VolumeGetOrCreate(req)
             self._hydrate(response.volume_id, resolver.client, response.metadata)
 
-        return _Volume._from_loader(_load, "Volume()", hydrate_lazily=True)
-
-    def _hydrate_metadata(self, metadata: Optional[Message]):
-        if metadata and isinstance(metadata, api_pb2.VolumeMetadata):
-            self._metadata = metadata
-        else:
-            raise TypeError("_hydrate_metadata() requires an `api_pb2.VolumeMetadata` to determine volume version")
-
-    def _get_metadata(self) -> Optional[Message]:
-        return self._metadata
-
-    @property
-    def _is_v1(self) -> bool:
-        return self._metadata.version in [
-            None,
-            api_pb2.VolumeFsVersion.VOLUME_FS_VERSION_UNSPECIFIED,
-            api_pb2.VolumeFsVersion.VOLUME_FS_VERSION_V1,
-        ]
+        return _Volume._from_loader(_load, "Volume()", hydrate_lazily=True, name=name)
 
     @classmethod
     @asynccontextmanager
@@ -338,6 +355,19 @@ class _Volume(_Object, type_prefix="vo"):
         resp = await retry_transient_errors(client.stub.VolumeGetOrCreate, request)
         return resp.volume_id
 
+    @live_method
+    async def info(self) -> VolumeInfo:
+        """Return information about the Volume object."""
+        metadata = self._get_metadata()
+        if not metadata:
+            return VolumeInfo()
+        creation_info = metadata.creation_info
+        return VolumeInfo(
+            name=metadata.name or None,
+            created_at=datetime.fromtimestamp(creation_info.created_at) if creation_info.created_at else None,
+            created_by=creation_info.created_by or None,
+        )
+
     @live_method
     async def _do_reload(self, lock=True):
         async with (await self._get_lock()) if lock else asyncnullcontext():

modal/volume.pyi

@@ -1,6 +1,7 @@
 import _io
 import asyncio.locks
 import collections.abc
+import datetime
 import enum
 import google.protobuf.message
 import modal._object
@@ -57,6 +58,27 @@ class FileEntry:
         """Return hash(self)."""
         ...
 
+class VolumeInfo:
+    """Information about the Volume 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 _Volume(modal._object._Object):
     """A writeable volume that can be used to share files between one or more Modal functions.
 
@@ -126,7 +148,13 @@ class _Volume(modal._object._Object):
         """
         ...
 
+    @property
+    def name(self) -> typing.Optional[str]: ...
+    def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
+    def _get_metadata(self) -> typing.Optional[google.protobuf.message.Message]: ...
     async def _get_lock(self): ...
+    @property
+    def _is_v1(self) -> bool: ...
     @staticmethod
     def from_name(
         name: str,
@@ -155,10 +183,6 @@ class _Volume(modal._object._Object):
         """
         ...
 
-    def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
-    def _get_metadata(self) -> typing.Optional[google.protobuf.message.Message]: ...
-    @property
-    def _is_v1(self) -> bool: ...
     @classmethod
     def ephemeral(
         cls: type[_Volume],
@@ -218,6 +242,10 @@ class _Volume(modal._object._Object):
         """mdmd:hidden"""
         ...
 
+    async def info(self) -> VolumeInfo:
+        """Return information about the Volume object."""
+        ...
+
     async def _do_reload(self, lock=True): ...
     async def commit(self):
         """Commit changes to the volume.
@@ -424,12 +452,19 @@ class Volume(modal.object.Object):
         """
         ...
 
+    @property
+    def name(self) -> typing.Optional[str]: ...
+    def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
+    def _get_metadata(self) -> typing.Optional[google.protobuf.message.Message]: ...
+
     class ___get_lock_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /): ...
         async def aio(self, /): ...
 
     _get_lock: ___get_lock_spec[typing_extensions.Self]
 
+    @property
+    def _is_v1(self) -> bool: ...
     @staticmethod
     def from_name(
         name: str,
@@ -458,10 +493,6 @@ class Volume(modal.object.Object):
         """
         ...
 
-    def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
-    def _get_metadata(self) -> typing.Optional[google.protobuf.message.Message]: ...
-    @property
-    def _is_v1(self) -> bool: ...
     @classmethod
     def ephemeral(
         cls: type[Volume],
@@ -566,6 +597,17 @@ class Volume(modal.object.Object):
 
     create_deployed: __create_deployed_spec
 
+    class __info_spec(typing_extensions.Protocol[SUPERSELF]):
+        def __call__(self, /) -> VolumeInfo:
+            """Return information about the Volume object."""
+            ...
+
+        async def aio(self, /) -> VolumeInfo:
+            """Return information about the Volume object."""
+            ...
+
+    info: __info_spec[typing_extensions.Self]
+
     class ___do_reload_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, lock=True): ...
         async def aio(self, /, lock=True): ...

{modal-1.1.1.dev26.dist-info → modal-1.1.1.dev28.dist-info}/METADATA

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

{modal-1.1.1.dev26.dist-info → modal-1.1.1.dev28.dist-info}/RECORD

@@ -6,8 +6,8 @@ modal/_container_entrypoint.py,sha256=1qBMNY_E9ICC_sRCtillMxmKPsmxJl1J0_qOAG8rH-
 modal/_functions.py,sha256=c1EeAcHcYP76wHbLomV0mFe73AoL-TUSjJNSDu6CELI,83065
 modal/_ipython.py,sha256=TW1fkVOmZL3YYqdS2YlM1hqpf654Yf8ZyybHdBnlhSw,301
 modal/_location.py,sha256=joiX-0ZeutEUDTrrqLF1GHXCdVLF-rHzstocbMcd_-k,366
-modal/_object.py,sha256=vzRWhAcFJDM8ZmiUSDgSj9gJhLZJA-wjLVvTl984N4A,11295
-modal/_output.py,sha256=4LbNjPyd6spKiwJS-UTrZKnfpIWmdNy7rnDIVcNVwSE,26327
+modal/_object.py,sha256=nCkQeLibSuvVAEIheGaLnUfN5PIh1CGpJCnzPIXymGY,11563
+modal/_output.py,sha256=T7CRq90W09d-WD4ko7T4PBe26JNeAXE1-8HNO9xpNPI,25787
 modal/_partial_function.py,sha256=B1J4S9W-La0NHaVmY1aCuH0E3QxJHIX6ZWY5eNTQ7io,37142
 modal/_pty.py,sha256=JZfPDDpzqICZqtyPI_oMJf_9w-p_lLNuzHhwhodUXio,1329
 modal/_resolver.py,sha256=2RWvm34cNSnbv1v7izJMNZgfvpLDD6LzaBlr0lIrLnY,7364
@@ -22,7 +22,7 @@ modal/app.py,sha256=BBR2NmGzZbFGfhKAmtzllD0o4TbVDBbOEs0O2ysSdQo,48277
 modal/app.pyi,sha256=h6JtBA6a7wobdZAuS3QuXrWCUZqfyKPuGV3XdjCqT3k,43753
 modal/call_graph.py,sha256=1g2DGcMIJvRy-xKicuf63IVE98gJSnQsr8R_NVMptNc,2581
 modal/client.py,sha256=kyAIVB3Ay-XKJizQ_1ufUFB__EagV0MLmHJpyYyJ7J0,18636
-modal/client.pyi,sha256=ft7F2zZkCFWeifBXbRdMfWpa1UGC4nfw6rEqThzh4xo,15831
+modal/client.pyi,sha256=lLCQ-T2OTowy_xclR3HuOrUHday0qON2GzIglWlsks4,15831
 modal/cloud_bucket_mount.py,sha256=YOe9nnvSr4ZbeCn587d7_VhE9IioZYRvF9VYQTQux08,5914
 modal/cloud_bucket_mount.pyi,sha256=-qSfYAQvIoO_l2wsCCGTG5ZUwQieNKXdAO00yP1-LYU,7394
 modal/cls.py,sha256=7A0xGnugQzm8dOfnKMjLjtqekRlRtQ0jPFRYgq6xdUM,40018
@@ -30,8 +30,8 @@ modal/cls.pyi,sha256=_tZ5qrlL-ZDEcD-mf9BZkkNH5XPr4SmGTEQ-RVmqF3I,27772
 modal/config.py,sha256=FqVewLPVVR4feq_46JBENiCzqTuXKpnvQZxaeWbS39g,12009
 modal/container_process.py,sha256=XkPwNIW-iD_GB9u9yqv9q8y-i5cQ8eBbLZZ_GvEw9t8,6858
 modal/container_process.pyi,sha256=9m-st3hCUlNN1GOTctfPPvIvoLtEl7FbuGWwif5-7YU,6037
-modal/dict.py,sha256=YVrIARVfaD2kmdnqbGtneeLciiLkzKxYego0jfkv3Sk,14400
-modal/dict.pyi,sha256=gs3J7X5yG3J1L6rW0s3_7yRn8qAfY0f4n5-sqaDZY2g,20853
+modal/dict.py,sha256=IyhKwQPM-HX10ZT-0ouSxpM-oAWqrT5waXFHmunmtyo,15804
+modal/dict.pyi,sha256=vUrNmCKWZqiPIQSdbMT6fCq9q1QV3qkGVdz2B_yld34,22578
 modal/environments.py,sha256=gHFNLG78bqgizpQ4w_elz27QOqmcgAonFsmLs7NjUJ4,6804
 modal/environments.pyi,sha256=9-KtrzAcUe55cCP4020lSUD7-fWS7OPakAHssq4-bro,4219
 modal/exception.py,sha256=o0V93PK8Hcg2YQ2aeOB1Y-qWBw4Gz5ATfyokR8GapuQ,5634
@@ -50,7 +50,7 @@ modal/mount.pyi,sha256=n6AuS8J3bTCQj750nVZZdVBvzCAlSM2fyxAt_5LLFik,20264
 modal/network_file_system.py,sha256=AdjxI_hCYaDZz60gOuJeig8yourfWhHmEpn13C_fnMA,14775
 modal/network_file_system.pyi,sha256=Td_IobHr84iLo_9LZKQ4tNdUB60yjX8QWBaFiUvhfi8,17685
 modal/object.py,sha256=bTeskuY8JFrESjU4_UL_nTwYlBQdOLmVaOX3X6EMxsg,164
-modal/object.pyi,sha256=751TV6BntarPsErf0HDQPsvePjWFf0JZK8ZAiRpM1yg,6627
+modal/object.pyi,sha256=sgbaq_d3QSmnPKg5jRbMG3dOceKs0l54kHUAhAyZKAE,6796
 modal/output.py,sha256=q4T9uHduunj4NwY-YSwkHGgjZlCXMuJbfQ5UFaAGRAc,1968
 modal/parallel_map.py,sha256=-9nS9s1jbx1Iqh_5HQRK4xTdhnXF4AGIXwT4UGJ8R78,52666
 modal/parallel_map.pyi,sha256=fCugFsGup4Cflesb10_uR-nt5_eguuvhvtvavus_F98,11186
@@ -59,8 +59,8 @@ modal/partial_function.pyi,sha256=lqqOzZ9-QvHTDWKQ_oAYYOvsXgTOBKhO9u-RI98JbUk,13
 modal/proxy.py,sha256=NQJJMGo-D2IfmeU0vb10WWaE4oTLcuf9jTeEJvactOg,1446
 modal/proxy.pyi,sha256=yWGWwADCRGrC2w81B7671UTH4Uv3HMZKy5vVqlJUZoA,1417
 modal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-modal/queue.py,sha256=LuOtO5s6Aes-oXgzmIfLvmEF-QtAZdC9LPqSRbqy-X0,18925
-modal/queue.pyi,sha256=J6ggmVodMRegDuJE0g7AmOPAoMKbgtfvlBrWaT-T7MA,26657
+modal/queue.py,sha256=19Xri5HzY0VgOxWMZ4y_mNco8jhNgn9klegXrSHWmGc,20306
+modal/queue.pyi,sha256=Pv4OtY7j17Yb89HGKaMQRiIv0yol-aV-ZtelxQ9GrlU,28330
 modal/retries.py,sha256=IvNLDM0f_GLUDD5VgEDoN09C88yoxSrCquinAuxT1Sc,5205
 modal/runner.py,sha256=ostdzYpQb-20tlD6dIq7bpWTkZkOhjJBNuMNektqnJA,24068
 modal/runner.pyi,sha256=lbwLljm1cC8d6PcNvmYQhkE8501V9fg0bYqqKX6G4r4,8489
@@ -69,8 +69,8 @@ modal/sandbox.py,sha256=_hAoBwParMzooNUo02LRt-nC5RrTGUtOutyO9oI79Kc,40896
 modal/sandbox.pyi,sha256=GPPlsm-DiSUSgrxyA5bqkpuLlrfgmNR7Z7s3W0QLuQ0,41812
 modal/schedule.py,sha256=ng0g0AqNY5GQI9KhkXZQ5Wam5G42glbkqVQsNpBtbDE,3078
 modal/scheduler_placement.py,sha256=BAREdOY5HzHpzSBqt6jDVR6YC_jYfHMVqOzkyqQfngU,1235
-modal/secret.py,sha256=rzqPd2kT1FoN_R1_nstso3ZLhkRf7iK-fRWhaUBwP6M,10577
-modal/secret.pyi,sha256=_d_vvgIZY-FCMKJheBOn01DQGEvyzB_Rfw5K1hGEaXU,7990
+modal/secret.py,sha256=UaUmwYmT52VarDh92b0QzAa8_BNUAgBs-wE4eMQ6-B8,11967
+modal/secret.pyi,sha256=zcC_OM0JzIF1ccnhNvVIlL6sY3xVjq3t0s3fE1ZDDVs,9732
 modal/serving.py,sha256=3I3WBeVbzZY258u9PXBCW_dZBgypq3OhwBuTVvlgubE,4423
 modal/serving.pyi,sha256=YfixTaWikyYpwhnNxCHMZnDDQiPmV1xJ87QF91U_WGU,1924
 modal/snapshot.py,sha256=E3oxYQkYVRB_LeFBfmUV1Y6vHz8-azXJfC4x7A1QKnI,1455
@@ -78,8 +78,8 @@ modal/snapshot.pyi,sha256=0q83hlmWxAhDu8xwZyL5VmYh0i8Tigf7S60or2k30L8,1682
 modal/stream_type.py,sha256=A6320qoAAWhEfwOCZfGtymQTu5AfLfJXXgARqooTPvY,417
 modal/token_flow.py,sha256=GWpar0gANs71vm9Bd_Cj87UG1K3ljTURbkEjG3JLsrY,7616
 modal/token_flow.pyi,sha256=eirYjyqbRiT3GCKMIPHJPpkvBTu8WxDKqSHehWaJI_4,2533
-modal/volume.py,sha256=aIGp_ZFD6UUqM2XnS19GBqWLc1_xOVBIx2JcFn30aYk,44475
-modal/volume.pyi,sha256=Qo5D0Bojcp8J4t4OoRArrBFaC1MSvFf9jQIL9U6Qz2Q,40779
+modal/volume.py,sha256=b3VYD-0D8rZWxoeIIYpjqm2lgxrVOjFEgTyW2btUVnw,45396
+modal/volume.pyi,sha256=lMXzeyeC85ji8g2j0Ghy1WQrk2A2J0LPVpLFpabbr6A,41933
 modal/_runtime/__init__.py,sha256=MIEP8jhXUeGq_eCjYFcqN5b1bxBM4fdk0VESpjWR0fc,28
 modal/_runtime/asgi.py,sha256=_2xSTsDD27Cit7xnMs4lzkJA2wzer2_N4Oa3BkXFzVA,22521
 modal/_runtime/container_io_manager.py,sha256=hjkK4gke_A8_mULSfm3F1hZKR0C61lKbRUI8mHS-LGE,45464
@@ -151,7 +151,7 @@ modal/experimental/__init__.py,sha256=nuc7AL4r_Fs08DD5dciWFZhrV1nanwoClOfdTcudU0
 modal/experimental/flash.py,sha256=7-_RBNvm0tEpdxXWuPAj5HCxfN-hSHVBep8SEWgAhCQ,19721
 modal/experimental/flash.pyi,sha256=A8_qJGtGoXEzKDdHbvhmCw7oqfneFEvJQK3ZdTOvUdU,10830
 modal/experimental/ipython.py,sha256=TrCfmol9LGsRZMeDoeMPx3Hv3BFqQhYnmD_iH0pqdhk,2904
-modal-1.1.1.dev26.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+modal-1.1.1.dev28.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
 modal_docs/__init__.py,sha256=svYKtV8HDwDCN86zbdWqyq5T8sMdGDj0PVlzc2tIxDM,28
 modal_docs/gen_cli_docs.py,sha256=c1yfBS_x--gL5bs0N4ihMwqwX8l3IBWSkBAKNNIi6bQ,3801
 modal_docs/gen_reference_docs.py,sha256=d_CQUGQ0rfw28u75I2mov9AlS773z9rG40-yq5o7g2U,6359
@@ -174,10 +174,10 @@ modal_proto/options_pb2.pyi,sha256=l7DBrbLO7q3Ir-XDkWsajm0d0TQqqrfuX54i4BMpdQg,1
 modal_proto/options_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXHDCNMhZD2VXqocC9l_gk,159
 modal_proto/options_pb2_grpc.pyi,sha256=CImmhxHsYnF09iENPoe8S4J-n93jtgUYD2JPAc0yJSI,247
 modal_proto/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-modal_version/__init__.py,sha256=nXGRSgHDLw-Aoa3Oy9TNto9xzwGo0zDk5GekIAscWs8,121
+modal_version/__init__.py,sha256=Bhn-Ugb3ll-Q8THvxH35TRv5X0r0MdFbSqaPDwMQcxE,121
 modal_version/__main__.py,sha256=2FO0yYQQwDTh6udt1h-cBnGd1c4ZyHnHSI4BksxzVac,105
-modal-1.1.1.dev26.dist-info/METADATA,sha256=VcBI6MCCTq3s-owzZ580fF4dbDfBeNQNrezWiyZPLLU,2460
-modal-1.1.1.dev26.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-modal-1.1.1.dev26.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
-modal-1.1.1.dev26.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
-modal-1.1.1.dev26.dist-info/RECORD,,
+modal-1.1.1.dev28.dist-info/METADATA,sha256=YXzS8Vb0BSQAE7bFDxldcOyJEBLClAY01vE9LMjpnZQ,2460
+modal-1.1.1.dev28.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+modal-1.1.1.dev28.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
+modal-1.1.1.dev28.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
+modal-1.1.1.dev28.dist-info/RECORD,,

modal_version/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Modal Labs 2025
 """Supplies the current version of the modal client library."""
 
-__version__ = "1.1.1.dev26"
+__version__ = "1.1.1.dev28"