modal 0.74.55__py3-none-any.whl → 0.74.56__py3-none-any.whl

modal/cli/cluster.py

@@ -0,0 +1,82 @@
+# Copyright Modal Labs 2022
+from typing import Optional, Union
+
+import typer
+from rich.console import Console
+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.cli.utils import ENV_OPTION, display_table, is_tty, timestamp_to_local
+from modal.client import _Client
+from modal.config import config
+from modal.container_process import _ContainerProcess
+from modal.environments import ensure_env
+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
+)
+
+
+@cluster_cli.command("list")
+@synchronizer.create_blocking
+async def list_(env: Optional[str] = ENV_OPTION, json: bool = False):
+    """List all clusters that are currently running."""
+    env = ensure_env(env)
+    client = await _Client.from_env()
+    environment_name = _get_environment_name(env)
+    res: api_pb2.ClusterListResponse = await client.stub.ClusterList(
+        api_pb2.ClusterListRequest(environment_name=environment_name)
+    )
+
+    column_names = ["Cluster ID", "App ID", "Start Time", "Nodes"]
+    rows: list[list[Union[Text, str]]] = []
+    res.clusters.sort(key=lambda c: c.started_at, reverse=True)
+
+    for c in res.clusters:
+        rows.append(
+            [
+                c.cluster_id,
+                c.app_id,
+                timestamp_to_local(c.started_at, json) if c.started_at else "Pending",
+                str(len(c.task_ids)),
+            ]
+        )
+
+    display_table(column_names, rows, json=json, title=f"Active Multi-node Clusters in environment: {environment_name}")
+
+
+@cluster_cli.command("shell")
+@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"),
+):
+    """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}")
+    task_id = res.cluster.task_ids[rank]
+    console = 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"
+    )
+
+    pty = is_tty()
+    req = api_pb2.ContainerExecRequest(
+        task_id=task_id,
+        command=["/bin/bash"],
+        pty_info=get_pty_info(shell=True) if pty else None,
+        runtime_debug=config.get("function_runtime_debug"),
+    )
+    exec_res: api_pb2.ContainerExecResponse = await client.stub.ContainerExec(req)
+    if pty:
+        await _ContainerProcess(exec_res.exec_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()

modal/cli/entry_point.py

@@ -10,6 +10,7 @@ from modal._utils.async_utils import synchronizer
 
 from . import run
 from .app import app_cli
+from .cluster import cluster_cli
 from .config import config_cli
 from .container import container_cli
 from .dict import dict_cli
@@ -92,6 +93,8 @@ entrypoint_cli_typer.add_typer(launch_cli)
 # Deployments
 entrypoint_cli_typer.add_typer(app_cli, rich_help_panel="Deployments")
 entrypoint_cli_typer.add_typer(container_cli, rich_help_panel="Deployments")
+# TODO: cluster is hidden while multi-node is in beta/experimental
+entrypoint_cli_typer.add_typer(cluster_cli, rich_help_panel="Deployments", hidden=True)
 
 # Storage
 entrypoint_cli_typer.add_typer(dict_cli, rich_help_panel="Storage")

modal/client.pyi

@@ -27,7 +27,7 @@ class _Client:
     _snapshotted: bool
 
     def __init__(
-        self, server_url: str, client_type: int, credentials: typing.Optional[tuple[str, str]], version: str = "0.74.55"
+        self, server_url: str, client_type: int, credentials: typing.Optional[tuple[str, str]], version: str = "0.74.56"
     ): ...
     def is_closed(self) -> bool: ...
     @property
@@ -86,7 +86,7 @@ class Client:
     _snapshotted: bool
 
     def __init__(
-        self, server_url: str, client_type: int, credentials: typing.Optional[tuple[str, str]], version: str = "0.74.55"
+        self, server_url: str, client_type: int, credentials: typing.Optional[tuple[str, str]], version: str = "0.74.56"
     ): ...
     def is_closed(self) -> bool: ...
     @property

{modal-0.74.55.dist-info → modal-0.74.56.dist-info}/METADATA

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

{modal-0.74.55.dist-info → modal-0.74.56.dist-info}/RECORD

@@ -22,7 +22,7 @@ modal/app.py,sha256=r-9vVU1lrR1CWtJEo60fuaianvxY_oOXZyv1Qx1DEkI,51231
 modal/app.pyi,sha256=0QNtnUpAFbOPcbwCt119ge7OmoBqMFw5SajLgdE5eOw,28600
 modal/call_graph.py,sha256=1g2DGcMIJvRy-xKicuf63IVE98gJSnQsr8R_NVMptNc,2581
 modal/client.py,sha256=o-aQThHpvDHUzg_kUafyhWzACViUBhY2WLZ2EitnSHA,16787
-modal/client.pyi,sha256=9fUzrcuA2uqCuRxHuIZxhsTR-lopTQuKxs_VvusFdLY,8343
+modal/client.pyi,sha256=QrmnL4WEe1xp9xBSlNgy90e8f2BqH5331EUj6sI8ITo,8343
 modal/cloud_bucket_mount.py,sha256=YOe9nnvSr4ZbeCn587d7_VhE9IioZYRvF9VYQTQux08,5914
 modal/cloud_bucket_mount.pyi,sha256=30T3K1a89l6wzmEJ_J9iWv9SknoGqaZDx59Xs-ZQcmk,1607
 modal/cls.py,sha256=aHoMEWMZUN7bOezs3tRPxzS1FP3gTxZBORVjbPmtxyg,35338
@@ -118,10 +118,11 @@ modal/cli/__init__.py,sha256=6FRleWQxBDT19y7OayO4lBOzuL6Bs9r0rLINYYYbHwQ,769
 modal/cli/_download.py,sha256=t6BXZwjTd9MgznDvbsV8rp0FZWggdzC-lUAGZU4xx1g,3984
 modal/cli/_traceback.py,sha256=4ywtmFcmPnY3tqb4-3fA061N2tRiM01xs8fSagtkwhE,7293
 modal/cli/app.py,sha256=87LWg3bTQQIHFOqs8iiJYD_X03omXBZ6lFYR0rMJV-I,8433
+modal/cli/cluster.py,sha256=EBDhkzfOtPSbwknYdYPBGYvRAwl4Gm7OJkD6_zxrcus,3106
 modal/cli/config.py,sha256=QvFsqO4eUOtI7d_pQAOAyfq_ZitjhPtav3C6GIDQcZM,1680
 modal/cli/container.py,sha256=FYwEgjf93j4NMorAjGbSV98i1wpebqdAeNU1wfrFp1k,3668
 modal/cli/dict.py,sha256=8Wq3w-UDaywk8EVNdj-ECCNV9TYHqh4kzhUqhhulatM,4593
-modal/cli/entry_point.py,sha256=dOosuCwhfznwTCB4oMljUFhihq5aLUVoAz7RhcBEDnc,4189
+modal/cli/entry_point.py,sha256=Ytpsy0MTLQC1RSClI0wNhCbiy6ecPO8555PMmsrxoSc,4377
 modal/cli/environment.py,sha256=Ayddkiq9jdj3XYDJ8ZmUqFpPPH8xajYlbexRkzGtUcg,4334
 modal/cli/import_refs.py,sha256=pmzY0hpexx6DtvobNmCOvRqEdS9IriEP4BpMw1TIy2w,13911
 modal/cli/launch.py,sha256=0_sBu6bv2xJEPWi-rbGS6Ri9ggnkWQvrGlgpYSUBMyY,3097
@@ -145,7 +146,7 @@ modal/requirements/2024.10.txt,sha256=qD-5cVIVM9wXesJ6JC89Ew-3m2KjEElUz3jaw_MddR
 modal/requirements/PREVIEW.txt,sha256=qD-5cVIVM9wXesJ6JC89Ew-3m2KjEElUz3jaw_MddRo,296
 modal/requirements/README.md,sha256=9tK76KP0Uph7O0M5oUgsSwEZDj5y-dcUPsnpR0Sc-Ik,854
 modal/requirements/base-images.json,sha256=57vMSqzMbLBxw5tFWSaMiIkkVEps4JfX5PAtXGnkS4U,740
-modal-0.74.55.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+modal-0.74.56.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
 modal_docs/__init__.py,sha256=svYKtV8HDwDCN86zbdWqyq5T8sMdGDj0PVlzc2tIxDM,28
 modal_docs/gen_cli_docs.py,sha256=c1yfBS_x--gL5bs0N4ihMwqwX8l3IBWSkBAKNNIi6bQ,3801
 modal_docs/gen_reference_docs.py,sha256=d_CQUGQ0rfw28u75I2mov9AlS773z9rG40-yq5o7g2U,6359
@@ -170,9 +171,9 @@ modal_proto/options_pb2_grpc.pyi,sha256=CImmhxHsYnF09iENPoe8S4J-n93jtgUYD2JPAc0y
 modal_proto/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 modal_version/__init__.py,sha256=m94xZNWIjH8oUtJk4l9xfovzDJede2o7X-q0MHVECtM,470
 modal_version/__main__.py,sha256=2FO0yYQQwDTh6udt1h-cBnGd1c4ZyHnHSI4BksxzVac,105
-modal_version/_version_generated.py,sha256=OZ_XmoTkO3MCoksyO8lR_vFkMH1zV93AgoruWFvLPis,149
-modal-0.74.55.dist-info/METADATA,sha256=oCE7_7EOAb5XgRznncfj2CpEJmlHutoa2JPOv9cDg_I,2451
-modal-0.74.55.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-modal-0.74.55.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
-modal-0.74.55.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
-modal-0.74.55.dist-info/RECORD,,
+modal_version/_version_generated.py,sha256=mWCznyF_KU6y7pcK7_8wqzPaR8ffAIUYXN0M9edQdgI,149
+modal-0.74.56.dist-info/METADATA,sha256=han4gW42B3IgaYxb_xsACvwdhj32_bptrSf9hGDaOQw,2451
+modal-0.74.56.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+modal-0.74.56.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
+modal-0.74.56.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
+modal-0.74.56.dist-info/RECORD,,

modal_version/_version_generated.py

@@ -1,4 +1,4 @@
 # Copyright Modal Labs 2025
 
 # Note: Reset this value to -1 whenever you make a minor `0.X` release of the client.
-build_number = 55  # git: aa1b399
+build_number = 56  # git: 9749b47