tabsdata-cli 2.0.0__cp312-abi3-win_amd64.whl

tabsdata_cli-2.0.0.data/purelib/tabsdatak/cli/td/plan_group.py

@@ -0,0 +1,324 @@
+#
+# Copyright 2026 Tabsdata Inc.
+#
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, List
+
+import rich_click as click
+from rich.table import Table
+
+from tabsdatak.cli._registry import cli_command
+from tabsdatak.cli.cli_utils import (
+    beautify_time,
+    collection_label,
+    echo_more_results,
+    format_option,
+    hint_common_solutions,
+    make_console,
+    max_result_option,
+    output_format,
+    render,
+    show_hint,
+    verify_login_or_prompt,
+)
+from tabsdatak.cli.td.execution_utils import (
+    confirm_cancel,
+    emit_worker_logs,
+    function_runs_table,
+    live_monitor,
+    obtain_execution_list,
+    obtain_list_exec_filters,
+    pick_worker,
+    plans_table,
+    span_projects,
+    workers_table,
+)
+from tabsdatak.sdk.status_utils.execution import (
+    EXECUTION_FINAL_STATUSES,
+    EXECUTION_SUCCESSFUL_FINAL_STATUSES,
+    EXECUTION_VALID_USER_PROVIDED_STATUSES,
+)
+
+if TYPE_CHECKING:
+    from tabsdatak.sdk.tabsdata_server import TabsdataServer
+
+AT_OPTION_HELP = (
+    "If provided, only plans started before that time will be shown. Must be "
+    "either a valid timestamp in the form of a unix timestamp (milliseconds since "
+    "epoch without a dot, e.g. '1750074554472') or a valid date-time format. "
+    "The valid "
+    "formats are 'YYYY-MM-DD', 'YYYY-MM-DDTHH', 'YYYY-MM-DDTHH:MM', "
+    "'YYYY-MM-DDTHH:MM:SS', and 'YYYY-MM-DDTHH:MM:SS.sss'. A 'Z' character can be "
+    "added at the end to indicate UTC time (e.g., '2023-10-01T12Z' or "
+    "'2023-10-01T12:00:00.000Z') or it can be omitted to indicate local "
+    "time (e.g., '2023-10-01T12' or '2023-10-01T12:00:00.000')."
+)
+
+
+@cli_command
+@click.group()
+def plan():
+    """Plan (execution) management commands"""
+
+
+@plan.command(name="list")
+@click.option("--proj", type=str, help="Name of the project to filter plans by.")
+@click.option(
+    "--status",
+    type=str,
+    multiple=True,
+    help=(
+        "Filter plans by status. The possible statuses are "
+        f"'{EXECUTION_VALID_USER_PROVIDED_STATUSES}'. This field is "
+        "case-insensitive. "
+    ),
+)
+@click.option("--fn", type=str, help="Name of the function to filter plans by.")
+@click.option("--coll", type=str, help="Name of the collection to filter plans by.")
+@click.option(
+    "--name",
+    "-n",
+    help=(
+        "A plan name wildcard to match for the list. "
+        "For example, 'my_plan*' will match all plans "
+        "with names starting with 'my_plan'."
+    ),
+)
+@click.option(
+    "--last",
+    is_flag=True,
+    help="If set, only the last plan of the list will be shown.",
+)
+@click.option("--at", help=AT_OPTION_HELP, type=str)
+@click.option(
+    "--monitor",
+    is_flag=True,
+    help=(
+        "If set, the command will monitor the listed plans until they all reach "
+        "a final state."
+    ),
+)
+@format_option
+@max_result_option
+@click.pass_context
+def list_plans(
+    ctx: click.Context,
+    proj: str,
+    status: List[str],
+    fn: str,
+    coll: str,
+    name: str,
+    last: bool,
+    at: str,
+    monitor: bool,
+):
+    """List plans across every project you can view."""
+    verify_login_or_prompt(ctx)
+    request_filter = obtain_list_exec_filters(
+        status=status,
+        exe_name=name,
+        fn=fn,
+        collection=coll,
+        at=at,
+        project=proj,
+    )
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        span_projects(server)
+        list_of_executions, truncated = obtain_execution_list(
+            ctx, server, request_filter, last
+        )
+
+        if output_format(ctx) != "table":
+            render(
+                ctx,
+                data=[e._data for e in list_of_executions],
+                table=lambda: None,
+            )
+            echo_more_results(ctx, truncated)
+            return
+
+        if monitor:
+            click.echo("Waiting for the plans to finish...")
+            list_of_executions = live_monitor(
+                list_of_executions,
+                lambda: obtain_execution_list(ctx, server, request_filter, last)[0],
+                plans_table,
+                lambda e: e.status in EXECUTION_FINAL_STATUSES,
+            )
+            click.echo("Plans finished.")
+        else:
+            click.echo()
+            console = make_console()
+            console.print(plans_table(list_of_executions))
+        echo_more_results(ctx, truncated)
+        click.echo()
+        if not all([
+            aux_exe.status in EXECUTION_SUCCESSFUL_FINAL_STATUSES
+            for aux_exe in list_of_executions
+        ]):
+            show_hint(
+                ctx,
+                "If you want to explore why a plan failed, run "
+                "'tdk plan logs --plan <PLAN-ID>' to pick a worker and read its "
+                "logs, or 'tdk worker list --plan <PLAN-ID>' to see the workers.",
+            )
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to list plans: {e}")
+
+
+@plan.command()
+@click.option("--plan", required=True, help="ID of the plan to display.")
+@format_option
+@click.pass_context
+def get(ctx: click.Context, plan: str):
+    """
+    Display a plan: its details plus its function runs and workers.
+    """
+    verify_login_or_prompt(ctx)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        span_projects(server)
+        execution = server.get_execution(plan)
+        function_runs = server.list_function_runs(filter=f"execution_id:eq:{plan}")
+        workers = server.list_workers(filter=f"execution_id:eq:{plan}")
+
+        if output_format(ctx) != "table":
+            render(
+                ctx,
+                data={
+                    "plan": execution._data,
+                    "function_runs": [r._data for r in function_runs],
+                    "workers": [w._data for w in workers],
+                },
+                table=lambda: None,
+            )
+            return
+
+        table = Table(title="Plan")
+        table.add_column("Name")
+        table.add_column("Project")
+        table.add_column("Collection")
+        table.add_column("Function")
+        table.add_column("Triggered on")
+        table.add_column("Started on")
+        table.add_column("Ended on")
+        table.add_column("Status", no_wrap=True)
+        table.add_row(
+            execution.name,
+            execution.project or "-",
+            collection_label(execution),
+            execution.function.name,
+            beautify_time(execution.triggered_on_str),
+            beautify_time(execution.started_on_str),
+            beautify_time(execution.ended_on_str),
+            execution.status,
+        )
+
+        click.echo()
+        console = make_console()
+        console.print(table)
+        console.print(function_runs_table(function_runs))
+        console.print(workers_table(workers))
+        click.echo()
+
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to display plan: {e}")
+
+
+@plan.command()
+@click.option("--plan", required=True, help="ID of the plan to cancel.")
+@click.option(
+    "--confirm",
+    help="Write 'cancel' to confirm cancellation. Will be prompted for it if "
+    "not provided.",
+)
+@click.pass_context
+def cancel(ctx: click.Context, plan: str, confirm: str):
+    """
+    Cancel a plan: every non-committed transaction in it is canceled.
+    Canceled runs cannot be recovered.
+    """
+    verify_login_or_prompt(ctx)
+    click.echo(f"Canceling plan with ID '{plan}'")
+    click.echo("-" * 10)
+    confirm_cancel(ctx, confirm, f"plan '{plan}'")
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        server.cancel_execution(plan)
+        click.echo("Plan canceled successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to cancel plan: {e}")
+
+
+@plan.command()
+@click.option("--plan", required=True, help="ID of the plan to recover.")
+@click.pass_context
+def recover(ctx: click.Context, plan: str):
+    """
+    Recover a plan: its failed or on-hold function runs are re-scheduled.
+    """
+    verify_login_or_prompt(ctx)
+    click.echo(f"Recovering plan with ID '{plan}'")
+    click.echo("-" * 10)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        server.recover_execution(plan)
+        click.echo("Plan recovered successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to recover plan: {e}")
+
+
+@plan.command()
+@click.option("--plan", required=True, help="ID of the plan to monitor.")
+@click.pass_context
+def monitor(ctx: click.Context, plan: str):
+    """
+    Monitor the execution of a plan.
+    """
+    verify_login_or_prompt(ctx)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        span_projects(server)
+        execution = server.get_execution(plan)
+        from tabsdatak.cli.td.fn_group import _monitor_execution_or_transaction
+
+        _monitor_execution_or_transaction(ctx, execution=execution)
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to monitor plan: {e}")
+
+
+@plan.command()
+@click.option("--plan", required=True, help="ID of the plan whose logs to show.")
+@click.option(
+    "--file",
+    help=(
+        "Path of the file where the logs will be saved, or '-' to write them to "
+        "stdout. Any folders provided before the file must already exist."
+    ),
+)
+@format_option
+@click.pass_context
+def logs(ctx: click.Context, plan: str, file: str):
+    """
+    Show logs of one of the plan's workers; when several ran, pick one from
+    the listing.
+    """
+    verify_login_or_prompt(ctx)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        span_projects(server)
+        target = pick_worker(ctx, server, [f"execution_id:eq:{plan}"], f"Plan '{plan}'")
+        emit_worker_logs(ctx, server, target, file)
+    except click.exceptions.Exit:
+        raise
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to show logs: {e}")

tabsdata_cli-2.0.0.data/purelib/tabsdatak/cli/td/project_group.py

@@ -0,0 +1,170 @@
+#
+# Copyright 2026 Tabsdata Inc.
+#
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import rich_click as click
+from rich.table import Table
+
+from tabsdatak.cli._registry import cli_command
+from tabsdatak.cli.cli_utils import (
+    echo_more_results,
+    format_option,
+    hint_common_solutions,
+    logical_prompt,
+    make_console,
+    max_result_option,
+    render,
+    take,
+    verify_login_or_prompt,
+)
+
+if TYPE_CHECKING:
+    from tabsdatak.sdk.tabsdata_server import TabsdataServer
+
+
+@cli_command
+@click.group()
+def project():
+    """Project management commands"""
+
+
+@project.command()
+@click.option("--name", "-n", help="Name of the project to create.")
+@click.option("--description", help="Description of the project.")
+@click.pass_context
+def create(ctx: click.Context, name: str, description: str):
+    """Create a new project"""
+    verify_login_or_prompt(ctx)
+    name = name or logical_prompt(ctx, "Name of the project to create")
+    description = description or ""
+    click.echo("Creating a new project")
+    click.echo("-" * 10)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        server.create_project(name, description)
+        click.echo("Project created successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to create project: {e}")
+
+
+@project.command()
+@click.option("--name", "-n", help="Name of the project to delete.")
+@click.option(
+    "--confirm",
+    help="Write 'delete' to confirm deletion. Will be prompted for it if not provided.",
+)
+@click.pass_context
+def delete(ctx: click.Context, name: str, confirm: str):
+    """Delete a project by name."""
+    verify_login_or_prompt(ctx)
+    name = name or logical_prompt(ctx, "Name of the project to delete")
+    click.echo(f"Deleting project: {name}")
+    click.echo("-" * 10)
+    confirm = confirm or logical_prompt(ctx, "Please type 'delete' to confirm deletion")
+    if confirm != "delete":
+        raise click.ClickException(
+            "Deletion not confirmed. The confirmation word is 'delete'."
+        )
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        server.delete_project(name)
+        click.echo("Project deleted successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to delete project: {e}")
+
+
+@project.command()
+@format_option
+@click.option("--name", "-n", help="Name of the project to display.")
+@click.pass_context
+def get(ctx: click.Context, name: str):
+    """Display a project by name"""
+    verify_login_or_prompt(ctx)
+    name = name or logical_prompt(ctx, "Name of the project to display")
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        prj = server.get_project(name)
+
+        def _table():
+            table = Table(title="Project", show_header=False, show_lines=True)
+            table.add_column("Field", style="cyan", no_wrap=True)
+            table.add_column("Value")
+            table.add_row("Name:", prj.name)
+            table.add_row("Description:", prj.description or "")
+            table.add_row("Created by:", prj.created_by or "-")
+            table.add_row("Created on:", prj.created_on_str or "-")
+            click.echo()
+            make_console(emoji=False, markup=False).print(table)
+            click.echo()
+
+        render(ctx, data=lambda: prj._data, table=_table)
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to display project: {e}")
+
+
+@project.command()
+@format_option
+@max_result_option
+@click.pass_context
+def list(ctx: click.Context):
+    """List all projects"""
+    verify_login_or_prompt(ctx)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        list_of_projects, truncated = take(ctx, server.list_projects_generator())
+
+        def _table():
+            table = Table(title="Projects")
+            table.add_column("Name", style="cyan", no_wrap=True)
+            table.add_column("Description")
+            table.add_column("Created by")
+            table.add_column("Created on")
+            for prj in list_of_projects:
+                table.add_row(
+                    prj.name,
+                    prj.description,
+                    prj.created_by,
+                    prj.created_on_str,
+                )
+            click.echo()
+            make_console().print(table)
+            click.echo(f"Number of projects: {len(list_of_projects)}")
+            click.echo()
+
+        render(ctx, data=lambda: [p._data for p in list_of_projects], table=_table)
+        echo_more_results(ctx, truncated)
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to list projects: {e}")
+
+
+@project.command()
+@click.option("--name", "-n", help="Name of the project to update.")
+@click.option("--new-name", help="New name for the project.")
+@click.option("--description", help="New description for the project.")
+@click.pass_context
+def update(
+    ctx: click.Context,
+    name: str,
+    new_name: str,
+    description: str,
+):
+    """Update a project by name"""
+    verify_login_or_prompt(ctx)
+    name = name or logical_prompt(ctx, "Name of the project to update")
+    click.echo(f"Updating project: {name}")
+    click.echo("-" * 10)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        server.update_project(name, new_name=new_name, new_description=description)
+        click.echo("Project updated successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to update project: {e}")