flwr-nightly 1.26.0.dev20260127__py3-none-any.whl → 1.26.0.dev20260129__py3-none-any.whl

flwr/cli/run/run.py

@@ -16,19 +16,17 @@
 
 
 import hashlib
-import io
 import json
 import subprocess
 from pathlib import Path
-from typing import Annotated, Any, cast
+from typing import Annotated, Any
 
 import click
 import typer
-from rich.console import Console
 
 from flwr.cli.build import build_fab_from_disk, get_fab_filename
 from flwr.cli.config_migration import migrate, warn_if_federation_config_overrides
-from flwr.cli.config_utils import load as load_toml
+from flwr.cli.config_utils import load_and_validate
 from flwr.cli.constant import FEDERATION_CONFIG_HELP_MESSAGE, RUN_CONFIG_HELP_MESSAGE
 from flwr.cli.flower_config import (
     _serialize_simulation_options,
@@ -36,12 +34,12 @@ from flwr.cli.flower_config import (
 )
 from flwr.cli.typing import SuperLinkConnection, SuperLinkSimulationOptions
 from flwr.common.config import (
+    flatten_dict,
     get_metadata_from_config,
     parse_config_args,
     user_config_to_configrecord,
 )
 from flwr.common.constant import FAB_CONFIG_FILE, CliOutputFormat
-from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.common.serde import config_record_to_proto, fab_to_proto, user_config_to_proto
 from flwr.common.typing import Fab
 from flwr.proto.control_pb2 import StartRunRequest  # pylint: disable=E0611
@@ -49,7 +47,12 @@ from flwr.proto.control_pb2_grpc import ControlStub
 from flwr.supercore.utils import parse_app_spec
 
 from ..log import start_stream
-from ..utils import flwr_cli_grpc_exc_handler, init_channel_from_connection
+from ..utils import (
+    cli_output_handler,
+    flwr_cli_grpc_exc_handler,
+    init_channel_from_connection,
+    print_json_to_stdout,
+)
 
 CONN_REFRESH_PERIOD = 60  # Connection refresh period for log streaming (seconds)
 
@@ -98,25 +101,19 @@ def run(
     ] = CliOutputFormat.DEFAULT,
 ) -> None:
     """Run Flower App."""
-    suppress_output = output_format == CliOutputFormat.JSON
-    captured_output = io.StringIO()
-
-    if suppress_output:
-        redirect_output(captured_output)
-
-    # Warn `--federation-config` is ignored
-    warn_if_federation_config_overrides(federation_config_overrides)
+    with cli_output_handler(output_format=output_format) as is_json:
+        # Warn `--federation-config` is ignored
+        warn_if_federation_config_overrides(federation_config_overrides)
 
-    # Migrate legacy usage if any
-    migrate(str(app), [], ignore_legacy_usage=True)
+        # Migrate legacy usage if any
+        migrate(str(app), [], ignore_legacy_usage=True)
 
-    # Read superlink connection configuration
-    superlink_connection = read_superlink_connection(superlink)
-
-    try:
+        # Read superlink connection configuration
+        superlink_connection = read_superlink_connection(superlink)
 
         # Determine if app is remote
         app_spec = None
+        config: dict[str, Any] = {}
         if (app_str := str(app)).startswith("@"):
             # Validate app version and ID format
             try:
@@ -125,16 +122,27 @@ def run(
                 raise click.ClickException(str(e)) from e
 
             app_spec = app_str
-            # Set `app` to current directory for credential storage
-            app = Path(".")
+
+        # Validate TOML configuration for local app
+        else:
+            config, warnings = load_and_validate(app / FAB_CONFIG_FILE)
+            if warnings:
+                typer.secho(
+                    "Missing recommended fields in Flower App configuration "
+                    "(pyproject.toml):\n"
+                    + "\n".join([f"- {line}" for line in warnings]),
+                    fg=typer.colors.YELLOW,
+                    bold=True,
+                )
 
         if superlink_connection.address:
             _run_with_control_api(
                 app,
+                config,
                 superlink_connection,
                 run_config_overrides,
                 stream,
-                output_format,
+                is_json,
                 app_spec,
             )
         else:
@@ -143,26 +151,16 @@ def run(
                 simulation_options=superlink_connection.options,  # type: ignore
                 config_overrides=run_config_overrides,
             )
-    except Exception as err:  # pylint: disable=broad-except
-        if suppress_output:
-            restore_output()
-            e_message = captured_output.getvalue()
-            print_json_error(e_message, err)
-        else:
-            raise click.ClickException(str(err)) from None
-    finally:
-        if suppress_output:
-            restore_output()
-        captured_output.close()
 
 
 # pylint: disable-next=R0913, R0914, R0917
 def _run_with_control_api(
     app: Path,
+    config: dict[str, Any],
     superlink_connection: SuperLinkConnection,
     config_overrides: list[str] | None,
     stream: bool,
-    output_format: str,
+    is_json: bool,
     app_spec: str | None,
 ) -> None:
     channel = None
@@ -175,7 +173,6 @@ def _run_with_control_api(
         if not is_remote_app:
             fab_bytes = build_fab_from_disk(app)
             fab_hash = hashlib.sha256(fab_bytes).hexdigest()
-            config = cast(dict[str, Any], load_toml(app / FAB_CONFIG_FILE))
             fab_id, fab_version = get_metadata_from_config(config)
             fab = Fab(fab_hash, fab_bytes, {})
         # Skip FAB build if remote app
@@ -187,7 +184,9 @@ def _run_with_control_api(
         # Construct a `ConfigRecord` out of a flattened `UserConfig`
         options = {}
         if superlink_connection.options:
-            options = _serialize_simulation_options(superlink_connection.options)
+            options = flatten_dict(
+                _serialize_simulation_options(superlink_connection.options)
+            )
 
         c_record = user_config_to_configrecord(options)
 
@@ -208,7 +207,7 @@ def _run_with_control_api(
         else:
             raise click.ClickException("Failed to start run")
 
-        if output_format == CliOutputFormat.JSON:
+        if is_json:
             # Only include FAB metadata if we actually built a local FAB
             payload: dict[str, Any] = {
                 "success": res.HasField("run_id"),
@@ -224,8 +223,7 @@ def _run_with_control_api(
                         "fab-filename": get_fab_filename(config, fab_hash),
                     }
                 )
-            restore_output()
-            Console().print_json(json.dumps(payload))
+            print_json_to_stdout(payload)
 
         if stream:
             start_stream(res.run_id, channel, CONN_REFRESH_PERIOD)
@@ -241,7 +239,7 @@ def _run_without_control_api(
 ) -> None:
 
     num_supernodes = simulation_options.num_supernodes
-    verbose = False  # bool | None = superlink_connection.options.verbose
+    verbose = simulation_options.verbose or False
 
     command = [
         "flower-simulation",

flwr/cli/stop.py

@@ -15,26 +15,27 @@
 """Flower command line interface `stop` command."""
 
 
-import io
-import json
 from typing import Annotated
 
 import click
 import typer
-from rich.console import Console
 
 from flwr.cli.config_migration import migrate, warn_if_federation_config_overrides
 from flwr.cli.constant import FEDERATION_CONFIG_HELP_MESSAGE
 from flwr.cli.flower_config import read_superlink_connection
 from flwr.common.constant import CliOutputFormat
-from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     StopRunRequest,
     StopRunResponse,
 )
 from flwr.proto.control_pb2_grpc import ControlStub
 
-from .utils import flwr_cli_grpc_exc_handler, init_channel_from_connection
+from .utils import (
+    cli_output_handler,
+    flwr_cli_grpc_exc_handler,
+    init_channel_from_connection,
+    print_json_to_stdout,
+)
 
 
 def stop(  # pylint: disable=R0914
@@ -69,48 +70,29 @@ def stop(  # pylint: disable=R0914
     This command stops a running Flower App execution by sending a stop request to the
     SuperLink via the Control API.
     """
-    suppress_output = output_format == CliOutputFormat.JSON
-    captured_output = io.StringIO()
-
-    if suppress_output:
-        redirect_output(captured_output)
-
-    # Warn `--federation-config` is ignored
-    warn_if_federation_config_overrides(federation_config_overrides)
+    with cli_output_handler(output_format=output_format) as is_json:
+        # Warn `--federation-config` is ignored
+        warn_if_federation_config_overrides(federation_config_overrides)
 
-    migrate(superlink, args=ctx.args)
+        migrate(superlink, args=ctx.args)
 
-    # Read superlink connection configuration
-    superlink_connection = read_superlink_connection(superlink)
-    channel = None
+        # Read superlink connection configuration
+        superlink_connection = read_superlink_connection(superlink)
+        channel = None
 
-    try:
         try:
             channel = init_channel_from_connection(superlink_connection)
             stub = ControlStub(channel)  # pylint: disable=unused-variable # noqa: F841
 
             typer.secho(f"✋ Stopping run ID {run_id}...", fg=typer.colors.GREEN)
-            _stop_run(stub=stub, run_id=run_id, output_format=output_format)
+            _stop_run(stub=stub, run_id=run_id, is_json=is_json)
 
-        except ValueError as err:
-            raise click.ClickException(str(err)) from err
         finally:
             if channel:
                 channel.close()
-    except Exception as err:  # pylint: disable=broad-except
-        if suppress_output:
-            restore_output()
-            e_message = captured_output.getvalue()
-            print_json_error(e_message, err)
-        else:
-            raise click.ClickException(str(err)) from None
-    finally:
-        if suppress_output:
-            restore_output()
-        captured_output.close()
-
-
-def _stop_run(stub: ControlStub, run_id: int, output_format: str) -> None:
+
+
+def _stop_run(stub: ControlStub, run_id: int, is_json: bool) -> None:
     """Stop a run and display the result.
 
     Parameters
@@ -119,21 +101,19 @@ def _stop_run(stub: ControlStub, run_id: int, output_format: str) -> None:
         The gRPC stub for Control API communication.
     run_id : int
         The unique identifier of the run to stop.
-    output_format : str
-        Output format ('default' or 'json').
+    is_json : bool
+        Whether JSON output format is requested.
     """
     with flwr_cli_grpc_exc_handler():
         response: StopRunResponse = stub.StopRun(request=StopRunRequest(run_id=run_id))
     if response.success:
         typer.secho(f"✅ Run {run_id} successfully stopped.", fg=typer.colors.GREEN)
-        if output_format == CliOutputFormat.JSON:
-            run_output = json.dumps(
+        if is_json:
+            print_json_to_stdout(
                 {
                     "success": True,
                     "run-id": f"{run_id}",
                 }
             )
-            restore_output()
-            Console().print_json(run_output)
     else:
         raise click.ClickException(f"Run {run_id} couldn't be stopped.")

flwr/cli/supernode/ls.py

@@ -15,7 +15,6 @@
 """Flower command line interface `supernode list` command."""
 
 
-import io
 import json
 from datetime import datetime, timedelta
 from typing import Annotated
@@ -28,7 +27,6 @@ from rich.text import Text
 from flwr.cli.config_migration import migrate
 from flwr.cli.flower_config import read_superlink_connection
 from flwr.common.constant import NOOP_ACCOUNT_NAME, CliOutputFormat
-from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     ListNodesRequest,
     ListNodesResponse,
@@ -38,7 +36,12 @@ from flwr.proto.node_pb2 import NodeInfo  # pylint: disable=E0611
 from flwr.supercore.date import isoformat8601_utc
 from flwr.supercore.utils import humanize_duration
 
-from ..utils import flwr_cli_grpc_exc_handler, init_channel_from_connection
+from ..utils import (
+    cli_output_handler,
+    flwr_cli_grpc_exc_handler,
+    init_channel_from_connection,
+    print_json_to_stdout,
+)
 
 _NodeListType = tuple[int, str, str, str, str, str, str, str, float]
 
@@ -66,50 +69,29 @@ def ls(  # pylint: disable=R0914, R0913, R0917
         ),
     ] = False,
 ) -> None:
-    """List SuperNodes in the federation."""
-    suppress_output = output_format == CliOutputFormat.JSON
-    captured_output = io.StringIO()
-
-    if suppress_output:
-        redirect_output(captured_output)
-
-    # Migrate legacy usage if any
-    migrate(superlink, args=ctx.args)
+    """List SuperNodes in the federation (alias: ls)."""
+    with cli_output_handler(output_format=output_format) as is_json:
+        # Migrate legacy usage if any
+        migrate(superlink, args=ctx.args)
 
-    # Read superlink connection configuration
-    superlink_connection = read_superlink_connection(superlink)
-    channel = None
+        # Read superlink connection configuration
+        superlink_connection = read_superlink_connection(superlink)
+        channel = None
 
-    try:
         try:
             channel = init_channel_from_connection(superlink_connection)
             stub = ControlStub(channel)
             typer.echo("📄 Listing all nodes...")
             formatted_nodes = _list_nodes(stub)
-            restore_output()
-            if output_format == CliOutputFormat.JSON:
-                Console().print_json(_to_json(formatted_nodes, verbose=verbose))
+
+            if is_json:
+                print_json_to_stdout(_to_json(formatted_nodes, verbose=verbose))
             else:
                 Console().print(_to_table(formatted_nodes, verbose=verbose))
 
         finally:
             if channel:
                 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.secho(
-                f"{err}",
-                fg=typer.colors.RED,
-                bold=True,
-            )
-    finally:
-        if suppress_output:
-            restore_output()
-        captured_output.close()
 
 
 def _list_nodes(stub: ControlStub) -> list[_NodeListType]:

flwr/cli/supernode/register.py

@@ -15,8 +15,6 @@
 """Flower command line interface `supernode register` command."""
 
 
-import io
-import json
 from pathlib import Path
 from typing import Annotated
 
@@ -25,13 +23,11 @@ import typer
 from cryptography.exceptions import UnsupportedAlgorithm
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric import ec
-from rich.console import Console
 
 from flwr.cli.config_migration import migrate
 from flwr.cli.flower_config import read_superlink_connection
 from flwr.common.constant import CliOutputFormat
 from flwr.common.exit import ExitCode, flwr_exit
-from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     RegisterNodeRequest,
     RegisterNodeResponse,
@@ -39,7 +35,12 @@ from flwr.proto.control_pb2 import (  # pylint: disable=E0611
 from flwr.proto.control_pb2_grpc import ControlStub
 from flwr.supercore.primitives.asymmetric import public_key_to_bytes, uses_nist_ec_curve
 
-from ..utils import flwr_cli_grpc_exc_handler, init_channel_from_connection
+from ..utils import (
+    cli_output_handler,
+    flwr_cli_grpc_exc_handler,
+    init_channel_from_connection,
+    print_json_to_stdout,
+)
 
 
 def register(  # pylint: disable=R0914
@@ -64,52 +65,34 @@ def register(  # pylint: disable=R0914
     ] = CliOutputFormat.DEFAULT,
 ) -> None:
     """Add a SuperNode to the federation."""
-    suppress_output = output_format == CliOutputFormat.JSON
-    captured_output = io.StringIO()
-
     # Load public key
     public_key_path = Path(public_key)
     public_key_bytes = try_load_public_key(public_key_path)
 
-    if suppress_output:
-        redirect_output(captured_output)
+    with cli_output_handler(output_format=output_format) as is_json:
+        # Migrate legacy usage if any
+        migrate(superlink, args=ctx.args)
 
-    # Migrate legacy usage if any
-    migrate(superlink, args=ctx.args)
+        # Read superlink connection configuration
+        superlink_connection = read_superlink_connection(superlink)
+        channel = None
 
-    # Read superlink connection configuration
-    superlink_connection = read_superlink_connection(superlink)
-    channel = None
-
-    try:
         try:
             channel = init_channel_from_connection(superlink_connection)
             stub = ControlStub(channel)
 
             _register_node(
-                stub=stub, public_key=public_key_bytes, output_format=output_format
+                stub=stub,
+                public_key=public_key_bytes,
+                is_json=is_json,
             )
 
-        except ValueError as err:
-            raise click.ClickException(str(err)) from err
         finally:
             if channel:
                 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:
-            raise click.ClickException(str(err)) from None
-    finally:
-        if suppress_output:
-            restore_output()
-        captured_output.close()
-
 
-def _register_node(stub: ControlStub, public_key: bytes, output_format: str) -> None:
+def _register_node(stub: ControlStub, public_key: bytes, is_json: bool) -> None:
     """Register a node."""
     with flwr_cli_grpc_exc_handler():
         response: RegisterNodeResponse = stub.RegisterNode(
@@ -120,15 +103,13 @@ def _register_node(stub: ControlStub, public_key: bytes, output_format: str) ->
             f"✅ SuperNode {response.node_id} registered successfully.",
             fg=typer.colors.GREEN,
         )
-        if output_format == CliOutputFormat.JSON:
-            run_output = json.dumps(
+        if is_json:
+            print_json_to_stdout(
                 {
                     "success": True,
                     "node-id": response.node_id,
                 }
             )
-            restore_output()
-            Console().print_json(run_output)
     else:
         raise click.ClickException("SuperNode couldn't be registered.")
 

flwr/cli/supernode/unregister.py

@@ -15,22 +15,22 @@
 """Flower command line interface `supernode unregister` command."""
 
 
-import io
-import json
 from typing import Annotated
 
-import click
 import typer
-from rich.console import Console
 
 from flwr.cli.config_migration import migrate
 from flwr.cli.flower_config import read_superlink_connection
 from flwr.common.constant import CliOutputFormat
-from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.proto.control_pb2 import UnregisterNodeRequest  # pylint: disable=E0611
 from flwr.proto.control_pb2_grpc import ControlStub
 
-from ..utils import flwr_cli_grpc_exc_handler, init_channel_from_connection
+from ..utils import (
+    cli_output_handler,
+    flwr_cli_grpc_exc_handler,
+    init_channel_from_connection,
+    print_json_to_stdout,
+)
 
 
 def unregister(  # pylint: disable=R0914
@@ -55,49 +55,29 @@ def unregister(  # pylint: disable=R0914
     ] = CliOutputFormat.DEFAULT,
 ) -> None:
     """Unregister a SuperNode from the federation."""
-    suppress_output = output_format == CliOutputFormat.JSON
-    captured_output = io.StringIO()
+    with cli_output_handler(output_format=output_format) as is_json:
+        # Migrate legacy usage if any
+        migrate(superlink, args=ctx.args)
 
-    if suppress_output:
-        redirect_output(captured_output)
+        # Read superlink connection configuration
+        superlink_connection = read_superlink_connection(superlink)
+        channel = None
 
-    # Migrate legacy usage if any
-    migrate(superlink, args=ctx.args)
-
-    # Read superlink connection configuration
-    superlink_connection = read_superlink_connection(superlink)
-    channel = None
-
-    try:
         try:
             channel = init_channel_from_connection(superlink_connection)
             stub = ControlStub(channel)
 
-            _unregister_node(stub=stub, node_id=node_id, output_format=output_format)
+            _unregister_node(stub=stub, node_id=node_id, is_json=is_json)
 
-        except ValueError as err:
-            raise click.ClickException(str(err)) from err
         finally:
             if channel:
                 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:
-            raise click.ClickException(str(err)) from None
-    finally:
-        if suppress_output:
-            restore_output()
-        captured_output.close()
-
 
 def _unregister_node(
     stub: ControlStub,
     node_id: int,
-    output_format: str,
+    is_json: bool,
 ) -> None:
     """Unregister a SuperNode from the federation."""
     with flwr_cli_grpc_exc_handler():
@@ -105,12 +85,10 @@ def _unregister_node(
     typer.secho(
         f"✅ SuperNode {node_id} unregistered successfully.", fg=typer.colors.GREEN
     )
-    if output_format == CliOutputFormat.JSON:
-        run_output = json.dumps(
+    if is_json:
+        print_json_to_stdout(
             {
                 "success": True,
                 "node-id": node_id,
             }
         )
-        restore_output()
-        Console().print_json(run_output)

flwr/cli/typing.py

@@ -22,6 +22,7 @@ from flwr.cli.constant import (
     DEFAULT_SIMULATION_BACKEND_NAME,
     SuperLinkConnectionTomlKey,
 )
+from flwr.supercore.utils import check_federation_format
 
 _ERROR_MSG_FMT = "SuperLinkConnection.%s is None"
 
@@ -82,6 +83,7 @@ class SuperLinkSimulationOptions:
 
     num_supernodes: int
     backend: SimulationBackendConfig | None = None
+    verbose: bool | None = None
 
     def __post_init__(self) -> None:
         """Validate simulation options."""
@@ -89,6 +91,8 @@ class SuperLinkSimulationOptions:
             raise ValueError(
                 "Invalid simulation options: num-supernodes must be an integer."
             )
+        if self.verbose is not None and not isinstance(self.verbose, bool):
+            raise ValueError("Invalid simulation options: verbose must be a boolean.")
 
 
 @dataclass
@@ -176,11 +180,15 @@ class SuperLinkConnection:
                 + f"expected bool, but got {type(self._insecure).__name__}."
             )
 
-        if self.federation is not None and not isinstance(self.federation, str):
-            raise ValueError(
-                err_prefix % SuperLinkConnectionTomlKey.FEDERATION
-                + f"expected str, but got {type(self.federation).__name__}."
-            )
+        if self.federation is not None:
+            if not isinstance(self.federation, str):
+                raise ValueError(
+                    err_prefix % SuperLinkConnectionTomlKey.FEDERATION
+                    + f"expected str, but got {type(self.federation).__name__}."
+                )
+
+            # Check if the federation string is valid
+            check_federation_format(self.federation)
 
         # The connection needs to have either an address or options (or both).
         if self.address is None and self.options is None: