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

flwr/cli/federation/show.py

@@ -1,317 +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 ..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}]",
-            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": node.node_id,
-                "owner": node.owner_name,
-                "status": node.status,
-            }
-        )
-
-    for run in runs:
-        runs_list.append(
-            {
-                "run_id": 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/cli/new/templates/app/.gitignore.tpl

@@ -1,163 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# Flower directory
-.flwr
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/

flwr/cli/new/templates/app/LICENSE.tpl

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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.