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

flwr/cli/app_cmd/review.py

@@ -77,15 +77,15 @@ def review(
     url = f"{PLATFORM_API_URL}/hub/fetch-fab"
     try:
         presigned_url, _ = request_download_link(app_id, app_version, url, "fab_url")
-    except ValueError as e:
-        raise click.ClickException(str(e)) from e
 
-    fab_bytes = _download_fab(presigned_url)
+        fab_bytes = _download_fab(presigned_url)
 
-    # Unpack FAB
-    typer.secho("Unpacking FAB... ", fg=typer.colors.BLUE)
-    review_dir = _create_review_dir()
-    review_app_path = install_from_fab(fab_bytes, review_dir)
+        # Unpack FAB
+        typer.secho("Unpacking FAB... ", fg=typer.colors.BLUE)
+        review_dir = _create_review_dir()
+        review_app_path = install_from_fab(fab_bytes, review_dir)
+    except ValueError as e:
+        raise click.ClickException(str(e)) from e
 
     # Extract app version
     version_pattern = re.compile(r"\b(\d+\.\d+\.\d+)\b")

flwr/cli/build.py

@@ -71,7 +71,7 @@ def get_fab_filename(config: dict[str, Any], fab_hash: str) -> str:
     Parameters
     ----------
     config : dict[str, Any]
-        The project configuration dictionary.
+        The Flower App configuration dictionary.
     fab_hash : str
         The SHA-256 hash of the FAB file.
 
@@ -114,23 +114,21 @@ def build(
 
     if not is_valid_project_name(app.name):
         raise click.ClickException(
-            f"The project name {app.name} is invalid, "
-            "a valid project name must start with a letter, "
+            f"The Flower App name {app.name} is invalid, "
+            "a valid app name must start with a letter, "
             "and can only contain letters, digits, and hyphens."
         )
 
-    config, errors, warnings = load_and_validate(app / "pyproject.toml")
-    if config is None:
-        raise click.ClickException(
-            "Project configuration could not be loaded.\npyproject.toml is invalid:\n"
-            + "\n".join([f"- {line}" for line in errors])
-        )
+    try:
+        config, warnings = load_and_validate(app / "pyproject.toml")
+    except ValueError as e:
+        raise click.ClickException(str(e)) from None
 
     if warnings:
         typer.secho(
-            "Project configuration is missing the following "
+            "Flower App configuration (pyproject.toml) is missing the following "
             "recommended properties:\n" + "\n".join([f"- {line}" for line in warnings]),
-            fg=typer.colors.RED,
+            fg=typer.colors.YELLOW,
             bold=True,
         )
 

flwr/cli/config/ls.py

@@ -15,19 +15,15 @@
 """Flower command line interface `config list` command."""
 
 
-import io
-import json
 from typing import Annotated
 
-import click
 import typer
-from rich.console import Console
 
 from flwr.common.constant import CliOutputFormat
-from flwr.common.logger import print_json_error, redirect_output, restore_output
 
 from ..constant import SuperLinkConnectionTomlKey
 from ..flower_config import read_flower_config
+from ..utils import cli_output_handler, print_json_to_stdout
 
 
 def ls(
@@ -41,14 +37,7 @@ def ls(
     ] = CliOutputFormat.DEFAULT,
 ) -> None:
     """List all SuperLink connections (alias: ls)."""
-    suppress_output = output_format == CliOutputFormat.JSON
-    captured_output = io.StringIO()
-    config_path = None
-
-    if suppress_output:
-        redirect_output(captured_output)
-
-    try:
+    with cli_output_handler(output_format=output_format) as is_json:
         # Load Flower Config
         config, config_path = read_flower_config()
 
@@ -59,13 +48,13 @@ def ls(
         default = superlink_connections.pop(SuperLinkConnectionTomlKey.DEFAULT, None)
 
         connection_names = list(superlink_connections.keys())
-        restore_output()
-        if output_format == CliOutputFormat.JSON:
+
+        if is_json:
             conn = {
                 SuperLinkConnectionTomlKey.SUPERLINK: connection_names,
                 SuperLinkConnectionTomlKey.DEFAULT: default,
             }
-            Console().print_json(json.dumps(conn))
+            print_json_to_stdout(conn)
         else:
             typer.secho("Flower Config file: ", fg=typer.colors.BLUE, nl=False)
             typer.secho(f"{config_path}", fg=typer.colors.GREEN)
@@ -80,20 +69,3 @@ def ls(
                         nl=False,
                     )
                 typer.echo()
-
-    except Exception as err:  # pylint: disable=broad-except
-        # log the error if json format requested
-        if suppress_output:
-            restore_output()
-            e_message = captured_output.getvalue()
-            print_json_error(e_message, err)
-        else:
-            raise click.ClickException(
-                f"An unexpected error occurred while listing the SuperLink "
-                f"connections in the Flower configuration file ({config_path}): {err}"
-            ) from err
-
-    finally:
-        if suppress_output:
-            restore_output()
-        captured_output.close()

flwr/cli/config_migration.py

@@ -94,13 +94,12 @@ def _is_migratable(app: Path) -> tuple[bool, str | None]:
     toml_path = app / "pyproject.toml"
     if not toml_path.exists():
         return False, f"No pyproject.toml found in '{app}'"
-    config, errors, _ = load_and_validate(toml_path, check_module=False)
-    if config is None:
-        return False, f"Failed to load TOML configuration: {toml_path}"
-    if errors:
-        err_msg = f"Invalid TOML configuration found in '{toml_path}':\n"
-        err_msg += "\n".join(f"- {err}" for err in errors)
-        return False, err_msg
+
+    try:
+        config, _ = load_and_validate(toml_path, check_module=False)
+    except ValueError as e:
+        return False, str(e)
+
     try:
         _ = config["tool"]["flwr"]["federations"]
         return True, None
@@ -114,9 +113,7 @@ def _migrate_pyproject_toml_to_flower_config(
     """Migrate old TOML configuration to Flower config."""
     # Load and validate the old TOML configuration
     toml_path = app / "pyproject.toml"
-    config, _, _ = load_and_validate(toml_path, check_module=False)
-    if config is None:
-        raise ValueError(f"Failed to load TOML configuration: {toml_path}")
+    config, _ = load_and_validate(toml_path, check_module=False)
     validate_federation_in_project_config(toml_federation, config)
 
     # Construct SuperLinkConnection

flwr/cli/config_utils.py

@@ -51,7 +51,7 @@ def get_fab_metadata(fab_file: Path | bytes) -> tuple[str, str]:
 def load_and_validate(
     path: Path | None = None,
     check_module: bool = True,
-) -> tuple[dict[str, Any] | None, list[str], list[str]]:
+) -> tuple[dict[str, Any], list[str]]:
     """Load and validate pyproject.toml as dict.
 
     Parameters
@@ -66,28 +66,34 @@ def load_and_validate(
 
     Returns
     -------
-    Tuple[Optional[config], List[str], List[str]]
-        A tuple with the optional config in case it exists and is valid
-        and associated errors and warnings.
+    tuple[dict[str, Any], list[str]]
+        A tuple of the loaded configuration as dictionary and a list of warnings.
+
+    Raises
+    ------
+    ValueError
+        If the configuration is invalid or the file cannot be loaded.
     """
     if path is None:
         path = Path.cwd() / "pyproject.toml"
-
+    path = path.resolve()
     config = load(path)
 
     if config is None:
-        errors = [
-            "Project configuration could not be loaded. "
-            "`pyproject.toml` does not exist."
-        ]
-        return (None, errors, [])
+        raise ValueError(
+            f"Failed to load Flower App configuration in '{path}'. "
+            "File may be missing or invalid."
+        )
 
     is_valid, errors, warnings = validate_config(config, check_module, path.parent)
 
     if not is_valid:
-        return (None, errors, warnings)
+        raise ValueError(
+            f"Invalid Flower App configuration in '{path}':\n"
+            + "\n".join([f"- {line}" for line in errors])
+        )
 
-    return (config, errors, warnings)
+    return config, warnings
 
 
 def load(toml_path: Path) -> dict[str, Any] | None:

flwr/cli/constant.py

@@ -66,6 +66,7 @@ class SuperLinkSimulationOptionsTomlKey:
 
     NUM_SUPERNODES = "num-supernodes"
     BACKEND = "backend"
+    VERBOSE = "verbose"
 
 
 class SimulationClientResourcesTomlKey:

flwr/cli/federation/ls.py

@@ -15,10 +15,8 @@
 """Flower command line interface `federation list` command."""
 
 
-import io
 from typing import Annotated, Any
 
-import click
 import typer
 from rich.console import Console
 from rich.table import Table
@@ -28,7 +26,6 @@ from flwr.cli.config_migration import migrate
 from flwr.cli.flower_config import read_superlink_connection
 from flwr.cli.ls import _get_status_style
 from flwr.common.constant import NOOP_ACCOUNT_NAME, CliOutputFormat
-from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.common.serde import run_from_proto
 from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     ListFederationsRequest,
@@ -42,7 +39,12 @@ from flwr.proto.node_pb2 import NodeInfo  # pylint: disable=E0611
 from flwr.supercore.utils import humanize_duration
 
 from ..run_utils import RunRow, format_runs
-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 ls(  # pylint: disable=R0914, R0913, R0917, R0912
@@ -69,20 +71,14 @@ def ls(  # pylint: disable=R0914, R0913, R0917, R0912
     ] = None,
 ) -> None:
     """List available federations or details of a specific federation (alias: ls)."""
-    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)
+    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)
@@ -92,10 +88,9 @@ def ls(  # pylint: disable=R0914, R0913, R0917, R0912
                 typer.echo(f"📄 Showing '{federation}' federation ...")
                 members, nodes, runs = _show_federation(stub, federation)
 
-                restore_output()
-                if output_format == CliOutputFormat.JSON:
-                    Console().print_json(
-                        data=_to_json(members=members, nodes=nodes, runs=runs)
+                if is_json:
+                    print_json_to_stdout(
+                        _to_json(members=members, nodes=nodes, runs=runs)
                     )
                 else:
                     Console().print(_to_members_table(members))
@@ -105,25 +100,14 @@ def ls(  # pylint: disable=R0914, R0913, R0917, R0912
                 # List federations
                 typer.echo("📄 Listing federations...")
                 federations = _list_federations(stub)
-                restore_output()
-                if output_format == CliOutputFormat.JSON:
-                    Console().print_json(data=_to_json(federations=federations))
+
+                if is_json:
+                    print_json_to_stdout(_to_json(federations=federations))
                 else:
                     Console().print(_to_table(federations))
         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 _list_federations(stub: ControlStub) -> list[Federation]:
@@ -206,7 +190,7 @@ def _show_federation(
     Returns
     -------
     tuple[list[str], list[NodeInfo], list[RunRow]]
-        A tuple containing (member_account_ids, nodes, runs).
+        A tuple containing (account_names, nodes, runs).
     """
     with flwr_cli_grpc_exc_handler():
         res: ShowFederationResponse = stub.ShowFederation(
@@ -217,16 +201,20 @@ def _show_federation(
     runs = [run_from_proto(run_proto) for run_proto in fed_proto.runs]
     formatted_runs = format_runs(runs, res.now)
 
-    return list(fed_proto.member_aids), list(fed_proto.nodes), formatted_runs
+    return (
+        [account.name for account in fed_proto.accounts],
+        list(fed_proto.nodes),
+        formatted_runs,
+    )
 
 
-def _to_members_table(member_aids: list[str]) -> Table:
+def _to_members_table(account_names: list[str]) -> Table:
     """Format the provided list of federation members as a rich Table.
 
     Parameters
     ----------
-    member_aids : list[str]
-        List of member account identifiers.
+    account_names : list[str]
+        List of member account names.
 
     Returns
     -------
@@ -236,12 +224,12 @@ def _to_members_table(member_aids: list[str]) -> Table:
     table = Table(title="Federation Members", header_style="bold cyan", show_lines=True)
 
     table.add_column(
-        Text("Account ID", justify="center"), style="bright_black", no_wrap=True
+        Text("Account Name", justify="center"), style="bright_black", no_wrap=True
     )
     table.add_column(Text("Role", justify="center"), style="bright_black", no_wrap=True)
 
-    for member_aid in member_aids:
-        table.add_row(member_aid, "Member")
+    for account_name in account_names:
+        table.add_row(account_name, "Member")
 
     return table
 

flwr/cli/flower_config.py

@@ -48,6 +48,7 @@ from flwr.supercore.utils import get_flwr_home
 def _parse_simulation_options(options: dict[str, Any]) -> SuperLinkSimulationOptions:
     """Parse simulation options from a dictionary in a SuperLink connection."""
     num_supernodes = options.get(SuperLinkSimulationOptionsTomlKey.NUM_SUPERNODES)
+    verbose = options.get(SuperLinkSimulationOptionsTomlKey.VERBOSE)
     # Validation handled in SuperLinkSimulationOptions.__post_init__
 
     backend_dict = options.get(SuperLinkSimulationOptionsTomlKey.BACKEND)
@@ -94,6 +95,7 @@ def _parse_simulation_options(options: dict[str, Any]) -> SuperLinkSimulationOpt
     return SuperLinkSimulationOptions(
         num_supernodes=cast(int, num_supernodes),
         backend=simulation_backend,
+        verbose=verbose,
     )
 
 
@@ -105,6 +107,9 @@ def _serialize_simulation_options(
         SuperLinkSimulationOptionsTomlKey.NUM_SUPERNODES: options.num_supernodes
     }
 
+    if options.verbose is not None:
+        options_dict[SuperLinkSimulationOptionsTomlKey.VERBOSE] = options.verbose
+
     if options.backend is not None:
         backend = options.backend
 

flwr/cli/install.py

@@ -72,7 +72,10 @@ def install(
     if source.suffix != ".fab":
         raise click.ClickException(f"The source {source} is not a `.fab` file.")
 
-    install_from_fab(source, flwr_dir)
+    try:
+        install_from_fab(source, flwr_dir)
+    except ValueError as e:
+        raise click.ClickException(str(e)) from None
 
 
 def install_from_fab(
@@ -171,10 +174,7 @@ def validate_and_install(
     click.ClickException
         If configuration is invalid or metadata doesn't match.
     """
-    config, _, _ = load_and_validate(project_dir / "pyproject.toml", check_module=False)
-
-    if config is None:
-        raise click.ClickException("Invalid config inside FAB file.")
+    config, _ = load_and_validate(project_dir / "pyproject.toml", check_module=False)
 
     fab_id, version = get_metadata_from_config(config)
     publisher, project_name = fab_id.split("/")

flwr/cli/ls.py

@@ -15,11 +15,9 @@
 """Flower command line interface `ls` command."""
 
 
-import io
 import json
 from typing import Annotated
 
-import click
 import typer
 from rich.console import Console
 from rich.table import Table
@@ -29,7 +27,6 @@ from flwr.cli.config_migration import migrate, warn_if_federation_config_overrid
 from flwr.cli.constant import FEDERATION_CONFIG_HELP_MESSAGE
 from flwr.cli.flower_config import read_superlink_connection
 from flwr.common.constant import CliOutputFormat, Status, SubStatus
-from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.common.serde import run_from_proto
 from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     ListRunsRequest,
@@ -39,7 +36,12 @@ from flwr.proto.control_pb2_grpc import ControlStub
 from flwr.supercore.utils import humanize_bytes, humanize_duration
 
 from .run_utils import RunRow, format_runs
-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 ls(  # pylint: disable=too-many-locals, too-many-branches, R0913, R0917
@@ -92,23 +94,17 @@ def ls(  # pylint: disable=too-many-locals, too-many-branches, R0913, R0917
 
     All timestamps follow ISO 8601, UTC and are formatted as ``YYYY-MM-DD HH:MM:SSZ``.
     """
-    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(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:
             if runs and run_id is not None:
                 raise ValueError(
@@ -125,9 +121,9 @@ def ls(  # pylint: disable=too-many-locals, too-many-branches, R0913, R0917
             else:
                 typer.echo("📄 Listing all runs...")
                 formatted_runs = _list_runs(stub)
-            restore_output()
-            if output_format == CliOutputFormat.JSON:
-                Console().print_json(_to_json(formatted_runs))
+
+            if is_json:
+                print_json_to_stdout(_to_json(formatted_runs))
             else:
                 if run_id is not None:
                     Console().print(_to_detail_table(formatted_runs[0]))
@@ -136,17 +132,6 @@ def ls(  # pylint: disable=too-many-locals, too-many-branches, R0913, R0917
         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 _get_status_style(status_text: str) -> str: