modal 1.0.6.dev58__py3-none-any.whl → 1.2.3.dev7__py3-none-any.whl

modal/cli/app.py

@@ -15,7 +15,7 @@ from modal.client import _Client
 from modal.environments import ensure_env
 from modal_proto import api_pb2
 
-from .._utils.time_utils import timestamp_to_local
+from .._utils.time_utils import timestamp_to_localized_str
 from .utils import ENV_OPTION, display_table, get_app_id_from_name, stream_app_logs
 
 APP_IDENTIFIER = Argument("", help="App name or ID")
@@ -71,8 +71,8 @@ async def list_(env: Optional[str] = ENV_OPTION, json: bool = False):
                 app_stats.description,
                 state,
                 str(app_stats.n_running_tasks),
-                timestamp_to_local(app_stats.created_at, json),
-                timestamp_to_local(app_stats.stopped_at, json),
+                timestamp_to_localized_str(app_stats.created_at, json),
+                timestamp_to_localized_str(app_stats.stopped_at, json),
             ]
         )
 
@@ -217,7 +217,7 @@ async def history(
 
         row = [
             Text(f"v{app_stats.version}", style=style),
-            Text(timestamp_to_local(app_stats.deployed_at, json), style=style),
+            Text(timestamp_to_localized_str(app_stats.deployed_at, json), style=style),
             Text(app_stats.client_version, style=style),
             Text(app_stats.deployed_by, style=style),
         ]

modal/cli/cluster.py

@@ -2,13 +2,14 @@
 from typing import Optional, Union
 
 import typer
-from rich.console import Console
+from rich.table import Column
 from rich.text import Text
 
 from modal._object import _get_environment_name
+from modal._output import make_console
 from modal._pty import get_pty_info
 from modal._utils.async_utils import synchronizer
-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, display_table, is_tty
 from modal.client import _Client
 from modal.config import config
@@ -33,7 +34,12 @@ async def list_(env: Optional[str] = ENV_OPTION, json: bool = False):
         api_pb2.ClusterListRequest(environment_name=environment_name)
     )
 
-    column_names = ["Cluster ID", "App ID", "Start Time", "Nodes"]
+    column_names: list[Union[Column, str]] = [
+        Column("Cluster ID", min_width=25),
+        Column("App ID", min_width=25),
+        "Start Time",
+        "Nodes",
+    ]
     rows: list[list[Union[Text, str]]] = []
     res.clusters.sort(key=lambda c: c.started_at, reverse=True)
 
@@ -42,7 +48,7 @@ async def list_(env: Optional[str] = ENV_OPTION, json: bool = False):
             [
                 c.cluster_id,
                 c.app_id,
-                timestamp_to_local(c.started_at, json) if c.started_at else "Pending",
+                timestamp_to_localized_str(c.started_at, json) if c.started_at else "Pending",
                 str(len(c.task_ids)),
             ]
         )
@@ -62,7 +68,7 @@ async def shell(
     if len(res.cluster.task_ids) <= rank:
         raise typer.Abort(f"No node with rank {rank} in cluster {cluster_id}")
     task_id = res.cluster.task_ids[rank]
-    console = Console()
+    console = make_console()
     is_main = "(main)" if rank == 0 else ""
     console.print(
         f"Opening shell to node {rank} {is_main} of cluster {cluster_id} (container {task_id})", style="green"
@@ -77,7 +83,9 @@ async def shell(
     )
     exec_res: api_pb2.ContainerExecResponse = await client.stub.ContainerExec(req)
     if pty:
-        await _ContainerProcess(exec_res.exec_id, client).attach()
+        await _ContainerProcess(exec_res.exec_id, task_id, client).attach()
     else:
         # TODO: redirect stderr to its own stream?
-        await _ContainerProcess(exec_res.exec_id, client, stdout=StreamType.STDOUT, stderr=StreamType.STDOUT).wait()
+        await _ContainerProcess(
+            exec_res.exec_id, task_id, client, stdout=StreamType.STDOUT, stderr=StreamType.STDOUT
+        ).wait()

modal/cli/config.py

@@ -1,7 +1,9 @@
 # Copyright Modal Labs 2022
+import json
+
 import typer
-from rich.console import Console
 
+from modal._output import make_console
 from modal.config import _profile, _store_user_config, config
 from modal.environments import Environment
 
@@ -24,8 +26,8 @@ def show(redact: bool = typer.Option(True, help="Redact the `token_secret` value
     if redact and config_dict.get("token_secret"):
         config_dict["token_secret"] = "***"
 
-    console = Console()
-    console.print(config_dict)
+    console = make_console()
+    console.print_json(json.dumps(config_dict))
 
 
 SET_DEFAULT_ENV_HELP = """Set the default Modal environment for the active profile

modal/cli/container.py

@@ -7,8 +7,7 @@ from rich.text import Text
 from modal._object import _get_environment_name
 from modal._pty import get_pty_info
 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, display_table, is_tty, stream_app_logs
 from modal.client import _Client
 from modal.config import config
@@ -40,7 +39,7 @@ async def list_(env: Optional[str] = ENV_OPTION, json: bool = False):
                 task_stats.task_id,
                 task_stats.app_id,
                 task_stats.app_description,
-                timestamp_to_local(task_stats.started_at, json) if task_stats.started_at else "Pending",
+                timestamp_to_localized_str(task_stats.started_at, json) if task_stats.started_at else "Pending",
             ]
         )
 
@@ -80,10 +79,12 @@ async def exec(
     res: api_pb2.ContainerExecResponse = await client.stub.ContainerExec(req)
 
     if pty:
-        await _ContainerProcess(res.exec_id, client).attach()
+        await _ContainerProcess(res.exec_id, container_id, client).attach()
     else:
         # TODO: redirect stderr to its own stream?
-        await _ContainerProcess(res.exec_id, client, stdout=StreamType.STDOUT, stderr=StreamType.STDOUT).wait()
+        await _ContainerProcess(
+            res.exec_id, container_id, client, stdout=StreamType.STDOUT, stderr=StreamType.STDOUT
+        ).wait()
 
 
 @container_cli.command("stop")
@@ -95,4 +96,4 @@ async def stop(container_id: str = typer.Argument(help="Container ID")):
     """
     client = await _Client.from_env()
     request = api_pb2.ContainerStopRequest(task_id=container_id)
-    await retry_transient_errors(client.stub.ContainerStop, request)
+    await client.stub.ContainerStop(request)

modal/cli/dict.py

@@ -2,18 +2,17 @@
 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.dict import _Dict
 from modal.environments import ensure_env
-from modal_proto import api_pb2
 
 dict_cli = Typer(
     name="dict",
@@ -31,8 +30,10 @@ async def create(name: str, *, env: Optional[str] = ENV_OPTION):
     """
     d = _Dict.from_name(name, environment_name=env, create_if_missing=True)
     client = await _Client.from_env()
-    resolver = Resolver(client=client)
-    await resolver.load(d)
+    resolver = Resolver()
+
+    load_context = LoadContext(client=client, environment_name=env)
+    await resolver.load(d, load_context)
 
 
 @dict_cli.command(name="list", rich_help_panel="Management")
@@ -40,12 +41,13 @@ async def create(name: str, *, env: Optional[str] = ENV_OPTION):
 async def list_(*, json: bool = False, env: Optional[str] = ENV_OPTION):
     """List all named Dicts."""
     env = ensure_env(env)
-    client = await _Client.from_env()
-    request = api_pb2.DictListRequest(environment_name=env)
-    response = await retry_transient_errors(client.stub.DictList, request)
+    dicts = await _Dict.objects.list(environment_name=env)
+    rows = []
+    for obj in dicts:
+        info = await obj.info()
+        rows.append((info.name, timestamp_to_localized_str(info.created_at.timestamp(), json), info.created_by))
 
-    rows = [(d.name, timestamp_to_local(d.created_at, json)) for d in response.dicts]
-    display_table(["Name", "Created at"], rows, json)
+    display_table(["Name", "Created at", "Created by"], rows, json)
 
 
 @dict_cli.command("clear", rich_help_panel="Management")
@@ -64,17 +66,21 @@ async def clear(name: str, *, yes: bool = YES_OPTION, env: Optional[str] = ENV_O
 
 @dict_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 Dict doesn't exist."),
+    yes: bool = YES_OPTION,
+    env: Optional[str] = ENV_OPTION,
+):
     """Delete a named Dict and all of its data."""
-    # Lookup first to validate the name, even though delete is a staticmethod
-    await _Dict.from_name(name, environment_name=env).hydrate()
     if not yes:
         typer.confirm(
             f"Are you sure you want to irrevocably delete the modal.Dict '{name}'?",
             default=False,
             abort=True,
         )
-    await _Dict.delete(name, environment_name=env)
+    await _Dict.objects.delete(name, environment_name=env, allow_missing=allow_missing)
 
 
 @dict_cli.command(name="get", rich_help_panel="Inspection")
@@ -85,7 +91,7 @@ async def get(name: str, key: str, *, env: Optional[str] = ENV_OPTION):
     Note: When using the CLI, keys are always interpreted as having a string type.
     """
     d = _Dict.from_name(name, environment_name=env)
-    console = Console()
+    console = make_console()
     val = await d.get(key)
     console.print(val)
 

modal/cli/entry_point.py

@@ -3,9 +3,9 @@ import subprocess
 from typing import Optional
 
 import typer
-from rich.console import Console
 from rich.rule import Rule
 
+from modal._output import make_console
 from modal._utils.async_utils import synchronizer
 
 from . import run
@@ -33,9 +33,10 @@ def version_callback(value: bool):
 
 
 entrypoint_cli_typer = typer.Typer(
-    no_args_is_help=True,
+    no_args_is_help=False,
     add_completion=False,
     rich_markup_mode="markdown",
+    context_settings={"help_option_names": ["-h", "--help"]},
     help="""
     Modal is the fastest way to run code in the cloud.
 
@@ -45,12 +46,18 @@ entrypoint_cli_typer = typer.Typer(
 )
 
 
-@entrypoint_cli_typer.callback()
+@entrypoint_cli_typer.callback(invoke_without_command=True)
 def modal(
     ctx: typer.Context,
     version: bool = typer.Option(None, "--version", callback=version_callback),
 ):
-    pass
+    # TODO: When https://github.com/fastapi/typer/pull/1240 gets shipped, then
+    # - set invoke_without_command=False in the callback decorator
+    # - set no_args_is_help=True in entrypoint_cli_typer
+    if ctx.invoked_subcommand is None:
+        console = make_console()
+        console.print(ctx.get_help())
+        raise typer.Exit()
 
 
 def check_path():
@@ -71,7 +78,7 @@ def check_path():
             "You may need to give it permissions or use `[white]python -m modal[/white]` as a workaround.[/red]\n"
         )
     text += f"See more information here:\n\n[link={url}]{url}[/link]\n"
-    console = Console()
+    console = make_console()
     console.print(text)
     console.print(Rule(style="white"))
 

modal/cli/environment.py

@@ -8,7 +8,7 @@ from rich.text import Text
 
 from modal import environments
 from modal._utils.name_utils import check_environment_name
-from modal.cli.utils import display_table
+from modal.cli.utils import YES_OPTION, display_table
 from modal.config import config
 from modal.exception import InvalidError
 
@@ -80,13 +80,14 @@ Deletes all apps in the selected environment and deletes the environment irrevoc
 @environment_cli.command(name="delete", help=ENVIRONMENT_DELETE_HELP)
 def delete(
     name: str = typer.Argument(help="Name of the environment to be deleted. Case sensitive"),
-    confirm: bool = typer.Option(default=False, help="Set this flag to delete without prompting for confirmation"),
+    *,
+    yes: bool = YES_OPTION,
 ):
-    if not confirm:
+    if not yes:
         typer.confirm(
             (
                 f"Are you sure you want to irrevocably delete the environment '{name}' and"
-                " all its associated apps and secrets?"
+                " all its associated Apps, Secrets, Volumes, Dicts and Queues?"
             ),
             default=False,
             abort=True,

modal/cli/import_refs.py

@@ -19,9 +19,9 @@ from pathlib import Path
 from typing import Optional, Union, cast
 
 import click
-from rich.console import Console
 from rich.markdown import Markdown
 
+from modal._output import make_console
 from modal._utils.deprecation import deprecation_warning
 from modal.app import App, LocalEntrypoint
 from modal.cls import Cls
@@ -258,7 +258,7 @@ def import_app_from_ref(import_ref: ImportRef, base_cmd: str = "") -> App:
     app = getattr(module, object_path)
 
     if app is None:
-        error_console = Console(stderr=True)
+        error_console = make_console(stderr=True)
         error_console.print(f"[bold red]Could not find Modal app '{object_path}' in {import_path}.[/bold red]")
 
         if not object_path:
@@ -282,7 +282,7 @@ def import_app_from_ref(import_ref: ImportRef, base_cmd: str = "") -> App:
 def _show_function_ref_help(app_ref: ImportRef, base_cmd: str) -> None:
     object_path = app_ref.object_path
     import_path = app_ref.file_or_module
-    error_console = Console(stderr=True)
+    error_console = make_console(stderr=True)
     if object_path:
         error_console.print(
             f"[bold red]Could not find Modal function or local entrypoint"

modal/cli/launch.py

@@ -3,11 +3,16 @@ import asyncio
 import inspect
 import json
 import os
+import subprocess
+import tempfile
 from pathlib import Path
 from typing import Any, Optional
 
+import rich.panel
+from rich.markdown import Markdown
 from typer import Typer
 
+from .._output import make_console
 from ..exception import _CliUserExecutionError
 from ..output import enable_output
 from ..runner import run_app
@@ -16,15 +21,24 @@ from .import_refs import ImportRef, _get_runnable_app, import_file_or_module
 launch_cli = Typer(
     name="launch",
     no_args_is_help=True,
+    rich_markup_mode="markdown",
     help="""
-    Open a serverless app instance on Modal.
-
-    This command is in preview and may change in the future.
+    [Experimental] Open a serverless app instance on Modal.
     """,
 )
 
 
-def _launch_program(name: str, filename: str, detach: bool, args: dict[str, Any]) -> None:
+def _launch_program(
+    name: str, filename: str, detach: bool, args: dict[str, Any], *, description: Optional[str] = None
+) -> None:
+    console = make_console()
+    console.print(
+        rich.panel.Panel(
+            Markdown(f"⚠️  `modal launch {name}` is **experimental** and may change in the future."),
+            border_style="yellow",
+        ),
+    )
+
     os.environ["MODAL_LAUNCH_ARGS"] = json.dumps(args)
 
     program_path = str(Path(__file__).parent / "programs" / filename)
@@ -33,7 +47,7 @@ def _launch_program(name: str, filename: str, detach: bool, args: dict[str, Any]
     entrypoint = module.main
 
     app = _get_runnable_app(entrypoint)
-    app.set_description(base_cmd)
+    app.set_description(description if description else base_cmd)
 
     # `launch/` scripts must have a `local_entrypoint()` with no args, for simplicity here.
     func = entrypoint.info.raw_f
@@ -61,6 +75,17 @@ def jupyter(
     volume: Optional[str] = None,  # Attach a persisted `modal.Volume` by name (creating if missing).
     detach: bool = False,  # Run the app in "detached" mode to persist after local client disconnects
 ):
+    console = make_console()
+    console.print(
+        rich.panel.Panel(
+            (
+                "[link=https://modal.com/notebooks]Try Modal Notebooks! "
+                "modal.com/notebooks[/link]\n"
+                "Notebooks have a new UI, saved content, real-time collaboration and more."
+            ),
+        ),
+        style="bold cyan",
+    )
     args = {
         "cpu": cpu,
         "memory": memory,
@@ -95,3 +120,75 @@ def vscode(
         "volume": volume,
     }
     _launch_program("vscode", "vscode.py", detach, args)
+
+
+@launch_cli.command(name="machine", help="Start an instance on Modal, with direct SSH access.", hidden=True)
+def machine(
+    name: str,  # Name of the machine App.
+    cpu: int = 8,  # Reservation of CPU cores (can burst above this value).
+    memory: int = 32768,  # Reservation of memory in MiB (can burst above this value).
+    gpu: Optional[str] = None,  # GPU type and count, e.g. "t4" or "h100:2".
+    image: Optional[str] = None,  # Image tag to use from registry. Defaults to the notebook base image.
+    timeout: int = 3600 * 24,  # Timeout in seconds for the instance.
+    volume: str = "machine-vol",  # Attach a persisted `modal.Volume` at /workspace (created if missing).
+):
+    tempdir = Path(tempfile.gettempdir())
+    key_path = tempdir / "modal-machine-keyfile.pem"
+    # Generate a new SSH key pair for this machine instance.
+    if not key_path.exists():
+        subprocess.run(
+            ["ssh-keygen", "-t", "ed25519", "-f", str(key_path), "-N", ""],
+            check=True,
+            stdout=subprocess.DEVNULL,
+        )
+    # Add the key with expiry 1d to ssh agent.
+    subprocess.run(
+        ["ssh-add", "-t", "1d", str(key_path)],
+        check=True,
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )
+
+    os.environ["SSH_PUBLIC_KEY"] = Path(str(key_path) + ".pub").read_text()
+    os.environ["MODAL_LOGS_TIMEOUT"] = "0"  # hack to work with --detach
+
+    args = {
+        "cpu": cpu,
+        "memory": memory,
+        "gpu": gpu,
+        "image": image,
+        "timeout": timeout,
+        "volume": volume,
+    }
+    _launch_program(
+        "machine",
+        "launch_instance_ssh.py",
+        True,
+        args,
+        description=name,
+    )
+
+
+@launch_cli.command(name="marimo", help="Start a remote Marimo notebook on Modal.", hidden=True)
+def marimo(
+    cpu: int = 8,
+    memory: int = 32768,
+    gpu: Optional[str] = None,
+    image: str = "debian:12",
+    timeout: int = 3600,
+    add_python: Optional[str] = "3.12",
+    mount: Optional[str] = None,  # Create a `modal.Mount` from a local directory.
+    volume: Optional[str] = None,  # Attach a persisted `modal.Volume` by name (creating if missing).
+    detach: bool = False,  # Run the app in "detached" mode to persist after local client disconnects
+):
+    args = {
+        "cpu": cpu,
+        "memory": memory,
+        "gpu": gpu,
+        "timeout": timeout,
+        "image": image,
+        "add_python": add_python,
+        "mount": mount,
+        "volume": volume,
+    }
+    _launch_program("marimo", "run_marimo.py", detach, args)

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,7 +199,7 @@ async def rm(
 ):
     ensure_env(env)
     volume = _NetworkFileSystem.from_name(volume_name)
-    console = Console()
+    console = make_console()
     try:
         await volume.remove_file(remote_path, recursive=recursive)
         console.print(OutputManager.step_completed(f"{remote_path} was deleted successfully!"))

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 = []