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

modal/cli/network_file_system.py

@@ -7,17 +7,15 @@ from typing import Optional
 import typer
 from click import UsageError
 from grpclib import GRPCError, Status
-from rich.console import Console
 from rich.syntax import Syntax
 from rich.table import Table
 from typer import Argument, Typer
 
 import modal
 from modal._location import display_location
-from modal._output import OutputManager, ProgressHandler
+from modal._output import OutputManager, ProgressHandler, make_console
 from modal._utils.async_utils import synchronizer
-from modal._utils.grpc_utils import retry_transient_errors
-from modal._utils.time_utils import timestamp_to_local
+from modal._utils.time_utils import timestamp_to_localized_str
 from modal.cli._download import _volume_download
 from modal.cli.utils import ENV_OPTION, YES_OPTION, display_table
 from modal.client import _Client
@@ -34,9 +32,7 @@ async def list_(env: Optional[str] = ENV_OPTION, json: Optional[bool] = False):
     env = ensure_env(env)
 
     client = await _Client.from_env()
-    response = await retry_transient_errors(
-        client.stub.SharedVolumeList, api_pb2.SharedVolumeListRequest(environment_name=env)
-    )
+    response = await client.stub.SharedVolumeList(api_pb2.SharedVolumeListRequest(environment_name=env))
     env_part = f" in environment '{env}'" if env else ""
     column_names = ["Name", "Location", "Created at"]
     rows = []
@@ -45,7 +41,7 @@ async def list_(env: Optional[str] = ENV_OPTION, json: Optional[bool] = False):
             [
                 item.label,
                 display_location(item.cloud_provider),
-                timestamp_to_local(item.created_at, json),
+                timestamp_to_localized_str(item.created_at, json),
             ]
         )
     display_table(column_names, rows, json, title=f"Shared Volumes{env_part}")
@@ -66,7 +62,7 @@ def create(
 ):
     ensure_env(env)
     modal.NetworkFileSystem.create_deployed(name, environment_name=env)
-    console = Console()
+    console = make_console()
     console.print(f"Created volume '{name}'. \n\nCode example:\n")
     usage = Syntax(gen_usage_code(name), "python")
     console.print(usage)
@@ -93,7 +89,7 @@ async def ls(
         raise
 
     if sys.stdout.isatty():
-        console = Console()
+        console = make_console()
         console.print(f"Directory listing of '{path}' in '{volume_name}'")
         table = Table()
 
@@ -131,7 +127,7 @@ async def put(
     volume = _NetworkFileSystem.from_name(volume_name)
     if remote_path.endswith("/"):
         remote_path = remote_path + os.path.basename(local_path)
-    console = Console()
+    console = make_console()
 
     if Path(local_path).is_dir():
         progress_handler = ProgressHandler(type="upload", console=console)
@@ -184,7 +180,7 @@ async def get(
     ensure_env(env)
     destination = Path(local_destination)
     volume = _NetworkFileSystem.from_name(volume_name)
-    console = Console()
+    console = make_console()
     progress_handler = ProgressHandler(type="download", console=console)
     with progress_handler.live:
         await _volume_download(volume, remote_path, destination, force, progress_cb=progress_handler.progress)
@@ -203,8 +199,11 @@ async def rm(
 ):
     ensure_env(env)
     volume = _NetworkFileSystem.from_name(volume_name)
+    console = make_console()
     try:
         await volume.remove_file(remote_path, recursive=recursive)
+        console.print(OutputManager.step_completed(f"{remote_path} was deleted successfully!"))
+
     except GRPCError as exc:
         if exc.status in (Status.NOT_FOUND, Status.INVALID_ARGUMENT):
             raise UsageError(exc.message)

modal/cli/profile.py

@@ -5,10 +5,10 @@ import os
 from typing import Optional
 
 import typer
-from rich.console import Console
 from rich.json import JSON
 from rich.table import Table
 
+from modal._output import make_console
 from modal._utils.async_utils import synchronizer
 from modal.config import Config, _lookup_workspace, _profile, config_profiles, config_set_active_profile
 from modal.exception import AuthError
@@ -19,6 +19,7 @@ profile_cli = typer.Typer(name="profile", help="Switch between Modal profiles.",
 @profile_cli.command(help="Change the active Modal profile.")
 def activate(profile: str = typer.Argument(..., help="Modal profile to activate.")):
     config_set_active_profile(profile)
+    typer.echo(f"Active profile: {profile}")
 
 
 @profile_cli.command(help="Print the currently active Modal profile.")
@@ -69,7 +70,7 @@ async def list_(json: Optional[bool] = False):
         except AuthError:
             env_based_workspace = "Unknown (authentication failure)"
 
-    console = Console()
+    console = make_console()
     highlight = "bold green" if env_based_workspace is None else "yellow"
     if json:
         json_data = []

modal/cli/programs/launch_instance_ssh.py

@@ -0,0 +1,94 @@
+# Copyright Modal Labs 2023
+# type: ignore
+import json
+import os
+import sys
+from typing import Any
+
+import rich
+import rich.panel
+import rich.rule
+
+import modal
+import modal.experimental
+
+# Passed by `modal launch` locally via CLI.
+args: dict[str, Any] = json.loads(os.environ.get("MODAL_LAUNCH_ARGS", "{}"))
+
+app = modal.App()
+
+image: modal.Image
+if args.get("image"):
+    image = modal.Image.from_registry(args.get("image"))
+else:
+    # Must be set to the same image builder version as the notebook base image.
+    os.environ["MODAL_IMAGE_BUILDER_VERSION"] = "2024.10"
+    image = modal.experimental.notebook_base_image(python_version="3.12")
+
+volume = (
+    modal.Volume.from_name(
+        args.get("volume"),
+        create_if_missing=True,
+    )
+    if args.get("volume")
+    else None
+)
+volumes = {"/workspace": volume} if volume else {}
+
+
+startup_script = """
+set -eu
+mkdir -p /run/sshd
+
+# Check if sshd is installed, install if not
+test -x /usr/sbin/sshd || (apt-get update && apt-get install -y openssh-server)
+
+# Change default working directory to /workspace
+echo "cd /workspace" >> /root/.profile
+
+mkdir -p /root/.ssh
+echo "$SSH_PUBLIC_KEY" >> /root/.ssh/authorized_keys
+/usr/sbin/sshd -D -e
+"""
+
+
+@app.local_entrypoint()
+def main():
+    if not os.environ.get("SSH_PUBLIC_KEY"):
+        raise ValueError("SSH_PUBLIC_KEY environment variable is not set")
+
+    sb = modal.Sandbox.create(
+        *("sh", "-c", startup_script),
+        app=app,
+        image=image,
+        cpu=args.get("cpu"),
+        memory=args.get("memory"),
+        gpu=args.get("gpu"),
+        timeout=args.get("timeout"),
+        volumes=volumes,
+        unencrypted_ports=[22],  # Forward SSH port
+        secrets=[modal.Secret.from_dict({"SSH_PUBLIC_KEY": os.environ.get("SSH_PUBLIC_KEY")})],
+    )
+    hostname, port = sb.tunnels()[22].tcp_socket
+    connection_cmd = f"ssh -A -p {port} root@{hostname}"
+
+    rich.print(
+        rich.rule.Rule(style="yellow"),
+        rich.panel.Panel(
+            f"""Your instance is ready! You can SSH into it using the following command:
+
+  [dim gray]>[/dim gray] [bold cyan]{connection_cmd}[/bold cyan]
+
+[italic]Details:[/italic]
+  • Name:    [magenta]{app.description}[/magenta]
+  • CPU:     [yellow]{args.get("cpu")} cores[/yellow]
+  • Memory:  [yellow]{args.get("memory")} MiB[/yellow]
+  • Timeout: [yellow]{args.get("timeout")} seconds[/yellow]
+  • GPU:     [green]{(args.get("gpu") or "N/A").upper()}[/green]""",
+            title="SSH Connection",
+            expand=False,
+        ),
+        rich.rule.Rule(style="yellow"),
+    )
+
+    sys.exit(0)  # Exit immediately to prevent "Timed out waiting for final apps log."

modal/cli/programs/run_jupyter.py

@@ -54,7 +54,7 @@ def wait_for_port(url: str, q: Queue):
     cpu=args.get("cpu"),
     memory=args.get("memory"),
     gpu=args.get("gpu"),
-    timeout=args.get("timeout"),
+    timeout=args.get("timeout", 3600),
     secrets=[Secret.from_dict({"MODAL_LAUNCH_ARGS": json.dumps(args)})],
     volumes=volumes,
     max_containers=1 if volume else None,

modal/cli/programs/run_marimo.py

@@ -0,0 +1,95 @@
+# Copyright Modal Labs 2025
+# type: ignore
+import json
+import os
+import secrets
+import socket
+import subprocess
+import threading
+import time
+import webbrowser
+from typing import Any
+
+from modal import App, Image, Queue, Secret, Volume, forward
+
+# Args injected by `modal launch` CLI.
+args: dict[str, Any] = json.loads(os.environ.get("MODAL_LAUNCH_ARGS", "{}"))
+
+app = App()
+
+image = Image.from_registry(args.get("image"), add_python=args.get("add_python")).uv_pip_install("marimo")
+
+# Optional host-filesystem mount (read-only snapshot of your project, useful for editing)
+if args.get("mount"):
+    image = image.add_local_dir(args["mount"], remote_path="/root/marimo/mount")
+
+# Optional persistent Modal volume
+volume = Volume.from_name(args["volume"], create_if_missing=True) if args.get("volume") else None
+volumes = {"/root/marimo/volume": volume} if volume else {}
+
+
+def _wait_for_port(url: str, q: Queue) -> None:
+    start = time.monotonic()
+    while True:
+        try:
+            with socket.create_connection(("localhost", 8888), timeout=30):
+                break
+        except OSError as exc:
+            if time.monotonic() - start > 30:
+                raise TimeoutError("marimo server did not start within 30 s") from exc
+            time.sleep(0.05)
+    q.put(url)
+
+
+@app.function(
+    image=image,
+    cpu=args.get("cpu"),
+    memory=args.get("memory"),
+    gpu=args.get("gpu"),
+    timeout=args.get("timeout", 3600),
+    secrets=[Secret.from_dict({"MODAL_LAUNCH_ARGS": json.dumps(args)})],
+    volumes=volumes,
+    max_containers=1 if volume else None,
+)
+def run_marimo(q: Queue):
+    os.makedirs("/root/marimo", exist_ok=True)
+
+    # marimo supports token-based auth; generate one so only you can connect
+    token = secrets.token_urlsafe(12)
+
+    with forward(8888) as tunnel:
+        url = f"{tunnel.url}/?access_token={token}"
+        threading.Thread(target=_wait_for_port, args=(url, q), daemon=True).start()
+
+        print("\nmarimo on Modal, opening in browser …")
+        print(f"   -> {url}\n")
+
+        # Launch the headless edit server
+        subprocess.run(
+            [
+                "marimo",
+                "edit",
+                "--headless",  # don't open browser in container
+                "--host",
+                "0.0.0.0",  # bind all interfaces
+                "--port",
+                "8888",
+                "--token-password",
+                token,  # enable session-based auth
+                "--skip-update-check",
+                "/root/marimo",  # workspace directory
+            ],
+            env={**os.environ, "SHELL": "/bin/bash"},
+        )
+
+    q.put("done")
+
+
+@app.local_entrypoint()
+def main():
+    with Queue.ephemeral() as q:
+        run_marimo.spawn(q)
+        url = q.get()  # first message = connect URL
+        time.sleep(1)  # give server a heartbeat
+        webbrowser.open(url)
+        assert q.get() == "done"

modal/cli/programs/vscode.py

@@ -79,7 +79,7 @@ def wait_for_port(data: tuple[str, str], q: Queue):
     cpu=args.get("cpu"),
     memory=args.get("memory"),
     gpu=args.get("gpu"),
-    timeout=args.get("timeout"),
+    timeout=args.get("timeout", 3600),
     secrets=[Secret.from_dict({"MODAL_LAUNCH_ARGS": json.dumps(args)})],
     volumes=volumes,
     max_containers=1 if volume else None,

modal/cli/queues.py

@@ -1,14 +1,15 @@
 # Copyright Modal Labs 2024
+from datetime import datetime
 from typing import Optional
 
 import typer
-from rich.console import Console
 from typer import Argument, Option, Typer
 
+from modal._load_context import LoadContext
+from modal._output import make_console
 from modal._resolver import Resolver
 from modal._utils.async_utils import synchronizer
-from modal._utils.grpc_utils import retry_transient_errors
-from modal._utils.time_utils import timestamp_to_local
+from modal._utils.time_utils import timestamp_to_localized_str
 from modal.cli.utils import ENV_OPTION, YES_OPTION, display_table
 from modal.client import _Client
 from modal.environments import ensure_env
@@ -38,23 +39,29 @@ async def create(name: str, *, env: Optional[str] = ENV_OPTION):
     """
     q = _Queue.from_name(name, environment_name=env, create_if_missing=True)
     client = await _Client.from_env()
-    resolver = Resolver(client=client)
-    await resolver.load(q)
+    resolver = Resolver()
+    load_context = LoadContext(client=client, environment_name=env)
+    await resolver.load(q, load_context)
 
 
 @queue_cli.command(name="delete", rich_help_panel="Management")
 @synchronizer.create_blocking
-async def delete(name: str, *, yes: bool = YES_OPTION, env: Optional[str] = ENV_OPTION):
+async def delete(
+    name: str,
+    *,
+    allow_missing: bool = Option(False, "--allow-missing", help="Don't error if the Queue doesn't exist."),
+    yes: bool = YES_OPTION,
+    env: Optional[str] = ENV_OPTION,
+):
     """Delete a named Queue and all of its data."""
-    # Lookup first to validate the name, even though delete is a staticmethod
-    await _Queue.from_name(name, environment_name=env).hydrate()
+    env = ensure_env(env)
     if not yes:
         typer.confirm(
             f"Are you sure you want to irrevocably delete the modal.Queue '{name}'?",
             default=False,
             abort=True,
         )
-    await _Queue.delete(name, environment_name=env)
+    await _Queue.objects.delete(name, environment_name=env, allow_missing=allow_missing)
 
 
 @queue_cli.command(name="list", rich_help_panel="Management")
@@ -62,22 +69,46 @@ async def delete(name: str, *, yes: bool = YES_OPTION, env: Optional[str] = ENV_
 async def list_(*, json: bool = False, env: Optional[str] = ENV_OPTION):
     """List all named Queues."""
     env = ensure_env(env)
-
-    max_total_size = 100_000
     client = await _Client.from_env()
-    request = api_pb2.QueueListRequest(environment_name=env, total_size_limit=max_total_size + 1)
-    response = await retry_transient_errors(client.stub.QueueList, request)
-
-    rows = [
-        (
-            q.name,
-            timestamp_to_local(q.created_at, json),
-            str(q.num_partitions),
-            str(q.total_size) if q.total_size <= max_total_size else f">{max_total_size}",
+    max_total_size = 100_000  # Limit on the *Queue size* that we report
+
+    items: list[api_pb2.QueueListResponse.QueueInfo] = []
+
+    # Note that we need to continue using the gRPC API directly here rather than using Queue.objects.list.
+    # There is some metadata that historically appears in the CLI output (num_partitions, total_size) that
+    # doesn't make sense to transmit as hydration metadata, because the values can change over time and
+    # the metadata retrieved at hydration time could get stale. Alternatively, we could rewrite this using
+    # only public API by sequentially retrieving the queues and then querying their dynamic metadata, but
+    # that would require multiple round trips and would add lag to the CLI.
+    async def retrieve_page(created_before: float) -> bool:
+        max_page_size = 100
+        pagination = api_pb2.ListPagination(max_objects=max_page_size, created_before=created_before)
+        req = api_pb2.QueueListRequest(environment_name=env, pagination=pagination, total_size_limit=max_total_size)
+        resp = await client.stub.QueueList(req)
+        items.extend(resp.queues)
+        return len(resp.queues) < max_page_size
+
+    finished = await retrieve_page(datetime.now().timestamp())
+    while True:
+        if finished:
+            break
+        finished = await retrieve_page(items[-1].metadata.creation_info.created_at)
+
+    queues = [_Queue._new_hydrated(item.queue_id, client, item.metadata, is_another_app=True) for item in items]
+
+    rows = []
+    for obj, resp_data in zip(queues, items):
+        info = await obj.info()
+        rows.append(
+            (
+                obj.name,
+                timestamp_to_localized_str(info.created_at.timestamp(), json),
+                info.created_by,
+                str(resp_data.num_partitions),
+                str(resp_data.total_size) if resp_data.total_size <= max_total_size else f">{max_total_size}",
+            )
         )
-        for q in response.queues
-    ]
-    display_table(["Name", "Created at", "Partitions", "Total size"], rows, json)
+    display_table(["Name", "Created at", "Created by", "Partitions", "Total size"], rows, json)
 
 
 @queue_cli.command(name="clear", rich_help_panel="Management")
@@ -108,7 +139,7 @@ async def peek(
 ):
     """Print the next N items in the queue or queue partition (without removal)."""
     q = _Queue.from_name(name, environment_name=env)
-    console = Console()
+    console = make_console()
     i = 0
     async for item in q.iterate(partition=partition):
         console.print(item)
@@ -119,7 +150,7 @@ async def peek(
 
 @queue_cli.command(name="len", rich_help_panel="Inspection")
 @synchronizer.create_blocking
-async def len(
+async def len_(
     name: str,
     partition: Optional[str] = PARTITION_OPTION,
     total: bool = Option(False, "-t", "--total", help="Compute the sum of the queue lengths across all partitions"),
@@ -128,5 +159,5 @@ async def len(
 ):
     """Print the length of a queue partition or the total length of all partitions."""
     q = _Queue.from_name(name, environment_name=env)
-    console = Console()
+    console = make_console()
     console.print(await q.len(partition=partition, total=total))