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

flwr/cli/federation/show.py

@@ -1,318 +0,0 @@
-# Copyright 2025 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 `federation show` command."""
-
-
-import io
-from pathlib import Path
-from typing import Annotated, Any
-
-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.ls import _get_status_style
-from flwr.common.constant import FAB_CONFIG_FILE, 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
-    ShowFederationRequest,
-    ShowFederationResponse,
-)
-from flwr.proto.control_pb2_grpc import ControlStub
-from flwr.proto.node_pb2 import NodeInfo  # pylint: disable=E0611
-from flwr.supercore.constant import NOOP_FEDERATION
-from flwr.supercore.utils import humanize_duration
-
-from ..run_utils import RunRow, format_runs
-from ..utils import flwr_cli_grpc_exc_handler, init_channel, load_cli_auth_plugin
-
-
-def show(  # pylint: disable=R0914, R0913, R0917
-    app: Annotated[
-        Path,
-        typer.Argument(help="Path of the Flower project"),
-    ] = Path("."),
-    federation: Annotated[
-        str | None,
-        typer.Argument(help="Name of the federation"),
-    ] = None,
-    output_format: Annotated[
-        str,
-        typer.Option(
-            "--format",
-            case_sensitive=False,
-            help="Format output using 'default' view or 'json'",
-        ),
-    ] = CliOutputFormat.DEFAULT,
-) -> None:
-    """Show details of a federation.
-
-    Display comprehensive information about a federation including its members,
-    registered SuperNodes, and runs.
-    """
-    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 / 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
-        )
-        exit_if_no_address(federation_config, "federation show")
-        real_federation: str = federation_config.get("federation", NOOP_FEDERATION)
-        channel = None
-        try:
-            auth_plugin = load_cli_auth_plugin(app, federation, federation_config)
-            channel = init_channel(app, federation_config, auth_plugin)
-            stub = ControlStub(channel)
-            typer.echo(f"📄 Showing '{real_federation}' federation ...")
-            members, nodes, runs = _show_federation(stub, real_federation)
-            restore_output()
-            if output_format == CliOutputFormat.JSON:
-                Console().print_json(data=_to_json(members, nodes, runs))
-            else:
-                Console().print(_to_members_table(members))
-                Console().print(_to_nodes_table(nodes))
-                Console().print(_to_runs_table(runs))
-        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 _show_federation(
-    stub: ControlStub, federation: str
-) -> tuple[list[str], list[NodeInfo], list[RunRow]]:
-    """Show federation details.
-
-    Parameters
-    ----------
-    stub : ControlStub
-        The gRPC stub for Control API communication.
-    federation : str
-        Name of the federation to show.
-
-    Returns
-    -------
-    tuple[list[str], list[NodeInfo], list[RunRow]]
-        A tuple containing (member_account_ids, nodes, runs).
-    """
-    with flwr_cli_grpc_exc_handler():
-        res: ShowFederationResponse = stub.ShowFederation(
-            ShowFederationRequest(federation_name=federation)
-        )
-
-    fed_proto = res.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
-
-
-def _to_members_table(member_aids: list[str]) -> Table:
-    """Format the provided list of federation members as a rich Table.
-
-    Parameters
-    ----------
-    member_aids : list[str]
-        List of member account identifiers.
-
-    Returns
-    -------
-    Table
-        Rich Table object with formatted member information.
-    """
-    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
-    )
-    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")
-
-    return table
-
-
-def _to_nodes_table(nodes: list[NodeInfo]) -> Table:
-    """Format the provided list of federation nodes as a rich Table.
-
-    Parameters
-    ----------
-    nodes : list[NodeInfo]
-        List of NodeInfo objects containing node details.
-
-    Returns
-    -------
-    Table
-        Rich Table object with formatted node information.
-
-    Raises
-    ------
-    ValueError
-        If an unexpected node status is encountered.
-    """
-    table = Table(
-        title="SuperNodes in the Federation", header_style="bold cyan", show_lines=True
-    )
-
-    # Add columns
-    table.add_column(
-        Text("Node ID", justify="center"), style="bright_black", no_wrap=True
-    )
-    table.add_column(Text("Owner", justify="center"))
-    table.add_column(Text("Status", justify="center"))
-
-    for row in nodes:
-        owner_name = row.owner_name
-        status = row.status
-
-        if status == "online":
-            status_style = "green"
-        elif status == "offline":
-            status_style = "bright_yellow"
-        elif status == "unregistered":
-            continue
-        elif status == "registered":
-            status_style = "blue"
-        else:
-            raise ValueError(f"Unexpected node status '{status}'")
-
-        formatted_row = (
-            f"[bold]{row.node_id}[/bold]",
-            (
-                f"{owner_name}"
-                if owner_name != NOOP_ACCOUNT_NAME
-                else f"[dim]{owner_name}[/dim]"
-            ),
-            f"[{status_style}]{status}",
-        )
-        table.add_row(*formatted_row)
-
-    return table
-
-
-def _to_runs_table(run_list: list[RunRow]) -> Table:
-    """Format the provided list of federation runs as a rich Table.
-
-    Parameters
-    ----------
-    run_list : list[RunRow]
-        List of RunRow objects containing run details.
-
-    Returns
-    -------
-    Table
-        Rich Table object with formatted run information.
-    """
-    table = Table(
-        title="Runs in the Federation", header_style="bold cyan", show_lines=True
-    )
-
-    # Add columns
-    table.add_column(Text("Run ID", justify="center"), no_wrap=True)
-    table.add_column(Text("App", justify="center"))
-    table.add_column(Text("Status", justify="center"))
-    table.add_column(Text("Elapsed", justify="center"), style="blue")
-
-    for row in run_list:
-        status_style = _get_status_style(row.status_text)
-
-        formatted_row = (
-            f"[bold]{row.run_id}[/bold]",
-            f"@{row.fab_id}=={row.fab_version}",
-            f"[{status_style}]{row.status_text}[/{status_style}]",
-            f"{humanize_duration(row.elapsed)}",
-        )
-        table.add_row(*formatted_row)
-
-    return table
-
-
-def _to_json(
-    members: list[str], nodes: list[NodeInfo], runs: list[RunRow]
-) -> list[list[dict[str, str]]]:
-    """Format the provided federation information to JSON serializable format.
-
-    Parameters
-    ----------
-    members : list[str]
-        List of member account identifiers.
-    nodes : list[NodeInfo]
-        List of NodeInfo objects.
-    runs : list[RunRow]
-        List of RunRow objects.
-
-    Returns
-    -------
-    list[list[dict[str, str]]]
-        Nested list containing dictionaries for members, nodes, and runs.
-    """
-    members_list: list[dict[str, Any]] = []
-    nodes_list: list[dict[str, Any]] = []
-    runs_list: list[dict[str, Any]] = []
-
-    for member in members:
-        members_list.append({"member_id": member, "role": "Member"})
-
-    for node in nodes:
-        nodes_list.append(
-            {
-                "node_id": f"{node.node_id}",
-                "owner": node.owner_name,
-                "status": node.status,
-            }
-        )
-
-    for run in runs:
-        runs_list.append(
-            {
-                "run_id": f"{run.run_id}",
-                "app": f"@{run.fab_id}=={run.fab_version}",
-                "status": run.status_text,
-                "elapsed": run.elapsed,
-            }
-        )
-
-    return [members_list, nodes_list, runs_list]

flwr/common/pyproject.py

@@ -1,42 +0,0 @@
-# Copyright 2025 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.
-# ==============================================================================
-"""Validates the project's name property."""
-
-
-import re
-
-
-def validate_project_name(name: str) -> bool:
-    """Validate the project name against PEP 621 and PEP 503 specifications.
-
-    Conventions at a glance:
-    - Must be lowercase
-    - Must not contain special characters
-    - Must use hyphens(recommended) or underscores. No spaces.
-    - Recommended to be no more than 40 characters long (But it can be)
-
-    Parameters
-    ----------
-    name : str
-        The project name to validate.
-
-    Returns
-    -------
-    bool
-        True if the name is valid, False otherwise.
-    """
-    if not name or len(name) > 40 or not re.match(r"^[a-z0-9-_]+$", name):
-        return False
-    return True

flwr/supercore/sqlite_mixin.py

@@ -1,159 +0,0 @@
-# Copyright 2025 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.
-# ==============================================================================
-"""Mixin providing common SQLite connection and initialization logic."""
-
-
-import re
-import sqlite3
-from abc import ABC
-from collections.abc import Sequence
-from logging import DEBUG, ERROR
-from typing import Any
-
-from flwr.common.logger import log
-
-DictOrTuple = tuple[Any, ...] | dict[str, Any]
-
-
-class SqliteMixin(ABC):
-    """Mixin providing common SQLite connection and initialization logic."""
-
-    def __init__(self, database_path: str) -> None:
-        self.database_path = database_path
-        self._conn: sqlite3.Connection | None = None
-
-    @property
-    def conn(self) -> sqlite3.Connection:
-        """Get the SQLite connection."""
-        if self._conn is None:
-            raise AttributeError("Database not initialized. Call initialize() first.")
-        return self._conn
-
-    def get_sql_statements(self) -> tuple[str, ...]:
-        """Return SQL statements for this class.
-
-        Subclasses can override this to provide their SQL CREATE statements.
-        The base implementation returns an empty tuple.
-
-        Returns
-        -------
-        tuple[str, ...]
-            SQL CREATE TABLE/INDEX statements for this class.
-        """
-        return ()
-
-    def initialize(self, log_queries: bool = False) -> list[tuple[str]]:
-        """Connect to the DB, enable FK support, and create tables if needed.
-
-        This method executes SQL statements returned by `get_sql_statements()`.
-
-        Parameters
-        ----------
-        log_queries : bool
-            Log each query which is executed.
-
-        Returns
-        -------
-        list[tuple[str]]
-            The list of all tables in the DB.
-
-        Examples
-        --------
-        Override `get_sql_statements()` in your subclass:
-
-        .. code:: python
-
-            def get_sql_statements(self) -> tuple[str, ...]:
-                return (
-                    SQL_CREATE_TABLE_FOO,
-                    SQL_CREATE_TABLE_BAR,
-                )
-
-        To include parent SQL statements, call super():
-
-        .. code:: python
-
-            def get_sql_statements(self) -> tuple[str, ...]:
-                return super().get_sql_statements() + (
-                    SQL_CREATE_TABLE_FOO,
-                    SQL_CREATE_TABLE_BAR,
-                )
-        """
-        self._conn = sqlite3.connect(self.database_path)
-        # Enable Write-Ahead Logging (WAL) for better concurrency
-        self._conn.execute("PRAGMA journal_mode = WAL;")
-        self._conn.execute("PRAGMA synchronous = NORMAL;")
-        self._conn.execute("PRAGMA foreign_keys = ON;")
-        self._conn.execute("PRAGMA cache_size = -64000;")  # 64MB cache
-        self._conn.execute("PRAGMA temp_store = MEMORY;")  # In-memory temp tables
-        self._conn.execute("PRAGMA mmap_size = 268435456;")  # 256MB memory-mapped I/O
-        self._conn.row_factory = dict_factory
-
-        if log_queries:
-            self._conn.set_trace_callback(lambda q: log(DEBUG, q))
-
-        # Create tables and indexes
-        cur = self._conn.cursor()
-        for sql in self.get_sql_statements():
-            cur.execute(sql)
-        res = cur.execute("SELECT name FROM sqlite_schema;")
-        return res.fetchall()
-
-    def query(
-        self,
-        query: str,
-        data: Sequence[DictOrTuple] | DictOrTuple | None = None,
-    ) -> list[dict[str, Any]]:
-        """Execute a SQL query and return the results as list of dicts."""
-        if self._conn is None:
-            raise AttributeError("LinkState is not initialized.")
-
-        if data is None:
-            data = []
-
-        # Clean up whitespace to make the logs nicer
-        query = re.sub(r"\s+", " ", query)
-
-        try:
-            with self._conn:
-                if (
-                    len(data) > 0
-                    and isinstance(data, (tuple | list))
-                    and isinstance(data[0], (tuple | dict))
-                ):
-                    rows = self._conn.executemany(query, data)
-                else:
-                    rows = self._conn.execute(query, data)
-
-                # Extract results before committing to support
-                #   INSERT/UPDATE ... RETURNING
-                # style queries
-                result = rows.fetchall()
-        except KeyError as exc:
-            log(ERROR, {"query": query, "data": data, "exception": exc})
-
-        return result
-
-
-def dict_factory(
-    cursor: sqlite3.Cursor,
-    row: sqlite3.Row,
-) -> dict[str, Any]:
-    """Turn SQLite results into dicts.
-
-    Less efficent for retrival of large amounts of data but easier to use.
-    """
-    fields = [column[0] for column in cursor.description]
-    return dict(zip(fields, row, strict=True))