flwr-nightly 1.14.0.dev20241203__py3-none-any.whl → 1.14.0.dev20241205__py3-none-any.whl

flwr/cli/ls.py

@@ -15,16 +15,19 @@
 """Flower command line interface `ls` command."""
 
 
+import io
+import json
 from datetime import datetime, timedelta
 from logging import DEBUG
 from pathlib import Path
-from typing import Annotated, Any, Optional
+from typing import Annotated, Any, Optional, Union
 
 import grpc
 import typer
 from rich.console import Console
 from rich.table import Table
 from rich.text import Text
+from typer import Exit
 
 from flwr.cli.config_utils import (
     load_and_validate,
@@ -32,10 +35,10 @@ from flwr.cli.config_utils import (
     validate_federation_in_project_config,
     validate_project_config,
 )
-from flwr.common.constant import FAB_CONFIG_FILE, SubStatus
+from flwr.common.constant import FAB_CONFIG_FILE, CliOutputFormat, SubStatus
 from flwr.common.date import format_timedelta, isoformat8601_utc
 from flwr.common.grpc import GRPC_MAX_MESSAGE_LENGTH, create_channel
-from flwr.common.logger import log
+from flwr.common.logger import log, redirect_output, remove_emojis, restore_output
 from flwr.common.serde import run_from_proto
 from flwr.common.typing import Run
 from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
@@ -44,8 +47,10 @@ from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.exec_pb2_grpc import ExecStub
 
+_RunListType = tuple[int, str, str, str, str, str, str, str, str]
 
-def ls(
+
+def ls(  # pylint: disable=too-many-locals, too-many-branches
     app: Annotated[
         Path,
         typer.Argument(help="Path of the Flower project"),
@@ -68,54 +73,85 @@ def ls(
             help="Specific run ID to display",
         ),
     ] = None,
+    output_format: Annotated[
+        str,
+        typer.Option(
+            "--format",
+            case_sensitive=False,
+            help="Format output using 'default' view or 'json'",
+        ),
+    ] = CliOutputFormat.DEFAULT,
 ) -> None:
     """List runs."""
-    # Load and validate federation config
-    typer.secho("Loading project configuration... ", fg=typer.colors.BLUE)
-
-    pyproject_path = app / FAB_CONFIG_FILE if app else None
-    config, errors, warnings = load_and_validate(path=pyproject_path)
-    config = validate_project_config(config, errors, warnings)
-    federation, federation_config = validate_federation_in_project_config(
-        federation, config
-    )
+    suppress_output = output_format == CliOutputFormat.JSON
+    captured_output = io.StringIO()
+    try:
+        if suppress_output:
+            redirect_output(captured_output)
+
+        # Load and validate federation config
+        typer.secho("Loading project configuration... ", fg=typer.colors.BLUE)
 
-    if "address" not in federation_config:
-        typer.secho(
-            "❌ `flwr ls` currently works with Exec API. Ensure that the correct"
-            "Exec API address is provided in the `pyproject.toml`.",
-            fg=typer.colors.RED,
-            bold=True,
+        pyproject_path = app / FAB_CONFIG_FILE if app else None
+        config, errors, warnings = load_and_validate(path=pyproject_path)
+        config = validate_project_config(config, errors, warnings)
+        federation, federation_config = validate_federation_in_project_config(
+            federation, config
         )
-        raise typer.Exit(code=1)
 
-    try:
-        if runs and run_id is not None:
-            raise ValueError(
-                "The options '--runs' and '--run-id' are mutually exclusive."
+        if "address" not in federation_config:
+            typer.secho(
+                "❌ `flwr ls` currently works with Exec API. Ensure that the correct"
+                "Exec API address is provided in the `pyproject.toml`.",
+                fg=typer.colors.RED,
+                bold=True,
             )
-
-        channel = _init_channel(app, federation_config)
-        stub = ExecStub(channel)
-
-        # Display information about a specific run ID
-        if run_id is not None:
-            typer.echo(f"🔍 Displaying information for run ID {run_id}...")
-            _display_one_run(stub, run_id)
-        # By default, list all runs
+            raise typer.Exit(code=1)
+
+        try:
+            if runs and run_id is not None:
+                raise ValueError(
+                    "The options '--runs' and '--run-id' are mutually exclusive."
+                )
+
+            channel = _init_channel(app, federation_config)
+            stub = ExecStub(channel)
+
+            # Display information about a specific run ID
+            if run_id is not None:
+                typer.echo(f"🔍 Displaying information for run ID {run_id}...")
+                restore_output()
+                _display_one_run(stub, run_id, output_format)
+            # By default, list all runs
+            else:
+                typer.echo("📄 Listing all runs...")
+                restore_output()
+                _list_runs(stub, output_format)
+
+        except ValueError as err:
+            typer.secho(
+                f"❌ {err}",
+                fg=typer.colors.RED,
+                bold=True,
+            )
+            raise typer.Exit(code=1) from err
+        finally:
+            channel.close()
+    except (typer.Exit, Exception) as err:  # pylint: disable=broad-except
+        if suppress_output:
+            restore_output()
+            e_message = captured_output.getvalue()
+            _print_json_error(e_message, err)
         else:
-            typer.echo("📄 Listing all runs...")
-            _list_runs(stub)
-
-    except ValueError as err:
-        typer.secho(
-            f"❌ {err}",
-            fg=typer.colors.RED,
-            bold=True,
-        )
-        raise typer.Exit(code=1) from err
+            typer.secho(
+                f"{err}",
+                fg=typer.colors.RED,
+                bold=True,
+            )
     finally:
-        channel.close()
+        if suppress_output:
+            restore_output()
+        captured_output.close()
 
 
 def on_channel_state_change(channel_connectivity: str) -> None:
@@ -139,23 +175,13 @@ def _init_channel(app: Path, federation_config: dict[str, Any]) -> grpc.Channel:
     return channel
 
 
-def _format_run_table(run_dict: dict[int, Run], now_isoformat: str) -> Table:
-    """Format run status as a rich Table."""
-    table = Table(header_style="bold cyan", show_lines=True)
+def _format_runs(run_dict: dict[int, Run], now_isoformat: str) -> list[_RunListType]:
+    """Format runs to a list."""
 
     def _format_datetime(dt: Optional[datetime]) -> str:
         return isoformat8601_utc(dt).replace("T", " ") if dt else "N/A"
 
-    # Add columns
-    table.add_column(
-        Text("Run ID", justify="center"), style="bright_white", overflow="fold"
-    )
-    table.add_column(Text("FAB", justify="center"), style="dim white")
-    table.add_column(Text("Status", justify="center"))
-    table.add_column(Text("Elapsed", justify="center"), style="blue")
-    table.add_column(Text("Created At", justify="center"), style="dim white")
-    table.add_column(Text("Running At", justify="center"), style="dim white")
-    table.add_column(Text("Finished At", justify="center"), style="dim white")
+    run_list: list[_RunListType] = []
 
     # Add rows
     for run in sorted(
@@ -167,15 +193,6 @@ def _format_run_table(run_dict: dict[int, Run], now_isoformat: str) -> Table:
         else:
             status_text = f"{run.status.status}:{run.status.sub_status}"
 
-        # Style the status based on its value
-        sub_status = run.status.sub_status
-        if sub_status == SubStatus.COMPLETED:
-            status_style = "green"
-        elif sub_status == SubStatus.FAILED:
-            status_style = "red"
-        else:
-            status_style = "yellow"
-
         # Convert isoformat to datetime
         pending_at = datetime.fromisoformat(run.pending_at) if run.pending_at else None
         running_at = datetime.fromisoformat(run.running_at) if run.running_at else None
@@ -192,31 +209,124 @@ def _format_run_table(run_dict: dict[int, Run], now_isoformat: str) -> Table:
                 end_time = datetime.fromisoformat(now_isoformat)
             elapsed_time = end_time - running_at
 
-        table.add_row(
-            f"[bold]{run.run_id}[/bold]",
-            f"{run.fab_id} (v{run.fab_version})",
+        run_list.append(
+            (
+                run.run_id,
+                run.fab_id,
+                run.fab_version,
+                run.fab_hash,
+                status_text,
+                format_timedelta(elapsed_time),
+                _format_datetime(pending_at),
+                _format_datetime(running_at),
+                _format_datetime(finished_at),
+            )
+        )
+    return run_list
+
+
+def _to_table(run_list: list[_RunListType]) -> Table:
+    """Format the provided run list to a rich Table."""
+    table = Table(header_style="bold cyan", show_lines=True)
+
+    # Add columns
+    table.add_column(
+        Text("Run ID", justify="center"), style="bright_white", overflow="fold"
+    )
+    table.add_column(Text("FAB", justify="center"), style="dim white")
+    table.add_column(Text("Status", justify="center"))
+    table.add_column(Text("Elapsed", justify="center"), style="blue")
+    table.add_column(Text("Created At", justify="center"), style="dim white")
+    table.add_column(Text("Running At", justify="center"), style="dim white")
+    table.add_column(Text("Finished At", justify="center"), style="dim white")
+
+    for row in run_list:
+        (
+            run_id,
+            fab_id,
+            fab_version,
+            _,
+            status_text,
+            elapsed,
+            created_at,
+            running_at,
+            finished_at,
+        ) = row
+        # Style the status based on its value
+        sub_status = status_text.rsplit(":", maxsplit=1)[-1]
+        if sub_status == SubStatus.COMPLETED:
+            status_style = "green"
+        elif sub_status == SubStatus.FAILED:
+            status_style = "red"
+        else:
+            status_style = "yellow"
+
+        formatted_row = (
+            f"[bold]{run_id}[/bold]",
+            f"{fab_id} (v{fab_version})",
             f"[{status_style}]{status_text}[/{status_style}]",
-            format_timedelta(elapsed_time),
-            _format_datetime(pending_at),
-            _format_datetime(running_at),
-            _format_datetime(finished_at),
+            elapsed,
+            created_at,
+            running_at,
+            finished_at,
         )
+        table.add_row(*formatted_row)
+
     return table
 
 
+def _to_json(run_list: list[_RunListType]) -> str:
+    """Format run status list to a JSON formatted string."""
+    runs_list = []
+    for row in run_list:
+        (
+            run_id,
+            fab_id,
+            fab_version,
+            fab_hash,
+            status_text,
+            elapsed,
+            created_at,
+            running_at,
+            finished_at,
+        ) = row
+        runs_list.append(
+            {
+                "run-id": run_id,
+                "fab-id": fab_id,
+                "fab-name": fab_id.split("/")[-1],
+                "fab-version": fab_version,
+                "fab-hash": fab_hash[:8],
+                "status": status_text,
+                "elapsed": elapsed,
+                "created-at": created_at,
+                "running-at": running_at,
+                "finished-at": finished_at,
+            }
+        )
+
+    return json.dumps({"success": True, "runs": runs_list})
+
+
 def _list_runs(
     stub: ExecStub,
+    output_format: str = CliOutputFormat.DEFAULT,
 ) -> None:
     """List all runs."""
     res: ListRunsResponse = stub.ListRuns(ListRunsRequest())
     run_dict = {run_id: run_from_proto(proto) for run_id, proto in res.run_dict.items()}
 
-    Console().print(_format_run_table(run_dict, res.now))
+    formatted_runs = _format_runs(run_dict, res.now)
+    if output_format == CliOutputFormat.JSON:
+        Console().print_json(_to_json(formatted_runs))
+    else:
+        Console().print(_to_table(formatted_runs))
 
 
 def _display_one_run(
     stub: ExecStub,
     run_id: int,
+    output_format: str = CliOutputFormat.DEFAULT,
 ) -> None:
     """Display information about a specific run."""
     res: ListRunsResponse = stub.ListRuns(ListRunsRequest(run_id=run_id))
@@ -225,4 +335,20 @@ def _display_one_run(
 
     run_dict = {run_id: run_from_proto(proto) for run_id, proto in res.run_dict.items()}
 
-    Console().print(_format_run_table(run_dict, res.now))
+    formatted_runs = _format_runs(run_dict, res.now)
+    if output_format == CliOutputFormat.JSON:
+        Console().print_json(_to_json(formatted_runs))
+    else:
+        Console().print(_to_table(formatted_runs))
+
+
+def _print_json_error(msg: str, e: Union[Exit, Exception]) -> None:
+    """Print error message as JSON."""
+    Console().print_json(
+        json.dumps(
+            {
+                "success": False,
+                "error-message": remove_emojis(str(msg) + "\n" + str(e)),
+            }
+        )
+    )

flwr/cli/run/run.py

@@ -14,16 +14,19 @@
 # ==============================================================================
 """Flower command line interface `run` command."""
 
+import io
 import json
 import subprocess
 from logging import DEBUG
 from pathlib import Path
-from typing import Annotated, Any, Optional
+from typing import Annotated, Any, Optional, Union
 
 import typer
+from rich.console import Console
 
 from flwr.cli.build import build
 from flwr.cli.config_utils import (
+    get_fab_metadata,
     load_and_validate,
     validate_certificate_in_federation_config,
     validate_federation_in_project_config,
@@ -34,8 +37,9 @@ from flwr.common.config import (
     parse_config_args,
     user_config_to_configsrecord,
 )
+from flwr.common.constant import CliOutputFormat
 from flwr.common.grpc import GRPC_MAX_MESSAGE_LENGTH, create_channel
-from flwr.common.logger import log
+from flwr.common.logger import log, redirect_output, remove_emojis, restore_output
 from flwr.common.serde import (
     configs_record_to_proto,
     fab_to_proto,
@@ -85,21 +89,51 @@ def run(
             "logs are not streamed by default.",
         ),
     ] = False,
+    output_format: Annotated[
+        str,
+        typer.Option(
+            "--format",
+            case_sensitive=False,
+            help="Format output using 'default' view or 'json'",
+        ),
+    ] = CliOutputFormat.DEFAULT,
 ) -> None:
     """Run Flower App."""
-    typer.secho("Loading project configuration... ", fg=typer.colors.BLUE)
+    suppress_output = output_format == CliOutputFormat.JSON
+    captured_output = io.StringIO()
+    try:
+        if suppress_output:
+            redirect_output(captured_output)
+        typer.secho("Loading project configuration... ", fg=typer.colors.BLUE)
 
-    pyproject_path = app / "pyproject.toml" if app else None
-    config, errors, warnings = load_and_validate(path=pyproject_path)
-    config = validate_project_config(config, errors, warnings)
-    federation, federation_config = validate_federation_in_project_config(
-        federation, config
-    )
+        pyproject_path = app / "pyproject.toml" if app else None
+        config, errors, warnings = load_and_validate(path=pyproject_path)
+        config = validate_project_config(config, errors, warnings)
+        federation, federation_config = validate_federation_in_project_config(
+            federation, config
+        )
 
-    if "address" in federation_config:
-        _run_with_exec_api(app, federation_config, config_overrides, stream)
-    else:
-        _run_without_exec_api(app, federation_config, config_overrides, federation)
+        if "address" in federation_config:
+            _run_with_exec_api(
+                app, federation_config, config_overrides, stream, output_format
+            )
+        else:
+            _run_without_exec_api(app, federation_config, config_overrides, federation)
+    except (typer.Exit, Exception) as err:  # pylint: disable=broad-except
+        if suppress_output:
+            restore_output()
+            e_message = captured_output.getvalue()
+            _print_json_error(e_message, err)
+        else:
+            typer.secho(
+                f"{err}",
+                fg=typer.colors.RED,
+                bold=True,
+            )
+    finally:
+        if suppress_output:
+            restore_output()
+        captured_output.close()
 
 
 # pylint: disable-next=too-many-locals
@@ -108,6 +142,7 @@ def _run_with_exec_api(
     federation_config: dict[str, Any],
     config_overrides: Optional[list[str]],
     stream: bool,
+    output_format: str,
 ) -> None:
 
     insecure, root_certificates_bytes = validate_certificate_in_federation_config(
@@ -125,6 +160,7 @@ def _run_with_exec_api(
 
     fab_path, fab_hash = build(app)
     content = Path(fab_path).read_bytes()
+    fab_id, fab_version = get_fab_metadata(Path(fab_path))
 
     # Delete FAB file once the bytes is computed
     Path(fab_path).unlink()
@@ -142,7 +178,26 @@ def _run_with_exec_api(
     )
     res = stub.StartRun(req)
 
-    typer.secho(f"🎊 Successfully started run {res.run_id}", fg=typer.colors.GREEN)
+    if res.HasField("run_id"):
+        typer.secho(f"🎊 Successfully started run {res.run_id}", fg=typer.colors.GREEN)
+    else:
+        typer.secho("❌ Failed to start run", fg=typer.colors.RED)
+        raise typer.Exit(code=1)
+
+    if output_format == CliOutputFormat.JSON:
+        run_output = json.dumps(
+            {
+                "success": res.HasField("run_id"),
+                "run-id": res.run_id if res.HasField("run_id") else None,
+                "fab-id": fab_id,
+                "fab-name": fab_id.rsplit("/", maxsplit=1)[-1],
+                "fab-version": fab_version,
+                "fab-hash": fab_hash[:8],
+                "fab-filename": fab_path,
+            }
+        )
+        restore_output()
+        Console().print_json(run_output)
 
     if stream:
         start_stream(res.run_id, channel, CONN_REFRESH_PERIOD)
@@ -194,3 +249,15 @@ def _run_without_exec_api(
         check=True,
         text=True,
     )
+
+
+def _print_json_error(msg: str, e: Union[typer.Exit, Exception]) -> None:
+    """Print error message as JSON."""
+    Console().print_json(
+        json.dumps(
+            {
+                "success": False,
+                "error-message": remove_emojis(str(msg) + "\n" + str(e)),
+            }
+        )
+    )

flwr/common/constant.py

@@ -181,3 +181,14 @@ class SubStatus:
     def __new__(cls) -> SubStatus:
         """Prevent instantiation."""
         raise TypeError(f"{cls.__name__} cannot be instantiated.")
+
+
+class CliOutputFormat:
+    """Define output format for `flwr` CLI commands."""
+
+    DEFAULT = "default"
+    JSON = "json"
+
+    def __new__(cls) -> CliOutputFormat:
+        """Prevent instantiation."""
+        raise TypeError(f"{cls.__name__} cannot be instantiated.")

flwr/common/logger.py

@@ -14,11 +14,12 @@
 # ==============================================================================
 """Flower Logger."""
 
-
 import logging
+import re
 import sys
 import threading
 import time
+from io import StringIO
 from logging import WARN, LogRecord
 from logging.handlers import HTTPHandler
 from queue import Empty, Queue
@@ -303,6 +304,13 @@ def restore_output() -> None:
     console_handler.stream = sys.stdout
 
 
+def redirect_output(output_buffer: StringIO) -> None:
+    """Redirect stdout and stderr to text I/O buffer."""
+    sys.stdout = output_buffer
+    sys.stderr = output_buffer
+    console_handler.stream = sys.stdout
+
+
 def _log_uploader(
     log_queue: Queue[Optional[str]], node_id: int, run_id: int, stub: ServerAppIoStub
 ) -> None:
@@ -366,3 +374,19 @@ def stop_log_uploader(
     """Stop the log uploader thread."""
     log_queue.put(None)
     log_uploader.join()
+
+
+def remove_emojis(text: str) -> str:
+    """Remove emojis from the provided text."""
+    emoji_pattern = re.compile(
+        "["
+        "\U0001F600-\U0001F64F"  # Emoticons
+        "\U0001F300-\U0001F5FF"  # Symbols & Pictographs
+        "\U0001F680-\U0001F6FF"  # Transport & Map Symbols
+        "\U0001F1E0-\U0001F1FF"  # Flags
+        "\U00002702-\U000027B0"  # Dingbats
+        "\U000024C2-\U0001F251"
+        "]+",
+        flags=re.UNICODE,
+    )
+    return emoji_pattern.sub(r"", text)

flwr/proto/exec_pb2.py

@@ -18,7 +18,7 @@ from flwr.proto import recordset_pb2 as flwr_dot_proto_dot_recordset__pb2
 from flwr.proto import run_pb2 as flwr_dot_proto_dot_run__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/exec.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x1a\x66lwr/proto/transport.proto\x1a\x1a\x66lwr/proto/recordset.proto\x1a\x14\x66lwr/proto/run.proto\"\xfb\x01\n\x0fStartRunRequest\x12\x1c\n\x03\x66\x61\x62\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Fab\x12H\n\x0foverride_config\x18\x02 \x03(\x0b\x32/.flwr.proto.StartRunRequest.OverrideConfigEntry\x12\x35\n\x12\x66\x65\x64\x65ration_options\x18\x03 \x01(\x0b\x32\x19.flwr.proto.ConfigsRecord\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"\"\n\x10StartRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"<\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x17\n\x0f\x61\x66ter_timestamp\x18\x02 \x01(\x01\"B\n\x12StreamLogsResponse\x12\x12\n\nlog_output\x18\x01 \x01(\t\x12\x18\n\x10latest_timestamp\x18\x02 \x01(\x01\"1\n\x0fListRunsRequest\x12\x13\n\x06run_id\x18\x01 \x01(\x04H\x00\x88\x01\x01\x42\t\n\x07_run_id\"\x9d\x01\n\x10ListRunsResponse\x12;\n\x08run_dict\x18\x01 \x03(\x0b\x32).flwr.proto.ListRunsResponse.RunDictEntry\x12\x0b\n\x03now\x18\x02 \x01(\t\x1a?\n\x0cRunDictEntry\x12\x0b\n\x03key\x18\x01 \x01(\x04\x12\x1e\n\x05value\x18\x02 \x01(\x0b\x32\x0f.flwr.proto.Run:\x02\x38\x01\x32\xe9\x01\n\x04\x45xec\x12G\n\x08StartRun\x12\x1b.flwr.proto.StartRunRequest\x1a\x1c.flwr.proto.StartRunResponse\"\x00\x12O\n\nStreamLogs\x12\x1d.flwr.proto.StreamLogsRequest\x1a\x1e.flwr.proto.StreamLogsResponse\"\x00\x30\x01\x12G\n\x08ListRuns\x12\x1b.flwr.proto.ListRunsRequest\x1a\x1c.flwr.proto.ListRunsResponse\"\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/exec.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x1a\x66lwr/proto/transport.proto\x1a\x1a\x66lwr/proto/recordset.proto\x1a\x14\x66lwr/proto/run.proto\"\xfb\x01\n\x0fStartRunRequest\x12\x1c\n\x03\x66\x61\x62\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Fab\x12H\n\x0foverride_config\x18\x02 \x03(\x0b\x32/.flwr.proto.StartRunRequest.OverrideConfigEntry\x12\x35\n\x12\x66\x65\x64\x65ration_options\x18\x03 \x01(\x0b\x32\x19.flwr.proto.ConfigsRecord\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"2\n\x10StartRunResponse\x12\x13\n\x06run_id\x18\x01 \x01(\x04H\x00\x88\x01\x01\x42\t\n\x07_run_id\"<\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x17\n\x0f\x61\x66ter_timestamp\x18\x02 \x01(\x01\"B\n\x12StreamLogsResponse\x12\x12\n\nlog_output\x18\x01 \x01(\t\x12\x18\n\x10latest_timestamp\x18\x02 \x01(\x01\"1\n\x0fListRunsRequest\x12\x13\n\x06run_id\x18\x01 \x01(\x04H\x00\x88\x01\x01\x42\t\n\x07_run_id\"\x9d\x01\n\x10ListRunsResponse\x12;\n\x08run_dict\x18\x01 \x03(\x0b\x32).flwr.proto.ListRunsResponse.RunDictEntry\x12\x0b\n\x03now\x18\x02 \x01(\t\x1a?\n\x0cRunDictEntry\x12\x0b\n\x03key\x18\x01 \x01(\x04\x12\x1e\n\x05value\x18\x02 \x01(\x0b\x32\x0f.flwr.proto.Run:\x02\x38\x01\" \n\x0eStopRunRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"\"\n\x0fStopRunResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\x32\xaf\x02\n\x04\x45xec\x12G\n\x08StartRun\x12\x1b.flwr.proto.StartRunRequest\x1a\x1c.flwr.proto.StartRunResponse\"\x00\x12\x44\n\x07StopRun\x12\x1a.flwr.proto.StopRunRequest\x1a\x1b.flwr.proto.StopRunResponse\"\x00\x12O\n\nStreamLogs\x12\x1d.flwr.proto.StreamLogsRequest\x1a\x1e.flwr.proto.StreamLogsResponse\"\x00\x30\x01\x12G\n\x08ListRuns\x12\x1b.flwr.proto.ListRunsRequest\x1a\x1c.flwr.proto.ListRunsResponse\"\x00\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -34,17 +34,21 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=316
   _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=389
   _globals['_STARTRUNRESPONSE']._serialized_start=391
-  _globals['_STARTRUNRESPONSE']._serialized_end=425
-  _globals['_STREAMLOGSREQUEST']._serialized_start=427
-  _globals['_STREAMLOGSREQUEST']._serialized_end=487
-  _globals['_STREAMLOGSRESPONSE']._serialized_start=489
-  _globals['_STREAMLOGSRESPONSE']._serialized_end=555
-  _globals['_LISTRUNSREQUEST']._serialized_start=557
-  _globals['_LISTRUNSREQUEST']._serialized_end=606
-  _globals['_LISTRUNSRESPONSE']._serialized_start=609
-  _globals['_LISTRUNSRESPONSE']._serialized_end=766
-  _globals['_LISTRUNSRESPONSE_RUNDICTENTRY']._serialized_start=703
-  _globals['_LISTRUNSRESPONSE_RUNDICTENTRY']._serialized_end=766
-  _globals['_EXEC']._serialized_start=769
-  _globals['_EXEC']._serialized_end=1002
+  _globals['_STARTRUNRESPONSE']._serialized_end=441
+  _globals['_STREAMLOGSREQUEST']._serialized_start=443
+  _globals['_STREAMLOGSREQUEST']._serialized_end=503
+  _globals['_STREAMLOGSRESPONSE']._serialized_start=505
+  _globals['_STREAMLOGSRESPONSE']._serialized_end=571
+  _globals['_LISTRUNSREQUEST']._serialized_start=573
+  _globals['_LISTRUNSREQUEST']._serialized_end=622
+  _globals['_LISTRUNSRESPONSE']._serialized_start=625
+  _globals['_LISTRUNSRESPONSE']._serialized_end=782
+  _globals['_LISTRUNSRESPONSE_RUNDICTENTRY']._serialized_start=719
+  _globals['_LISTRUNSRESPONSE_RUNDICTENTRY']._serialized_end=782
+  _globals['_STOPRUNREQUEST']._serialized_start=784
+  _globals['_STOPRUNREQUEST']._serialized_end=816
+  _globals['_STOPRUNRESPONSE']._serialized_start=818
+  _globals['_STOPRUNRESPONSE']._serialized_end=852
+  _globals['_EXEC']._serialized_start=855
+  _globals['_EXEC']._serialized_end=1158
 # @@protoc_insertion_point(module_scope)

flwr/proto/exec_pb2.pyi

@@ -57,9 +57,11 @@ class StartRunResponse(google.protobuf.message.Message):
     run_id: builtins.int
     def __init__(self,
         *,
-        run_id: builtins.int = ...,
+        run_id: typing.Optional[builtins.int] = ...,
         ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["run_id",b"run_id"]) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["_run_id",b"_run_id","run_id",b"run_id"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["_run_id",b"_run_id","run_id",b"run_id"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_run_id",b"_run_id"]) -> typing.Optional[typing_extensions.Literal["run_id"]]: ...
 global___StartRunResponse = StartRunResponse
 
 class StreamLogsRequest(google.protobuf.message.Message):
@@ -132,3 +134,25 @@ class ListRunsResponse(google.protobuf.message.Message):
         ) -> None: ...
     def ClearField(self, field_name: typing_extensions.Literal["now",b"now","run_dict",b"run_dict"]) -> None: ...
 global___ListRunsResponse = ListRunsResponse
+
+class StopRunRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    RUN_ID_FIELD_NUMBER: builtins.int
+    run_id: builtins.int
+    def __init__(self,
+        *,
+        run_id: builtins.int = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["run_id",b"run_id"]) -> None: ...
+global___StopRunRequest = StopRunRequest
+
+class StopRunResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    SUCCESS_FIELD_NUMBER: builtins.int
+    success: builtins.bool
+    def __init__(self,
+        *,
+        success: builtins.bool = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["success",b"success"]) -> None: ...
+global___StopRunResponse = StopRunResponse