Merge pull request #2049 from transformerlab/add/cli-task-list-subtype-filter

add --subtype filter to `lab task list`

Author: greninja

cli/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "transformerlab-cli"
-version = "0.0.54"
+version = "0.0.55"
 description = "Transformer Lab CLI"
 requires-python = ">=3.10"
 authors = [{ name = "Transformer Lab", email = "hello@transformerlab.ai" }]

cli/src/transformerlab_cli/commands/task.py

@@ -24,6 +24,18 @@
 REQUIRED_TASK_FIELDS = ["name", "type"]
 
 
+KNOWN_TASK_SUBTYPES = ["interactive"]
+
+
+def _validate_subtype(value: str | None) -> str | None:
+    if value is None:
+        return None
+    normalized = value.lower()
+    if normalized not in KNOWN_TASK_SUBTYPES:
+        raise typer.BadParameter(f"Allowed: {', '.join(KNOWN_TASK_SUBTYPES)}")
+    return normalized
+
+
 def _resolve_experiment_id(experiment_id: str | None = None) -> str:
     """Resolve experiment from command override or configured default."""
     if experiment_id is not None and str(experiment_id).strip():
@@ -78,13 +90,18 @@ def _extract_error_detail(response: httpx.Response) -> str:
     return str(detail)
 
 
-def list_tasks(output_format: str = "pretty", experiment_id: str = "alpha") -> None:
-    """List all REMOTE tasks."""
+def list_tasks(output_format: str = "pretty", experiment_id: str = "alpha", subtype: str | None = None) -> None:
+    """List all REMOTE tasks, optionally filtered by subtype (e.g. 'interactive')."""
+    if subtype:
+        endpoint = f"/experiment/{experiment_id}/task/list_by_subtype_in_experiment?subtype={subtype}&type=REMOTE"
+    else:
+        endpoint = f"/experiment/{experiment_id}/task/list_by_type_in_experiment?type=REMOTE"
+
     if output_format != "json":
         with console.status("[bold success]Fetching tasks...[/bold success]", spinner="dots"):
-            response = api.get(f"/experiment/{experiment_id}/task/list_by_type_in_experiment?type=REMOTE")
+            response = api.get(endpoint)
     else:
-        response = api.get(f"/experiment/{experiment_id}/task/list_by_type_in_experiment?type=REMOTE")
+        response = api.get(endpoint)
 
     if response.status_code == 200:
         tasks = response.json()
@@ -573,10 +590,16 @@ def _validate_task_yaml_file(
 @app.command("list")
 def command_task_list(
     experiment: str | None = typer.Option(None, "--experiment", "-e", help="Override experiment for this command"),
+    subtype: str | None = typer.Option(
+        None,
+        "--subtype",
+        callback=_validate_subtype,
+        help=f"Filter to only tasks with this subtype. Allowed: {', '.join(KNOWN_TASK_SUBTYPES)}.",
+    ),
 ):
     """List all tasks."""
     current_experiment = _resolve_experiment_id(experiment)
-    list_tasks(output_format=cli_state.output_format, experiment_id=current_experiment)
+    list_tasks(output_format=cli_state.output_format, experiment_id=current_experiment, subtype=subtype)
 
 
 TASK_INIT_TEMPLATES_DIR = Path(__file__).resolve().parent.parent / "templates" / "task_init"

cli/tests/commands/test_task.py

@@ -81,6 +81,42 @@ def test_task_list_json_no_spinner(_mock_exp, _mock_api):
     json.loads(result.output.strip())  # must not raise
 
 
+@patch("transformerlab_cli.commands.task.api.get", return_value=_mock_resp(SAMPLE_TASKS))
+@patch("transformerlab_cli.commands.task.require_current_experiment", return_value="exp1")
+def test_task_list_no_subtype_hits_list_by_type(_mock_exp, mock_api_get):
+    """Without --subtype, list calls list_by_type_in_experiment."""
+    result = runner.invoke(app, ["--format", "json", "task", "list"])
+    assert result.exit_code == 0
+    called_url = mock_api_get.call_args.args[0]
+    assert "list_by_type_in_experiment" in called_url
+    assert "type=REMOTE" in called_url
+    assert "subtype=" not in called_url
+
+
+@patch("transformerlab_cli.commands.task.api.get", return_value=_mock_resp(SAMPLE_TASKS))
+@patch("transformerlab_cli.commands.task.require_current_experiment", return_value="exp1")
+def test_task_list_with_subtype_hits_list_by_subtype(_mock_exp, mock_api_get):
+    """--subtype interactive routes to list_by_subtype_in_experiment with the right query params."""
+    result = runner.invoke(app, ["--format", "json", "task", "list", "--subtype", "interactive"])
+    assert result.exit_code == 0
+    called_url = mock_api_get.call_args.args[0]
+    assert "list_by_subtype_in_experiment" in called_url
+    assert "subtype=interactive" in called_url
+    assert "type=REMOTE" in called_url
+
+
+@patch("transformerlab_cli.commands.task.api.get", return_value=_mock_resp(SAMPLE_TASKS))
+@patch("transformerlab_cli.commands.task.require_current_experiment", return_value="exp1")
+def test_task_list_rejects_unknown_subtype(_mock_exp, mock_api_get):
+    """--subtype <unknown> exits non-zero with an Allowed: ... error and does not hit the server."""
+    result = runner.invoke(app, ["task", "list", "--subtype", "cuckoo"])
+    assert result.exit_code != 0
+    out = _cli_output(result)
+    assert "Invalid value for '--subtype'" in out
+    assert "Allowed: interactive" in out
+    mock_api_get.assert_not_called()
+
+
 def test_build_launch_payload_includes_description():
     """build_launch_payload forwards the description to the launch API body."""
     task = {"id": "t1", "name": "finetune", "experiment_id": "exp1", "run": "python main.py"}