anyscale 0.26.28__py3-none-any.whl → 0.26.30__py3-none-any.whl

anyscale/commands/job_queue_commands.py

@@ -1,172 +1,363 @@
-from typing import List
+from __future__ import annotations
+
+from datetime import datetime
+from enum import Enum
+from functools import partial
+from json import dumps as json_dumps
+import sys
+from typing import Dict, get_type_hints, List, Optional
 
 import click
+from rich.console import Console
+from rich.table import Table
 
 from anyscale.client.openapi_client.models.job_queue_sort_directive import (
     JobQueueSortDirective,
 )
 from anyscale.client.openapi_client.models.job_queue_sort_field import JobQueueSortField
+from anyscale.client.openapi_client.models.session_state import SessionState
 from anyscale.client.openapi_client.models.sort_order import SortOrder
 from anyscale.commands import command_examples
+from anyscale.commands.list_util import (
+    display_list,
+    MAX_PAGE_SIZE,
+    NON_INTERACTIVE_DEFAULT_MAX_ITEMS,
+    validate_page_size,
+)
 from anyscale.commands.util import AnyscaleCommand
-from anyscale.controllers.job_controller import JobController, JobQueueView
-from anyscale.util import validate_non_negative_arg
+import anyscale.job_queue
+from anyscale.job_queue.models import JobQueueStatus, JobQueueStatusKeys
+from anyscale.util import get_endpoint, get_user_info, validate_non_negative_arg
 
 
-@click.group(
-    "job-queues", help="Interact with production job queues running on Anyscale."
-)
+@click.group("job-queue", help="Manage Anyscale Job Queues.")
 def job_queue_cli() -> None:
     pass
 
 
-def parse_sort_fields(
-    param: str, sort_fields: List[str],
-) -> List[JobQueueSortDirective]:
-    sort_directives = []
-
-    for field_str in sort_fields:
-        descending = field_str.startswith("-")
-        raw_field = field_str.lstrip("-").upper()
-
-        if raw_field not in JobQueueSortField.allowable_values:
-            raise click.UsageError(
-                f"{param} must be one of {', '.join([v.lower() for v in JobQueueSortField.allowable_values])}"
-            )
+class ViewOption(Enum):
+    DEFAULT = "default"
+    STATS = "stats"
+    ALL = "all"
 
-        sort_directives.append(
-            JobQueueSortDirective(
-                sort_field=raw_field,
-                sort_order=SortOrder.DESC if descending else SortOrder.ASC,
-            )
-        )
 
-    return sort_directives
+VIEW_COLUMNS: Dict[ViewOption, List[JobQueueStatusKeys]] = {
+    ViewOption.DEFAULT: [
+        "name",
+        "id",
+        "state",
+        "creator_email",
+        "project_id",
+        "created_at",
+    ],
+    ViewOption.STATS: [
+        "id",
+        "name",
+        "total_jobs",
+        "active_jobs",
+        "successful_jobs",
+        "failed_jobs",
+    ],
+    ViewOption.ALL: [
+        "name",
+        "id",
+        "state",
+        "creator_email",
+        "project_id",
+        "created_at",
+        "max_concurrency",
+        "idle_timeout_s",
+        "cloud_id",
+        "user_provided_id",
+        "execution_mode",
+        "total_jobs",
+        "active_jobs",
+        "successful_jobs",
+        "failed_jobs",
+    ],
+}
 
 
 @job_queue_cli.command(
     name="list",
-    short_help="List job queues.",
+    help="List job queues.",
     cls=AnyscaleCommand,
     example=command_examples.JOB_QUEUE_LIST,
 )
+@click.option("--id", "job_queue_id", help="ID of a job queue.")
+@click.option("--name", type=str, help="Filter by name.")
+@click.option("--cloud", type=str, help="Filter by cloud.")
+@click.option("--project", type=str, help="Filter by project.")
+@click.option("--include-all-users/--only-mine", default=False)
 @click.option(
-    "--include-all-users",
-    is_flag=True,
-    default=False,
-    help="Include job queues not created by current user.",
+    "--cluster-status",
+    type=click.Choice(SessionState.allowable_values, case_sensitive=False),
+    help="Filter by cluster status.",
 )
 @click.option(
     "--view",
-    type=click.Choice([v.name.lower() for v in JobQueueView], case_sensitive=False),
-    default=JobQueueView.DEFAULT.name,
-    help="Select which view to display.",
-    callback=lambda _, __, value: JobQueueView[value.upper()],
+    type=click.Choice([opt.value for opt in ViewOption], case_sensitive=False),
+    default=ViewOption.DEFAULT.value,
+    help="Columns view.",
+    callback=lambda _ctx, _param, value: ViewOption(value),
 )
 @click.option(
-    "--page",
-    default=100,
+    "--page-size",
+    default=10,
     type=int,
-    help="Page size (default 100).",
-    callback=validate_non_negative_arg,
+    callback=validate_page_size,
+    help=f"Items per page (max {MAX_PAGE_SIZE}).",
 )
 @click.option(
     "--max-items",
-    required=False,
     type=int,
-    help="Max items to show in list (only valid in interactive mode).",
     callback=lambda ctx, param, value: validate_non_negative_arg(ctx, param, value)
     if value
     else None,
+    help="Non-interactive max items.",
 )
 @click.option(
     "--sort",
-    "sorting_directives",
+    "sort_dirs",
     multiple=True,
-    default=[JobQueueSortField.CREATED_AT],
-    help=f"""
-        Sort by column(s). Prefix column with - to sort in descending order.
-        Supported columns: {', '.join([v.lower() for v in JobQueueSortField.allowable_values])}.
-    """,
-    callback=lambda _, __, value: parse_sort_fields("sort", list(value)),
+    default=["-created_at"],
+    callback=lambda _ctx, _param, values: _parse_sort_fields("sort", list(values)),
 )
+@click.option("--no-interactive/--interactive", default=False)
 @click.option(
-    "--interactive/--no-interactive",
-    default=True,
-    help="--no-interactive disables the default interactive mode.",
+    "--json", "json_output", is_flag=True, default=False, help="JSON output.",
 )
-def list_job_queues(
+def list_job_queues(  # noqa: PLR0913
+    job_queue_id: Optional[str],
+    name: Optional[str],
+    cloud: Optional[str],
+    project: Optional[str],
+    cluster_status: Optional[str],
     include_all_users: bool,
-    view: JobQueueView,
-    page: int,
-    max_items: int,
-    sorting_directives: List[JobQueueSortDirective],
-    interactive: bool,
-):
-    if max_items is not None and interactive:
-        raise click.UsageError("--max-items can only be used in non interactive mode.")
-    job_controller = JobController()
-    job_controller.list_job_queues(
-        max_items=max_items,
-        page_size=page,
+    view: ViewOption,
+    page_size: int,
+    max_items: Optional[int],
+    sort_dirs: List[JobQueueSortDirective],
+    no_interactive: bool,
+    json_output: bool,
+) -> None:
+    """List and page job queues according to filters and view."""
+    if max_items and not no_interactive:
+        raise click.UsageError("--max-items only in non-interactive mode")
+
+    effective_max = max_items or NON_INTERACTIVE_DEFAULT_MAX_ITEMS
+    console = Console()
+    stderr = Console(stderr=True)
+
+    _print_list_diagnostics(
+        stderr=stderr,
+        job_queue_id=job_queue_id,
+        name=name,
         include_all_users=include_all_users,
+        cloud=cloud,
+        project=project,
+        cluster_status=cluster_status,
         view=view,
-        sorting_directives=sorting_directives,
-        interactive=interactive,
+        sort_dirs=sort_dirs,
+        no_interactive=no_interactive,
+        page_size=page_size,
+        effective_max=effective_max,
     )
 
+    try:
+        user = get_user_info()
+        iterator = anyscale.job_queue.list(
+            job_queue_id=job_queue_id,
+            name=name,
+            creator_id=None if include_all_users else (user.id if user else None),
+            cloud=cloud,
+            project=project,
+            page_size=page_size,
+            max_items=None if not no_interactive else effective_max,
+            sorting_directives=sort_dirs,
+        )
+        cols = VIEW_COLUMNS[view]
+        table_fn = partial(_create_table, view)
+
+        def row_fn(jq: JobQueueStatus) -> Dict[str, str]:
+            data = _format_data(jq)
+            return {c: data[c] for c in cols}
+
+        total = display_list(
+            iterator=iter(iterator),
+            item_formatter=row_fn,
+            table_creator=table_fn,
+            json_output=json_output,
+            page_size=page_size,
+            interactive=not no_interactive,
+            max_items=effective_max,
+            console=console,
+        )
+        if not json_output:
+            stderr.print(f"Fetched {total} queues" if total else "No queues found.")
+
+    except Exception as e:  # noqa: BLE001
+        stderr.print(f"Error: {e}", style="red")
+        sys.exit(1)
+
 
 @job_queue_cli.command(
     name="update",
-    short_help="Update job queue.",
+    help="Update job queue settings.",
     cls=AnyscaleCommand,
     example=command_examples.JOB_QUEUE_UPDATE,
 )
+@click.option("--id", "job_queue_id", required=True)
+@click.option("--max-concurrency", type=int)
+@click.option("--idle-timeout-s", type=int)
 @click.option(
-    "--id", "job_queue_id", required=False, default=None, help="ID of the job queue."
-)
-@click.option(
-    "--name",
-    "job_queue_name",
-    required=False,
-    default=None,
-    help="Name of the job queue.",
-)
-@click.option(
-    "--max-concurrency",
-    required=False,
-    default=None,
-    help="Maximum concurrency of the job queue",
-)
-@click.option(
-    "--idle-timeout-s",
-    required=False,
-    default=None,
-    help="Idle timeout of the job queue",
+    "--json", "json_output", is_flag=True, default=False, help="JSON output.",
 )
 def update_job_queue(
-    job_queue_id: str, job_queue_name: str, max_concurrency: int, idle_timeout_s: int
-):
-    if job_queue_id is None and job_queue_name is None:
-        raise click.ClickException("ID or name of job queue is required")
-    job_controller = JobController()
-    job_controller.update_job_queue(
-        job_queue_id=job_queue_id,
-        job_queue_name=job_queue_name,
-        max_concurrency=max_concurrency,
-        idle_timeout_s=idle_timeout_s,
-    )
+    job_queue_id: str,
+    max_concurrency: Optional[int],
+    idle_timeout_s: Optional[int],
+    json_output: bool,
+) -> None:
+    """Update the max_concurrency or idle_timeout_s of a job queue."""
+    if max_concurrency is None and idle_timeout_s is None:
+        raise click.ClickException("Specify --max-concurrency or --idle-timeout-s")
+    stderr = Console(stderr=True)
+    stderr.print(f"Updating job queue '{job_queue_id}'...")
+    try:
+        jq = anyscale.job_queue.update(
+            job_queue_id=job_queue_id,
+            job_queue_name=None,
+            max_concurrency=max_concurrency,
+            idle_timeout_s=idle_timeout_s,
+        )
+        if json_output:
+            Console().print_json(json_dumps(_format_data(jq), indent=2))
+        else:
+            _display_single(jq, stderr, ViewOption.ALL)
+    except Exception as e:  # noqa: BLE001
+        stderr.print(f"Update failed: {e}", style="red")
+        sys.exit(1)
 
 
 @job_queue_cli.command(
-    name="info",
-    short_help="Info of a job queue.",
+    name="status",
+    help="Show job queue details.",
     cls=AnyscaleCommand,
     example=command_examples.JOB_QUEUE_INFO,
 )
+@click.option("--id", "job_queue_id", required=True)
 @click.option(
-    "--id", "job_queue_id", required=True, default=None, help="ID of the job."
+    "--view",
+    type=click.Choice([opt.value for opt in ViewOption], case_sensitive=False),
+    default=ViewOption.DEFAULT.value,
+    help="Columns view.",
+    callback=lambda _ctx, _param, value: ViewOption(value),
 )
-def get_job_queue(job_queue_id: str):
-    job_controller = JobController()
-    job_controller.get_job_queue(job_queue_id=job_queue_id)
+@click.option(
+    "--json", "json_output", is_flag=True, default=False, help="JSON output.",
+)
+def status(job_queue_id: str, view: ViewOption, json_output: bool,) -> None:
+    """Fetch and display a single job queue's details."""
+    stderr = Console(stderr=True)
+    stderr.print(f"Fetching job queue '{job_queue_id}'...")
+    try:
+        jq = anyscale.job_queue.status(job_queue_id=job_queue_id)
+        if json_output:
+            Console().print_json(json_dumps(_format_data(jq), indent=2))
+        else:
+            _display_single(jq, stderr, view)
+    except Exception as e:  # noqa: BLE001
+        stderr.print(f"Failed: {e}", style="red")
+        sys.exit(1)
+
+
+def _parse_sort_fields(
+    param: str, sort_fields: List[str],
+) -> List[JobQueueSortDirective]:
+    """Convert a list of string fields into JobQueueSortDirective objects."""
+    directives: List[JobQueueSortDirective] = []
+    opts = ", ".join(v.lower() for v in JobQueueSortField.allowable_values)
+    for field_str in sort_fields:
+        desc = field_str.startswith("-")
+        raw = field_str.lstrip("-").upper()
+        if raw not in JobQueueSortField.allowable_values:
+            raise click.UsageError(f"{param} must be one of {opts}")
+        directives.append(
+            JobQueueSortDirective(
+                sort_field=raw, sort_order=SortOrder.DESC if desc else SortOrder.ASC,
+            )
+        )
+    return directives
+
+
+def _create_table(view: ViewOption, show_header: bool) -> Table:
+    """Create a Rich Table with columns based on the selected view."""
+    table = Table(show_header=show_header, expand=True)
+    for key in VIEW_COLUMNS[view]:
+        table.add_column(key.replace("_", " ").upper(), overflow="fold")
+    return table
+
+
+def _format_data(jq: JobQueueStatus) -> Dict[str, str]:
+    """Format a JobQueueStatus object into a dictionary of strings for display."""
+    data = {}
+    for key in get_type_hints(JobQueueStatus):
+        value = getattr(jq, key, None)
+        if isinstance(value, datetime):
+            data[key] = value.strftime("%Y-%m-%d %H:%M:%S") if value else ""
+        elif value is None:
+            data[key] = ""
+        else:
+            data[key] = str(value)
+    return data
+
+
+def _display_single(jq: JobQueueStatus, stderr: Console, view: ViewOption,) -> None:
+    """Display a single job queue's details in a table using the selected view.
+
+    Args:
+        jq: The JobQueueStatus object to display.
+        stderr: The Rich Console object to print to.
+        view: The ViewOption determining which columns to display.
+    """
+    table = _create_table(view, show_header=True)
+    data = _format_data(jq)
+    table.add_row(*(data[col] for col in VIEW_COLUMNS[view]))
+    stderr.print(table)
+
+
+def _print_list_diagnostics(  # noqa: PLR0913
+    stderr: Console,
+    job_queue_id: Optional[str],
+    name: Optional[str],
+    include_all_users: bool,
+    cloud: Optional[str],
+    project: Optional[str],
+    cluster_status: Optional[str],
+    view: ViewOption,
+    sort_dirs: List[JobQueueSortDirective],
+    no_interactive: bool,
+    page_size: int,
+    effective_max: int,
+) -> None:
+    """Prints diagnostic information for the list_job_queues command."""
+    stderr.print("[bold]Listing with:[/]")
+    stderr.print(f"id: {job_queue_id or '<any>'}")
+    stderr.print(f"name: {name or '<any>'}")
+    stderr.print(f"creator: {'all' if include_all_users else 'mine'}")
+    stderr.print(f"cloud: {cloud or '<any>'}")
+    stderr.print(f"project: {project or '<any>'}")
+    stderr.print(f"cluster: {cluster_status or '<any>'}")
+    stderr.print(f"view: {view.value}")
+
+    formatted_sort_dirs = [
+        f"{'-' if d.sort_order == SortOrder.DESC else ''}{(d.sort_field or '').lower()}"
+        for d in sort_dirs
+    ]
+    stderr.print(f"sort: {formatted_sort_dirs}")
+
+    stderr.print(f"mode: {'batch' if no_interactive else 'interactive'}")
+    stderr.print(f"page-size: {page_size}")
+    stderr.print(f"max-items: {effective_max}")
+    stderr.print(f"UI: {get_endpoint('/job-queues')}\n")

anyscale/commands/list_util.py

@@ -2,10 +2,23 @@ import itertools
 from json import dumps as json_dumps
 from typing import Any, Callable, Dict, Iterator, List, Optional
 
+import click
 from rich.console import Console
 from rich.table import Table
 
-from anyscale.util import AnyscaleJSONEncoder
+from anyscale.util import AnyscaleJSONEncoder, validate_non_negative_arg
+
+
+MAX_PAGE_SIZE = 50
+NON_INTERACTIVE_DEFAULT_MAX_ITEMS = 10
+
+
+def validate_page_size(ctx, param, value):
+    """Click callback to validate page size argument."""
+    value = validate_non_negative_arg(ctx, param, value)
+    if value is not None and value > MAX_PAGE_SIZE:
+        raise click.BadParameter(f"must be less than or equal to {MAX_PAGE_SIZE}.")
+    return value
 
 
 def _paginate(iterator: Iterator[Any], page_size: Optional[int]) -> Iterator[List[Any]]:

anyscale/commands/machine_pool_commands.py

@@ -113,8 +113,9 @@ def describe(name: str, format_: str) -> None:
             "PARTITION",
             "STATE",
             "WORKLOAD DETAILS",
-            "WORKLOAD SCORE",
             "WORKLOAD START TIME",
+            "WORKLOAD CREATOR",
+            "WORKLOAD SCORE",
             "CLOUD INSTANCE ID",
         ]
         for row in scheduler_info.machines:
@@ -124,13 +125,16 @@ def describe(name: str, format_: str) -> None:
                     row.machine_type,
                     row.partition,
                     row.allocation_state,
-                    f"{row.workload_info.workload_type}/{row.workload_info.workload_name}/{row.workload_info.workload_cloud}"
+                    f"{row.workload_info.workload_type}/{row.workload_info.workload_name}/{row.workload_info.workload_project}/{row.workload_info.workload_cloud}"
                     if row.workload_info.workload_name
                     else "",
-                    row.workload_score,
                     format_time(row.workload_info.workload_start_time)
                     if row.workload_info.workload_name
                     else "",
+                    row.workload_info.workload_creator
+                    if row.workload_info.workload_name
+                    else "",
+                    row.workload_score,
                     row.cloud_instance_id,
                 ]
             )
@@ -151,7 +155,7 @@ def describe(name: str, format_: str) -> None:
             "MACHINE TYPE",
             "WORKLOAD DETAILS",
             "WORKLOAD START TIME",
-            "WORKLOAD CLOUD",
+            "WORKLOAD CREATOR",
             "PARTITION SCORES",
         ]
         for row in scheduler_info.requests:
@@ -159,11 +163,9 @@ def describe(name: str, format_: str) -> None:
                 [
                     row.size,
                     row.machine_type,
-                    f"{row.workload_info.workload_type}/{row.workload_info.workload_name}",
-                    format_time(row.workload_info.workload_start_time)
-                    if row.workload_info.workload_name
-                    else "",
-                    row.workload_info.workload_cloud,
+                    f"{row.workload_info.workload_type}/{row.workload_info.workload_name}/{row.workload_info.workload_project}/{row.workload_info.workload_cloud}",
+                    format_time(row.workload_info.workload_start_time),
+                    row.workload_info.workload_creator,
                     row.partition_scores,
                 ]
             )
@@ -258,7 +260,13 @@ def list_machine_pools(format_: str) -> None:
         raise click.ClickException(f"Invalid output format '{format}'.")
 
 
-@machine_pool_cli.command(name="attach", help="Attach a machine pool to a cloud.")
+@machine_pool_cli.command(
+    name="attach",
+    help="Attach a machine pool to a cloud.",
+    cls=AnyscaleCommand,
+    example=command_examples.MACHINE_POOL_ATTACH_EXAMPLE,
+    is_beta=True,
+)
 @click.option("--name", type=str, required=True, help="Provide a machine pool name.")
 @click.option("--cloud", type=str, required=True, help="Provide a cloud name.")
 def attach_machine_pool_to_cloud(name: str, cloud: str) -> None:
@@ -269,7 +277,13 @@ def attach_machine_pool_to_cloud(name: str, cloud: str) -> None:
     print(f"Attached machine pool '{name}' to cloud '{cloud}'.")
 
 
-@machine_pool_cli.command(name="detach", help="Detach a machine pool from a cloud.")
+@machine_pool_cli.command(
+    name="detach",
+    help="Detach a machine pool from a cloud.",
+    cls=AnyscaleCommand,
+    example=command_examples.MACHINE_POOL_DETACH_EXAMPLE,
+    is_beta=True,
+)
 @click.option("--name", type=str, required=True, help="Provide a machine pool name.")
 @click.option("--cloud", type=str, required=True, help="Provide a cloud name.")
 def detach_machine_pool_from_cloud(name: str, cloud: str) -> None:

anyscale/commands/service_commands.py

@@ -13,7 +13,12 @@ import yaml
 from anyscale._private.models.image_uri import ImageURI
 from anyscale.cli_logger import BlockLogger
 from anyscale.commands import command_examples
-from anyscale.commands.list_util import display_list
+from anyscale.commands.list_util import (
+    display_list,
+    MAX_PAGE_SIZE,
+    NON_INTERACTIVE_DEFAULT_MAX_ITEMS,
+    validate_page_size,
+)
 from anyscale.commands.util import (
     AnyscaleCommand,
     convert_kv_strings_to_dict,
@@ -159,7 +164,7 @@ def _read_name_from_config_file(path: str):
     required=False,
     default=None,
     type=int,
-    help="The percentage of traffic to send to the canary version of the service (0-100). This can be used to manually shift traffic toward (or away from) the canary version. If not provided, traffic will be shifted incrementally toward the canary version until it reaches 100. Not supported when using --in-place.",
+    help="The percentage of traffic to send to the canary version of the service (0-100). This can be used to manually shift traffic toward (or away from) the canary version. If not provided, traffic will be shifted incrementally toward the canary version until it reaches 100. Not supported when using --in-place. This is ignored when restarting a service or creating a new service.",
 )
 @click.option(
     "--max-surge-percent",
@@ -642,17 +647,6 @@ def rollout(  # noqa: PLR0913
     )
 
 
-MAX_PAGE_SIZE = 50
-NON_INTERACTIVE_DEFAULT_MAX_ITEMS = 10
-
-
-def validate_page_size(ctx, param, value):
-    value = validate_non_negative_arg(ctx, param, value)
-    if value is not None and value > MAX_PAGE_SIZE:
-        raise click.BadParameter(f"must be less than or equal to {MAX_PAGE_SIZE}.")
-    return value
-
-
 def validate_max_items(ctx, param, value):
     if value is None:
         return None
@@ -967,6 +961,8 @@ def terminate(
 
     This applies to both v1 and v2 services.
     """
+    # TODO: Remove service_controller and use the sdk method. Need to update the sdk method
+    # so that it can resolve either service name or config file to the service id.
     service_controller = ServiceController()
     service_id = service_controller.get_service_id(
         service_id=service_id,
@@ -975,7 +971,7 @@ def terminate(
         project_id=project_id,
     )
     try:
-        anyscale.service.terminate(service_id)
+        anyscale.service.terminate(id=service_id)
         log.info(f"Service {service_id} terminate initiated.")
         log.info(
             f'View the service in the UI at {get_endpoint(f"/services/{service_id}")}'