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

modal/runner.pyi

@@ -32,7 +32,10 @@ async def _create_all_objects(
     functions: dict[str, modal._functions._Function],
     classes: dict[str, modal.cls._Cls],
     environment_name: str,
-) -> None: ...
+) -> 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,
@@ -42,11 +45,25 @@ async def _publish_app(
     name: str = "",
     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,
     *,
@@ -54,23 +71,47 @@ def _run_app(
     detach: bool = False,
     environment_name: typing.Optional[str] = None,
     interactive: bool = False,
-) -> typing.AsyncContextManager[_App]: ...
+) -> typing.AsyncContextManager[_App]:
+    """mdmd:hidden"""
+    ...
+
 async def _serve_update(
     app: _App, existing_app_id: str, is_ready: multiprocessing.synchronize.Event, environment_name: str
-) -> None: ...
+) -> 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,
@@ -79,10 +120,39 @@ async def _deploy_app(
     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: ...
+) -> 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__(
@@ -94,7 +164,10 @@ class __run_app_spec(typing_extensions.Protocol):
         detach: bool = False,
         environment_name: typing.Optional[str] = None,
         interactive: bool = False,
-    ) -> synchronicity.combined_types.AsyncAndBlockingContextManager[_App]: ...
+    ) -> synchronicity.combined_types.AsyncAndBlockingContextManager[_App]:
+        """mdmd:hidden"""
+        ...
+
     def aio(
         self,
         /,
@@ -104,17 +177,24 @@ class __run_app_spec(typing_extensions.Protocol):
         detach: bool = False,
         environment_name: typing.Optional[str] = None,
         interactive: bool = False,
-    ) -> typing.AsyncContextManager[_App]: ...
+    ) -> typing.AsyncContextManager[_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: ...
+    ) -> None:
+        """mdmd:hidden"""
+        ...
+
     async def aio(
         self, /, app: _App, existing_app_id: str, is_ready: multiprocessing.synchronize.Event, environment_name: str
-    ) -> None: ...
+    ) -> None:
+        """mdmd:hidden"""
+        ...
 
 serve_update: __serve_update_spec
 
@@ -128,7 +208,13 @@ class __deploy_app_spec(typing_extensions.Protocol):
         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,
         /,
@@ -138,16 +224,68 @@ class __deploy_app_spec(typing_extensions.Protocol):
         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: ...
+    ) -> 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: ...
+    ) -> 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

modal/sandbox.py

@@ -70,7 +70,7 @@ class _Sandbox(_Object, type_prefix="sb"):
     """A `Sandbox` object lets you interact with a running sandbox. This API is similar to Python's
     [asyncio.subprocess.Process](https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process).
 
-    Refer to the [guide](/docs/guide/sandbox) on how to spawn and use sandboxes.
+    Refer to the [guide](https://modal.com/docs/guide/sandbox) on how to spawn and use sandboxes.
     """
 
     _result: Optional[api_pb2.GenericResult]
@@ -516,7 +516,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
         Returns a dictionary of `Tunnel` objects which are keyed by the container port.
 
-        NOTE: Previous to client [v0.64.153](/docs/reference/changelog#064153-2024-09-30), this
+        NOTE: Previous to client [v0.64.153](https://modal.com/docs/reference/changelog#064153-2024-09-30), this
         returned a list of `TunnelData` objects.
         """
 
@@ -617,7 +617,7 @@ class _Sandbox(_Object, type_prefix="sb"):
     ):
         """Execute a command in the Sandbox and return a ContainerProcess handle.
 
-        See the [`ContainerProcess`](/docs/reference/modal.container_process#modalcontainer_processcontainerprocess)
+        See the [`ContainerProcess`](https://modal.com/docs/reference/modal.container_process#modalcontainer_processcontainerprocess)
         docs for more information.
 
         **Usage**
@@ -722,7 +722,7 @@ class _Sandbox(_Object, type_prefix="sb"):
     ):
         """Open a file in the Sandbox and return a FileIO handle.
 
-        See the [`FileIO`](/docs/reference/modal.file_io#modalfile_iofileio) docs for more information.
+        See the [`FileIO`](https://modal.com/docs/reference/modal.file_io#modalfile_iofileio) docs for more information.
 
         **Usage**
 
@@ -766,7 +766,7 @@ class _Sandbox(_Object, type_prefix="sb"):
     @property
     def stdout(self) -> _StreamReader[str]:
         """
-        [`StreamReader`](/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
+        [`StreamReader`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
         the sandbox's stdout stream.
         """
 
@@ -774,7 +774,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
     @property
     def stderr(self) -> _StreamReader[str]:
-        """[`StreamReader`](/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
+        """[`StreamReader`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
         the Sandbox's stderr stream.
         """
 
@@ -783,7 +783,7 @@ class _Sandbox(_Object, type_prefix="sb"):
     @property
     def stdin(self) -> _StreamWriter:
         """
-        [`StreamWriter`](/docs/reference/modal.io_streams#modalio_streamsstreamwriter) for
+        [`StreamWriter`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamwriter) for
         the Sandbox's stdin stream.
         """