modal 1.1.5.dev83__py3-none-any.whl → 1.3.1.dev8__py3-none-any.whl

modal/file_io.pyi

@@ -7,21 +7,16 @@ import typing_extensions
 T = typing.TypeVar("T")
 
 async def _delete_bytes(file: _FileIO, start: typing.Optional[int] = None, end: typing.Optional[int] = None) -> None:
-    """Delete a range of bytes from the file.
-
-    `start` and `end` are byte offsets. `start` is inclusive, `end` is exclusive.
-    If either is None, the start or end of the file is used, respectively.
+    """mdmd:hidden
+    This method has been removed.
     """
     ...
 
 async def _replace_bytes(
     file: _FileIO, data: bytes, start: typing.Optional[int] = None, end: typing.Optional[int] = None
 ) -> None:
-    """Replace a range of bytes in the file with new data. The length of the data does not
-    have to be the same as the length of the range being replaced.
-
-    `start` and `end` are byte offsets. `start` is inclusive, `end` is exclusive.
-    If either is None, the start or end of the file is used, respectively.
+    """mdmd:hidden
+    This method has been removed.
     """
     ...
 
@@ -174,18 +169,14 @@ class _FileIO(typing.Generic[T]):
 
 class __delete_bytes_spec(typing_extensions.Protocol):
     def __call__(self, /, file: FileIO, start: typing.Optional[int] = None, end: typing.Optional[int] = None) -> None:
-        """Delete a range of bytes from the file.
-
-        `start` and `end` are byte offsets. `start` is inclusive, `end` is exclusive.
-        If either is None, the start or end of the file is used, respectively.
+        """mdmd:hidden
+        This method has been removed.
         """
         ...
 
     async def aio(self, /, file: FileIO, start: typing.Optional[int] = None, end: typing.Optional[int] = None) -> None:
-        """Delete a range of bytes from the file.
-
-        `start` and `end` are byte offsets. `start` is inclusive, `end` is exclusive.
-        If either is None, the start or end of the file is used, respectively.
+        """mdmd:hidden
+        This method has been removed.
         """
         ...
 
@@ -195,29 +186,21 @@ class __replace_bytes_spec(typing_extensions.Protocol):
     def __call__(
         self, /, file: FileIO, data: bytes, start: typing.Optional[int] = None, end: typing.Optional[int] = None
     ) -> None:
-        """Replace a range of bytes in the file with new data. The length of the data does not
-        have to be the same as the length of the range being replaced.
-
-        `start` and `end` are byte offsets. `start` is inclusive, `end` is exclusive.
-        If either is None, the start or end of the file is used, respectively.
+        """mdmd:hidden
+        This method has been removed.
         """
         ...
 
     async def aio(
         self, /, file: FileIO, data: bytes, start: typing.Optional[int] = None, end: typing.Optional[int] = None
     ) -> None:
-        """Replace a range of bytes in the file with new data. The length of the data does not
-        have to be the same as the length of the range being replaced.
-
-        `start` and `end` are byte offsets. `start` is inclusive, `end` is exclusive.
-        If either is None, the start or end of the file is used, respectively.
+        """mdmd:hidden
+        This method has been removed.
         """
         ...
 
 replace_bytes: __replace_bytes_spec
 
-SUPERSELF = typing.TypeVar("SUPERSELF", covariant=True)
-
 T_INNER = typing.TypeVar("T_INNER", covariant=True)
 
 class FileIO(typing.Generic[T]):
@@ -252,56 +235,70 @@ class FileIO(typing.Generic[T]):
     def __init__(self, client: modal.client.Client, task_id: str) -> None: ...
     def _validate_mode(self, mode: str) -> None: ...
 
-    class ___consume_output_spec(typing_extensions.Protocol[SUPERSELF]):
+    class ___consume_output_spec(typing_extensions.Protocol):
         def __call__(self, /, exec_id: str) -> typing.Iterator[typing.Union[bytes, None, Exception]]: ...
         def aio(self, /, exec_id: str) -> typing.AsyncIterator[typing.Union[bytes, None, Exception]]: ...
 
-    _consume_output: ___consume_output_spec[typing_extensions.Self]
+    _consume_output: ___consume_output_spec
 
-    class ___consume_watch_output_spec(typing_extensions.Protocol[SUPERSELF]):
+    class ___consume_watch_output_spec(typing_extensions.Protocol):
         def __call__(self, /, exec_id: str) -> None: ...
         async def aio(self, /, exec_id: str) -> None: ...
 
-    _consume_watch_output: ___consume_watch_output_spec[typing_extensions.Self]
+    _consume_watch_output: ___consume_watch_output_spec
 
-    class ___parse_watch_output_spec(typing_extensions.Protocol[SUPERSELF]):
+    class ___parse_watch_output_spec(typing_extensions.Protocol):
         def __call__(self, /, event: bytes) -> typing.Optional[FileWatchEvent]: ...
         async def aio(self, /, event: bytes) -> typing.Optional[FileWatchEvent]: ...
 
-    _parse_watch_output: ___parse_watch_output_spec[typing_extensions.Self]
+    _parse_watch_output: ___parse_watch_output_spec
 
-    class ___wait_spec(typing_extensions.Protocol[SUPERSELF]):
+    class ___wait_spec(typing_extensions.Protocol):
         def __call__(self, /, exec_id: str) -> bytes: ...
         async def aio(self, /, exec_id: str) -> bytes: ...
 
-    _wait: ___wait_spec[typing_extensions.Self]
+    _wait: ___wait_spec
 
     def _validate_type(self, data: typing.Union[bytes, str]) -> None: ...
 
-    class ___open_file_spec(typing_extensions.Protocol[SUPERSELF]):
+    class ___open_file_spec(typing_extensions.Protocol):
         def __call__(self, /, path: str, mode: str) -> None: ...
         async def aio(self, /, path: str, mode: str) -> None: ...
 
-    _open_file: ___open_file_spec[typing_extensions.Self]
+    _open_file: ___open_file_spec
+
+    class __create_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            /,
+            path: str,
+            mode: typing.Union[_typeshed.OpenTextMode, _typeshed.OpenBinaryMode],
+            client: modal.client.Client,
+            task_id: str,
+        ) -> FileIO:
+            """Create a new FileIO handle."""
+            ...
 
-    @classmethod
-    def create(
-        cls,
-        path: str,
-        mode: typing.Union[_typeshed.OpenTextMode, _typeshed.OpenBinaryMode],
-        client: modal.client.Client,
-        task_id: str,
-    ) -> FileIO:
-        """Create a new FileIO handle."""
-        ...
+        async def aio(
+            self,
+            /,
+            path: str,
+            mode: typing.Union[_typeshed.OpenTextMode, _typeshed.OpenBinaryMode],
+            client: modal.client.Client,
+            task_id: str,
+        ) -> FileIO:
+            """Create a new FileIO handle."""
+            ...
+
+    create: typing.ClassVar[__create_spec]
 
-    class ___make_read_request_spec(typing_extensions.Protocol[SUPERSELF]):
+    class ___make_read_request_spec(typing_extensions.Protocol):
         def __call__(self, /, n: typing.Optional[int]) -> bytes: ...
         async def aio(self, /, n: typing.Optional[int]) -> bytes: ...
 
-    _make_read_request: ___make_read_request_spec[typing_extensions.Self]
+    _make_read_request: ___make_read_request_spec
 
-    class __read_spec(typing_extensions.Protocol[T_INNER, SUPERSELF]):
+    class __read_spec(typing_extensions.Protocol[T_INNER]):
         def __call__(self, /, n: typing.Optional[int] = None) -> T_INNER:
             """Read n bytes from the current position, or the entire remaining file if n is None."""
             ...
@@ -310,9 +307,9 @@ class FileIO(typing.Generic[T]):
             """Read n bytes from the current position, or the entire remaining file if n is None."""
             ...
 
-    read: __read_spec[T, typing_extensions.Self]
+    read: __read_spec[T]
 
-    class __readline_spec(typing_extensions.Protocol[T_INNER, SUPERSELF]):
+    class __readline_spec(typing_extensions.Protocol[T_INNER]):
         def __call__(self, /) -> T_INNER:
             """Read a single line from the current position."""
             ...
@@ -321,9 +318,9 @@ class FileIO(typing.Generic[T]):
             """Read a single line from the current position."""
             ...
 
-    readline: __readline_spec[T, typing_extensions.Self]
+    readline: __readline_spec[T]
 
-    class __readlines_spec(typing_extensions.Protocol[T_INNER, SUPERSELF]):
+    class __readlines_spec(typing_extensions.Protocol[T_INNER]):
         def __call__(self, /) -> typing.Sequence[T_INNER]:
             """Read all lines from the current position."""
             ...
@@ -332,9 +329,9 @@ class FileIO(typing.Generic[T]):
             """Read all lines from the current position."""
             ...
 
-    readlines: __readlines_spec[T, typing_extensions.Self]
+    readlines: __readlines_spec[T]
 
-    class __write_spec(typing_extensions.Protocol[SUPERSELF]):
+    class __write_spec(typing_extensions.Protocol):
         def __call__(self, /, data: typing.Union[bytes, str]) -> None:
             """Write data to the current position.
 
@@ -353,9 +350,9 @@ class FileIO(typing.Generic[T]):
             """
             ...
 
-    write: __write_spec[typing_extensions.Self]
+    write: __write_spec
 
-    class __flush_spec(typing_extensions.Protocol[SUPERSELF]):
+    class __flush_spec(typing_extensions.Protocol):
         def __call__(self, /) -> None:
             """Flush the buffer to disk."""
             ...
@@ -364,11 +361,11 @@ class FileIO(typing.Generic[T]):
             """Flush the buffer to disk."""
             ...
 
-    flush: __flush_spec[typing_extensions.Self]
+    flush: __flush_spec
 
     def _get_whence(self, whence: int): ...
 
-    class __seek_spec(typing_extensions.Protocol[SUPERSELF]):
+    class __seek_spec(typing_extensions.Protocol):
         def __call__(self, /, offset: int, whence: int = 0) -> None:
             """Move to a new position in the file.
 
@@ -385,41 +382,72 @@ class FileIO(typing.Generic[T]):
             """
             ...
 
-    seek: __seek_spec[typing_extensions.Self]
+    seek: __seek_spec
 
-    @classmethod
-    def ls(cls, path: str, client: modal.client.Client, task_id: str) -> list[str]:
-        """List the contents of the provided directory."""
-        ...
+    class __ls_spec(typing_extensions.Protocol):
+        def __call__(self, /, path: str, client: modal.client.Client, task_id: str) -> list[str]:
+            """List the contents of the provided directory."""
+            ...
 
-    @classmethod
-    def mkdir(cls, path: str, client: modal.client.Client, task_id: str, parents: bool = False) -> None:
-        """Create a new directory."""
-        ...
+        async def aio(self, /, path: str, client: modal.client.Client, task_id: str) -> list[str]:
+            """List the contents of the provided directory."""
+            ...
 
-    @classmethod
-    def rm(cls, path: str, client: modal.client.Client, task_id: str, recursive: bool = False) -> None:
-        """Remove a file or directory in the Sandbox."""
-        ...
+    ls: typing.ClassVar[__ls_spec]
 
-    @classmethod
-    def watch(
-        cls,
-        path: str,
-        client: modal.client.Client,
-        task_id: str,
-        filter: typing.Optional[list[FileWatchEventType]] = None,
-        recursive: bool = False,
-        timeout: typing.Optional[int] = None,
-    ) -> typing.Iterator[FileWatchEvent]: ...
+    class __mkdir_spec(typing_extensions.Protocol):
+        def __call__(self, /, path: str, client: modal.client.Client, task_id: str, parents: bool = False) -> None:
+            """Create a new directory."""
+            ...
+
+        async def aio(self, /, path: str, client: modal.client.Client, task_id: str, parents: bool = False) -> None:
+            """Create a new directory."""
+            ...
+
+    mkdir: typing.ClassVar[__mkdir_spec]
+
+    class __rm_spec(typing_extensions.Protocol):
+        def __call__(self, /, path: str, client: modal.client.Client, task_id: str, recursive: bool = False) -> None:
+            """Remove a file or directory in the Sandbox."""
+            ...
+
+        async def aio(self, /, path: str, client: modal.client.Client, task_id: str, recursive: bool = False) -> None:
+            """Remove a file or directory in the Sandbox."""
+            ...
 
-    class ___close_spec(typing_extensions.Protocol[SUPERSELF]):
+    rm: typing.ClassVar[__rm_spec]
+
+    class __watch_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            /,
+            path: str,
+            client: modal.client.Client,
+            task_id: str,
+            filter: typing.Optional[list[FileWatchEventType]] = None,
+            recursive: bool = False,
+            timeout: typing.Optional[int] = None,
+        ) -> typing.Iterator[FileWatchEvent]: ...
+        def aio(
+            self,
+            /,
+            path: str,
+            client: modal.client.Client,
+            task_id: str,
+            filter: typing.Optional[list[FileWatchEventType]] = None,
+            recursive: bool = False,
+            timeout: typing.Optional[int] = None,
+        ) -> typing.AsyncIterator[FileWatchEvent]: ...
+
+    watch: typing.ClassVar[__watch_spec]
+
+    class ___close_spec(typing_extensions.Protocol):
         def __call__(self, /) -> None: ...
         async def aio(self, /) -> None: ...
 
-    _close: ___close_spec[typing_extensions.Self]
+    _close: ___close_spec
 
-    class __close_spec(typing_extensions.Protocol[SUPERSELF]):
+    class __close_spec(typing_extensions.Protocol):
         def __call__(self, /) -> None:
             """Flush the buffer and close the file."""
             ...
@@ -428,7 +456,7 @@ class FileIO(typing.Generic[T]):
             """Flush the buffer and close the file."""
             ...
 
-    close: __close_spec[typing_extensions.Self]
+    close: __close_spec
 
     def _check_writable(self) -> None: ...
     def _check_readable(self) -> None: ...