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

modal/volume.pyi

@@ -10,6 +10,7 @@ import modal.client
 import modal.object
 import modal_proto.api_pb2
 import pathlib
+import synchronicity
 import synchronicity.combined_types
 import typing
 import typing_extensions
@@ -79,6 +80,329 @@ class VolumeInfo:
         """Return self==value."""
         ...
 
+class _VolumeManager:
+    """Namespace with methods for managing named Volume objects."""
+    @staticmethod
+    async def create(
+        name: str,
+        *,
+        version: typing.Optional[int] = None,
+        allow_existing: bool = False,
+        environment_name: typing.Optional[str] = None,
+        client: typing.Optional[modal.client._Client] = None,
+    ) -> None:
+        """Create a new Volume object.
+
+        **Examples:**
+
+        ```python notest
+        modal.Volume.objects.create("my-volume")
+        ```
+
+        Volumes will be created in the active environment, or another one can be specified:
+
+        ```python notest
+        modal.Volume.objects.create("my-volume", environment_name="dev")
+        ```
+
+        By default, an error will be raised if the Volume already exists, but passing
+        `allow_existing=True` will make the creation attempt a no-op in this case.
+
+        ```python notest
+        modal.Volume.objects.create("my-volume", allow_existing=True)
+        ```
+
+        Note that this method does not return a local instance of the Volume. You can use
+        `modal.Volume.from_name` to perform a lookup after creation.
+
+        Added in v1.1.2.
+        """
+        ...
+
+    @staticmethod
+    async def list(
+        *,
+        max_objects: typing.Optional[int] = None,
+        created_before: typing.Union[datetime.datetime, str, None] = None,
+        environment_name: str = "",
+        client: typing.Optional[modal.client._Client] = None,
+    ) -> list[_Volume]:
+        """Return a list of hydrated Volume objects.
+
+        **Examples:**
+
+        ```python
+        volumes = modal.Volume.objects.list()
+        print([v.name for v in volumes])
+        ```
+
+        Volumes will be retreived from the active environment, or another one can be specified:
+
+        ```python notest
+        dev_volumes = modal.Volume.objects.list(environment_name="dev")
+        ```
+
+        By default, all named Volumes are returned, newest to oldest. It's also possible to limit the
+        number of results and to filter by creation date:
+
+        ```python
+        volumes = modal.Volume.objects.list(max_objects=10, created_before="2025-01-01")
+        ```
+
+        Added in v1.1.2.
+        """
+        ...
+
+    @staticmethod
+    async def delete(
+        name: str,
+        *,
+        allow_missing: bool = False,
+        environment_name: typing.Optional[str] = None,
+        client: typing.Optional[modal.client._Client] = None,
+    ):
+        """Delete a named Volume.
+
+        Warning: This deletes an *entire Volume*, not just a specific file.
+        Deletion is irreversible and will affect any Apps currently using the Volume.
+
+        **Examples:**
+
+        ```python notest
+        await modal.Volume.objects.delete("my-volume")
+        ```
+
+        Volumes will be deleted from the active environment, or another one can be specified:
+
+        ```python notest
+        await modal.Volume.objects.delete("my-volume", environment_name="dev")
+        ```
+
+        Added in v1.1.2.
+        """
+        ...
+
+class VolumeManager:
+    """Namespace with methods for managing named Volume objects."""
+    def __init__(self, /, *args, **kwargs):
+        """Initialize self.  See help(type(self)) for accurate signature."""
+        ...
+
+    class __create_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            /,
+            name: str,
+            *,
+            version: typing.Optional[int] = None,
+            allow_existing: bool = False,
+            environment_name: typing.Optional[str] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> None:
+            """Create a new Volume object.
+
+            **Examples:**
+
+            ```python notest
+            modal.Volume.objects.create("my-volume")
+            ```
+
+            Volumes will be created in the active environment, or another one can be specified:
+
+            ```python notest
+            modal.Volume.objects.create("my-volume", environment_name="dev")
+            ```
+
+            By default, an error will be raised if the Volume already exists, but passing
+            `allow_existing=True` will make the creation attempt a no-op in this case.
+
+            ```python notest
+            modal.Volume.objects.create("my-volume", allow_existing=True)
+            ```
+
+            Note that this method does not return a local instance of the Volume. You can use
+            `modal.Volume.from_name` to perform a lookup after creation.
+
+            Added in v1.1.2.
+            """
+            ...
+
+        async def aio(
+            self,
+            /,
+            name: str,
+            *,
+            version: typing.Optional[int] = None,
+            allow_existing: bool = False,
+            environment_name: typing.Optional[str] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> None:
+            """Create a new Volume object.
+
+            **Examples:**
+
+            ```python notest
+            modal.Volume.objects.create("my-volume")
+            ```
+
+            Volumes will be created in the active environment, or another one can be specified:
+
+            ```python notest
+            modal.Volume.objects.create("my-volume", environment_name="dev")
+            ```
+
+            By default, an error will be raised if the Volume already exists, but passing
+            `allow_existing=True` will make the creation attempt a no-op in this case.
+
+            ```python notest
+            modal.Volume.objects.create("my-volume", allow_existing=True)
+            ```
+
+            Note that this method does not return a local instance of the Volume. You can use
+            `modal.Volume.from_name` to perform a lookup after creation.
+
+            Added in v1.1.2.
+            """
+            ...
+
+    create: __create_spec
+
+    class __list_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            /,
+            *,
+            max_objects: typing.Optional[int] = None,
+            created_before: typing.Union[datetime.datetime, str, None] = None,
+            environment_name: str = "",
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> list[Volume]:
+            """Return a list of hydrated Volume objects.
+
+            **Examples:**
+
+            ```python
+            volumes = modal.Volume.objects.list()
+            print([v.name for v in volumes])
+            ```
+
+            Volumes will be retreived from the active environment, or another one can be specified:
+
+            ```python notest
+            dev_volumes = modal.Volume.objects.list(environment_name="dev")
+            ```
+
+            By default, all named Volumes are returned, newest to oldest. It's also possible to limit the
+            number of results and to filter by creation date:
+
+            ```python
+            volumes = modal.Volume.objects.list(max_objects=10, created_before="2025-01-01")
+            ```
+
+            Added in v1.1.2.
+            """
+            ...
+
+        async def aio(
+            self,
+            /,
+            *,
+            max_objects: typing.Optional[int] = None,
+            created_before: typing.Union[datetime.datetime, str, None] = None,
+            environment_name: str = "",
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> list[Volume]:
+            """Return a list of hydrated Volume objects.
+
+            **Examples:**
+
+            ```python
+            volumes = modal.Volume.objects.list()
+            print([v.name for v in volumes])
+            ```
+
+            Volumes will be retreived from the active environment, or another one can be specified:
+
+            ```python notest
+            dev_volumes = modal.Volume.objects.list(environment_name="dev")
+            ```
+
+            By default, all named Volumes are returned, newest to oldest. It's also possible to limit the
+            number of results and to filter by creation date:
+
+            ```python
+            volumes = modal.Volume.objects.list(max_objects=10, created_before="2025-01-01")
+            ```
+
+            Added in v1.1.2.
+            """
+            ...
+
+    list: __list_spec
+
+    class __delete_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            /,
+            name: str,
+            *,
+            allow_missing: bool = False,
+            environment_name: typing.Optional[str] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ):
+            """Delete a named Volume.
+
+            Warning: This deletes an *entire Volume*, not just a specific file.
+            Deletion is irreversible and will affect any Apps currently using the Volume.
+
+            **Examples:**
+
+            ```python notest
+            await modal.Volume.objects.delete("my-volume")
+            ```
+
+            Volumes will be deleted from the active environment, or another one can be specified:
+
+            ```python notest
+            await modal.Volume.objects.delete("my-volume", environment_name="dev")
+            ```
+
+            Added in v1.1.2.
+            """
+            ...
+
+        async def aio(
+            self,
+            /,
+            name: str,
+            *,
+            allow_missing: bool = False,
+            environment_name: typing.Optional[str] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ):
+            """Delete a named Volume.
+
+            Warning: This deletes an *entire Volume*, not just a specific file.
+            Deletion is irreversible and will affect any Apps currently using the Volume.
+
+            **Examples:**
+
+            ```python notest
+            await modal.Volume.objects.delete("my-volume")
+            ```
+
+            Volumes will be deleted from the active environment, or another one can be specified:
+
+            ```python notest
+            await modal.Volume.objects.delete("my-volume", environment_name="dev")
+            ```
+
+            Added in v1.1.2.
+            """
+            ...
+
+    delete: __delete_spec
+
 class _Volume(modal._object._Object):
     """A writeable volume that can be used to share files between one or more Modal functions.
 
@@ -125,6 +449,10 @@ class _Volume(modal._object._Object):
     _metadata: typing.Optional[modal_proto.api_pb2.VolumeMetadata]
     _read_only: bool
 
+    @synchronicity.classproperty
+    def objects(cls) -> _VolumeManager: ...
+    @property
+    def name(self) -> typing.Optional[str]: ...
     def read_only(self) -> _Volume:
         """Configure Volume to mount as read-only.
 
@@ -148,8 +476,6 @@ 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): ...
@@ -242,13 +568,24 @@ class _Volume(modal._object._Object):
         """mdmd:hidden"""
         ...
 
+    @staticmethod
+    async def _create_deployed(
+        deployment_name: str,
+        namespace=None,
+        client: typing.Optional[modal.client._Client] = None,
+        environment_name: typing.Optional[str] = None,
+        version: typing.Optional[int] = None,
+    ) -> str:
+        """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.
+        """Commit changes to a mounted volume.
 
         If successful, the changes made are now persisted in durable storage and available to other containers accessing
         the volume.
@@ -367,7 +704,17 @@ class _Volume(modal._object._Object):
     @staticmethod
     async def delete(
         name: str, client: typing.Optional[modal.client._Client] = None, environment_name: typing.Optional[str] = None
-    ): ...
+    ):
+        """mdmd:hidden
+        Delete a named Volume.
+
+        Warning: This deletes an *entire Volume*, not just a specific file.
+        Deletion is irreversible and will affect any Apps currently using the Volume.
+
+        DEPRECATED: This method is deprecated; we recommend using `modal.Volume.objects.delete` instead.
+        """
+        ...
+
     @staticmethod
     async def rename(
         old_name: str,
@@ -429,6 +776,10 @@ class Volume(modal.object.Object):
         """mdmd:hidden"""
         ...
 
+    @synchronicity.classproperty
+    def objects(cls) -> VolumeManager: ...
+    @property
+    def name(self) -> typing.Optional[str]: ...
     def read_only(self) -> Volume:
         """Configure Volume to mount as read-only.
 
@@ -452,8 +803,6 @@ 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]: ...
 
@@ -597,6 +946,33 @@ class Volume(modal.object.Object):
 
     create_deployed: __create_deployed_spec
 
+    class ___create_deployed_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            /,
+            deployment_name: str,
+            namespace=None,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+            version: typing.Optional[int] = None,
+        ) -> str:
+            """mdmd:hidden"""
+            ...
+
+        async def aio(
+            self,
+            /,
+            deployment_name: str,
+            namespace=None,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+            version: typing.Optional[int] = None,
+        ) -> str:
+            """mdmd:hidden"""
+            ...
+
+    _create_deployed: ___create_deployed_spec
+
     class __info_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /) -> VolumeInfo:
             """Return information about the Volume object."""
@@ -616,7 +992,7 @@ class Volume(modal.object.Object):
 
     class __commit_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /):
-            """Commit changes to the volume.
+            """Commit changes to a mounted volume.
 
             If successful, the changes made are now persisted in durable storage and available to other containers accessing
             the volume.
@@ -624,7 +1000,7 @@ class Volume(modal.object.Object):
             ...
 
         async def aio(self, /):
-            """Commit changes to the volume.
+            """Commit changes to a mounted volume.
 
             If successful, the changes made are now persisted in durable storage and available to other containers accessing
             the volume.
@@ -886,14 +1262,33 @@ class Volume(modal.object.Object):
             name: str,
             client: typing.Optional[modal.client.Client] = None,
             environment_name: typing.Optional[str] = None,
-        ): ...
+        ):
+            """mdmd:hidden
+            Delete a named Volume.
+
+            Warning: This deletes an *entire Volume*, not just a specific file.
+            Deletion is irreversible and will affect any Apps currently using the Volume.
+
+            DEPRECATED: This method is deprecated; we recommend using `modal.Volume.objects.delete` instead.
+            """
+            ...
+
         async def aio(
             self,
             /,
             name: str,
             client: typing.Optional[modal.client.Client] = None,
             environment_name: typing.Optional[str] = None,
-        ): ...
+        ):
+            """mdmd:hidden
+            Delete a named Volume.
+
+            Warning: This deletes an *entire Volume*, not just a specific file.
+            Deletion is irreversible and will affect any Apps currently using the Volume.
+
+            DEPRECATED: This method is deprecated; we recommend using `modal.Volume.objects.delete` instead.
+            """
+            ...
 
     delete: __delete_spec
 

{modal-1.1.1.dev41.dist-info → modal-1.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.1.1.dev41
+Version: 1.1.2
 Summary: Python client library for Modal
 Author-email: Modal Labs <support@modal.com>
 License: Apache-2.0
@@ -22,7 +22,7 @@ Requires-Dist: click~=8.1
 Requires-Dist: grpclib<0.4.9,>=0.4.7
 Requires-Dist: protobuf!=4.24.0,<7.0,>=3.19
 Requires-Dist: rich>=12.0.0
-Requires-Dist: synchronicity~=0.10.1
+Requires-Dist: synchronicity~=0.10.2
 Requires-Dist: toml
 Requires-Dist: typer>=0.9
 Requires-Dist: types-certifi