flwr-nightly 1.13.0.dev20241106__py3-none-any.whl → 1.13.0.dev20241117__py3-none-any.whl

flwr/cli/app.py

@@ -20,6 +20,7 @@ from typer.main import get_command
 from .build import build
 from .install import install
 from .log import log
+from .ls import ls
 from .new import new
 from .run import run
 
@@ -37,6 +38,7 @@ app.command()(run)
 app.command()(build)
 app.command()(install)
 app.command()(log)
+app.command()(ls)
 
 typer_click_object = get_command(app)
 

flwr/cli/build.py

@@ -19,14 +19,18 @@ import os
 import shutil
 import tempfile
 import zipfile
+from logging import DEBUG, ERROR
 from pathlib import Path
 from typing import Annotated, Any, Optional, Union
 
 import pathspec
 import tomli_w
 import typer
+from hatchling.builders.wheel import WheelBuilder
+from hatchling.metadata.core import ProjectMetadata
 
 from flwr.common.constant import FAB_ALLOWED_EXTENSIONS, FAB_DATE, FAB_HASH_TRUNCATION
+from flwr.common.logger import log
 
 from .config_utils import load_and_validate
 from .utils import is_valid_project_name
@@ -51,6 +55,27 @@ def get_fab_filename(conf: dict[str, Any], fab_hash: str) -> str:
     return f"{publisher}.{name}.{version}.{fab_hash_truncated}.fab"
 
 
+def _build_app_wheel(app: Path) -> Path:
+    """Build app as a wheel and return its path."""
+    # Path to your project directory
+    app_dir = str(app.resolve())
+    try:
+
+        # Initialize the WheelBuilder
+        builder = WheelBuilder(
+            app_dir, metadata=ProjectMetadata(root=app_dir, plugin_manager=None)
+        )
+
+        # Build
+        whl_path = Path(next(builder.build(directory=app_dir)))
+        log(DEBUG, "Wheel succesfully built: %s", str(whl_path))
+    except Exception as ex:
+        log(ERROR, "Exception encountered when building wheel.", exc_info=ex)
+        raise typer.Exit(code=1) from ex
+
+    return whl_path
+
+
 # pylint: disable=too-many-locals, too-many-statements
 def build(
     app: Annotated[
@@ -106,6 +131,12 @@ def build(
             bold=True,
         )
 
+    # Build wheel
+    whl_path = _build_app_wheel(app)
+
+    # Add path to .whl to `[tool.flwr.app]`
+    conf["tool"]["flwr"]["app"]["whl"] = str(whl_path.name)
+
     # Load .gitignore rules if present
     ignore_spec = _load_gitignore(app)
 
@@ -137,6 +168,9 @@ def build(
                 and f.name != "pyproject.toml"  # Exclude the original pyproject.toml
             ]
 
+            # Include FAB .whl
+            all_files.append(whl_path)
+
             for file_path in all_files:
                 # Read the file content manually
                 with open(file_path, "rb") as f:
@@ -153,6 +187,9 @@ def build(
             # Add CONTENT and CONTENT.jwt to the zip file
             write_to_zip(fab_file, ".info/CONTENT", list_file_content)
 
+    # Erase FAB .whl in app directory
+    whl_path.unlink()
+
     # Get hash of FAB file
     content = Path(temp_filename).read_bytes()
     fab_hash = hashlib.sha256(content).hexdigest()

flwr/cli/install.py

@@ -188,23 +188,25 @@ def validate_and_install(
         else:
             shutil.copy2(item, install_dir / item.name)
 
+    whl_file = config["tool"]["flwr"]["app"]["whl"]
+    install_whl = install_dir / whl_file
     try:
         subprocess.run(
-            ["pip", "install", "-e", install_dir, "--no-deps"],
+            ["pip", "install", "--no-deps", install_whl],
             capture_output=True,
             text=True,
             check=True,
         )
     except subprocess.CalledProcessError as e:
         typer.secho(
-            f"❌ Failed to `pip install` package(s) from {install_dir}:\n{e.stderr}",
+            f"❌ Failed to install {project_name}:\n{e.stderr}",
             fg=typer.colors.RED,
             bold=True,
         )
         raise typer.Exit(code=1) from e
 
     typer.secho(
-        f"🎊 Successfully installed {project_name} to {install_dir}.",
+        f"🎊 Successfully installed {project_name}.",
         fg=typer.colors.GREEN,
         bold=True,
     )

flwr/cli/ls.py

@@ -0,0 +1,228 @@
+# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Flower command line interface `ls` command."""
+
+
+from datetime import datetime, timedelta
+from logging import DEBUG
+from pathlib import Path
+from typing import Annotated, Any, Optional
+
+import grpc
+import typer
+from rich.console import Console
+from rich.table import Table
+from rich.text import Text
+
+from flwr.cli.config_utils import (
+    load_and_validate,
+    validate_certificate_in_federation_config,
+    validate_federation_in_project_config,
+    validate_project_config,
+)
+from flwr.common.constant import FAB_CONFIG_FILE, 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.serde import run_from_proto
+from flwr.common.typing import Run
+from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
+    ListRunsRequest,
+    ListRunsResponse,
+)
+from flwr.proto.exec_pb2_grpc import ExecStub
+
+
+def ls(
+    app: Annotated[
+        Path,
+        typer.Argument(help="Path of the Flower project"),
+    ] = Path("."),
+    federation: Annotated[
+        Optional[str],
+        typer.Argument(help="Name of the federation"),
+    ] = None,
+    runs: Annotated[
+        bool,
+        typer.Option(
+            "--runs",
+            help="List all runs",
+        ),
+    ] = False,
+    run_id: Annotated[
+        Optional[int],
+        typer.Option(
+            "--run-id",
+            help="Specific run ID to display",
+        ),
+    ] = None,
+) -> 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
+    )
+
+    if "address" not in federation_config:
+        typer.secho(
+            "❌ `flwr log` currently works with Exec API. Ensure that the correct"
+            "Exec API address is provided in the `pyproject.toml`.",
+            fg=typer.colors.RED,
+            bold=True,
+        )
+        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}...")
+            _display_one_run(stub, run_id)
+        # By default, list all runs
+        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
+    finally:
+        channel.close()
+
+
+def on_channel_state_change(channel_connectivity: str) -> None:
+    """Log channel connectivity."""
+    log(DEBUG, channel_connectivity)
+
+
+def _init_channel(app: Path, federation_config: dict[str, Any]) -> grpc.Channel:
+    """Initialize gRPC channel to the Exec API."""
+    insecure, root_certificates_bytes = validate_certificate_in_federation_config(
+        app, federation_config
+    )
+    channel = create_channel(
+        server_address=federation_config["address"],
+        insecure=insecure,
+        root_certificates=root_certificates_bytes,
+        max_message_length=GRPC_MAX_MESSAGE_LENGTH,
+        interceptors=None,
+    )
+    channel.subscribe(on_channel_state_change)
+    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_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")
+
+    # Add rows
+    for run in sorted(
+        run_dict.values(), key=lambda x: datetime.fromisoformat(x.pending_at)
+    ):
+        # Combine status and sub-status into a single string
+        if run.status.sub_status == "":
+            status_text = run.status.status
+        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
+        finished_at = (
+            datetime.fromisoformat(run.finished_at) if run.finished_at else None
+        )
+
+        # Calculate elapsed time
+        elapsed_time = timedelta()
+        if running_at:
+            if finished_at:
+                end_time = finished_at
+            else:
+                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})",
+            f"[{status_style}]{status_text}[/{status_style}]",
+            format_timedelta(elapsed_time),
+            _format_datetime(pending_at),
+            _format_datetime(running_at),
+            _format_datetime(finished_at),
+        )
+    return table
+
+
+def _list_runs(
+    stub: ExecStub,
+) -> 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))
+
+
+def _display_one_run(
+    stub: ExecStub,
+    run_id: int,
+) -> None:
+    """Display information about a specific run."""
+    res: ListRunsResponse = stub.ListRuns(ListRunsRequest(run_id=run_id))
+    if not res.run_dict:
+        raise ValueError(f"Run ID {run_id} not found")
+
+    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))

flwr/cli/run/run.py

@@ -29,10 +29,18 @@ from flwr.cli.config_utils import (
     validate_federation_in_project_config,
     validate_project_config,
 )
-from flwr.common.config import flatten_dict, parse_config_args
+from flwr.common.config import (
+    flatten_dict,
+    parse_config_args,
+    user_config_to_configsrecord,
+)
 from flwr.common.grpc import GRPC_MAX_MESSAGE_LENGTH, create_channel
 from flwr.common.logger import log
-from flwr.common.serde import fab_to_proto, user_config_to_proto
+from flwr.common.serde import (
+    configs_record_to_proto,
+    fab_to_proto,
+    user_config_to_proto,
+)
 from flwr.common.typing import Fab
 from flwr.proto.exec_pb2 import StartRunRequest  # pylint: disable=E0611
 from flwr.proto.exec_pb2_grpc import ExecStub
@@ -94,6 +102,7 @@ def run(
         _run_without_exec_api(app, federation_config, config_overrides, federation)
 
 
+# pylint: disable-next=too-many-locals
 def _run_with_exec_api(
     app: Path,
     federation_config: dict[str, Any],
@@ -118,12 +127,14 @@ def _run_with_exec_api(
     content = Path(fab_path).read_bytes()
     fab = Fab(fab_hash, content)
 
+    # Construct a `ConfigsRecord` out of a flattened `UserConfig`
+    fed_conf = flatten_dict(federation_config.get("options", {}))
+    c_record = user_config_to_configsrecord(fed_conf)
+
     req = StartRunRequest(
         fab=fab_to_proto(fab),
         override_config=user_config_to_proto(parse_config_args(config_overrides)),
-        federation_config=user_config_to_proto(
-            flatten_dict(federation_config.get("options"))
-        ),
+        federation_options=configs_record_to_proto(c_record),
     )
     res = stub.StartRun(req)
 

flwr/client/app.py

@@ -32,15 +32,18 @@ from flwr.cli.config_utils import get_fab_metadata
 from flwr.cli.install import install_from_fab
 from flwr.client.client import Client
 from flwr.client.client_app import ClientApp, LoadClientAppError
+from flwr.client.nodestate.nodestate_factory import NodeStateFactory
 from flwr.client.typing import ClientFnExt
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH, Context, EventType, Message, event
 from flwr.common.address import parse_address
 from flwr.common.constant import (
-    CLIENTAPPIO_API_DEFAULT_ADDRESS,
+    CLIENT_OCTET,
+    CLIENTAPPIO_API_DEFAULT_SERVER_ADDRESS,
     ISOLATION_MODE_PROCESS,
     ISOLATION_MODE_SUBPROCESS,
     MISSING_EXTRA_REST,
     RUN_ID_NUM_BYTES,
+    SERVER_OCTET,
     TRANSPORT_TYPE_GRPC_ADAPTER,
     TRANSPORT_TYPE_GRPC_BIDI,
     TRANSPORT_TYPE_GRPC_RERE,
@@ -101,6 +104,11 @@ def start_client(
 ) -> None:
     """Start a Flower client node which connects to a Flower server.
 
+    Warning
+    -------
+    This function is deprecated since 1.13.0. Use :code:`flower-supernode` command
+    instead to start a SuperNode.
+
     Parameters
     ----------
     server_address : str
@@ -175,6 +183,17 @@ def start_client(
     >>>     root_certificates=Path("/crts/root.pem").read_bytes(),
     >>> )
     """
+    msg = (
+        "flwr.client.start_client() is deprecated."
+        "\n\tInstead, use the `flower-supernode` CLI command to start a SuperNode "
+        "as shown below:"
+        "\n\n\t\t$ flower-supernode --insecure --superlink='<IP>:<PORT>'"
+        "\n\n\tTo view all available options, run:"
+        "\n\n\t\t$ flower-supernode --help"
+        "\n\n\tUsing `start_client()` is deprecated."
+    )
+    warn_deprecated_feature(name=msg)
+
     event(EventType.START_CLIENT_ENTER)
     start_client_internal(
         server_address=server_address,
@@ -215,7 +234,9 @@ def start_client_internal(
     max_wait_time: Optional[float] = None,
     flwr_path: Optional[Path] = None,
     isolation: Optional[str] = None,
-    supernode_address: Optional[str] = CLIENTAPPIO_API_DEFAULT_ADDRESS,
+    clientappio_api_address: Optional[str] = CLIENTAPPIO_API_DEFAULT_SERVER_ADDRESS,
+    certificates: Optional[tuple[bytes, bytes, bytes]] = None,
+    ssl_ca_certfile: Optional[str] = None,
 ) -> None:
     """Start a Flower client node which connects to a Flower server.
 
@@ -273,10 +294,16 @@ def start_client_internal(
         `process`. Defaults to `None`, which runs the `ClientApp` in the same process
         as the SuperNode. If `subprocess`, the `ClientApp` runs in a subprocess started
         by the SueprNode and communicates using gRPC at the address
-        `supernode_address`. If `process`, the `ClientApp` runs in a separate isolated
-        process and communicates using gRPC at the address `supernode_address`.
-    supernode_address : Optional[str] (default: `CLIENTAPPIO_API_DEFAULT_ADDRESS`)
+        `clientappio_api_address`. If `process`, the `ClientApp` runs in a separate
+        isolated process and communicates using gRPC at the address
+        `clientappio_api_address`.
+    clientappio_api_address : Optional[str]
+        (default: `CLIENTAPPIO_API_DEFAULT_SERVER_ADDRESS`)
         The SuperNode gRPC server address.
+    certificates : Optional[Tuple[bytes, bytes, bytes]] (default: None)
+        Tuple containing the CA certificate, server certificate, and server private key.
+    ssl_ca_certfile : Optional[str] (default: None)
+        The path to the CA certificate file used by `flwr-clientapp` in subprocess mode.
     """
     if insecure is None:
         insecure = root_certificates is None
@@ -303,15 +330,16 @@ def start_client_internal(
         load_client_app_fn = _load_client_app
 
     if isolation:
-        if supernode_address is None:
+        if clientappio_api_address is None:
             raise ValueError(
-                f"`supernode_address` required when `isolation` is "
+                f"`clientappio_api_address` required when `isolation` is "
                 f"{ISOLATION_MODE_SUBPROCESS} or {ISOLATION_MODE_PROCESS}",
             )
         _clientappio_grpc_server, clientappio_servicer = run_clientappio_api_grpc(
-            address=supernode_address
+            address=clientappio_api_address,
+            certificates=certificates,
         )
-    supernode_address = cast(str, supernode_address)
+    clientappio_api_address = cast(str, clientappio_api_address)
 
     # At this point, only `load_client_app_fn` should be used
     # Both `client` and `client_fn` must not be used directly
@@ -365,6 +393,8 @@ def start_client_internal(
 
     # DeprecatedRunInfoStore gets initialized when the first connection is established
     run_info_store: Optional[DeprecatedRunInfoStore] = None
+    state_factory = NodeStateFactory()
+    state = state_factory.state()
 
     runs: dict[int, Run] = {}
 
@@ -396,13 +426,14 @@ def start_client_internal(
                     )
                 else:
                     # Call create_node fn to register node
-                    node_id: Optional[int] = (  # pylint: disable=assignment-from-none
-                        create_node()
-                    )  # pylint: disable=not-callable
-                    if node_id is None:
-                        raise ValueError("Node registration failed")
+                    # and store node_id in state
+                    if (node_id := create_node()) is None:
+                        raise ValueError(
+                            "Failed to register SuperNode with the SuperLink"
+                        )
+                    state.set_node_id(node_id)
                     run_info_store = DeprecatedRunInfoStore(
-                        node_id=node_id,
+                        node_id=state.get_node_id(),
                         node_config=node_config,
                     )
 
@@ -444,7 +475,7 @@ def start_client_internal(
                             runs[run_id] = get_run(run_id)
                         # If get_run is None, i.e., in grpc-bidi mode
                         else:
-                            runs[run_id] = Run(run_id, "", "", "", {})
+                            runs[run_id] = Run.create_empty(run_id=run_id)
 
                     run: Run = runs[run_id]
                     if get_fab is not None and run.fab_hash:
@@ -504,14 +535,28 @@ def start_client_internal(
                             )
 
                             if start_subprocess:
+                                _octet, _colon, _port = (
+                                    clientappio_api_address.rpartition(":")
+                                )
+                                io_address = (
+                                    f"{CLIENT_OCTET}:{_port}"
+                                    if _octet == SERVER_OCTET
+                                    else clientappio_api_address
+                                )
                                 # Start ClientApp subprocess
                                 command = [
                                     "flwr-clientapp",
-                                    "--supernode",
-                                    supernode_address,
+                                    "--clientappio-api-address",
+                                    io_address,
                                     "--token",
                                     str(token),
                                 ]
+                                if ssl_ca_certfile:
+                                    command.append("--root-certificates")
+                                    command.append(ssl_ca_certfile)
+                                else:
+                                    command.append("--insecure")
+
                                 subprocess.run(
                                     command,
                                     stdout=None,
@@ -779,7 +824,10 @@ class _AppStateTracker:
         signal.signal(signal.SIGTERM, signal_handler)
 
 
-def run_clientappio_api_grpc(address: str) -> tuple[grpc.Server, ClientAppIoServicer]:
+def run_clientappio_api_grpc(
+    address: str,
+    certificates: Optional[tuple[bytes, bytes, bytes]],
+) -> tuple[grpc.Server, ClientAppIoServicer]:
     """Run ClientAppIo API gRPC server."""
     clientappio_servicer: grpc.Server = ClientAppIoServicer()
     clientappio_add_servicer_to_server_fn = add_ClientAppIoServicer_to_server
@@ -790,6 +838,7 @@ def run_clientappio_api_grpc(address: str) -> tuple[grpc.Server, ClientAppIoServ
         ),
         server_address=address,
         max_message_length=GRPC_MAX_MESSAGE_LENGTH,
+        certificates=certificates,
     )
     log(INFO, "Starting Flower ClientAppIo gRPC server on %s", address)
     clientappio_grpc_server.start()