modal 1.4.2.dev6__tar.gz → 1.4.2.dev7__tar.gz

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.4.2.dev6
+Version: 1.4.2.dev7
 Summary: Python client library for Modal
 Author-email: Modal Labs <support@modal.com>
 License-Expression: Apache-2.0

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/modal/cli/app.py

@@ -20,13 +20,22 @@ from modal._utils.async_utils import synchronizer
 from modal._utils.browser_utils import open_url_and_display
 from modal.client import _Client
 from modal.environments import ensure_env
+from modal.exception import InvalidError, NotFoundError
 from modal.output import OutputManager
 from modal.runner import DEPLOYMENT_STRATEGY_TYPE, _stop_and_wait_for_containers
 from modal_proto import api_pb2
 
 from .._logs import _FETCH_LIMIT, _MAX_FETCH_RANGE, LogsFilters
 from .._utils.time_utils import locale_tz, timestamp_to_localized_str
-from .utils import ENV_OPTION, display_table, fetch_app_logs, get_app_id_from_name, stream_app_logs, tail_app_logs
+from .utils import (
+    ENV_OPTION,
+    YES_OPTION,
+    confirm_or_suggest_yes,
+    display_table,
+    fetch_app_logs,
+    stream_app_logs,
+    tail_app_logs,
+)
 
 APP_IDENTIFIER = Argument("", help="App name or ID")
 NAME_OPTION = typer.Option("", "-n", "--name", help="Deprecated: Pass App name as a positional argument")
@@ -45,12 +54,50 @@ APP_STATE_TO_MESSAGE = {
 }
 
 
-@synchronizer.create_blocking
-async def get_app_id(app_identifier: str, env: Optional[str], client: Optional[_Client] = None) -> str:
-    """Resolve an app_identifier that may be a name or an ID into an ID."""
+async def resolve_app_identifier(
+    app_identifier: str, env: Optional[str], client: Optional[_Client] = None
+) -> tuple[str, str, api_pb2.AppLifecycle]:  # Return app_id, environment_name, lifecycle
+    """Handle an App ID or an App name and return context about the App it points at.
+
+    When a name is provided, we may retrieve either a currently deployed App or an App that
+    was recently stopped (if no other App with that name has been deployed since).
+    It is up to callers of this function to decide whether it's valid to use the App ID
+    based on the lifecycle returned and their specific operations.
+
+    Can also raise a NotFoundError if the argument matches the App ID regex but the App
+    doesn't exist on the backend, or if there is no currently deployed or recently stopped App
+    with that name.
+
+    The function also always returns a valid environment name for any name-based lookups,
+    which may reflect the server-defined default environment when the provided argument was null.
+
+    """
+    if client is None:
+        client = await _Client.from_env()
     if re.match(r"^ap-[a-zA-Z0-9]{22}$", app_identifier):
-        return app_identifier
-    return await get_app_id_from_name.aio(app_identifier, env, client)
+        # Identifier is an App ID. This is unambiguous, so we can make the request and return
+        # the lifecycle. AppGetLifecycle will raise NotFoundError if the ID doesn't point at an App.
+        # If we return, it's a real App, but it's up to the caller to decide what to do based on
+        # the App's current state as conveyed by the lifecycle. We do propagate a NotFoundError
+        # from the server if the App ID doesn't actually exist.
+        request = api_pb2.AppGetLifecycleRequest(app_id=app_identifier)
+        resp = await client.stub.AppGetLifecycle(request)
+        return app_identifier, "", resp.lifecycle
+    else:
+        # Identifier is treated as a name, which may or may not point at a currently deployed App
+        # (inside a specific environment)
+        request = api_pb2.AppGetByDeploymentNameRequest(name=app_identifier, environment_name=env or "")
+        resp = await client.stub.AppGetByDeploymentName(request)
+        if resp.app_id:
+            # App is currently deployed
+            return resp.app_id, resp.environment_name, resp.lifecycle
+        elif resp.previous_app_id:
+            # An App with this name was recently stopped. Return the ID of the stopped App
+            # and let callers decide what to do based on the lifecycle.
+            return resp.previous_app_id, resp.environment_name, resp.lifecycle
+        else:
+            msg = f"No App with name '{app_identifier}' found in the '{resp.environment_name}' environment."
+            raise NotFoundError(msg)
 
 
 @app_cli.command("list")
@@ -129,7 +176,8 @@ _SOURCE_OPTIONS = {
 
 
 @app_cli.command("logs", no_args_is_help=True)
-def logs(
+@synchronizer.create_blocking
+async def logs(
     app_identifier: str = APP_IDENTIFIER,
     follow: bool = typer.Option(False, "-f", "--follow", help="Stream log output until App stops"),
     since: Optional[str] = typer.Option(
@@ -229,7 +277,7 @@ def logs(
     if tail is not None and tail > _FETCH_LIMIT:
         raise UsageError(f"--tail value must not exceed {_FETCH_LIMIT}.")
 
-    app_id = get_app_id(app_identifier, env)
+    app_id, _, _ = await resolve_app_identifier(app_identifier, env)
 
     if source is not None:
         if source not in _SOURCE_OPTIONS:
@@ -255,7 +303,7 @@ def logs(
     )
 
     if follow:
-        stream_app_logs(
+        await stream_app_logs.aio(
             app_id,
             task_id=container_id or "",
             show_timestamps=timestamps,
@@ -278,7 +326,7 @@ def logs(
 
         if since and tail is None:
             # Range mode: --since without --tail fetches everything in the range.
-            fetch_app_logs(
+            await fetch_app_logs.aio(
                 app_id,
                 since_dt,
                 until_dt or now,
@@ -290,7 +338,7 @@ def logs(
             # Tail mode: single fetch with limit.
             # --since is a hard floor, --until shifts the anchor.
             effective_tail = tail if tail is not None else _DEFAULT_LOGS_TAIL
-            tail_app_logs(
+            await tail_app_logs.aio(
                 app_id,
                 effective_tail,
                 show_timestamps=timestamps,
@@ -338,14 +386,18 @@ async def rollback(
     """
     env = ensure_env(env)
     client = await _Client.from_env()
-    app_id = await get_app_id.aio(app_identifier, env, client)
+    app_id, environment_name, lifecycle = await resolve_app_identifier(app_identifier, env, client)
+    if lifecycle.app_state != api_pb2.APP_STATE_DEPLOYED:
+        env_suffix = f" in the '{environment_name}' environment" if environment_name else ""
+        raise InvalidError(f"App '{app_identifier}' is not deployed{env_suffix}.")
+
     if not version:
         version_number = -1
     else:
         if m := re.match(r"v(\d+)", version):
             version_number = int(m.group(1))
         else:
-            raise UsageError(f"Invalid version specifer: {version}")
+            raise UsageError(f"Invalid version specifier: {version}")
     req = api_pb2.AppRollbackRequest(app_id=app_id, version=version_number)
     await client.stub.AppRollback(req)
     rich.print("[green]✓[/green] Deployment rollback successful!")
@@ -363,7 +415,7 @@ async def rollover(
     ),
     env: Optional[str] = ENV_OPTION,
 ):
-    """Rollover an App.
+    """Redeploy an App to get new containers without code changes.
 
     A rollover replaces existing containers with fresh ones built from the same
     App version — useful for refreshing containers without changing your code.
@@ -372,13 +424,13 @@ async def rollover(
     **Examples:**
 
     Rollover an App using a rolling deployment. Running containers are now considered
-    outdated and new containers will replace them.
+    outdated and will be gracefully replaced by new ones.
 
     ```
     modal app rollover my-app
     ```
 
-    Rollover an App by termatining all running containers. Inputs on the queue will
+    Rollover an App by terminating any running containers. Inputs on the queue will
     start new containers.
 
     ```
@@ -386,13 +438,17 @@ async def rollover(
     ```
     """
     env = ensure_env(env)
+    client = await _Client.from_env()
+
+    app_id, environment_name, lifecycle = await resolve_app_identifier(app_identifier, env, client)
+    if lifecycle.app_state != api_pb2.APP_STATE_DEPLOYED:
+        env_suffix = f" in the '{environment_name}' environment" if environment_name else ""
+        raise InvalidError(f"App '{app_identifier}' is not deployed{env_suffix}.")
+
     output_mgr = OutputManager.get()
     output_mgr.print(f"🔨 Starting app rollover with {strategy} strategy")
     t0 = time.monotonic()
 
-    client = await _Client.from_env()
-    app_id = await get_app_id.aio(app_identifier, env, client)
-
     req = api_pb2.AppRolloverRequest(app_id=app_id)
     response = await client.stub.AppRollover(req)
     print_server_warnings(response.server_warnings)
@@ -415,11 +471,40 @@ async def rollover(
 async def stop(
     app_identifier: str = APP_IDENTIFIER,
     *,
+    yes: bool = YES_OPTION,
     env: Optional[str] = ENV_OPTION,
 ):
-    """Stop an app."""
+    """Permanently stop an App and terminate its running containers."""
+    env = ensure_env(env)
     client = await _Client.from_env()
-    app_id = await get_app_id.aio(app_identifier, env)
+    app_id, environment_name, lifecycle = await resolve_app_identifier(app_identifier, env, client)
+
+    if lifecycle.app_state == api_pb2.APP_STATE_STOPPED:
+        msg = "App is already stopped."
+        if lifecycle.stopped_at:
+            stopped_at = timestamp_to_localized_str(lifecycle.stopped_at)
+            verb = "Stopped" if lifecycle.stopped_by else "Finished"
+            attribution = f" by '{lifecycle.stopped_by}'" if lifecycle.stopped_by else ""
+            msg += f" ({verb} at {stopped_at}{attribution})."
+        raise SystemExit(msg)
+
+    if not yes:
+        res = await client.stub.TaskList(api_pb2.TaskListRequest(app_id=app_id))
+        num_containers = len(res.tasks)
+
+        if environment_name:
+            msg = f"Are you sure you want to stop App '{app_identifier}' in the '{environment_name}' environment?"
+        else:
+            msg = f"Are you sure you want to stop App '{app_identifier}'?"
+
+        if num_containers:
+            msg += (
+                f" This will immediately terminate {num_containers} running"
+                f" container{'s' if num_containers != 1 else ''}."
+            )
+        else:
+            msg += " No containers are currently running."
+        confirm_or_suggest_yes(msg)
     req = api_pb2.AppStopRequest(app_id=app_id, source=api_pb2.APP_STOP_SOURCE_CLI)
     await client.stub.AppStop(req)
 
@@ -432,7 +517,7 @@ async def history(
     env: Optional[str] = ENV_OPTION,
     json: bool = False,
 ):
-    """Show App deployment history, for a currently deployed app
+    """Show an App's deployment history.
 
     **Examples:**
 
@@ -442,7 +527,7 @@ async def history(
     modal app history ap-123456
     ```
 
-    Get the history for a currently deployed App based on its name:
+    Get the history for an App based on its name:
 
     ```
     modal app history my-app
@@ -451,7 +536,7 @@ async def history(
     """
     env = ensure_env(env)
     client = await _Client.from_env()
-    app_id = await get_app_id.aio(app_identifier, env, client)
+    app_id, _, _ = await resolve_app_identifier(app_identifier, env, client)
     resp = await client.stub.AppDeploymentHistory(api_pb2.AppDeploymentHistoryRequest(app_id=app_id))
 
     columns = [
@@ -526,7 +611,6 @@ async def dashboard(
     ```
     """
     client = await _Client.from_env()
-    app_id = await get_app_id.aio(app_identifier, env, client)
-
+    app_id, _, _ = await resolve_app_identifier(app_identifier, env, client)
     url = f"https://modal.com/id/{app_id}"
     open_url_and_display(url, "App dashboard")

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/modal/cli/container.py

@@ -14,7 +14,16 @@ 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.app import _DEFAULT_LOGS_TAIL, _SOURCE_OPTIONS, _parse_time_arg
-from modal.cli.utils import ENV_OPTION, display_table, fetch_app_logs, is_tty, stream_app_logs, tail_app_logs
+from modal.cli.utils import (
+    ENV_OPTION,
+    YES_OPTION,
+    confirm_or_suggest_yes,
+    display_table,
+    fetch_app_logs,
+    is_tty,
+    stream_app_logs,
+    tail_app_logs,
+)
 from modal.client import _Client
 from modal.config import config
 from modal.container_process import _ContainerProcess
@@ -285,11 +294,20 @@ async def exec(
 
 @container_cli.command("stop")
 @synchronizer.create_blocking
-async def stop(container_id: str = typer.Argument(help="Container ID")):
+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.
 
     This will send the container a SIGINT signal that Modal will handle.
     """
     client = await _Client.from_env()
+    resp = await client.stub.TaskGetInfo(api_pb2.TaskGetInfoRequest(task_id=container_id))
+    if resp.info.finished_at:
+        raise SystemExit(f"Container '{container_id}' is already stopped.")
+    if not yes:
+        confirm_or_suggest_yes(f"Are you sure you want to stop container '{container_id}'?")
     request = api_pb2.ContainerStopRequest(task_id=container_id)
     await client.stub.ContainerStop(request)

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/modal/cli/utils.py

@@ -1,6 +1,7 @@
 # Copyright Modal Labs 2022
 import asyncio
 import io
+import sys
 from collections.abc import Sequence
 from contextlib import nullcontext
 from csv import writer as csv_writer
@@ -12,14 +13,11 @@ import typer
 from rich.table import Column, Table
 from rich.text import Text
 
-from modal_proto import api_pb2
-
 from .._logs import LogsFilters, fetch_logs, tail_logs
 from .._output.pty import _build_log_prefix, get_app_logs_loop
 from .._utils.async_utils import synchronizer
 from ..client import _Client
-from ..environments import ensure_env
-from ..exception import InvalidError, NotFoundError
+from ..exception import InvalidError
 from ..output import OutputManager
 
 
@@ -125,19 +123,6 @@ async def fetch_app_logs(
     await _drain_batches(output_mgr, batches, prefix_fields or [], filters.search_text)
 
 
-@synchronizer.create_blocking
-async def get_app_id_from_name(name: str, env: Optional[str], client: Optional[_Client] = None) -> str:
-    if client is None:
-        client = await _Client.from_env()
-    env_name = ensure_env(env)
-    request = api_pb2.AppGetByDeploymentNameRequest(name=name, environment_name=env_name)
-    resp = await client.stub.AppGetByDeploymentName(request)
-    if not resp.app_id:
-        env_comment = f" in the '{env_name}' environment" if env_name else ""
-        raise NotFoundError(f"Could not find a deployed app named '{name}'{env_comment}.")
-    return resp.app_id
-
-
 def _plain(text: Union[Text, str]) -> str:
     return text.plain if isinstance(text, Text) else text
 
@@ -185,3 +170,11 @@ Otherwise, raises an error if the workspace has multiple environments.
 ENV_OPTION = typer.Option(None, "-e", "--env", help=ENV_OPTION_HELP)
 
 YES_OPTION = typer.Option(False, "-y", "--yes", help="Run without pausing for confirmation.")
+
+
+def confirm_or_suggest_yes(msg: str) -> None:
+    """Prompt for confirmation, or abort with a hint to use --yes if stdin is not a TTY."""
+    if not sys.stdin.isatty():
+        typer.echo(f"{msg} [y/N]: ")
+        raise SystemExit("Aborted: no interactive terminal detected. Rerun with --yes (-y) to skip confirmation.")
+    typer.confirm(msg, default=False, abort=True)

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/modal/client.pyi

@@ -35,7 +35,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.4.2.dev6",
+        version: str = "1.4.2.dev7",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -171,7 +171,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.4.2.dev6",
+        version: str = "1.4.2.dev7",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/modal/functions.pyi

@@ -348,7 +348,7 @@ class Function(
 
     _call_generator: ___call_generator_spec
 
-    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> ReturnType_INNER:
             """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
             ...
@@ -357,7 +357,7 @@ class Function(
             """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
             ...
 
-    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P]
+    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType]
 
     class __remote_gen_spec(typing_extensions.Protocol):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -384,7 +384,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
             """[Experimental] Calls the function with the given arguments, without waiting for the results.
 
@@ -407,7 +407,7 @@ class Function(
             """
             ...
 
-    _experimental_spawn: ___experimental_spawn_spec[modal._functions.ReturnType, modal._functions.P]
+    _experimental_spawn: ___experimental_spawn_spec[modal._functions.P, modal._functions.ReturnType]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> None: ...
@@ -415,7 +415,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P]
 
-    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
             """Calls the function with the given arguments, without waiting for the results.
 
@@ -436,7 +436,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P]
+    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function."""

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/modal/image.py

@@ -1644,6 +1644,7 @@ class _Image(_Object, type_prefix="im"):
         context_dir: Optional[Union[Path, str]] = None,  # Context for relative COPY commands
         force_build: bool = False,  # Ignore cached builds, similar to 'docker build --no-cache'
         ignore: Union[Sequence[str], Callable[[Path], bool]] = AUTO_DOCKERIGNORE,
+        build_args: dict[str, str] = {},  # Dockerfile variables to set
     ) -> "_Image":
         """
         Extend an image with arbitrary Dockerfile-like commands.
@@ -1706,6 +1707,7 @@ class _Image(_Object, type_prefix="im"):
                 ignore=ignore, dockerfile_cmds=cmds, context_dir=context_dir
             ),
             force_build=self.force_build or force_build,
+            build_args=build_args,
         )
 
     def entrypoint(

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/modal/image.pyi

@@ -623,6 +623,7 @@ class _Image(modal._object._Object):
         ignore: typing.Union[
             collections.abc.Sequence[str], collections.abc.Callable[[pathlib.Path], bool]
         ] = modal.image.AUTO_DOCKERIGNORE,
+        build_args: dict[str, str] = {},
     ) -> _Image:
         """Extend an image with arbitrary Dockerfile-like commands.
 
@@ -1619,6 +1620,7 @@ class Image(modal.object.Object):
         ignore: typing.Union[
             collections.abc.Sequence[str], collections.abc.Callable[[pathlib.Path], bool]
         ] = modal.image.AUTO_DOCKERIGNORE,
+        build_args: dict[str, str] = {},
     ) -> Image:
         """Extend an image with arbitrary Dockerfile-like commands.
 

{modal-1.4.2.dev6 → modal-1.4.2.dev7}/modal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.4.2.dev6
+Version: 1.4.2.dev7
 Summary: Python client library for Modal
 Author-email: Modal Labs <support@modal.com>
 License-Expression: Apache-2.0