flwr 1.24.0__py3-none-any.whl → 1.26.0__py3-none-any.whl

flwr/cli/login/login.py

@@ -15,20 +15,14 @@
 """Flower command line interface `login` command."""
 
 
-from pathlib import Path
-from typing import Annotated
+from typing import Annotated, cast
 
+import click
 import typer
 
 from flwr.cli.auth_plugin import LoginError, NoOpCliAuthPlugin
-from flwr.cli.config_utils import (
-    exit_if_no_address,
-    get_insecure_flag,
-    load_and_validate,
-    process_loaded_project_config,
-    validate_federation_in_project_config,
-)
 from flwr.cli.constant import FEDERATION_CONFIG_HELP_MESSAGE
+from flwr.cli.utils import init_channel_from_connection
 from flwr.common.typing import AccountAuthLoginDetails
 from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     GetLoginDetailsRequest,
@@ -36,68 +30,45 @@ from flwr.proto.control_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.control_pb2_grpc import ControlStub
 
-from ..utils import (
-    account_auth_enabled,
-    flwr_cli_grpc_exc_handler,
-    init_channel,
-    load_cli_auth_plugin,
-)
+from ..config_migration import migrate, warn_if_federation_config_overrides
+from ..flower_config import read_superlink_connection
+from ..utils import flwr_cli_grpc_exc_handler, load_cli_auth_plugin_from_connection
 
 
-def login(  # pylint: disable=R0914
-    app: Annotated[
-        Path,
-        typer.Argument(help="Path of the Flower App to run."),
-    ] = Path("."),
-    federation: Annotated[
+def login(
+    ctx: typer.Context,
+    superlink: Annotated[
         str | None,
-        typer.Argument(help="Name of the federation to login into."),
+        typer.Argument(help="Name of the SuperLink connection."),
     ] = None,
     federation_config_overrides: Annotated[
         list[str] | None,
         typer.Option(
             "--federation-config",
             help=FEDERATION_CONFIG_HELP_MESSAGE,
+            hidden=True,
         ),
     ] = None,
 ) -> None:
     """Login to Flower SuperLink."""
-    typer.secho("Loading project configuration... ", fg=typer.colors.BLUE)
+    # Warn `--federation-config` is ignored
+    warn_if_federation_config_overrides(federation_config_overrides)
 
-    pyproject_path = app / "pyproject.toml" if app else None
-    config, errors, warnings = load_and_validate(pyproject_path, check_module=False)
+    # Migrate legacy usage if any
+    migrate(superlink, args=ctx.args)
 
-    config = process_loaded_project_config(config, errors, warnings)
-    federation, federation_config = validate_federation_in_project_config(
-        federation, config, federation_config_overrides
-    )
-    exit_if_no_address(federation_config, "login")
+    # Read superlink connection configuration
+    superlink_connection = read_superlink_connection(superlink)
+    superlink = superlink_connection.name
 
-    # Check if `enable-account-auth` is set to `true`
-
-    if not account_auth_enabled(federation_config):
-        typer.secho(
-            "❌ Account authentication is not enabled for the federation "
-            f"'{federation}'. To enable it, set `enable-account-auth = true` "
-            "in the federation configuration.",
-            fg=typer.colors.RED,
-            bold=True,
-            err=True,
-        )
-        raise typer.Exit(code=1)
     # Check if insecure flag is set to `True`
-    insecure = get_insecure_flag(federation_config)
-    if insecure:
-        typer.secho(
-            "❌ `flwr login` requires TLS to be enabled. `insecure` must NOT be set to "
-            "`true` in the federation configuration.",
-            fg=typer.colors.RED,
-            bold=True,
-            err=True,
+    if superlink_connection.insecure:
+        raise click.ClickException(
+            "`flwr login` requires TLS to be enabled. `insecure` must NOT be set to "
+            "`true` in the federation configuration."
         )
-        raise typer.Exit(code=1)
 
-    channel = init_channel(app, federation_config, NoOpCliAuthPlugin(Path()))
+    channel = init_channel_from_connection(superlink_connection, NoOpCliAuthPlugin())
     stub = ControlStub(channel)
 
     login_request = GetLoginDetailsRequest()
@@ -105,8 +76,9 @@ def login(  # pylint: disable=R0914
         login_response: GetLoginDetailsResponse = stub.GetLoginDetails(login_request)
 
     # Get the auth plugin
-    authn_type = login_response.authn_type
-    auth_plugin = load_cli_auth_plugin(app, federation, federation_config, authn_type)
+    authn_plugin = load_cli_auth_plugin_from_connection(
+        cast(str, superlink_connection.address), login_response.authn_type
+    )
 
     # Login
     details = AccountAuthLoginDetails(
@@ -118,20 +90,14 @@ def login(  # pylint: disable=R0914
     )
     try:
         with flwr_cli_grpc_exc_handler():
-            credentials = auth_plugin.login(details, stub)
+            credentials = authn_plugin.login(details, stub)
         typer.secho(
             "✅ Login successful.",
             fg=typer.colors.GREEN,
             bold=False,
         )
     except LoginError as e:
-        typer.secho(
-            f"❌ Login failed: {e.message}",
-            fg=typer.colors.RED,
-            bold=True,
-            err=True,
-        )
-        raise typer.Exit(code=1) from None
+        raise click.ClickException(f"Login failed: {e.message}") from None
 
     # Store the tokens
-    auth_plugin.store_tokens(credentials)
+    authn_plugin.store_tokens(credentials)

flwr/cli/ls.py

@@ -15,51 +15,47 @@
 """Flower command line interface `ls` command."""
 
 
-import io
 import json
-from pathlib import Path
-from typing import Annotated, cast
+from typing import Annotated
 
 import typer
 from rich.console import Console
 from rich.table import Table
 from rich.text import Text
 
-from flwr.cli.config_utils import (
-    exit_if_no_address,
-    load_and_validate,
-    process_loaded_project_config,
-    validate_federation_in_project_config,
-)
+from flwr.cli.config_migration import migrate, warn_if_federation_config_overrides
 from flwr.cli.constant import FEDERATION_CONFIG_HELP_MESSAGE
-from flwr.common.constant import FAB_CONFIG_FILE, CliOutputFormat, Status, SubStatus
-from flwr.common.logger import print_json_error, redirect_output, restore_output
+from flwr.cli.flower_config import read_superlink_connection
+from flwr.common.constant import CliOutputFormat, Status, SubStatus
 from flwr.common.serde import run_from_proto
 from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     ListRunsRequest,
     ListRunsResponse,
 )
 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, load_cli_auth_plugin
+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
     ctx: typer.Context,
-    app: Annotated[
-        Path,
-        typer.Argument(help="Path of the Flower project"),
-    ] = Path("."),
-    federation: Annotated[
+    superlink: Annotated[
         str | None,
-        typer.Argument(help="Name of the federation"),
+        typer.Argument(help="Name of the SuperLink connection."),
     ] = None,
     federation_config_overrides: Annotated[
         list[str] | None,
         typer.Option(
             "--federation-config",
             help=FEDERATION_CONFIG_HELP_MESSAGE,
+            hidden=True,
         ),
     ] = None,
     runs: Annotated[
@@ -85,7 +81,7 @@ def ls(  # pylint: disable=too-many-locals, too-many-branches, R0913, R0917
         ),
     ] = CliOutputFormat.DEFAULT,
 ) -> None:
-    """List the details of one provided run ID or all runs in a Flower federation.
+    """List the details of one provided run ID or all runs (alias: ls).
 
     The following details are displayed:
 
@@ -98,32 +94,23 @@ 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``.
     """
-    # Resolve command used (list or ls)
-    command_name = cast(str, ctx.command.name) if ctx.command else "list"
-
-    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)
-
-        pyproject_path = app / FAB_CONFIG_FILE if app else None
-        config, errors, warnings = load_and_validate(pyproject_path, check_module=False)
-        config = process_loaded_project_config(config, errors, warnings)
-        federation, federation_config = validate_federation_in_project_config(
-            federation, config, federation_config_overrides
-        )
-        exit_if_no_address(federation_config, command_name)
+    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)
+
+        # Read superlink connection configuration
+        superlink_connection = read_superlink_connection(superlink)
         channel = None
+
         try:
             if runs and run_id is not None:
                 raise ValueError(
                     "The options '--runs' and '--run-id' are mutually exclusive."
                 )
-            auth_plugin = load_cli_auth_plugin(app, federation, federation_config)
-            channel = init_channel(app, federation_config, auth_plugin)
+            channel = init_channel_from_connection(superlink_connection)
             stub = ControlStub(channel)
 
             # Display information about a specific run ID
@@ -134,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]))
@@ -145,22 +132,6 @@ def ls(  # pylint: disable=too-many-locals, too-many-branches, R0913, R0917
         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,
-                err=True,
-            )
-    finally:
-        if suppress_output:
-            restore_output()
-        captured_output.close()
 
 
 def _get_status_style(status_text: str) -> str:
@@ -231,7 +202,7 @@ def _to_table(run_list: list[RunRow]) -> Table:
             row.federation,
             f"@{row.fab_id}=={row.fab_version}",
             f"[{status_style}]{row.status_text}[/{status_style}]",
-            row.elapsed,
+            humanize_duration(row.elapsed),
             status_changed_at,
         )
         table.add_row(*formatted_row)
@@ -265,11 +236,39 @@ def _to_detail_table(run: RunRow) -> Table:
     table.add_row("App", f"@{run.fab_id}=={run.fab_version}")
     table.add_row("FAB Hash", f"{run.fab_hash[:8]}...{run.fab_hash[-8:]}")
     table.add_row("Status", f"[{status_style}]{run.status_text}[/{status_style}]")
-    table.add_row("Elapsed", f"[blue]{run.elapsed}[/blue]")
+    table.add_row("Elapsed", f"[blue]{humanize_duration(run.elapsed)}[/blue]")
     table.add_row("Pending At", run.pending_at)
     table.add_row("Starting At", run.starting_at)
     table.add_row("Running At", run.running_at)
     table.add_row("Finished At", run.finished_at)
+    table.add_row(
+        "Network traffic (inbound)",
+        f"[blue]{humanize_bytes(run.network_traffic_inbound)}[/blue]",
+    )
+    table.add_row(
+        "Network traffic (outbound)",
+        f"[blue]{humanize_bytes(run.network_traffic_outbound)}[/blue]",
+    )
+    table.add_row(
+        "Network Traffic (total)",
+        "[blue]"
+        f"{humanize_bytes(run.network_traffic_inbound + run.network_traffic_outbound)}"
+        "[/blue]",
+    )
+    table.add_row(
+        "Compute Time (ServerApp)",
+        f"[blue]{humanize_duration(run.compute_time_serverapp)}[/blue]",
+    )
+    table.add_row(
+        "Compute Time (ClientApp)",
+        f"[blue]{humanize_duration(run.compute_time_clientapp)}[/blue]",
+    )
+    table.add_row(
+        "Compute Time (total)",
+        "[blue]"
+        f"{humanize_duration(run.compute_time_serverapp + run.compute_time_clientapp)}"
+        "[/blue]",
+    )
 
     return table
 
@@ -291,7 +290,7 @@ def _to_json(run_list: list[RunRow]) -> str:
     for row in run_list:
         runs_list.append(
             {
-                "run-id": row.run_id,
+                "run-id": f"{row.run_id}",
                 "federation": row.federation,
                 "fab-id": row.fab_id,
                 "fab-name": row.fab_id.split("/")[-1],
@@ -303,6 +302,18 @@ def _to_json(run_list: list[RunRow]) -> str:
                 "starting-at": row.starting_at,
                 "running-at": row.running_at,
                 "finished-at": row.finished_at,
+                "network-traffic": {
+                    "inbound-bytes": row.network_traffic_inbound,
+                    "outbound-bytes": row.network_traffic_outbound,
+                    "total-bytes": row.network_traffic_inbound
+                    + row.network_traffic_outbound,
+                },
+                "compute-time": {
+                    "serverapp-seconds": row.compute_time_serverapp,
+                    "clientapp-seconds": row.compute_time_clientapp,
+                    "total-seconds": row.compute_time_serverapp
+                    + row.compute_time_clientapp,
+                },
             }
         )