modal 1.0.3.dev10__py3-none-any.whl → 1.2.3.dev7__py3-none-any.whl

modal/runner.pyi

@@ -1,6 +1,6 @@
-import modal._functions
+import modal._load_context
+import modal.app
 import modal.client
-import modal.cls
 import modal.running_app
 import modal_proto.api_pb2
 import multiprocessing.synchronize
@@ -8,8 +8,6 @@ import synchronicity.combined_types
 import typing
 import typing_extensions
 
-_App = typing.TypeVar("_App")
-
 V = typing.TypeVar("V")
 
 async def _heartbeat(client: modal.client._Client, app_id: str) -> None: ...
@@ -19,102 +17,190 @@ async def _init_local_app_existing(
 async def _init_local_app_new(
     client: modal.client._Client,
     description: str,
+    tags: dict[str, str],
     app_state: int,
     environment_name: str = "",
     interactive: bool = False,
 ) -> modal.running_app.RunningApp: ...
 async def _init_local_app_from_name(
-    client: modal.client._Client, name: str, namespace: typing.Any, environment_name: str = ""
+    client: modal.client._Client, name: str, tags: dict[str, str], environment_name: str = ""
 ) -> modal.running_app.RunningApp: ...
 async def _create_all_objects(
-    client: modal.client._Client,
     running_app: modal.running_app.RunningApp,
-    functions: dict[str, modal._functions._Function],
-    classes: dict[str, modal.cls._Cls],
-    environment_name: str,
-) -> None: ...
+    local_app_state: modal.app._LocalAppState,
+    load_context: modal._load_context.LoadContext,
+) -> None:
+    """Create objects that have been defined but not created on the server."""
+    ...
+
 async def _publish_app(
     client: modal.client._Client,
     running_app: modal.running_app.RunningApp,
     app_state: int,
-    functions: dict[str, modal._functions._Function],
-    classes: dict[str, modal.cls._Cls],
+    app_local_state: modal.app._LocalAppState,
     name: str = "",
-    tag: str = "",
+    deployment_tag: str = "",
     commit_info: typing.Optional[modal_proto.api_pb2.CommitInfo] = None,
-) -> tuple[str, list[modal_proto.api_pb2.Warning]]: ...
-async def _disconnect(client: modal.client._Client, app_id: str, reason: int, exc_str: str = "") -> None: ...
+) -> tuple[str, list[modal_proto.api_pb2.Warning]]:
+    """Wrapper for AppPublish RPC."""
+    ...
+
+async def _disconnect(client: modal.client._Client, app_id: str, reason: int, exc_str: str = "") -> None:
+    """Tell the server the client has disconnected for this app. Terminates all running tasks
+    for ephemeral apps.
+    """
+    ...
+
 async def _status_based_disconnect(
     client: modal.client._Client, app_id: str, exc_info: typing.Optional[BaseException] = None
-): ...
+):
+    """Disconnect local session of a running app, sending relevant metadata
+
+    exc_info: Exception if an exception caused the disconnect
+    """
+    ...
+
 def _run_app(
-    app: _App,
+    app: modal.app._App,
     *,
     client: typing.Optional[modal.client._Client] = None,
     detach: bool = False,
     environment_name: typing.Optional[str] = None,
     interactive: bool = False,
-) -> typing.AsyncContextManager[_App]: ...
+) -> typing.AsyncContextManager[modal.app._App]:
+    """mdmd:hidden"""
+    ...
+
 async def _serve_update(
-    app: _App, existing_app_id: str, is_ready: multiprocessing.synchronize.Event, environment_name: str
-) -> None: ...
+    app: modal.app._App, existing_app_id: str, is_ready: multiprocessing.synchronize.Event, environment_name: str
+) -> None:
+    """mdmd:hidden"""
+    ...
 
 class DeployResult:
+    """Dataclass representing the result of deploying an app."""
+
     app_id: str
     app_page_url: str
     app_logs_url: str
     warnings: list[str]
 
-    def __init__(self, app_id: str, app_page_url: str, app_logs_url: str, warnings: list[str]) -> None: ...
-    def __repr__(self): ...
-    def __eq__(self, other): ...
-    def __setattr__(self, name, value): ...
-    def __delattr__(self, name): ...
-    def __hash__(self): ...
+    def __init__(self, app_id: str, app_page_url: str, app_logs_url: str, warnings: list[str]) -> 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)."""
+        ...
 
 async def _deploy_app(
-    app: _App,
+    app: modal.app._App,
     name: typing.Optional[str] = None,
-    namespace: typing.Any = 1,
+    namespace: typing.Any = None,
     client: typing.Optional[modal.client._Client] = None,
     environment_name: typing.Optional[str] = None,
     tag: str = "",
-) -> DeployResult: ...
+) -> DeployResult:
+    """Internal function for deploying an App.
+
+    Users should prefer the `modal deploy` CLI or the `App.deploy` method.
+    """
+    ...
+
 async def _interactive_shell(
-    _app: _App, cmds: list[str], environment_name: str = "", pty: bool = True, **kwargs: typing.Any
-) -> None: ...
+    _app: modal.app._App, cmds: list[str], environment_name: str = "", pty: bool = True, **kwargs: typing.Any
+) -> None:
+    """Run an interactive shell (like `bash`) within the image for this app.
+
+    This is useful for online debugging and interactive exploration of the
+    contents of this image. If `cmd` is optionally provided, it will be run
+    instead of the default shell inside this image.
+
+    **Example**
+
+    ```python
+    import modal
+
+    app = modal.App(image=modal.Image.debian_slim().apt_install("vim"))
+    ```
+
+    You can now run this using
+
+    ```
+    modal shell script.py --cmd /bin/bash
+    ```
+
+    When calling programmatically, `kwargs` are passed to `Sandbox.create()`.
+    """
+    ...
 
 class __run_app_spec(typing_extensions.Protocol):
     def __call__(
         self,
         /,
-        app: _App,
+        app: modal.app.App,
         *,
         client: typing.Optional[modal.client.Client] = None,
         detach: bool = False,
         environment_name: typing.Optional[str] = None,
         interactive: bool = False,
-    ) -> synchronicity.combined_types.AsyncAndBlockingContextManager[_App]: ...
+    ) -> synchronicity.combined_types.AsyncAndBlockingContextManager[modal.app.App]:
+        """mdmd:hidden"""
+        ...
+
     def aio(
         self,
         /,
-        app: _App,
+        app: modal.app.App,
         *,
         client: typing.Optional[modal.client.Client] = None,
         detach: bool = False,
         environment_name: typing.Optional[str] = None,
         interactive: bool = False,
-    ) -> typing.AsyncContextManager[_App]: ...
+    ) -> typing.AsyncContextManager[modal.app.App]:
+        """mdmd:hidden"""
+        ...
 
 run_app: __run_app_spec
 
 class __serve_update_spec(typing_extensions.Protocol):
     def __call__(
-        self, /, app: _App, existing_app_id: str, is_ready: multiprocessing.synchronize.Event, environment_name: str
-    ) -> None: ...
+        self,
+        /,
+        app: modal.app.App,
+        existing_app_id: str,
+        is_ready: multiprocessing.synchronize.Event,
+        environment_name: str,
+    ) -> None:
+        """mdmd:hidden"""
+        ...
+
     async def aio(
-        self, /, app: _App, existing_app_id: str, is_ready: multiprocessing.synchronize.Event, environment_name: str
-    ) -> None: ...
+        self,
+        /,
+        app: modal.app.App,
+        existing_app_id: str,
+        is_ready: multiprocessing.synchronize.Event,
+        environment_name: str,
+    ) -> None:
+        """mdmd:hidden"""
+        ...
 
 serve_update: __serve_update_spec
 
@@ -122,32 +208,102 @@ class __deploy_app_spec(typing_extensions.Protocol):
     def __call__(
         self,
         /,
-        app: _App,
+        app: modal.app.App,
         name: typing.Optional[str] = None,
-        namespace: typing.Any = 1,
+        namespace: typing.Any = None,
         client: typing.Optional[modal.client.Client] = None,
         environment_name: typing.Optional[str] = None,
         tag: str = "",
-    ) -> DeployResult: ...
+    ) -> DeployResult:
+        """Internal function for deploying an App.
+
+        Users should prefer the `modal deploy` CLI or the `App.deploy` method.
+        """
+        ...
+
     async def aio(
         self,
         /,
-        app: _App,
+        app: modal.app.App,
         name: typing.Optional[str] = None,
-        namespace: typing.Any = 1,
+        namespace: typing.Any = None,
         client: typing.Optional[modal.client.Client] = None,
         environment_name: typing.Optional[str] = None,
         tag: str = "",
-    ) -> DeployResult: ...
+    ) -> DeployResult:
+        """Internal function for deploying an App.
+
+        Users should prefer the `modal deploy` CLI or the `App.deploy` method.
+        """
+        ...
 
 deploy_app: __deploy_app_spec
 
 class __interactive_shell_spec(typing_extensions.Protocol):
     def __call__(
-        self, /, _app: _App, cmds: list[str], environment_name: str = "", pty: bool = True, **kwargs: typing.Any
-    ) -> None: ...
+        self,
+        /,
+        _app: modal.app.App,
+        cmds: list[str],
+        environment_name: str = "",
+        pty: bool = True,
+        **kwargs: typing.Any,
+    ) -> None:
+        """Run an interactive shell (like `bash`) within the image for this app.
+
+        This is useful for online debugging and interactive exploration of the
+        contents of this image. If `cmd` is optionally provided, it will be run
+        instead of the default shell inside this image.
+
+        **Example**
+
+        ```python
+        import modal
+
+        app = modal.App(image=modal.Image.debian_slim().apt_install("vim"))
+        ```
+
+        You can now run this using
+
+        ```
+        modal shell script.py --cmd /bin/bash
+        ```
+
+        When calling programmatically, `kwargs` are passed to `Sandbox.create()`.
+        """
+        ...
+
     async def aio(
-        self, /, _app: _App, cmds: list[str], environment_name: str = "", pty: bool = True, **kwargs: typing.Any
-    ) -> None: ...
+        self,
+        /,
+        _app: modal.app.App,
+        cmds: list[str],
+        environment_name: str = "",
+        pty: bool = True,
+        **kwargs: typing.Any,
+    ) -> None:
+        """Run an interactive shell (like `bash`) within the image for this app.
+
+        This is useful for online debugging and interactive exploration of the
+        contents of this image. If `cmd` is optionally provided, it will be run
+        instead of the default shell inside this image.
+
+        **Example**
+
+        ```python
+        import modal
+
+        app = modal.App(image=modal.Image.debian_slim().apt_install("vim"))
+        ```
+
+        You can now run this using
+
+        ```
+        modal shell script.py --cmd /bin/bash
+        ```
+
+        When calling programmatically, `kwargs` are passed to `Sandbox.create()`.
+        """
+        ...
 
 interactive_shell: __interactive_shell_spec