modal 0.62.16__py3-none-any.whl → 0.72.11__py3-none-any.whl

modal/volume.pyi

@@ -1,4 +1,6 @@
 import asyncio.locks
+import collections.abc
+import enum
 import modal._utils.blob_utils
 import modal.client
 import modal.object
@@ -8,270 +10,333 @@ import synchronicity.combined_types
 import typing
 import typing_extensions
 
-class _Volume(modal.object._Object):
-    _lock: asyncio.locks.Lock
-
-    def _initialize_from_empty(self):
-        ...
+class FileEntryType(enum.IntEnum):
+    """Type of a file entry listed from a Modal volume."""
 
-    @staticmethod
-    def new() -> _Volume:
-        ...
+    UNSPECIFIED = 0
+    FILE = 1
+    DIRECTORY = 2
+    SYMLINK = 3
 
-    @staticmethod
-    def from_name(label: str, namespace=1, environment_name: typing.Union[str, None] = None, create_if_missing: bool = False) -> _Volume:
-        ...
+class FileEntry:
+    path: str
+    type: FileEntryType
+    mtime: int
+    size: int
 
     @classmethod
-    def ephemeral(cls: typing.Type[_Volume], client: typing.Union[modal.client._Client, None] = None, environment_name: typing.Union[str, None] = None, _heartbeat_sleep: float = 300) -> typing.AsyncContextManager[_Volume]:
-        ...
+    def _from_proto(cls, proto: modal_proto.api_pb2.FileEntry) -> FileEntry: ...
+    def __init__(self, path: str, type: FileEntryType, mtime: int, size: int) -> None: ...
+    def __repr__(self): ...
+    def __eq__(self, other): ...
+    def __setattr__(self, name, value): ...
+    def __delattr__(self, name): ...
+    def __hash__(self): ...
 
-    @staticmethod
-    def persisted(label: str, namespace=1, environment_name: typing.Union[str, None] = None, cloud: typing.Union[str, None] = None) -> _Volume:
-        ...
+class _Volume(modal.object._Object):
+    _lock: typing.Optional[asyncio.locks.Lock]
 
+    async def _get_lock(self): ...
     @staticmethod
-    async def lookup(label: str, namespace=1, client: typing.Union[modal.client._Client, None] = None, environment_name: typing.Union[str, None] = None, create_if_missing: bool = False) -> _Volume:
-        ...
-
+    def from_name(
+        name: str,
+        namespace=1,
+        environment_name: typing.Optional[str] = None,
+        create_if_missing: bool = False,
+        version: typing.Optional[int] = None,
+    ) -> _Volume: ...
+    @classmethod
+    def ephemeral(
+        cls: type[_Volume],
+        client: typing.Optional[modal.client._Client] = None,
+        environment_name: typing.Optional[str] = None,
+        version: typing.Optional[int] = None,
+        _heartbeat_sleep: float = 300,
+    ) -> typing.AsyncContextManager[_Volume]: ...
     @staticmethod
-    async def create_deployed(deployment_name: str, namespace=1, client: typing.Union[modal.client._Client, None] = None, environment_name: typing.Union[str, None] = None) -> str:
-        ...
-
-    async def _do_reload(self, lock=True):
-        ...
-
-    async def commit(self):
-        ...
-
-    async def reload(self):
-        ...
-
-    def iterdir(self, path: str) -> typing.AsyncIterator[modal_proto.api_pb2.VolumeListFilesEntry]:
-        ...
-
-    async def listdir(self, path: str) -> typing.List[modal_proto.api_pb2.VolumeListFilesEntry]:
-        ...
-
-    def read_file(self, path: typing.Union[str, bytes]) -> typing.AsyncIterator[bytes]:
-        ...
-
-    async def read_file_into_fileobj(self, path: typing.Union[str, bytes], fileobj: typing.IO[bytes], progress: bool = False) -> int:
-        ...
-
-    async def remove_file(self, path: typing.Union[str, bytes], recursive: bool = False) -> None:
-        ...
-
-    async def copy_files(self, src_paths: typing.Sequence[typing.Union[str, bytes]], dst_path: typing.Union[str, bytes]) -> None:
-        ...
-
-    async def batch_upload(self, force: bool = False) -> _VolumeUploadContextManager:
-        ...
-
-    async def delete(self):
-        ...
-
+    async def lookup(
+        name: str,
+        namespace=1,
+        client: typing.Optional[modal.client._Client] = None,
+        environment_name: typing.Optional[str] = None,
+        create_if_missing: bool = False,
+        version: typing.Optional[int] = None,
+    ) -> _Volume: ...
+    @staticmethod
+    async def create_deployed(
+        deployment_name: str,
+        namespace=1,
+        client: typing.Optional[modal.client._Client] = None,
+        environment_name: typing.Optional[str] = None,
+        version: typing.Optional[int] = None,
+    ) -> str: ...
+    async def _do_reload(self, lock=True): ...
+    async def commit(self): ...
+    async def reload(self): ...
+    def iterdir(self, path: str, *, recursive: bool = True) -> collections.abc.AsyncIterator[FileEntry]: ...
+    async def listdir(self, path: str, *, recursive: bool = False) -> list[FileEntry]: ...
+    def read_file(self, path: str) -> collections.abc.AsyncIterator[bytes]: ...
+    async def read_file_into_fileobj(self, path: str, fileobj: typing.IO[bytes]) -> int: ...
+    async def remove_file(self, path: str, recursive: bool = False) -> None: ...
+    async def copy_files(self, src_paths: collections.abc.Sequence[str], dst_path: str) -> None: ...
+    async def batch_upload(self, force: bool = False) -> _VolumeUploadContextManager: ...
+    async def _instance_delete(self): ...
+    @staticmethod
+    async def delete(
+        name: str, client: typing.Optional[modal.client._Client] = None, environment_name: typing.Optional[str] = None
+    ): ...
+    @staticmethod
+    async def rename(
+        old_name: str,
+        new_name: str,
+        *,
+        client: typing.Optional[modal.client._Client] = None,
+        environment_name: typing.Optional[str] = None,
+    ): ...
 
 class _VolumeUploadContextManager:
     _volume_id: str
     _client: modal.client._Client
     _force: bool
-    _upload_generators: typing.List[typing.Generator[typing.Callable[[], modal._utils.blob_utils.FileUploadSpec], None, None]]
-
-    def __init__(self, volume_id: str, client: modal.client._Client, force: bool = False):
-        ...
-
-    async def __aenter__(self):
-        ...
-
-    async def __aexit__(self, exc_type, exc_val, exc_tb):
-        ...
-
-    def put_file(self, local_file: typing.Union[pathlib.Path, str, typing.BinaryIO], remote_path: typing.Union[pathlib.PurePosixPath, str], mode: typing.Union[int, None] = None):
-        ...
-
-    def put_directory(self, local_path: typing.Union[pathlib.Path, str], remote_path: typing.Union[pathlib.PurePosixPath, str], recursive: bool = True):
-        ...
-
-    async def _upload_file(self, file_spec: modal._utils.blob_utils.FileUploadSpec) -> modal_proto.api_pb2.MountFile:
-        ...
-
+    progress_cb: typing.Callable[..., typing.Any]
+    _upload_generators: list[
+        collections.abc.Generator[typing.Callable[[], modal._utils.blob_utils.FileUploadSpec], None, None]
+    ]
+
+    def __init__(
+        self,
+        volume_id: str,
+        client: modal.client._Client,
+        progress_cb: typing.Optional[typing.Callable[..., typing.Any]] = None,
+        force: bool = False,
+    ): ...
+    async def __aenter__(self): ...
+    async def __aexit__(self, exc_type, exc_val, exc_tb): ...
+    def put_file(
+        self,
+        local_file: typing.Union[pathlib.Path, str, typing.BinaryIO],
+        remote_path: typing.Union[pathlib.PurePosixPath, str],
+        mode: typing.Optional[int] = None,
+    ): ...
+    def put_directory(
+        self,
+        local_path: typing.Union[pathlib.Path, str],
+        remote_path: typing.Union[pathlib.PurePosixPath, str],
+        recursive: bool = True,
+    ): ...
+    async def _upload_file(
+        self, file_spec: modal._utils.blob_utils.FileUploadSpec
+    ) -> modal_proto.api_pb2.MountFile: ...
 
 class Volume(modal.object.Object):
-    _lock: asyncio.locks.Lock
+    _lock: typing.Optional[asyncio.locks.Lock]
 
-    def __init__(self, *args, **kwargs):
-        ...
+    def __init__(self, *args, **kwargs): ...
 
-    def _initialize_from_empty(self):
-        ...
+    class ___get_lock_spec(typing_extensions.Protocol):
+        def __call__(self): ...
+        async def aio(self): ...
 
-    @staticmethod
-    def new() -> Volume:
-        ...
+    _get_lock: ___get_lock_spec
 
     @staticmethod
-    def from_name(label: str, namespace=1, environment_name: typing.Union[str, None] = None, create_if_missing: bool = False) -> Volume:
-        ...
-
+    def from_name(
+        name: str,
+        namespace=1,
+        environment_name: typing.Optional[str] = None,
+        create_if_missing: bool = False,
+        version: typing.Optional[int] = None,
+    ) -> Volume: ...
     @classmethod
-    def ephemeral(cls: typing.Type[Volume], client: typing.Union[modal.client.Client, None] = None, environment_name: typing.Union[str, None] = None, _heartbeat_sleep: float = 300) -> synchronicity.combined_types.AsyncAndBlockingContextManager[Volume]:
-        ...
-
-    @staticmethod
-    def persisted(label: str, namespace=1, environment_name: typing.Union[str, None] = None, cloud: typing.Union[str, None] = None) -> Volume:
-        ...
+    def ephemeral(
+        cls: type[Volume],
+        client: typing.Optional[modal.client.Client] = None,
+        environment_name: typing.Optional[str] = None,
+        version: typing.Optional[int] = None,
+        _heartbeat_sleep: float = 300,
+    ) -> synchronicity.combined_types.AsyncAndBlockingContextManager[Volume]: ...
 
     class __lookup_spec(typing_extensions.Protocol):
-        def __call__(self, label: str, namespace=1, client: typing.Union[modal.client.Client, None] = None, environment_name: typing.Union[str, None] = None, create_if_missing: bool = False) -> Volume:
-            ...
-
-        async def aio(self, *args, **kwargs) -> Volume:
-            ...
+        def __call__(
+            self,
+            name: str,
+            namespace=1,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+            create_if_missing: bool = False,
+            version: typing.Optional[int] = None,
+        ) -> Volume: ...
+        async def aio(
+            self,
+            name: str,
+            namespace=1,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+            create_if_missing: bool = False,
+            version: typing.Optional[int] = None,
+        ) -> Volume: ...
 
     lookup: __lookup_spec
 
     class __create_deployed_spec(typing_extensions.Protocol):
-        def __call__(self, deployment_name: str, namespace=1, client: typing.Union[modal.client.Client, None] = None, environment_name: typing.Union[str, None] = None) -> str:
-            ...
-
-        async def aio(self, *args, **kwargs) -> str:
-            ...
+        def __call__(
+            self,
+            deployment_name: str,
+            namespace=1,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+            version: typing.Optional[int] = None,
+        ) -> str: ...
+        async def aio(
+            self,
+            deployment_name: str,
+            namespace=1,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+            version: typing.Optional[int] = None,
+        ) -> str: ...
 
     create_deployed: __create_deployed_spec
 
     class ___do_reload_spec(typing_extensions.Protocol):
-        def __call__(self, lock=True):
-            ...
-
-        async def aio(self, *args, **kwargs):
-            ...
+        def __call__(self, lock=True): ...
+        async def aio(self, lock=True): ...
 
     _do_reload: ___do_reload_spec
 
     class __commit_spec(typing_extensions.Protocol):
-        def __call__(self):
-            ...
-
-        async def aio(self, *args, **kwargs):
-            ...
+        def __call__(self): ...
+        async def aio(self): ...
 
     commit: __commit_spec
 
     class __reload_spec(typing_extensions.Protocol):
-        def __call__(self):
-            ...
-
-        async def aio(self, *args, **kwargs):
-            ...
+        def __call__(self): ...
+        async def aio(self): ...
 
     reload: __reload_spec
 
     class __iterdir_spec(typing_extensions.Protocol):
-        def __call__(self, path: str) -> typing.Iterator[modal_proto.api_pb2.VolumeListFilesEntry]:
-            ...
-
-        def aio(self, path: str) -> typing.AsyncIterator[modal_proto.api_pb2.VolumeListFilesEntry]:
-            ...
+        def __call__(self, path: str, *, recursive: bool = True) -> typing.Iterator[FileEntry]: ...
+        def aio(self, path: str, *, recursive: bool = True) -> collections.abc.AsyncIterator[FileEntry]: ...
 
     iterdir: __iterdir_spec
 
     class __listdir_spec(typing_extensions.Protocol):
-        def __call__(self, path: str) -> typing.List[modal_proto.api_pb2.VolumeListFilesEntry]:
-            ...
-
-        async def aio(self, *args, **kwargs) -> typing.List[modal_proto.api_pb2.VolumeListFilesEntry]:
-            ...
+        def __call__(self, path: str, *, recursive: bool = False) -> list[FileEntry]: ...
+        async def aio(self, path: str, *, recursive: bool = False) -> list[FileEntry]: ...
 
     listdir: __listdir_spec
 
     class __read_file_spec(typing_extensions.Protocol):
-        def __call__(self, path: typing.Union[str, bytes]) -> typing.Iterator[bytes]:
-            ...
-
-        def aio(self, path: typing.Union[str, bytes]) -> typing.AsyncIterator[bytes]:
-            ...
+        def __call__(self, path: str) -> typing.Iterator[bytes]: ...
+        def aio(self, path: str) -> collections.abc.AsyncIterator[bytes]: ...
 
     read_file: __read_file_spec
 
     class __read_file_into_fileobj_spec(typing_extensions.Protocol):
-        def __call__(self, path: typing.Union[str, bytes], fileobj: typing.IO[bytes], progress: bool = False) -> int:
-            ...
-
-        async def aio(self, *args, **kwargs) -> int:
-            ...
+        def __call__(self, path: str, fileobj: typing.IO[bytes]) -> int: ...
+        async def aio(self, path: str, fileobj: typing.IO[bytes]) -> int: ...
 
     read_file_into_fileobj: __read_file_into_fileobj_spec
 
     class __remove_file_spec(typing_extensions.Protocol):
-        def __call__(self, path: typing.Union[str, bytes], recursive: bool = False) -> None:
-            ...
-
-        async def aio(self, *args, **kwargs) -> None:
-            ...
+        def __call__(self, path: str, recursive: bool = False) -> None: ...
+        async def aio(self, path: str, recursive: bool = False) -> None: ...
 
     remove_file: __remove_file_spec
 
     class __copy_files_spec(typing_extensions.Protocol):
-        def __call__(self, src_paths: typing.Sequence[typing.Union[str, bytes]], dst_path: typing.Union[str, bytes]) -> None:
-            ...
-
-        async def aio(self, *args, **kwargs) -> None:
-            ...
+        def __call__(self, src_paths: collections.abc.Sequence[str], dst_path: str) -> None: ...
+        async def aio(self, src_paths: collections.abc.Sequence[str], dst_path: str) -> None: ...
 
     copy_files: __copy_files_spec
 
     class __batch_upload_spec(typing_extensions.Protocol):
-        def __call__(self, force: bool = False) -> VolumeUploadContextManager:
-            ...
-
-        async def aio(self, *args, **kwargs) -> VolumeUploadContextManager:
-            ...
+        def __call__(self, force: bool = False) -> VolumeUploadContextManager: ...
+        async def aio(self, force: bool = False) -> VolumeUploadContextManager: ...
 
     batch_upload: __batch_upload_spec
 
-    class __delete_spec(typing_extensions.Protocol):
-        def __call__(self):
-            ...
+    class ___instance_delete_spec(typing_extensions.Protocol):
+        def __call__(self): ...
+        async def aio(self): ...
 
-        async def aio(self, *args, **kwargs):
-            ...
+    _instance_delete: ___instance_delete_spec
+
+    class __delete_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            name: str,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+        ): ...
+        async def aio(
+            self,
+            name: str,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+        ): ...
 
     delete: __delete_spec
 
+    class __rename_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            old_name: str,
+            new_name: str,
+            *,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+        ): ...
+        async def aio(
+            self,
+            old_name: str,
+            new_name: str,
+            *,
+            client: typing.Optional[modal.client.Client] = None,
+            environment_name: typing.Optional[str] = None,
+        ): ...
+
+    rename: __rename_spec
 
 class VolumeUploadContextManager:
     _volume_id: str
     _client: modal.client.Client
     _force: bool
-    _upload_generators: typing.List[typing.Generator[typing.Callable[[], modal._utils.blob_utils.FileUploadSpec], None, None]]
-
-    def __init__(self, volume_id: str, client: modal.client.Client, force: bool = False):
-        ...
-
-    def __enter__(self):
-        ...
-
-    async def __aenter__(self, *args, **kwargs):
-        ...
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        ...
-
-    async def __aexit__(self, *args, **kwargs):
-        ...
-
-    def put_file(self, local_file: typing.Union[pathlib.Path, str, typing.BinaryIO], remote_path: typing.Union[pathlib.PurePosixPath, str], mode: typing.Union[int, None] = None):
-        ...
-
-    def put_directory(self, local_path: typing.Union[pathlib.Path, str], remote_path: typing.Union[pathlib.PurePosixPath, str], recursive: bool = True):
-        ...
+    progress_cb: typing.Callable[..., typing.Any]
+    _upload_generators: list[
+        collections.abc.Generator[typing.Callable[[], modal._utils.blob_utils.FileUploadSpec], None, None]
+    ]
+
+    def __init__(
+        self,
+        volume_id: str,
+        client: modal.client.Client,
+        progress_cb: typing.Optional[typing.Callable[..., typing.Any]] = None,
+        force: bool = False,
+    ): ...
+    def __enter__(self): ...
+    async def __aenter__(self): ...
+    def __exit__(self, exc_type, exc_val, exc_tb): ...
+    async def __aexit__(self, exc_type, exc_val, exc_tb): ...
+    def put_file(
+        self,
+        local_file: typing.Union[pathlib.Path, str, typing.BinaryIO],
+        remote_path: typing.Union[pathlib.PurePosixPath, str],
+        mode: typing.Optional[int] = None,
+    ): ...
+    def put_directory(
+        self,
+        local_path: typing.Union[pathlib.Path, str],
+        remote_path: typing.Union[pathlib.PurePosixPath, str],
+        recursive: bool = True,
+    ): ...
 
     class ___upload_file_spec(typing_extensions.Protocol):
-        def __call__(self, file_spec: modal._utils.blob_utils.FileUploadSpec) -> modal_proto.api_pb2.MountFile:
-            ...
-
-        async def aio(self, *args, **kwargs) -> modal_proto.api_pb2.MountFile:
-            ...
+        def __call__(self, file_spec: modal._utils.blob_utils.FileUploadSpec) -> modal_proto.api_pb2.MountFile: ...
+        async def aio(self, file_spec: modal._utils.blob_utils.FileUploadSpec) -> modal_proto.api_pb2.MountFile: ...
 
     _upload_file: ___upload_file_spec
+
+def _open_files_error_annotation(mount_path: str) -> typing.Optional[str]: ...

{modal-0.62.16.dist-info → modal-0.72.11.dist-info}/METADATA

@@ -1,29 +1,29 @@
 Metadata-Version: 2.1
 Name: modal
-Version: 0.62.16
+Version: 0.72.11
 Summary: Python client library for Modal
 Author: Modal Labs
 Author-email: support@modal.com
 Project-URL: Homepage, https://modal.com
+Project-URL: Source, https://github.com/modal-labs/modal-client
 Keywords: modal,client,cloud,serverless,infrastructure
 Classifier: Topic :: System :: Distributed Computing
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp
-Requires-Dist: aiostream (~=0.5.2)
 Requires-Dist: certifi
 Requires-Dist: click (>=8.1.0)
 Requires-Dist: fastapi
 Requires-Dist: grpclib (==0.4.7)
-Requires-Dist: protobuf (!=4.24.0,<5.0,>=3.19)
+Requires-Dist: protobuf (!=4.24.0,<6.0,>=3.19)
 Requires-Dist: rich (>=12.0.0)
-Requires-Dist: synchronicity (~=0.6.3)
+Requires-Dist: synchronicity (~=0.9.8)
 Requires-Dist: toml
-Requires-Dist: typer (~=0.9.0)
+Requires-Dist: typer (>=0.9)
 Requires-Dist: types-certifi
 Requires-Dist: types-toml
 Requires-Dist: watchfiles
@@ -48,7 +48,7 @@ a [user guide](https://modal.com/docs/guide), and the detailed
 
 ## Installation
 
-**This library requires Python 3.8 – 3.12.**
+**This library requires Python 3.9 – 3.13.**
 
 Install the package with `pip`: