modAL 1.4.3.dev2__py3-none-any.whl → 1.4.3.dev4__py3-none-any.whl

modal/cli/billing.py

@@ -4,42 +4,48 @@ from json import dumps
 from typing import Optional
 
 import click
-import typer
 
 from modal._billing import _workspace_billing_report
 from modal._utils.async_utils import synchronizer
 from modal._utils.time_utils import parse_date, parse_date_range, resolve_timezone
 
+from ._help import ModalGroup
 from .utils import display_table
 
-billing_cli = typer.Typer(name="billing", help="View workspace billing information.", no_args_is_help=True)
+billing_cli = ModalGroup(name="billing", help="View workspace billing information.")
 
 
 DATE_HELP = "Date (in UTC by default): ISO format (2025-01-01) or relative (yesterday, 3 days ago, etc.)."
 
 
 @billing_cli.command("report", no_args_is_help=True)
+@click.option("--start", default=None, help=f"Start date. {DATE_HELP}")
+@click.option("--end", default=None, help=f"End date. {DATE_HELP} Defaults to now.")
+@click.option(
+    "--for",
+    "for_",
+    default=None,
+    help="Convenience range: today, yesterday, this week, last week, this month, last month.",
+)
+@click.option("-r", "--resolution", default="d", help="Time resolution: 'd' (daily) or 'h' (hourly).")
+@click.option(
+    "--tz",
+    default=None,
+    help="Timezone for date interpretation: 'local', offset (5, -4, +05:30), or IANA name. Requires hourly resolution.",
+)
+@click.option("-t", "--tag-names", default=None, help="Comma-separated list of tag names to include.")
+@click.option("--json", "json", is_flag=True, default=False, help="Output as JSON.")
+@click.option("--csv", "csv", is_flag=True, default=False, help="Output as CSV.")
 @synchronizer.create_blocking
 async def report(
-    start: Optional[str] = typer.Option(None, "--start", help=f"Start date. {DATE_HELP}"),
-    end: Optional[str] = typer.Option(None, "--end", help=f"End date. {DATE_HELP} Defaults to now."),
-    for_: Optional[str] = typer.Option(
-        None, "--for", help="Convenience range: today, yesterday, this week, last week, this month, last month."
-    ),
-    resolution: str = typer.Option("d", "--resolution", "-r", help="Time resolution: 'd' (daily) or 'h' (hourly)."),
-    tz: Optional[str] = typer.Option(
-        None,
-        "--tz",
-        help=(
-            "Timezone for date interpretation: 'local', offset (5, -4, +05:30), or IANA name."
-            " Requires hourly resolution."
-        ),
-    ),
-    tag_names: Optional[str] = typer.Option(
-        None, "--tag-names", "-t", help="Comma-separated list of tag names to include."
-    ),
-    json: bool = typer.Option(False, "--json", help="Output as JSON."),
-    csv: bool = typer.Option(False, "--csv", help="Output as CSV."),
+    start: Optional[str],
+    end: Optional[str],
+    for_: Optional[str],
+    resolution: str,
+    tz: Optional[str],
+    tag_names: Optional[str],
+    json: bool,
+    csv: bool,
 ):
     """Generate a billing report for the workspace.
 

modal/cli/bootstrap.py

@@ -6,7 +6,6 @@ from pathlib import Path
 from typing import Optional
 
 import click
-import typer
 
 from modal._utils.async_utils import synchronizer
 from modal._utils.http_utils import _http_client_with_tls
@@ -15,15 +14,20 @@ from modal.config import logger
 from modal.output import OutputManager
 from modal_proto import api_pb2
 
+from ._help import ModalCommand
 from .logo import GREEN, print_logo
 from .selector import Selector
 
 
+@click.command("bootstrap", cls=ModalCommand)
+@click.argument("name", required=False, default=None)
+@click.option("-o", "--output", default=".", help="Location for storing the template.")
+@click.option("--force", is_flag=True, default=False, help="Overwrite the output directory if it already exists.")
 @synchronizer.create_blocking
 async def bootstrap(
-    name: Optional[str] = typer.Argument(None, help="The name of the template to load."),
-    output: str = typer.Option(".", "-o", "--output", help="Location for storing the template."),
-    force: bool = typer.Option(False, "--force", help="Overwrite the output directory if it already exists."),
+    name: Optional[str] = None,
+    output: str = ".",
+    force: bool = False,
 ) -> None:
     """Initialize a sample Modal App."""
     client = await _Client.from_env()
@@ -36,7 +40,7 @@ async def bootstrap(
     if name is None:
         if not names:
             output_manager.print("No templates available. Try updating modal.")
-            raise typer.Exit(1)
+            raise SystemExit(1)
         try:
             selector = Selector(names, title="Select a template", highlight_style=f"bold {GREEN}")
             name = selector.run()
@@ -45,13 +49,13 @@ async def bootstrap(
             for n in names:
                 output_manager.print(f"  - {n}")
             output_manager.print("\nRun `modal bootstrap <name>` to select a template.")
-            raise typer.Exit(0)
+            raise SystemExit(0)
 
     item = next((item for item in resp.items if item.name == name), None)
     if item is None:
         output_manager.print(f"Unknown template: {name}")
         output_manager.print(f"Available templates: {', '.join(names)}")
-        raise typer.Exit(1)
+        raise SystemExit(1)
 
     template_root = Path(output)
     template_root.mkdir(parents=True, exist_ok=True)
@@ -76,7 +80,7 @@ async def bootstrap(
                 await session.close()
         except Exception as e:
             output_manager.print(f"Failed to download template from {archive_url}: {e}")
-            raise typer.Exit(1)
+            raise SystemExit(1)
 
     try:
         zf = zipfile.ZipFile(io.BytesIO(data))
@@ -85,7 +89,7 @@ async def bootstrap(
     except Exception as e:
         logger.debug(f"Failed to parse template archive: {e}")
         output_manager.print(f"Unable to fetch template '{name}'.")
-        raise typer.Exit(1)
+        raise SystemExit(1)
 
     with zf:
         template_prefix = root_prefix + name + "/"
@@ -98,7 +102,7 @@ async def bootstrap(
 
         if not members:
             output_manager.print(f"Template '{name}' not found in repository.")
-            raise typer.Exit(1)
+            raise SystemExit(1)
 
         if dest.exists() and force:
             shutil.rmtree(dest)
@@ -112,7 +116,7 @@ async def bootstrap(
             if not out_path.is_relative_to(resolved_dest):
                 logger.debug(f"Zip entry escapes destination: {member!r}")
                 output_manager.print(f"Unable to fetch template '{name}'.")
-                raise typer.Exit(1)
+                raise SystemExit(1)
             if member.endswith("/"):
                 out_path.mkdir(parents=True, exist_ok=True)
             else:

modal/cli/changelog.py

@@ -5,10 +5,12 @@ import urllib.request
 from dataclasses import asdict, dataclass
 from typing import Optional
 
-import typer
+import click
 
 from modal._vendor.version import Version
 
+from ._help import ModalCommand
+
 CHANGELOG_URL = "https://modal.com/docs/reference/changelog.md"
 
 
@@ -73,7 +75,7 @@ def _filter_entries(
     if for_version is not None:
         n = len(for_version.split("."))
         if n not in (2, 3):
-            raise typer.BadParameter(f"Invalid version format: {for_version!r}. Use X.Y or X.Y.Z.")
+            raise click.BadParameter(f"Invalid version format: {for_version!r}. Use X.Y or X.Y.Z.")
         fv = Version(for_version)
         return [e for e in entries if Version(e.version).release[:n] == fv.release[:n]]
     if newer:
@@ -93,19 +95,20 @@ def _format_entries(entries: list[ChangelogEntry], *, as_json: bool) -> str:
     return "\n\n".join(parts)
 
 
+@click.command("changelog", cls=ModalCommand)
+@click.option("--last", default=None, type=int, help="Show the N most recent entries before the installed version.")
+@click.option("--since", default=None, help="Show entries after a version (X.Y.Z) or date (YYYY-MM-DD), exclusive.")
+@click.option("--for", "for_version", default=None, help="Show entries for a version (X.Y.Z) or series (X.Y).")
+@click.option("--newer", is_flag=True, default=False, help="Show entries newer than the installed version.")
+@click.option("--all", "all", is_flag=True, default=False, help="Show all entries.")
+@click.option("--json", "json", is_flag=True, default=False, help="Output as JSON.")
 def changelog(
-    last: Optional[int] = typer.Option(
-        None, "--last", help="Show the N most recent entries before the installed version."
-    ),
-    since: Optional[str] = typer.Option(
-        None, "--since", help="Show entries after a version (X.Y.Z) or date (YYYY-MM-DD), exclusive."
-    ),
-    for_version: Optional[str] = typer.Option(
-        None, "--for", help="Show entries for a version (X.Y.Z) or series (X.Y)."
-    ),
-    newer: bool = typer.Option(False, "--newer", help="Show entries newer than the installed version."),
-    all: bool = typer.Option(False, "--all", help="Show all entries."),
-    json: bool = typer.Option(False, "--json", help="Output as JSON."),
+    last: Optional[int],
+    since: Optional[str],
+    for_version: Optional[str],
+    newer: bool,
+    all: bool,
+    json: bool,
 ):
     """Fetch release notes from the Modal changelog.
 
@@ -137,7 +140,7 @@ def changelog(
 
     filter_flags = sum([last is not None, since is not None, for_version is not None, newer, all])
     if filter_flags > 1:
-        raise typer.BadParameter("Only one of --last, --since, --for, --newer, or --all may be used at a time.")
+        raise click.BadParameter("Only one of --last, --since, --for, --newer, or --all may be used at a time.")
 
     markdown = _fetch_changelog_markdown()
     entries = _parse_entries(markdown)
@@ -152,8 +155,8 @@ def changelog(
     )
 
     if not filtered:
-        typer.echo("No changelog entries found.")
-        raise typer.Exit()
+        click.echo("No changelog entries found.")
+        raise SystemExit(0)
 
     output = _format_entries(filtered, as_json=json)
-    typer.echo(output)
+    click.echo(output)

modal/cli/cluster.py

@@ -1,7 +1,7 @@
 # Copyright Modal Labs 2022
 from typing import Optional, Union
 
-import typer
+import click
 from rich.table import Column
 from rich.text import Text
 
@@ -9,7 +9,7 @@ from modal._object import _get_environment_name
 from modal._output.pty import get_pty_info
 from modal._utils.async_utils import synchronizer
 from modal._utils.time_utils import timestamp_to_localized_str
-from modal.cli.utils import ENV_OPTION, display_table, is_tty
+from modal.cli.utils import display_table, env_option, is_tty
 from modal.client import _Client
 from modal.config import config
 from modal.container_process import _ContainerProcess
@@ -18,14 +18,16 @@ from modal.output import OutputManager
 from modal.stream_type import StreamType
 from modal_proto import api_pb2
 
-cluster_cli = typer.Typer(
-    name="cluster", help="Manage and connect to running multi-node clusters.", no_args_is_help=True
-)
+from ._help import ModalGroup
+
+cluster_cli = ModalGroup(name="cluster", help="Manage and connect to running multi-node clusters.")
 
 
 @cluster_cli.command("list")
+@env_option
+@click.option("--json", is_flag=True, default=False)
 @synchronizer.create_blocking
-async def list_(env: Optional[str] = ENV_OPTION, json: bool = False):
+async def list_(env: Optional[str] = None, json: bool = False):
     """List all clusters that are currently running."""
     env = ensure_env(env)
     client = await _Client.from_env()
@@ -57,16 +59,15 @@ async def list_(env: Optional[str] = ENV_OPTION, json: bool = False):
 
 
 @cluster_cli.command("shell")
+@click.argument("cluster_id")
+@click.option("--rank", default=0, help="Rank of the node to shell into")
 @synchronizer.create_blocking
-async def shell(
-    cluster_id: str = typer.Argument(help="Cluster ID"),
-    rank: int = typer.Option(default=0, help="Rank of the node to shell into"),
-):
+async def shell(cluster_id: str, rank: int = 0):
     """Open a shell to a multi-node cluster node."""
     client = await _Client.from_env()
     res: api_pb2.ClusterGetResponse = await client.stub.ClusterGet(api_pb2.ClusterGetRequest(cluster_id=cluster_id))
     if len(res.cluster.task_ids) <= rank:
-        raise typer.Abort(f"No node with rank {rank} in cluster {cluster_id}")
+        raise click.ClickException(f"No node with rank {rank} in cluster {cluster_id}")
     task_id = res.cluster.task_ids[rank]
     is_main = "(main)" if rank == 0 else ""
     OutputManager.get().print(

modal/cli/config.py

@@ -1,13 +1,15 @@
 # Copyright Modal Labs 2022
 import json
 
-import typer
+import click
 
 from modal.config import _profile, _store_user_config, config
 from modal.environments import Environment
 from modal.output import OutputManager
 
-config_cli = typer.Typer(
+from ._help import ModalGroup
+
+config_cli = ModalGroup(
     name="config",
     help="""
     Manage client configuration for the current profile.
@@ -15,12 +17,12 @@ config_cli = typer.Typer(
     Refer to https://modal.com/docs/reference/modal.config for a full explanation
     of what these options mean, and how to set them.
     """,
-    no_args_is_help=True,
 )
 
 
-@config_cli.command(help="Show current configuration values (debugging command).")
-def show(redact: bool = typer.Option(True, help="Redact the `token_secret` value.")):
+@config_cli.command("show", help="Show current configuration values (debugging command).")
+@click.option("--redact/--no-redact", default=True, help="Redact the `token_secret` value.")
+def show(redact: bool):
     # This is just a test command
     config_dict = config.to_dict()
     if redact and config_dict.get("token_secret"):
@@ -38,14 +40,17 @@ when running a command that requires an environment.
 """
 
 
-@config_cli.command(help=SET_DEFAULT_ENV_HELP)
+@config_cli.command("set-environment", help=SET_DEFAULT_ENV_HELP)
+@click.argument("environment_name")
 def set_environment(environment_name: str):
     # Confirm that the environment exists by looking it up
     Environment.from_name(environment_name).hydrate()
     _store_user_config({"environment": environment_name})
-    typer.echo(f"New default environment for profile {_profile}: {environment_name}")
+    click.echo(f"New default environment for profile {_profile}: {environment_name}")
 
 
-@config_cli.command(hidden=True)
+@config_cli.command("set", hidden=True)
+@click.argument("key")
+@click.argument("value")
 def set(key: str, value: str):
     _store_user_config({key: value})

modal/cli/container.py

@@ -3,7 +3,7 @@ import warnings
 from datetime import datetime, timezone
 from typing import Optional, Union
 
-import typer
+import click
 from click import UsageError
 from rich.table import Column
 from rich.text import Text
@@ -15,14 +15,14 @@ from modal._utils.async_utils import synchronizer
 from modal._utils.time_utils import timestamp_to_localized_str
 from modal.cli.app import _DEFAULT_LOGS_TAIL, _SOURCE_OPTIONS, _parse_time_arg
 from modal.cli.utils import (
-    ENV_OPTION,
-    YES_OPTION,
     confirm_or_suggest_yes,
     display_table,
+    env_option,
     fetch_app_logs,
     is_tty,
     stream_app_logs,
     tail_app_logs,
+    yes_option,
 )
 from modal.client import _Client
 from modal.config import config
@@ -32,14 +32,19 @@ from modal.exception import InvalidError
 from modal.stream_type import StreamType
 from modal_proto import api_pb2
 
-container_cli = typer.Typer(name="container", help="Manage and connect to running containers.", no_args_is_help=True)
+from ._help import ModalGroup
+
+container_cli = ModalGroup(name="container", help="Manage and connect to running containers.")
 
 
 @container_cli.command("list")
+@click.option("--app-id", default="", help="List containers running for a specific App.")
+@env_option
+@click.option("--json", is_flag=True, default=False)
 @synchronizer.create_blocking
 async def list_(
-    app_id: str = typer.Option("", "--app-id", help="List containers running for a specific App."),
-    env: Optional[str] = ENV_OPTION,
+    app_id: str = "",
+    env: Optional[str] = None,
     json: bool = False,
 ):
     """List all containers that are currently running."""
@@ -72,29 +77,30 @@ async def list_(
 
 
 @container_cli.command("logs", no_args_is_help=True)
+@click.argument("container_id")
+@click.option("-f", "--follow", is_flag=True, default=False, help="Stream log output until Container stops")
+@click.option("--all", "all_logs", is_flag=True, default=False, help="Show all logs for the container")
+@click.option(
+    "--since",
+    default=None,
+    help="Start of time range. Accepts ISO 8601 datetime or relative time, e.g. '1d' (1 day ago), '2h', '30m', etc.",
+)
+@click.option("--until", default=None, help="End of time range; accepts same argument types as --since")
+@click.option("-n", "--tail", default=None, type=int, help="Show only the last N log entries")
+@click.option("--search", default=None, help="Filter by search text")
+@click.option("-s", "--source", default=None, help="Filter by source: 'stdout', 'stderr', or 'system'")
+@click.option("--timestamps", is_flag=True, default=False, help="Prefix each line with its timestamp")
 @synchronizer.create_blocking
 async def logs(
-    container_id: str = typer.Argument(help="Container ID"),
-    follow: bool = typer.Option(False, "-f", "--follow", help="Stream log output until Container stops"),
-    all_logs: bool = typer.Option(False, "--all", help="Show all logs for the container"),
-    since: Optional[str] = typer.Option(
-        None,
-        "--since",
-        help=(
-            "Start of time range. Accepts ISO 8601 datetime or relative time, e.g. '1d' (1 day ago), '2h', '30m', etc."
-        ),
-    ),
-    until: Optional[str] = typer.Option(
-        None,
-        "--until",
-        help="End of time range; accepts same argument types as --since",
-    ),
-    tail: Optional[int] = typer.Option(None, "--tail", "-n", help="Show only the last N log entries"),
-    search: Optional[str] = typer.Option(None, "--search", help="Filter by search text"),
-    source: Optional[str] = typer.Option(
-        None, "--source", "-s", help="Filter by source: 'stdout', 'stderr', or 'system'"
-    ),
-    timestamps: bool = typer.Option(False, "--timestamps", help="Prefix each line with its timestamp"),
+    container_id: str,
+    follow: bool = False,
+    all_logs: bool = False,
+    since: Optional[str] = None,
+    until: Optional[str] = None,
+    tail: Optional[int] = None,
+    search: Optional[str] = None,
+    source: Optional[str] = None,
+    timestamps: bool = False,
 ):
     """Fetch or stream logs for a specific container.
 
@@ -257,18 +263,13 @@ async def logs(
             )
 
 
-@container_cli.command("exec")
 @synchronizer.create_blocking
-async def exec(
-    pty: Optional[bool] = typer.Option(default=None, help="Run the command using a PTY."),
-    container_id: str = typer.Argument(help="Container ID"),
-    command: list[str] = typer.Argument(
-        help="A command to run inside the container.\n\n"
-        "To pass command-line flags or options, add `--` before the start of your commands. "
-        "For example: `modal container exec <id> -- /bin/bash -c 'echo hi'`"
-    ),
+async def _exec_impl(
+    pty: Optional[bool] = None,
+    container_id: str = "",
+    command: tuple[str, ...] = (),
 ):
-    """Execute a command in a container."""
+    """Execute a command in a container (implementation)."""
 
     if pty is None:
         pty = is_tty()
@@ -292,16 +293,29 @@ async def exec(
         ).wait()
 
 
+@container_cli.command("exec")
+@click.option("--pty/--no-pty", default=None, help="Run the command using a PTY.")
+@click.argument("container_id")
+@click.argument("command", nargs=-1, required=True)
+def exec(
+    pty: Optional[bool] = None,
+    container_id: str = "",
+    command: tuple[str, ...] = (),
+):
+    """Execute a command in a container."""
+    _exec_impl(pty=pty, container_id=container_id, command=command)
+
+
 @container_cli.command("stop")
+@click.argument("container_id")
+@yes_option
 @synchronizer.create_blocking
-async def stop(
-    container_id: str = typer.Argument(help="Container ID"),
-    *,
-    yes: bool = YES_OPTION,
-):
-    """Stop a currently-running container and reassign its in-progress inputs.
+async def stop(container_id: str = "", *, yes: bool = False):
+    """Terminate a running container.
 
     This will send the container a SIGINT signal that Modal will handle.
+    Any inputs that are currently running on the container will be cancelled and rescheduled
+    on other containers.
     """
     client = await _Client.from_env()
     resp = await client.stub.TaskGetInfo(api_pb2.TaskGetInfoRequest(task_id=container_id))

modal/cli/dashboard.py

@@ -1,7 +1,7 @@
 # Copyright Modal Labs 2026
 from typing import Optional
 
-import typer
+import click
 
 from modal._utils.async_utils import synchronizer
 from modal._utils.browser_utils import open_url_and_display
@@ -9,10 +9,14 @@ from modal.client import _Client
 from modal.config import config
 from modal_proto import api_pb2
 
+from ._help import ModalCommand
 
+
+@click.command("dashboard", cls=ModalCommand)
+@click.argument("object_id", default=None, required=False)
 @synchronizer.create_blocking
 async def dashboard(
-    object_id: Optional[str] = typer.Argument(None, help="Open a view for a specific object."),
+    object_id: Optional[str] = None,
 ):
     """Open the Modal Dashboard in a web browser."""
     if object_id: