def __init__(self, app_id: str) -> None
async def deploy_stub( stub: _Stub, name: str = None, namespace=api_pb2.DEPLOYMENT_NAMESPACE_WORKSPACE, client=None, stdout=None, show_progress=True, environment_name: Optional[str] = None, ) -> DeployResult:
Deploy an app and export its objects persistently.
Typically, using the command-line tool
modal deploy <module or script>
should be used, instead of this method.
if __name__ == "__main__": deploy_stub(stub)
Deployment has two primary purposes:
- Persists all of the objects in the app, allowing them to live past the current app run. For schedules this enables headless “cron”-like functionality where scheduled functions continue to be invoked after the client has disconnected.
- Allows for certain kinds of these objects, deployment objects, to be referred to and used by other apps.
async def interactive_shell(_function: _Function, cmd: str, environment_name: str = ""):
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.
import modal stub = modal.Stub(image=modal.Image.debian_slim().apt_install("vim"))
You can now run this using
modal shell script.py --cmd /bin/bash