tabsdata-cli 2.0.0__cp312-abi3-win_amd64.whl

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

@@ -0,0 +1,285 @@
+#
+# 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,
+    logical_prompt,
+    make_console,
+    max_result_option,
+    output_format,
+    render,
+    take,
+    verify_login_or_prompt,
+)
+from tabsdatak.cli.td.execution_utils import (
+    echo_plan_status,
+    echo_transaction_status,
+    emit_worker_logs,
+    function_runs_table,
+    obtain_list_fn_run_filters,
+    pick_worker,
+    span_projects,
+    workers_table,
+)
+from tabsdatak.sdk.status_utils.function_run import (
+    FUNCTION_RUN_VALID_USER_PROVIDED_STATUSES,
+)
+
+if TYPE_CHECKING:
+    from tabsdatak.sdk.tabsdata_server import TabsdataServer
+
+
+@cli_command
+@click.group()
+def fnrun():
+    """Function run management commands"""
+
+
+@fnrun.command(name="list")
+@click.option(
+    "--proj", type=str, help="Name of the project to filter function runs by."
+)
+@click.option(
+    "--status",
+    type=str,
+    multiple=True,
+    help=(
+        "Filter function runs by status. The possible statuses are "
+        f"'{FUNCTION_RUN_VALID_USER_PROVIDED_STATUSES}'. This field is "
+        "case-insensitive. "
+    ),
+)
+@click.option(
+    "--coll",
+    type=str,
+    help="Collection of the function to which the function runs belong.",
+)
+@click.option(
+    "--fn",
+    type=str,
+    help="Name of the function to which the function runs belong.",
+)
+@click.option("--plan", type=str, help="ID of the plan to filter function runs by.")
+@click.option(
+    "--plan-name",
+    help=(
+        "A plan name wildcard to match. "
+        "For example, 'my_plan*' will match all plans "
+        "with names starting with 'my_plan'."
+    ),
+)
+@click.option(
+    "--trx", type=str, help="ID of the transaction to filter function runs by."
+)
+@format_option
+@max_result_option
+@click.pass_context
+def list_runs(
+    ctx: click.Context,
+    proj: str,
+    status: List[str],
+    coll: str,
+    fn: str,
+    plan: str,
+    plan_name: str,
+    trx: str,
+):
+    """List function runs across every project you can view."""
+    verify_login_or_prompt(ctx)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        span_projects(server)
+        request_filter = obtain_list_fn_run_filters(
+            status=status,
+            exe_name=plan_name,
+            execution_id=plan,
+            fn=fn,
+            collection=coll,
+            trx=trx,
+            project=proj,
+        )
+        if output_format(ctx) == "table":
+            if plan:
+                echo_plan_status(server, plan)
+            if trx:
+                echo_transaction_status(server, trx)
+        list_of_function_runs, truncated = take(
+            ctx, server.list_function_runs_generator(filter=request_filter)
+        )
+
+        if output_format(ctx) != "table":
+            render(
+                ctx,
+                data=[r._data for r in list_of_function_runs],
+                table=lambda: None,
+            )
+            echo_more_results(ctx, truncated)
+            return
+
+        click.echo()
+        console = make_console()
+        console.print(function_runs_table(list_of_function_runs))
+        click.echo(f"Number of function runs: {len(list_of_function_runs)}")
+        echo_more_results(ctx, truncated)
+        click.echo()
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to list function runs: {e}")
+
+
+@fnrun.command()
+@click.option("--fnrun", required=True, help="ID of the function run to display.")
+@format_option
+@click.pass_context
+def get(ctx: click.Context, fnrun: str):
+    """
+    Display a function run: its details plus its workers.
+    """
+    verify_login_or_prompt(ctx)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        span_projects(server)
+        function_run = server.get_function_run(fnrun)
+        workers = server.list_workers(filter=f"logical_function_run_id:eq:{fnrun}")
+
+        if output_format(ctx) != "table":
+            render(
+                ctx,
+                data={
+                    "function_run": function_run._data,
+                    "workers": [w._data for w in workers],
+                },
+                table=lambda: None,
+            )
+            return
+
+        table = Table(title="Function run")
+        table.add_column("Project")
+        table.add_column("Collection")
+        table.add_column("Function")
+        table.add_column("Plan name")
+        table.add_column("Plan ID", no_wrap=True)
+        table.add_column("Transaction ID", no_wrap=True)
+        table.add_column("Started on")
+        table.add_column("Ended on")
+        table.add_column("Status", no_wrap=True)
+        table.add_row(
+            function_run.project or "-",
+            collection_label(function_run),
+            function_run.function.name,
+            function_run.execution.name,
+            function_run.execution.id,
+            function_run.transaction.id,
+            beautify_time(function_run.started_on_str),
+            beautify_time(function_run.ended_on_str),
+            function_run.status,
+        )
+
+        click.echo()
+        console = make_console()
+        console.print(table)
+        console.print(workers_table(workers))
+        click.echo()
+
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to display function run: {e}")
+
+
+@fnrun.command()
+@click.option(
+    "--fnrun", required=True, help="ID of the function run 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, fnrun: str, file: str):
+    """
+    Show logs of one of the function run's workers; when several ran (retries),
+    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"logical_function_run_id:eq:{fnrun}"],
+            f"Function run '{fnrun}'",
+        )
+        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}")
+
+
+@fnrun.command()
+@click.option("--fnrun", help="ID of the function run to replay.")
+@click.pass_context
+def replay(ctx: click.Context, fnrun: str):
+    """Re-execute a finished function run.
+
+    Mints a new concrete physical function run against the latest patch (or
+    head, if no patch exists). The pointer stays bound to the previous
+    attempt's outputs until the new attempt finishes successfully.
+    """
+    verify_login_or_prompt(ctx)
+    fnrun = fnrun or logical_prompt(ctx, "ID of the function run to replay")
+    click.echo(f"Replaying function run '{fnrun}'")
+    click.echo("-" * 10)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        result = server.replay_logical_function_run(fnrun)
+        click.echo("Replay scheduled")
+        click.echo(f"Run id:               {result.get('logical_function_run_id')}")
+        click.echo(f"Previous FR (bound):  {result.get('previous_function_run_id')}")
+        click.echo(f"New FR (running):     {result.get('new_function_run_id')}")
+        click.echo(f"Function version id:  {result.get('function_version_id')}")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to replay function run: {e}")
+
+
+@fnrun.command()
+@click.option("--fnrun", required=True, help="ID of the function run to recover.")
+@click.pass_context
+def recover(ctx: click.Context, fnrun: str):
+    """
+    Recover the transaction a function run belongs to: the transaction's
+    failed or on-hold function runs are re-scheduled.
+    """
+    verify_login_or_prompt(ctx)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        span_projects(server)
+        function_run = server.get_function_run(fnrun)
+        trx = function_run.transaction.id
+        click.echo(f"Recovering transaction '{trx}' of function run '{fnrun}'")
+        click.echo("-" * 10)
+        server.recover_transaction(trx)
+        click.echo("Transaction recovered successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to recover function run: {e}")

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

@@ -0,0 +1,184 @@
+#
+# 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 (
+    beautify_list,
+    echo_more_results,
+    format_option,
+    hint_common_solutions,
+    logical_prompt,
+    make_console,
+    max_result_option,
+    proj_option,
+    render,
+    take,
+    verify_login_or_prompt,
+)
+
+if TYPE_CHECKING:
+    from tabsdatak.sdk.tabsdata_server import TabsdataServer
+
+
+@cli_command
+@click.group()
+def group():
+    """Group management commands"""
+
+
+@group.command()
+@proj_option
+@click.option("--name", "-n", help="Name of the group to create.")
+@click.option("--description", help="Description of the group.")
+@click.pass_context
+def create(ctx: click.Context, name: str, description: str):
+    """Create a new group"""
+    verify_login_or_prompt(ctx)
+    name = name or logical_prompt(ctx, "Name of the group to create")
+    description = description or ""
+    click.echo("Creating a new group")
+    click.echo("-" * 10)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        server.create_group(name, description)
+        click.echo("Group created successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to create group: {e}")
+
+
+@group.command()
+@proj_option
+@click.option("--name", "-n", help="Name of the group 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 group by name. System groups cannot be deleted."""
+    verify_login_or_prompt(ctx)
+    name = name or logical_prompt(ctx, "Name of the group to delete")
+    click.echo(f"Deleting group: {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_group(name)
+        click.echo("Group deleted successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to delete group: {e}")
+
+
+@group.command()
+@proj_option
+@format_option
+@click.option("--name", "-n", help="Name of the group to display.")
+@click.pass_context
+def get(ctx: click.Context, name: str):
+    """Display a group by name"""
+    verify_login_or_prompt(ctx)
+    name = name or logical_prompt(ctx, "Name of the group to display")
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        grp = server.get_group(name)
+        collection_names = sorted(
+            c.name
+            for c in server.list_collections()
+            if (c._data or {}).get("group") == name
+        )
+
+        def _table():
+            table = Table(title="Group", show_header=False, show_lines=True)
+            table.add_column("Field", style="cyan", no_wrap=True)
+            table.add_column("Value")
+            table.add_row("Name:", grp.name)
+            table.add_row("Description:", grp.description or "")
+            table.add_row("System:", "Yes" if grp.system else "No")
+            table.add_row("Created by:", grp.created_by or "-")
+            table.add_row("Created on:", grp.created_on_str or "-")
+            table.add_row("Collections:", beautify_list(collection_names))
+            click.echo()
+            make_console(emoji=False, markup=False).print(table)
+            click.echo()
+
+        render(ctx, data=lambda: grp._data, table=_table)
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to display group: {e}")
+
+
+@group.command()
+@proj_option
+@format_option
+@max_result_option
+@click.pass_context
+def list(ctx: click.Context):
+    """List all groups"""
+    verify_login_or_prompt(ctx)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        list_of_groups, truncated = take(ctx, server.list_groups_generator())
+
+        def _table():
+            table = Table(title="Groups")
+            table.add_column("Name", style="cyan", no_wrap=True)
+            table.add_column("Description")
+            table.add_column("Created by")
+            table.add_column("Created on")
+            for grp in list_of_groups:
+                table.add_row(
+                    grp.name,
+                    grp.description,
+                    grp.created_by,
+                    grp.created_on_str,
+                )
+            click.echo()
+            make_console().print(table)
+            click.echo(f"Number of groups: {len(list_of_groups)}")
+            click.echo()
+
+        render(ctx, data=lambda: [g._data for g in list_of_groups], table=_table)
+        echo_more_results(ctx, truncated)
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to list groups: {e}")
+
+
+@group.command()
+@proj_option
+@click.option("--name", "-n", help="Name of the group to update.")
+@click.option("--new-name", help="New name for the group.")
+@click.option("--description", help="New description for the group.")
+@click.pass_context
+def update(
+    ctx: click.Context,
+    name: str,
+    new_name: str,
+    description: str,
+):
+    """Update a group by name. System groups cannot be updated."""
+    verify_login_or_prompt(ctx)
+    name = name or logical_prompt(ctx, "Name of the group to update")
+    click.echo(f"Updating group: {name}")
+    click.echo("-" * 10)
+    try:
+        server: TabsdataServer = ctx.obj["tabsdataserver"]
+        server.update_group(name, new_name=new_name, new_description=description)
+        click.echo("Group updated successfully")
+    except Exception as e:
+        hint_common_solutions(ctx, e)
+        raise click.ClickException(f"Failed to update group: {e}")