modal 1.0.5.dev2__py3-none-any.whl → 1.0.5.dev4__py3-none-any.whl

modal/volume.pyi

@@ -24,6 +24,8 @@ class FileEntryType(enum.IntEnum):
     SOCKET = 5
 
 class FileEntry:
+    """A file or directory entry listed from a Modal volume."""
+
     path: str
     type: FileEntryType
     mtime: int
@@ -31,14 +33,72 @@ class FileEntry:
 
     @classmethod
     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): ...
+    def __init__(self, path: str, type: FileEntryType, mtime: int, size: int) -> None:
+        """Initialize self.  See help(type(self)) for accurate signature."""
+        ...
+
+    def __repr__(self):
+        """Return repr(self)."""
+        ...
+
+    def __eq__(self, other):
+        """Return self==value."""
+        ...
+
+    def __setattr__(self, name, value):
+        """Implement setattr(self, name, value)."""
+        ...
+
+    def __delattr__(self, name):
+        """Implement delattr(self, name)."""
+        ...
+
+    def __hash__(self):
+        """Return hash(self)."""
+        ...
 
 class _Volume(modal._object._Object):
+    """A writeable volume that can be used to share files between one or more Modal functions.
+
+    The contents of a volume is exposed as a filesystem. You can use it to share data between different functions, or
+    to persist durable state across several instances of the same function.
+
+    Unlike a networked filesystem, you need to explicitly reload the volume to see changes made since it was mounted.
+    Similarly, you need to explicitly commit any changes you make to the volume for the changes to become visible
+    outside the current container.
+
+    Concurrent modification is supported, but concurrent modifications of the same files should be avoided! Last write
+    wins in case of concurrent modification of the same file - any data the last writer didn't have when committing
+    changes will be lost!
+
+    As a result, volumes are typically not a good fit for use cases where you need to make concurrent modifications to
+    the same file (nor is distributed file locking supported).
+
+    Volumes can only be reloaded if there are no open files for the volume - attempting to reload with open files
+    will result in an error.
+
+    **Usage**
+
+    ```python
+    import modal
+
+    app = modal.App()
+    volume = modal.Volume.from_name("my-persisted-volume", create_if_missing=True)
+
+    @app.function(volumes={"/root/foo": volume})
+    def f():
+        with open("/root/foo/bar.txt", "w") as f:
+            f.write("hello")
+        volume.commit()  # Persist changes
+
+    @app.function(volumes={"/root/foo": volume})
+    def g():
+        volume.reload()  # Fetch latest changes
+        with open("/root/foo/bar.txt", "r") as f:
+            print(f.read())
+    ```
+    """
+
     _lock: typing.Optional[asyncio.locks.Lock]
     _metadata: typing.Optional[modal_proto.api_pb2.VolumeMetadata]
 
@@ -51,7 +111,26 @@ class _Volume(modal._object._Object):
         environment_name: typing.Optional[str] = None,
         create_if_missing: bool = False,
         version: typing.Optional[int] = None,
-    ) -> _Volume: ...
+    ) -> _Volume:
+        """Reference a Volume by name, creating if necessary.
+
+        In contrast to `modal.Volume.lookup`, this is a lazy method
+        that defers hydrating the local object with metadata from
+        Modal servers until the first time is is actually used.
+
+        ```python
+        vol = modal.Volume.from_name("my-volume", create_if_missing=True)
+
+        app = modal.App()
+
+        # Volume refers to the same object, even across instances of `app`.
+        @app.function(volumes={"/data": vol})
+        def f():
+            pass
+        ```
+        """
+        ...
+
     def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
     def _get_metadata(self) -> typing.Optional[google.protobuf.message.Message]: ...
     @property
@@ -63,7 +142,23 @@ class _Volume(modal._object._Object):
         environment_name: typing.Optional[str] = None,
         version: typing.Optional[int] = None,
         _heartbeat_sleep: float = 300,
-    ) -> typing.AsyncContextManager[_Volume]: ...
+    ) -> typing.AsyncContextManager[_Volume]:
+        """Creates a new ephemeral volume within a context manager:
+
+        Usage:
+        ```python
+        import modal
+        with modal.Volume.ephemeral() as vol:
+            assert vol.listdir("/") == []
+        ```
+
+        ```python notest
+        async with modal.Volume.ephemeral() as vol:
+            assert await vol.listdir("/") == []
+        ```
+        """
+        ...
+
     @staticmethod
     async def lookup(
         name: str,
@@ -72,7 +167,22 @@ class _Volume(modal._object._Object):
         environment_name: typing.Optional[str] = None,
         create_if_missing: bool = False,
         version: typing.Optional[int] = None,
-    ) -> _Volume: ...
+    ) -> _Volume:
+        """mdmd:hidden
+        Lookup a named Volume.
+
+        DEPRECATED: This method is deprecated in favor of `modal.Volume.from_name`.
+
+        In contrast to `modal.Volume.from_name`, this is an eager method
+        that will hydrate the local object with metadata from Modal servers.
+
+        ```python notest
+        vol = modal.Volume.from_name("my-volume")
+        print(vol.listdir("/"))
+        ```
+        """
+        ...
+
     @staticmethod
     async def create_deployed(
         deployment_name: str,
@@ -80,24 +190,127 @@ class _Volume(modal._object._Object):
         client: typing.Optional[modal.client._Client] = None,
         environment_name: typing.Optional[str] = None,
         version: typing.Optional[int] = None,
-    ) -> str: ...
+    ) -> str:
+        """mdmd:hidden"""
+        ...
+
     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 commit(self):
+        """Commit changes to the volume.
+
+        If successful, the changes made are now persisted in durable storage and available to other containers accessing
+        the volume.
+        """
+        ...
+
+    async def reload(self):
+        """Make latest committed state of volume available in the running container.
+
+        Any uncommitted changes to the volume, such as new or modified files, may implicitly be committed when
+        reloading.
+
+        Reloading will fail if there are open files for the volume.
+        """
+        ...
+
+    def iterdir(self, path: str, *, recursive: bool = True) -> collections.abc.AsyncIterator[FileEntry]:
+        """Iterate over all files in a directory in the volume.
+
+        Passing a directory path lists all files in the directory. For a file path, return only that
+        file's description. If `recursive` is set to True, list all files and folders under the path
+        recursively.
+        """
+        ...
+
+    async def listdir(self, path: str, *, recursive: bool = False) -> list[FileEntry]:
+        """List all files under a path prefix in the modal.Volume.
+
+        Passing a directory path lists all files in the directory. For a file path, return only that
+        file's description. If `recursive` is set to True, list all files and folders under the path
+        recursively.
+        """
+        ...
+
+    def read_file(self, path: str) -> collections.abc.AsyncIterator[bytes]:
+        """Read a file from the modal.Volume.
+
+        Note - this function is primarily intended to be used outside of a Modal App.
+        For more information on downloading files from a Modal Volume, see
+        [the guide](https://modal.com/docs/guide/volumes).
+
+        **Example:**
+
+        ```python notest
+        vol = modal.Volume.from_name("my-modal-volume")
+        data = b""
+        for chunk in vol.read_file("1mb.csv"):
+            data += chunk
+        print(len(data))  # == 1024 * 1024
+        ```
+        """
+        ...
+
     async def read_file_into_fileobj(
         self,
         path: str,
         fileobj: typing.IO[bytes],
         progress_cb: typing.Optional[collections.abc.Callable[..., typing.Any]] = None,
-    ) -> int: ...
-    async def remove_file(self, path: str, recursive: bool = False) -> None: ...
+    ) -> int:
+        """mdmd:hidden
+        Read volume file into file-like IO object.
+        """
+        ...
+
+    async def remove_file(self, path: str, recursive: bool = False) -> None:
+        """Remove a file or directory from a volume."""
+        ...
+
     async def copy_files(
         self, src_paths: collections.abc.Sequence[str], dst_path: str, recursive: bool = False
-    ) -> None: ...
-    async def batch_upload(self, force: bool = False) -> _AbstractVolumeUploadContextManager: ...
+    ) -> None:
+        """Copy files within the volume from src_paths to dst_path.
+        The semantics of the copy operation follow those of the UNIX cp command.
+
+        The `src_paths` parameter is a list. If you want to copy a single file, you should pass a list with a
+        single element.
+
+        `src_paths` and `dst_path` should refer to the desired location *inside* the volume. You do not need to prepend
+        the volume mount path.
+
+        **Usage**
+
+        ```python notest
+        vol = modal.Volume.from_name("my-modal-volume")
+
+        vol.copy_files(["bar/example.txt"], "bar2")  # Copy files to another directory
+        vol.copy_files(["bar/example.txt"], "bar/example2.txt")  # Rename a file by copying
+        ```
+
+        Note that if the volume is already mounted on the Modal function, you should use normal filesystem operations
+        like `os.rename()` and then `commit()` the volume. The `copy_files()` method is useful when you don't have
+        the volume mounted as a filesystem, e.g. when running a script on your local computer.
+        """
+        ...
+
+    async def batch_upload(self, force: bool = False) -> _AbstractVolumeUploadContextManager:
+        """Initiate a batched upload to a volume.
+
+        To allow overwriting existing files, set `force` to `True` (you cannot overwrite existing directories with
+        uploaded files regardless).
+
+        **Example:**
+
+        ```python notest
+        vol = modal.Volume.from_name("my-modal-volume")
+
+        with vol.batch_upload() as batch:
+            batch.put_file("local-path.txt", "/remote-path.txt")
+            batch.put_directory("/local/directory/", "/remote/directory")
+            batch.put_file(io.BytesIO(b"some data"), "/foobar")
+        ```
+        """
+        ...
+
     async def _instance_delete(self): ...
     @staticmethod
     async def delete(
@@ -115,10 +328,53 @@ class _Volume(modal._object._Object):
 SUPERSELF = typing.TypeVar("SUPERSELF", covariant=True)
 
 class Volume(modal.object.Object):
+    """A writeable volume that can be used to share files between one or more Modal functions.
+
+    The contents of a volume is exposed as a filesystem. You can use it to share data between different functions, or
+    to persist durable state across several instances of the same function.
+
+    Unlike a networked filesystem, you need to explicitly reload the volume to see changes made since it was mounted.
+    Similarly, you need to explicitly commit any changes you make to the volume for the changes to become visible
+    outside the current container.
+
+    Concurrent modification is supported, but concurrent modifications of the same files should be avoided! Last write
+    wins in case of concurrent modification of the same file - any data the last writer didn't have when committing
+    changes will be lost!
+
+    As a result, volumes are typically not a good fit for use cases where you need to make concurrent modifications to
+    the same file (nor is distributed file locking supported).
+
+    Volumes can only be reloaded if there are no open files for the volume - attempting to reload with open files
+    will result in an error.
+
+    **Usage**
+
+    ```python
+    import modal
+
+    app = modal.App()
+    volume = modal.Volume.from_name("my-persisted-volume", create_if_missing=True)
+
+    @app.function(volumes={"/root/foo": volume})
+    def f():
+        with open("/root/foo/bar.txt", "w") as f:
+            f.write("hello")
+        volume.commit()  # Persist changes
+
+    @app.function(volumes={"/root/foo": volume})
+    def g():
+        volume.reload()  # Fetch latest changes
+        with open("/root/foo/bar.txt", "r") as f:
+            print(f.read())
+    ```
+    """
+
     _lock: typing.Optional[asyncio.locks.Lock]
     _metadata: typing.Optional[modal_proto.api_pb2.VolumeMetadata]
 
-    def __init__(self, *args, **kwargs): ...
+    def __init__(self, *args, **kwargs):
+        """mdmd:hidden"""
+        ...
 
     class ___get_lock_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /): ...
@@ -134,7 +390,26 @@ class Volume(modal.object.Object):
         environment_name: typing.Optional[str] = None,
         create_if_missing: bool = False,
         version: typing.Optional[int] = None,
-    ) -> Volume: ...
+    ) -> Volume:
+        """Reference a Volume by name, creating if necessary.
+
+        In contrast to `modal.Volume.lookup`, this is a lazy method
+        that defers hydrating the local object with metadata from
+        Modal servers until the first time is is actually used.
+
+        ```python
+        vol = modal.Volume.from_name("my-volume", create_if_missing=True)
+
+        app = modal.App()
+
+        # Volume refers to the same object, even across instances of `app`.
+        @app.function(volumes={"/data": vol})
+        def f():
+            pass
+        ```
+        """
+        ...
+
     def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
     def _get_metadata(self) -> typing.Optional[google.protobuf.message.Message]: ...
     @property
@@ -146,7 +421,22 @@ class Volume(modal.object.Object):
         environment_name: typing.Optional[str] = None,
         version: typing.Optional[int] = None,
         _heartbeat_sleep: float = 300,
-    ) -> synchronicity.combined_types.AsyncAndBlockingContextManager[Volume]: ...
+    ) -> synchronicity.combined_types.AsyncAndBlockingContextManager[Volume]:
+        """Creates a new ephemeral volume within a context manager:
+
+        Usage:
+        ```python
+        import modal
+        with modal.Volume.ephemeral() as vol:
+            assert vol.listdir("/") == []
+        ```
+
+        ```python notest
+        async with modal.Volume.ephemeral() as vol:
+            assert await vol.listdir("/") == []
+        ```
+        """
+        ...
 
     class __lookup_spec(typing_extensions.Protocol):
         def __call__(
@@ -158,7 +448,22 @@ class Volume(modal.object.Object):
             environment_name: typing.Optional[str] = None,
             create_if_missing: bool = False,
             version: typing.Optional[int] = None,
-        ) -> Volume: ...
+        ) -> Volume:
+            """mdmd:hidden
+            Lookup a named Volume.
+
+            DEPRECATED: This method is deprecated in favor of `modal.Volume.from_name`.
+
+            In contrast to `modal.Volume.from_name`, this is an eager method
+            that will hydrate the local object with metadata from Modal servers.
+
+            ```python notest
+            vol = modal.Volume.from_name("my-volume")
+            print(vol.listdir("/"))
+            ```
+            """
+            ...
+
         async def aio(
             self,
             /,
@@ -168,7 +473,21 @@ class Volume(modal.object.Object):
             environment_name: typing.Optional[str] = None,
             create_if_missing: bool = False,
             version: typing.Optional[int] = None,
-        ) -> Volume: ...
+        ) -> Volume:
+            """mdmd:hidden
+            Lookup a named Volume.
+
+            DEPRECATED: This method is deprecated in favor of `modal.Volume.from_name`.
+
+            In contrast to `modal.Volume.from_name`, this is an eager method
+            that will hydrate the local object with metadata from Modal servers.
+
+            ```python notest
+            vol = modal.Volume.from_name("my-volume")
+            print(vol.listdir("/"))
+            ```
+            """
+            ...
 
     lookup: __lookup_spec
 
@@ -181,7 +500,10 @@ class Volume(modal.object.Object):
             client: typing.Optional[modal.client.Client] = None,
             environment_name: typing.Optional[str] = None,
             version: typing.Optional[int] = None,
-        ) -> str: ...
+        ) -> str:
+            """mdmd:hidden"""
+            ...
+
         async def aio(
             self,
             /,
@@ -190,7 +512,9 @@ class Volume(modal.object.Object):
             client: typing.Optional[modal.client.Client] = None,
             environment_name: typing.Optional[str] = None,
             version: typing.Optional[int] = None,
-        ) -> str: ...
+        ) -> str:
+            """mdmd:hidden"""
+            ...
 
     create_deployed: __create_deployed_spec
 
@@ -201,32 +525,127 @@ class Volume(modal.object.Object):
     _do_reload: ___do_reload_spec[typing_extensions.Self]
 
     class __commit_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /): ...
-        async def aio(self, /): ...
+        def __call__(self, /):
+            """Commit changes to the volume.
+
+            If successful, the changes made are now persisted in durable storage and available to other containers accessing
+            the volume.
+            """
+            ...
+
+        async def aio(self, /):
+            """Commit changes to the volume.
+
+            If successful, the changes made are now persisted in durable storage and available to other containers accessing
+            the volume.
+            """
+            ...
 
     commit: __commit_spec[typing_extensions.Self]
 
     class __reload_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /): ...
-        async def aio(self, /): ...
+        def __call__(self, /):
+            """Make latest committed state of volume available in the running container.
+
+            Any uncommitted changes to the volume, such as new or modified files, may implicitly be committed when
+            reloading.
+
+            Reloading will fail if there are open files for the volume.
+            """
+            ...
+
+        async def aio(self, /):
+            """Make latest committed state of volume available in the running container.
+
+            Any uncommitted changes to the volume, such as new or modified files, may implicitly be committed when
+            reloading.
+
+            Reloading will fail if there are open files for the volume.
+            """
+            ...
 
     reload: __reload_spec[typing_extensions.Self]
 
     class __iterdir_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, path: str, *, recursive: bool = True) -> typing.Iterator[FileEntry]: ...
-        def aio(self, /, path: str, *, recursive: bool = True) -> collections.abc.AsyncIterator[FileEntry]: ...
+        def __call__(self, /, path: str, *, recursive: bool = True) -> typing.Iterator[FileEntry]:
+            """Iterate over all files in a directory in the volume.
+
+            Passing a directory path lists all files in the directory. For a file path, return only that
+            file's description. If `recursive` is set to True, list all files and folders under the path
+            recursively.
+            """
+            ...
+
+        def aio(self, /, path: str, *, recursive: bool = True) -> collections.abc.AsyncIterator[FileEntry]:
+            """Iterate over all files in a directory in the volume.
+
+            Passing a directory path lists all files in the directory. For a file path, return only that
+            file's description. If `recursive` is set to True, list all files and folders under the path
+            recursively.
+            """
+            ...
 
     iterdir: __iterdir_spec[typing_extensions.Self]
 
     class __listdir_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, path: str, *, recursive: bool = False) -> list[FileEntry]: ...
-        async def aio(self, /, path: str, *, recursive: bool = False) -> list[FileEntry]: ...
+        def __call__(self, /, path: str, *, recursive: bool = False) -> list[FileEntry]:
+            """List all files under a path prefix in the modal.Volume.
+
+            Passing a directory path lists all files in the directory. For a file path, return only that
+            file's description. If `recursive` is set to True, list all files and folders under the path
+            recursively.
+            """
+            ...
+
+        async def aio(self, /, path: str, *, recursive: bool = False) -> list[FileEntry]:
+            """List all files under a path prefix in the modal.Volume.
+
+            Passing a directory path lists all files in the directory. For a file path, return only that
+            file's description. If `recursive` is set to True, list all files and folders under the path
+            recursively.
+            """
+            ...
 
     listdir: __listdir_spec[typing_extensions.Self]
 
     class __read_file_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, path: str) -> typing.Iterator[bytes]: ...
-        def aio(self, /, path: str) -> collections.abc.AsyncIterator[bytes]: ...
+        def __call__(self, /, path: str) -> typing.Iterator[bytes]:
+            """Read a file from the modal.Volume.
+
+            Note - this function is primarily intended to be used outside of a Modal App.
+            For more information on downloading files from a Modal Volume, see
+            [the guide](https://modal.com/docs/guide/volumes).
+
+            **Example:**
+
+            ```python notest
+            vol = modal.Volume.from_name("my-modal-volume")
+            data = b""
+            for chunk in vol.read_file("1mb.csv"):
+                data += chunk
+            print(len(data))  # == 1024 * 1024
+            ```
+            """
+            ...
+
+        def aio(self, /, path: str) -> collections.abc.AsyncIterator[bytes]:
+            """Read a file from the modal.Volume.
+
+            Note - this function is primarily intended to be used outside of a Modal App.
+            For more information on downloading files from a Modal Volume, see
+            [the guide](https://modal.com/docs/guide/volumes).
+
+            **Example:**
+
+            ```python notest
+            vol = modal.Volume.from_name("my-modal-volume")
+            data = b""
+            for chunk in vol.read_file("1mb.csv"):
+                data += chunk
+            print(len(data))  # == 1024 * 1024
+            ```
+            """
+            ...
 
     read_file: __read_file_spec[typing_extensions.Self]
 
@@ -237,36 +656,130 @@ class Volume(modal.object.Object):
             path: str,
             fileobj: typing.IO[bytes],
             progress_cb: typing.Optional[collections.abc.Callable[..., typing.Any]] = None,
-        ) -> int: ...
+        ) -> int:
+            """mdmd:hidden
+            Read volume file into file-like IO object.
+            """
+            ...
+
         async def aio(
             self,
             /,
             path: str,
             fileobj: typing.IO[bytes],
             progress_cb: typing.Optional[collections.abc.Callable[..., typing.Any]] = None,
-        ) -> int: ...
+        ) -> int:
+            """mdmd:hidden
+            Read volume file into file-like IO object.
+            """
+            ...
 
     read_file_into_fileobj: __read_file_into_fileobj_spec[typing_extensions.Self]
 
     class __remove_file_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, path: str, recursive: bool = False) -> None: ...
-        async def aio(self, /, path: str, recursive: bool = False) -> None: ...
+        def __call__(self, /, path: str, recursive: bool = False) -> None:
+            """Remove a file or directory from a volume."""
+            ...
+
+        async def aio(self, /, path: str, recursive: bool = False) -> None:
+            """Remove a file or directory from a volume."""
+            ...
 
     remove_file: __remove_file_spec[typing_extensions.Self]
 
     class __copy_files_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(
-            self, /, src_paths: collections.abc.Sequence[str], dst_path: str, recursive: bool = False
-        ) -> None: ...
+        def __call__(self, /, src_paths: collections.abc.Sequence[str], dst_path: str, recursive: bool = False) -> None:
+            """Copy files within the volume from src_paths to dst_path.
+            The semantics of the copy operation follow those of the UNIX cp command.
+
+            The `src_paths` parameter is a list. If you want to copy a single file, you should pass a list with a
+            single element.
+
+            `src_paths` and `dst_path` should refer to the desired location *inside* the volume. You do not need to prepend
+            the volume mount path.
+
+            **Usage**
+
+            ```python notest
+            vol = modal.Volume.from_name("my-modal-volume")
+
+            vol.copy_files(["bar/example.txt"], "bar2")  # Copy files to another directory
+            vol.copy_files(["bar/example.txt"], "bar/example2.txt")  # Rename a file by copying
+            ```
+
+            Note that if the volume is already mounted on the Modal function, you should use normal filesystem operations
+            like `os.rename()` and then `commit()` the volume. The `copy_files()` method is useful when you don't have
+            the volume mounted as a filesystem, e.g. when running a script on your local computer.
+            """
+            ...
+
         async def aio(
             self, /, src_paths: collections.abc.Sequence[str], dst_path: str, recursive: bool = False
-        ) -> None: ...
+        ) -> None:
+            """Copy files within the volume from src_paths to dst_path.
+            The semantics of the copy operation follow those of the UNIX cp command.
+
+            The `src_paths` parameter is a list. If you want to copy a single file, you should pass a list with a
+            single element.
+
+            `src_paths` and `dst_path` should refer to the desired location *inside* the volume. You do not need to prepend
+            the volume mount path.
+
+            **Usage**
+
+            ```python notest
+            vol = modal.Volume.from_name("my-modal-volume")
+
+            vol.copy_files(["bar/example.txt"], "bar2")  # Copy files to another directory
+            vol.copy_files(["bar/example.txt"], "bar/example2.txt")  # Rename a file by copying
+            ```
+
+            Note that if the volume is already mounted on the Modal function, you should use normal filesystem operations
+            like `os.rename()` and then `commit()` the volume. The `copy_files()` method is useful when you don't have
+            the volume mounted as a filesystem, e.g. when running a script on your local computer.
+            """
+            ...
 
     copy_files: __copy_files_spec[typing_extensions.Self]
 
     class __batch_upload_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, force: bool = False) -> AbstractVolumeUploadContextManager: ...
-        async def aio(self, /, force: bool = False) -> AbstractVolumeUploadContextManager: ...
+        def __call__(self, /, force: bool = False) -> AbstractVolumeUploadContextManager:
+            """Initiate a batched upload to a volume.
+
+            To allow overwriting existing files, set `force` to `True` (you cannot overwrite existing directories with
+            uploaded files regardless).
+
+            **Example:**
+
+            ```python notest
+            vol = modal.Volume.from_name("my-modal-volume")
+
+            with vol.batch_upload() as batch:
+                batch.put_file("local-path.txt", "/remote-path.txt")
+                batch.put_directory("/local/directory/", "/remote/directory")
+                batch.put_file(io.BytesIO(b"some data"), "/foobar")
+            ```
+            """
+            ...
+
+        async def aio(self, /, force: bool = False) -> AbstractVolumeUploadContextManager:
+            """Initiate a batched upload to a volume.
+
+            To allow overwriting existing files, set `force` to `True` (you cannot overwrite existing directories with
+            uploaded files regardless).
+
+            **Example:**
+
+            ```python notest
+            vol = modal.Volume.from_name("my-modal-volume")
+
+            with vol.batch_upload() as batch:
+                batch.put_file("local-path.txt", "/remote-path.txt")
+                batch.put_directory("/local/directory/", "/remote/directory")
+                batch.put_file(io.BytesIO(b"some data"), "/foobar")
+            ```
+            """
+            ...
 
     batch_upload: __batch_upload_spec[typing_extensions.Self]
 
@@ -341,7 +854,10 @@ class _AbstractVolumeUploadContextManager:
     ) -> _AbstractVolumeUploadContextManager: ...
 
 class AbstractVolumeUploadContextManager:
-    def __init__(self, /, *args, **kwargs): ...
+    def __init__(self, /, *args, **kwargs):
+        """Initialize self.  See help(type(self)) for accurate signature."""
+        ...
+
     def __enter__(self): ...
     async def __aenter__(self): ...
     def __exit__(self, exc_type, exc_val, exc_tb): ...
@@ -368,6 +884,8 @@ class AbstractVolumeUploadContextManager:
     ) -> AbstractVolumeUploadContextManager: ...
 
 class _VolumeUploadContextManager(_AbstractVolumeUploadContextManager):
+    """Context manager for batch-uploading files to a Volume."""
+
     _volume_id: str
     _client: modal.client._Client
     _force: bool
@@ -382,7 +900,10 @@ class _VolumeUploadContextManager(_AbstractVolumeUploadContextManager):
         client: modal.client._Client,
         progress_cb: typing.Optional[collections.abc.Callable[..., typing.Any]] = None,
         force: bool = False,
-    ): ...
+    ):
+        """mdmd:hidden"""
+        ...
+
     async def __aenter__(self): ...
     async def __aexit__(self, exc_type, exc_val, exc_tb): ...
     def put_file(
@@ -390,18 +911,34 @@ class _VolumeUploadContextManager(_AbstractVolumeUploadContextManager):
         local_file: typing.Union[pathlib.Path, str, typing.BinaryIO, _io.BytesIO],
         remote_path: typing.Union[pathlib.PurePosixPath, str],
         mode: typing.Optional[int] = None,
-    ): ...
+    ):
+        """Upload a file from a local file or file-like object.
+
+        Will create any needed parent directories automatically.
+
+        If `local_file` is a file-like object it must remain readable for the lifetime of the batch.
+        """
+        ...
+
     def put_directory(
         self,
         local_path: typing.Union[pathlib.Path, str],
         remote_path: typing.Union[pathlib.PurePosixPath, str],
         recursive: bool = True,
-    ): ...
+    ):
+        """Upload all files in a local directory.
+
+        Will create any needed parent directories automatically.
+        """
+        ...
+
     async def _upload_file(
         self, file_spec: modal._utils.blob_utils.FileUploadSpec
     ) -> modal_proto.api_pb2.MountFile: ...
 
 class VolumeUploadContextManager(AbstractVolumeUploadContextManager):
+    """Context manager for batch-uploading files to a Volume."""
+
     _volume_id: str
     _client: modal.client.Client
     _force: bool
@@ -416,7 +953,10 @@ class VolumeUploadContextManager(AbstractVolumeUploadContextManager):
         client: modal.client.Client,
         progress_cb: typing.Optional[collections.abc.Callable[..., typing.Any]] = None,
         force: bool = False,
-    ): ...
+    ):
+        """mdmd:hidden"""
+        ...
+
     def __enter__(self): ...
     async def __aenter__(self): ...
     def __exit__(self, exc_type, exc_val, exc_tb): ...
@@ -426,13 +966,26 @@ class VolumeUploadContextManager(AbstractVolumeUploadContextManager):
         local_file: typing.Union[pathlib.Path, str, typing.BinaryIO, _io.BytesIO],
         remote_path: typing.Union[pathlib.PurePosixPath, str],
         mode: typing.Optional[int] = None,
-    ): ...
+    ):
+        """Upload a file from a local file or file-like object.
+
+        Will create any needed parent directories automatically.
+
+        If `local_file` is a file-like object it must remain readable for the lifetime of the batch.
+        """
+        ...
+
     def put_directory(
         self,
         local_path: typing.Union[pathlib.Path, str],
         remote_path: typing.Union[pathlib.PurePosixPath, str],
         recursive: bool = True,
-    ): ...
+    ):
+        """Upload all files in a local directory.
+
+        Will create any needed parent directories automatically.
+        """
+        ...
 
     class ___upload_file_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, file_spec: modal._utils.blob_utils.FileUploadSpec) -> modal_proto.api_pb2.MountFile: ...
@@ -441,6 +994,8 @@ class VolumeUploadContextManager(AbstractVolumeUploadContextManager):
     _upload_file: ___upload_file_spec[typing_extensions.Self]
 
 class _VolumeUploadContextManager2(_AbstractVolumeUploadContextManager):
+    """Context manager for batch-uploading files to a Volume version 2."""
+
     _volume_id: str
     _client: modal.client._Client
     _progress_cb: collections.abc.Callable[..., typing.Any]
@@ -463,7 +1018,10 @@ class _VolumeUploadContextManager2(_AbstractVolumeUploadContextManager):
         force: bool = False,
         hash_concurrency: int = 4,
         put_concurrency: int = 128,
-    ): ...
+    ):
+        """mdmd:hidden"""
+        ...
+
     async def __aenter__(self): ...
     async def __aexit__(self, exc_type, exc_val, exc_tb): ...
     def put_file(
@@ -471,16 +1029,32 @@ class _VolumeUploadContextManager2(_AbstractVolumeUploadContextManager):
         local_file: typing.Union[pathlib.Path, str, typing.BinaryIO, _io.BytesIO],
         remote_path: typing.Union[pathlib.PurePosixPath, str],
         mode: typing.Optional[int] = None,
-    ): ...
+    ):
+        """Upload a file from a local file or file-like object.
+
+        Will create any needed parent directories automatically.
+
+        If `local_file` is a file-like object it must remain readable for the lifetime of the batch.
+        """
+        ...
+
     def put_directory(
         self,
         local_path: typing.Union[pathlib.Path, str],
         remote_path: typing.Union[pathlib.PurePosixPath, str],
         recursive: bool = True,
-    ): ...
+    ):
+        """Upload all files in a local directory.
+
+        Will create any needed parent directories automatically.
+        """
+        ...
+
     async def _put_file_specs(self, file_specs: list[modal._utils.blob_utils.FileUploadSpec2]): ...
 
 class VolumeUploadContextManager2(AbstractVolumeUploadContextManager):
+    """Context manager for batch-uploading files to a Volume version 2."""
+
     _volume_id: str
     _client: modal.client.Client
     _progress_cb: collections.abc.Callable[..., typing.Any]
@@ -503,7 +1077,10 @@ class VolumeUploadContextManager2(AbstractVolumeUploadContextManager):
         force: bool = False,
         hash_concurrency: int = 4,
         put_concurrency: int = 128,
-    ): ...
+    ):
+        """mdmd:hidden"""
+        ...
+
     def __enter__(self): ...
     async def __aenter__(self): ...
     def __exit__(self, exc_type, exc_val, exc_tb): ...
@@ -513,13 +1090,26 @@ class VolumeUploadContextManager2(AbstractVolumeUploadContextManager):
         local_file: typing.Union[pathlib.Path, str, typing.BinaryIO, _io.BytesIO],
         remote_path: typing.Union[pathlib.PurePosixPath, str],
         mode: typing.Optional[int] = None,
-    ): ...
+    ):
+        """Upload a file from a local file or file-like object.
+
+        Will create any needed parent directories automatically.
+
+        If `local_file` is a file-like object it must remain readable for the lifetime of the batch.
+        """
+        ...
+
     def put_directory(
         self,
         local_path: typing.Union[pathlib.Path, str],
         remote_path: typing.Union[pathlib.PurePosixPath, str],
         recursive: bool = True,
-    ): ...
+    ):
+        """Upload all files in a local directory.
+
+        Will create any needed parent directories automatically.
+        """
+        ...
 
     class ___put_file_specs_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, file_specs: list[modal._utils.blob_utils.FileUploadSpec2]): ...