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

modal/sandbox.pyi

@@ -1,217 +1,445 @@
+import _typeshed
+import collections.abc
 import google.protobuf.message
+import modal._tunnel
+import modal.app
 import modal.client
 import modal.cloud_bucket_mount
+import modal.container_process
+import modal.file_io
 import modal.gpu
 import modal.image
+import modal.io_streams
 import modal.mount
 import modal.network_file_system
 import modal.object
+import modal.proxy
+import modal.scheduler_placement
 import modal.secret
+import modal.stream_type
 import modal.volume
 import modal_proto.api_pb2
 import os
 import typing
 import typing_extensions
 
-class _LogsReader:
-    def __init__(self, file_descriptor: int, sandbox_id: str, client: modal.client._Client) -> None:
-        ...
-
-    async def read(self) -> str:
-        ...
-
-    def _get_logs(self) -> typing.AsyncIterator[typing.Union[modal_proto.api_pb2.TaskLogs, None]]:
-        ...
-
-    def __aiter__(self):
-        ...
-
-    async def __anext__(self):
-        ...
-
-
-class _StreamWriter:
-    def __init__(self, sandbox_id: str, client: modal.client._Client):
-        ...
-
-    def get_next_index(self):
-        ...
-
-    def write(self, data: typing.Union[bytes, bytearray, memoryview]):
-        ...
-
-    def write_eof(self):
-        ...
-
-    async def drain(self):
-        ...
-
-
-class LogsReader:
-    def __init__(self, file_descriptor: int, sandbox_id: str, client: modal.client.Client) -> None:
-        ...
-
-    class __read_spec(typing_extensions.Protocol):
-        def __call__(self) -> str:
-            ...
-
-        async def aio(self, *args, **kwargs) -> str:
-            ...
-
-    read: __read_spec
-
-    class ___get_logs_spec(typing_extensions.Protocol):
-        def __call__(self) -> typing.Iterator[typing.Union[modal_proto.api_pb2.TaskLogs, None]]:
-            ...
-
-        def aio(self) -> typing.AsyncIterator[typing.Union[modal_proto.api_pb2.TaskLogs, None]]:
-            ...
-
-    _get_logs: ___get_logs_spec
-
-    def __iter__(self):
-        ...
-
-    def __aiter__(self):
-        ...
-
-    def __next__(self):
-        ...
-
-    async def __anext__(self, *args, **kwargs):
-        ...
-
-
-class StreamWriter:
-    def __init__(self, sandbox_id: str, client: modal.client.Client):
-        ...
-
-    def get_next_index(self):
-        ...
-
-    def write(self, data: typing.Union[bytes, bytearray, memoryview]):
-        ...
-
-    def write_eof(self):
-        ...
-
-    class __drain_spec(typing_extensions.Protocol):
-        def __call__(self):
-            ...
-
-        async def aio(self, *args, **kwargs):
-            ...
-
-    drain: __drain_spec
-
-
 class _Sandbox(modal.object._Object):
-    _result: typing.Union[modal_proto.api_pb2.GenericResult, None]
-    _stdout: _LogsReader
-    _stderr: _LogsReader
-    _stdin: _StreamWriter
+    _result: typing.Optional[modal_proto.api_pb2.GenericResult]
+    _stdout: modal.io_streams._StreamReader[str]
+    _stderr: modal.io_streams._StreamReader[str]
+    _stdin: modal.io_streams._StreamWriter
+    _task_id: typing.Optional[str]
+    _tunnels: typing.Optional[dict[int, modal._tunnel.Tunnel]]
 
     @staticmethod
-    def _new(entrypoint_args: typing.Sequence[str], image: modal.image._Image, mounts: typing.Sequence[modal.mount._Mount], secrets: typing.Sequence[modal.secret._Secret], timeout: typing.Union[int, None] = None, workdir: typing.Union[str, None] = None, gpu: typing.Union[None, bool, str, modal.gpu._GPUConfig] = None, cloud: typing.Union[str, None] = None, cpu: typing.Union[float, None] = None, memory: typing.Union[int, None] = None, network_file_systems: typing.Dict[typing.Union[str, os.PathLike], modal.network_file_system._NetworkFileSystem] = {}, block_network: bool = False, volumes: typing.Dict[typing.Union[str, os.PathLike], typing.Union[modal.volume._Volume, modal.cloud_bucket_mount._CloudBucketMount]] = {}, allow_background_volume_commits: bool = False, pty_info: typing.Union[modal_proto.api_pb2.PTYInfo, None] = None) -> _Sandbox:
-        ...
-
-    def _hydrate_metadata(self, handle_metadata: typing.Union[google.protobuf.message.Message, None]):
-        ...
-
+    def _new(
+        entrypoint_args: collections.abc.Sequence[str],
+        image: modal.image._Image,
+        mounts: collections.abc.Sequence[modal.mount._Mount],
+        secrets: collections.abc.Sequence[modal.secret._Secret],
+        timeout: typing.Optional[int] = None,
+        workdir: typing.Optional[str] = None,
+        gpu: typing.Union[None, bool, str, modal.gpu._GPUConfig] = None,
+        cloud: typing.Optional[str] = None,
+        region: typing.Union[str, collections.abc.Sequence[str], None] = None,
+        cpu: typing.Optional[float] = None,
+        memory: typing.Union[int, tuple[int, int], None] = None,
+        network_file_systems: dict[typing.Union[str, os.PathLike], modal.network_file_system._NetworkFileSystem] = {},
+        block_network: bool = False,
+        cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
+        volumes: dict[
+            typing.Union[str, os.PathLike],
+            typing.Union[modal.volume._Volume, modal.cloud_bucket_mount._CloudBucketMount],
+        ] = {},
+        pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        encrypted_ports: collections.abc.Sequence[int] = [],
+        unencrypted_ports: collections.abc.Sequence[int] = [],
+        proxy: typing.Optional[modal.proxy._Proxy] = None,
+        _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
+    ) -> _Sandbox: ...
     @staticmethod
-    async def from_id(sandbox_id: str, client: typing.Union[modal.client._Client, None] = None) -> _Sandbox:
-        ...
-
-    async def wait(self, raise_on_termination: bool = True):
-        ...
-
-    async def terminate(self):
-        ...
-
-    async def poll(self) -> typing.Union[int, None]:
-        ...
-
+    async def create(
+        *entrypoint_args: str,
+        app: typing.Optional[modal.app._App] = None,
+        environment_name: typing.Optional[str] = None,
+        image: typing.Optional[modal.image._Image] = None,
+        mounts: collections.abc.Sequence[modal.mount._Mount] = (),
+        secrets: collections.abc.Sequence[modal.secret._Secret] = (),
+        network_file_systems: dict[typing.Union[str, os.PathLike], modal.network_file_system._NetworkFileSystem] = {},
+        timeout: typing.Optional[int] = None,
+        workdir: typing.Optional[str] = None,
+        gpu: typing.Union[None, bool, str, modal.gpu._GPUConfig] = None,
+        cloud: typing.Optional[str] = None,
+        region: typing.Union[str, collections.abc.Sequence[str], None] = None,
+        cpu: typing.Union[float, tuple[float, float], None] = None,
+        memory: typing.Union[int, tuple[int, int], None] = None,
+        block_network: bool = False,
+        cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
+        volumes: dict[
+            typing.Union[str, os.PathLike],
+            typing.Union[modal.volume._Volume, modal.cloud_bucket_mount._CloudBucketMount],
+        ] = {},
+        pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        encrypted_ports: collections.abc.Sequence[int] = [],
+        unencrypted_ports: collections.abc.Sequence[int] = [],
+        proxy: typing.Optional[modal.proxy._Proxy] = None,
+        _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
+        client: typing.Optional[modal.client._Client] = None,
+    ) -> _Sandbox: ...
+    def _hydrate_metadata(self, handle_metadata: typing.Optional[google.protobuf.message.Message]): ...
+    @staticmethod
+    async def from_id(sandbox_id: str, client: typing.Optional[modal.client._Client] = None) -> _Sandbox: ...
+    async def set_tags(self, tags: dict[str, str], *, client: typing.Optional[modal.client._Client] = None): ...
+    async def snapshot_filesystem(self, timeout: int = 55) -> modal.image._Image: ...
+    async def wait(self, raise_on_termination: bool = True): ...
+    async def tunnels(self, timeout: int = 50) -> dict[int, modal._tunnel.Tunnel]: ...
+    async def terminate(self): ...
+    async def poll(self) -> typing.Optional[int]: ...
+    async def _get_task_id(self): ...
+    @typing.overload
+    async def exec(
+        self,
+        *cmds: str,
+        pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+        stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+        timeout: typing.Optional[int] = None,
+        workdir: typing.Optional[str] = None,
+        secrets: collections.abc.Sequence[modal.secret._Secret] = (),
+        text: typing.Literal[True] = True,
+        bufsize: typing.Literal[-1, 1] = -1,
+        _pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+    ) -> modal.container_process._ContainerProcess[str]: ...
+    @typing.overload
+    async def exec(
+        self,
+        *cmds: str,
+        pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+        stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+        timeout: typing.Optional[int] = None,
+        workdir: typing.Optional[str] = None,
+        secrets: collections.abc.Sequence[modal.secret._Secret] = (),
+        text: typing.Literal[False] = False,
+        bufsize: typing.Literal[-1, 1] = -1,
+        _pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+    ) -> modal.container_process._ContainerProcess[bytes]: ...
+    @typing.overload
+    async def open(self, path: str, mode: _typeshed.OpenTextMode) -> modal.file_io._FileIO[str]: ...
+    @typing.overload
+    async def open(self, path: str, mode: _typeshed.OpenBinaryMode) -> modal.file_io._FileIO[bytes]: ...
+    async def ls(self, path: str) -> list[str]: ...
+    async def mkdir(self, path: str, parents: bool = False) -> None: ...
+    async def rm(self, path: str, recursive: bool = False) -> None: ...
+    def watch(
+        self,
+        path: str,
+        filter: typing.Optional[list[modal.file_io.FileWatchEventType]] = None,
+        recursive: typing.Optional[bool] = None,
+        timeout: typing.Optional[int] = None,
+    ) -> typing.AsyncIterator[modal.file_io.FileWatchEvent]: ...
     @property
-    def stdout(self) -> _LogsReader:
-        ...
-
+    def stdout(self) -> modal.io_streams._StreamReader[str]: ...
     @property
-    def stderr(self) -> _LogsReader:
-        ...
-
+    def stderr(self) -> modal.io_streams._StreamReader[str]: ...
     @property
-    def stdin(self) -> _StreamWriter:
-        ...
-
+    def stdin(self) -> modal.io_streams._StreamWriter: ...
     @property
-    def returncode(self) -> typing.Union[int, None]:
-        ...
-
+    def returncode(self) -> typing.Optional[int]: ...
+    @staticmethod
+    def list(
+        *,
+        app_id: typing.Optional[str] = None,
+        tags: typing.Optional[dict[str, str]] = None,
+        client: typing.Optional[modal.client._Client] = None,
+    ) -> collections.abc.AsyncGenerator[_Sandbox, None]: ...
 
 class Sandbox(modal.object.Object):
-    _result: typing.Union[modal_proto.api_pb2.GenericResult, None]
-    _stdout: LogsReader
-    _stderr: LogsReader
-    _stdin: StreamWriter
+    _result: typing.Optional[modal_proto.api_pb2.GenericResult]
+    _stdout: modal.io_streams.StreamReader[str]
+    _stderr: modal.io_streams.StreamReader[str]
+    _stdin: modal.io_streams.StreamWriter
+    _task_id: typing.Optional[str]
+    _tunnels: typing.Optional[dict[int, modal._tunnel.Tunnel]]
+
+    def __init__(self, *args, **kwargs): ...
+    @staticmethod
+    def _new(
+        entrypoint_args: collections.abc.Sequence[str],
+        image: modal.image.Image,
+        mounts: collections.abc.Sequence[modal.mount.Mount],
+        secrets: collections.abc.Sequence[modal.secret.Secret],
+        timeout: typing.Optional[int] = None,
+        workdir: typing.Optional[str] = None,
+        gpu: typing.Union[None, bool, str, modal.gpu._GPUConfig] = None,
+        cloud: typing.Optional[str] = None,
+        region: typing.Union[str, collections.abc.Sequence[str], None] = None,
+        cpu: typing.Optional[float] = None,
+        memory: typing.Union[int, tuple[int, int], None] = None,
+        network_file_systems: dict[typing.Union[str, os.PathLike], modal.network_file_system.NetworkFileSystem] = {},
+        block_network: bool = False,
+        cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
+        volumes: dict[
+            typing.Union[str, os.PathLike], typing.Union[modal.volume.Volume, modal.cloud_bucket_mount.CloudBucketMount]
+        ] = {},
+        pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        encrypted_ports: collections.abc.Sequence[int] = [],
+        unencrypted_ports: collections.abc.Sequence[int] = [],
+        proxy: typing.Optional[modal.proxy.Proxy] = None,
+        _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
+    ) -> Sandbox: ...
+
+    class __create_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            *entrypoint_args: str,
+            app: typing.Optional[modal.app.App] = None,
+            environment_name: typing.Optional[str] = None,
+            image: typing.Optional[modal.image.Image] = None,
+            mounts: collections.abc.Sequence[modal.mount.Mount] = (),
+            secrets: collections.abc.Sequence[modal.secret.Secret] = (),
+            network_file_systems: dict[
+                typing.Union[str, os.PathLike], modal.network_file_system.NetworkFileSystem
+            ] = {},
+            timeout: typing.Optional[int] = None,
+            workdir: typing.Optional[str] = None,
+            gpu: typing.Union[None, bool, str, modal.gpu._GPUConfig] = None,
+            cloud: typing.Optional[str] = None,
+            region: typing.Union[str, collections.abc.Sequence[str], None] = None,
+            cpu: typing.Union[float, tuple[float, float], None] = None,
+            memory: typing.Union[int, tuple[int, int], None] = None,
+            block_network: bool = False,
+            cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
+            volumes: dict[
+                typing.Union[str, os.PathLike],
+                typing.Union[modal.volume.Volume, modal.cloud_bucket_mount.CloudBucketMount],
+            ] = {},
+            pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+            encrypted_ports: collections.abc.Sequence[int] = [],
+            unencrypted_ports: collections.abc.Sequence[int] = [],
+            proxy: typing.Optional[modal.proxy.Proxy] = None,
+            _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> Sandbox: ...
+        async def aio(
+            self,
+            *entrypoint_args: str,
+            app: typing.Optional[modal.app.App] = None,
+            environment_name: typing.Optional[str] = None,
+            image: typing.Optional[modal.image.Image] = None,
+            mounts: collections.abc.Sequence[modal.mount.Mount] = (),
+            secrets: collections.abc.Sequence[modal.secret.Secret] = (),
+            network_file_systems: dict[
+                typing.Union[str, os.PathLike], modal.network_file_system.NetworkFileSystem
+            ] = {},
+            timeout: typing.Optional[int] = None,
+            workdir: typing.Optional[str] = None,
+            gpu: typing.Union[None, bool, str, modal.gpu._GPUConfig] = None,
+            cloud: typing.Optional[str] = None,
+            region: typing.Union[str, collections.abc.Sequence[str], None] = None,
+            cpu: typing.Union[float, tuple[float, float], None] = None,
+            memory: typing.Union[int, tuple[int, int], None] = None,
+            block_network: bool = False,
+            cidr_allowlist: typing.Optional[collections.abc.Sequence[str]] = None,
+            volumes: dict[
+                typing.Union[str, os.PathLike],
+                typing.Union[modal.volume.Volume, modal.cloud_bucket_mount.CloudBucketMount],
+            ] = {},
+            pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+            encrypted_ports: collections.abc.Sequence[int] = [],
+            unencrypted_ports: collections.abc.Sequence[int] = [],
+            proxy: typing.Optional[modal.proxy.Proxy] = None,
+            _experimental_scheduler_placement: typing.Optional[modal.scheduler_placement.SchedulerPlacement] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> Sandbox: ...
+
+    create: __create_spec
+
+    def _hydrate_metadata(self, handle_metadata: typing.Optional[google.protobuf.message.Message]): ...
 
-    def __init__(self, *args, **kwargs):
-        ...
+    class __from_id_spec(typing_extensions.Protocol):
+        def __call__(self, sandbox_id: str, client: typing.Optional[modal.client.Client] = None) -> Sandbox: ...
+        async def aio(self, sandbox_id: str, client: typing.Optional[modal.client.Client] = None) -> Sandbox: ...
 
-    @staticmethod
-    def _new(entrypoint_args: typing.Sequence[str], image: modal.image.Image, mounts: typing.Sequence[modal.mount.Mount], secrets: typing.Sequence[modal.secret.Secret], timeout: typing.Union[int, None] = None, workdir: typing.Union[str, None] = None, gpu: typing.Union[None, bool, str, modal.gpu._GPUConfig] = None, cloud: typing.Union[str, None] = None, cpu: typing.Union[float, None] = None, memory: typing.Union[int, None] = None, network_file_systems: typing.Dict[typing.Union[str, os.PathLike], modal.network_file_system.NetworkFileSystem] = {}, block_network: bool = False, volumes: typing.Dict[typing.Union[str, os.PathLike], typing.Union[modal.volume.Volume, modal.cloud_bucket_mount.CloudBucketMount]] = {}, allow_background_volume_commits: bool = False, pty_info: typing.Union[modal_proto.api_pb2.PTYInfo, None] = None) -> Sandbox:
-        ...
+    from_id: __from_id_spec
 
-    def _hydrate_metadata(self, handle_metadata: typing.Union[google.protobuf.message.Message, None]):
-        ...
+    class __set_tags_spec(typing_extensions.Protocol):
+        def __call__(self, tags: dict[str, str], *, client: typing.Optional[modal.client.Client] = None): ...
+        async def aio(self, tags: dict[str, str], *, client: typing.Optional[modal.client.Client] = None): ...
 
-    class __from_id_spec(typing_extensions.Protocol):
-        def __call__(self, sandbox_id: str, client: typing.Union[modal.client.Client, None] = None) -> Sandbox:
-            ...
+    set_tags: __set_tags_spec
 
-        async def aio(self, *args, **kwargs) -> Sandbox:
-            ...
+    class __snapshot_filesystem_spec(typing_extensions.Protocol):
+        def __call__(self, timeout: int = 55) -> modal.image.Image: ...
+        async def aio(self, timeout: int = 55) -> modal.image.Image: ...
 
-    from_id: __from_id_spec
+    snapshot_filesystem: __snapshot_filesystem_spec
 
     class __wait_spec(typing_extensions.Protocol):
-        def __call__(self, raise_on_termination: bool = True):
-            ...
-
-        async def aio(self, *args, **kwargs):
-            ...
+        def __call__(self, raise_on_termination: bool = True): ...
+        async def aio(self, raise_on_termination: bool = True): ...
 
     wait: __wait_spec
 
-    class __terminate_spec(typing_extensions.Protocol):
-        def __call__(self):
-            ...
+    class __tunnels_spec(typing_extensions.Protocol):
+        def __call__(self, timeout: int = 50) -> dict[int, modal._tunnel.Tunnel]: ...
+        async def aio(self, timeout: int = 50) -> dict[int, modal._tunnel.Tunnel]: ...
 
-        async def aio(self, *args, **kwargs):
-            ...
+    tunnels: __tunnels_spec
+
+    class __terminate_spec(typing_extensions.Protocol):
+        def __call__(self): ...
+        async def aio(self): ...
 
     terminate: __terminate_spec
 
     class __poll_spec(typing_extensions.Protocol):
-        def __call__(self) -> typing.Union[int, None]:
-            ...
-
-        async def aio(self, *args, **kwargs) -> typing.Union[int, None]:
-            ...
+        def __call__(self) -> typing.Optional[int]: ...
+        async def aio(self) -> typing.Optional[int]: ...
 
     poll: __poll_spec
 
-    @property
-    def stdout(self) -> LogsReader:
-        ...
+    class ___get_task_id_spec(typing_extensions.Protocol):
+        def __call__(self): ...
+        async def aio(self): ...
+
+    _get_task_id: ___get_task_id_spec
+
+    class __exec_spec(typing_extensions.Protocol):
+        @typing.overload
+        def __call__(
+            self,
+            *cmds: str,
+            pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+            stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            timeout: typing.Optional[int] = None,
+            workdir: typing.Optional[str] = None,
+            secrets: collections.abc.Sequence[modal.secret.Secret] = (),
+            text: typing.Literal[True] = True,
+            bufsize: typing.Literal[-1, 1] = -1,
+            _pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        ) -> modal.container_process.ContainerProcess[str]: ...
+        @typing.overload
+        def __call__(
+            self,
+            *cmds: str,
+            pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+            stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            timeout: typing.Optional[int] = None,
+            workdir: typing.Optional[str] = None,
+            secrets: collections.abc.Sequence[modal.secret.Secret] = (),
+            text: typing.Literal[False] = False,
+            bufsize: typing.Literal[-1, 1] = -1,
+            _pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        ) -> modal.container_process.ContainerProcess[bytes]: ...
+        @typing.overload
+        async def aio(
+            self,
+            *cmds: str,
+            pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+            stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            timeout: typing.Optional[int] = None,
+            workdir: typing.Optional[str] = None,
+            secrets: collections.abc.Sequence[modal.secret.Secret] = (),
+            text: typing.Literal[True] = True,
+            bufsize: typing.Literal[-1, 1] = -1,
+            _pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        ) -> modal.container_process.ContainerProcess[str]: ...
+        @typing.overload
+        async def aio(
+            self,
+            *cmds: str,
+            pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+            stdout: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            stderr: modal.stream_type.StreamType = modal.stream_type.StreamType.PIPE,
+            timeout: typing.Optional[int] = None,
+            workdir: typing.Optional[str] = None,
+            secrets: collections.abc.Sequence[modal.secret.Secret] = (),
+            text: typing.Literal[False] = False,
+            bufsize: typing.Literal[-1, 1] = -1,
+            _pty_info: typing.Optional[modal_proto.api_pb2.PTYInfo] = None,
+        ) -> modal.container_process.ContainerProcess[bytes]: ...
+
+    exec: __exec_spec
+
+    class __open_spec(typing_extensions.Protocol):
+        @typing.overload
+        def __call__(self, path: str, mode: _typeshed.OpenTextMode) -> modal.file_io.FileIO[str]: ...
+        @typing.overload
+        def __call__(self, path: str, mode: _typeshed.OpenBinaryMode) -> modal.file_io.FileIO[bytes]: ...
+        @typing.overload
+        async def aio(self, path: str, mode: _typeshed.OpenTextMode) -> modal.file_io.FileIO[str]: ...
+        @typing.overload
+        async def aio(self, path: str, mode: _typeshed.OpenBinaryMode) -> modal.file_io.FileIO[bytes]: ...
+
+    open: __open_spec
+
+    class __ls_spec(typing_extensions.Protocol):
+        def __call__(self, path: str) -> list[str]: ...
+        async def aio(self, path: str) -> list[str]: ...
+
+    ls: __ls_spec
+
+    class __mkdir_spec(typing_extensions.Protocol):
+        def __call__(self, path: str, parents: bool = False) -> None: ...
+        async def aio(self, path: str, parents: bool = False) -> None: ...
+
+    mkdir: __mkdir_spec
+
+    class __rm_spec(typing_extensions.Protocol):
+        def __call__(self, path: str, recursive: bool = False) -> None: ...
+        async def aio(self, path: str, recursive: bool = False) -> None: ...
+
+    rm: __rm_spec
+
+    class __watch_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            path: str,
+            filter: typing.Optional[list[modal.file_io.FileWatchEventType]] = None,
+            recursive: typing.Optional[bool] = None,
+            timeout: typing.Optional[int] = None,
+        ) -> typing.Iterator[modal.file_io.FileWatchEvent]: ...
+        def aio(
+            self,
+            path: str,
+            filter: typing.Optional[list[modal.file_io.FileWatchEventType]] = None,
+            recursive: typing.Optional[bool] = None,
+            timeout: typing.Optional[int] = None,
+        ) -> typing.AsyncIterator[modal.file_io.FileWatchEvent]: ...
+
+    watch: __watch_spec
 
     @property
-    def stderr(self) -> LogsReader:
-        ...
-
+    def stdout(self) -> modal.io_streams.StreamReader[str]: ...
     @property
-    def stdin(self) -> StreamWriter:
-        ...
-
+    def stderr(self) -> modal.io_streams.StreamReader[str]: ...
+    @property
+    def stdin(self) -> modal.io_streams.StreamWriter: ...
     @property
-    def returncode(self) -> typing.Union[int, None]:
-        ...
+    def returncode(self) -> typing.Optional[int]: ...
+
+    class __list_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            *,
+            app_id: typing.Optional[str] = None,
+            tags: typing.Optional[dict[str, str]] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> typing.Generator[Sandbox, None, None]: ...
+        def aio(
+            self,
+            *,
+            app_id: typing.Optional[str] = None,
+            tags: typing.Optional[dict[str, str]] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> collections.abc.AsyncGenerator[Sandbox, None]: ...
+
+    list: __list_spec
+
+def __getattr__(name): ...
+
+_default_image: modal.image._Image

modal/schedule.py

@@ -19,10 +19,10 @@ class Cron(Schedule):
 
     ```python
     import modal
-    stub = modal.Stub()
+    app = modal.App()
 
 
-    @stub.function(schedule=modal.Cron("* * * * *"))
+    @app.function(schedule=modal.Cron("* * * * *"))
     def f():
         print("This function will run every minute")
     ```
@@ -49,9 +49,9 @@ class Period(Schedule):
 
     ```python
     import modal
-    stub = modal.Stub()
+    app = modal.App()
 
-    @stub.function(schedule=modal.Period(days=1))
+    @app.function(schedule=modal.Period(days=1))
     def f():
         print("This function will run every day")
 

modal/scheduler_placement.py

@@ -1,5 +1,6 @@
 # Copyright Modal Labs 2024
-from typing import Optional
+from collections.abc import Sequence
+from typing import Optional, Union
 
 from modal_proto import api_pb2
 
@@ -11,17 +12,33 @@ class SchedulerPlacement:
 
     def __init__(
         self,
-        region: Optional[str] = None,
+        region: Optional[Union[str, Sequence[str]]] = None,
         zone: Optional[str] = None,
         spot: Optional[bool] = None,
+        instance_type: Optional[Union[str, Sequence[str]]] = None,
     ):
         """mdmd:hidden"""
         _lifecycle: Optional[str] = None
         if spot is not None:
             _lifecycle = "spot" if spot else "on-demand"
 
+        regions = []
+        if region:
+            if isinstance(region, str):
+                regions = [region]
+            else:
+                regions = list(region)
+
+        instance_types = []
+        if instance_type:
+            if isinstance(instance_type, str):
+                instance_types = [instance_type]
+            else:
+                instance_types = list(instance_type)
+
         self.proto = api_pb2.SchedulerPlacement(
-            _region=region,
+            regions=regions,
             _zone=zone,
             _lifecycle=_lifecycle,
+            _instance_types=instance_types,
         )