flwr 1.20.0__py3-none-any.whl → 1.22.0__py3-none-any.whl

flwr/proto/exec_pb2_grpc.pyi

@@ -1,93 +0,0 @@
-"""
-@generated by mypy-protobuf.  Do not edit manually!
-isort:skip_file
-"""
-import abc
-import flwr.proto.exec_pb2
-import grpc
-import typing
-
-class ExecStub:
-    def __init__(self, channel: grpc.Channel) -> None: ...
-    StartRun: grpc.UnaryUnaryMultiCallable[
-        flwr.proto.exec_pb2.StartRunRequest,
-        flwr.proto.exec_pb2.StartRunResponse]
-    """Start run upon request"""
-
-    StopRun: grpc.UnaryUnaryMultiCallable[
-        flwr.proto.exec_pb2.StopRunRequest,
-        flwr.proto.exec_pb2.StopRunResponse]
-    """Stop run upon request"""
-
-    StreamLogs: grpc.UnaryStreamMultiCallable[
-        flwr.proto.exec_pb2.StreamLogsRequest,
-        flwr.proto.exec_pb2.StreamLogsResponse]
-    """Start log stream upon request"""
-
-    ListRuns: grpc.UnaryUnaryMultiCallable[
-        flwr.proto.exec_pb2.ListRunsRequest,
-        flwr.proto.exec_pb2.ListRunsResponse]
-    """flwr ls command"""
-
-    GetLoginDetails: grpc.UnaryUnaryMultiCallable[
-        flwr.proto.exec_pb2.GetLoginDetailsRequest,
-        flwr.proto.exec_pb2.GetLoginDetailsResponse]
-    """Get login details upon request"""
-
-    GetAuthTokens: grpc.UnaryUnaryMultiCallable[
-        flwr.proto.exec_pb2.GetAuthTokensRequest,
-        flwr.proto.exec_pb2.GetAuthTokensResponse]
-    """Get auth tokens upon request"""
-
-
-class ExecServicer(metaclass=abc.ABCMeta):
-    @abc.abstractmethod
-    def StartRun(self,
-        request: flwr.proto.exec_pb2.StartRunRequest,
-        context: grpc.ServicerContext,
-    ) -> flwr.proto.exec_pb2.StartRunResponse:
-        """Start run upon request"""
-        pass
-
-    @abc.abstractmethod
-    def StopRun(self,
-        request: flwr.proto.exec_pb2.StopRunRequest,
-        context: grpc.ServicerContext,
-    ) -> flwr.proto.exec_pb2.StopRunResponse:
-        """Stop run upon request"""
-        pass
-
-    @abc.abstractmethod
-    def StreamLogs(self,
-        request: flwr.proto.exec_pb2.StreamLogsRequest,
-        context: grpc.ServicerContext,
-    ) -> typing.Iterator[flwr.proto.exec_pb2.StreamLogsResponse]:
-        """Start log stream upon request"""
-        pass
-
-    @abc.abstractmethod
-    def ListRuns(self,
-        request: flwr.proto.exec_pb2.ListRunsRequest,
-        context: grpc.ServicerContext,
-    ) -> flwr.proto.exec_pb2.ListRunsResponse:
-        """flwr ls command"""
-        pass
-
-    @abc.abstractmethod
-    def GetLoginDetails(self,
-        request: flwr.proto.exec_pb2.GetLoginDetailsRequest,
-        context: grpc.ServicerContext,
-    ) -> flwr.proto.exec_pb2.GetLoginDetailsResponse:
-        """Get login details upon request"""
-        pass
-
-    @abc.abstractmethod
-    def GetAuthTokens(self,
-        request: flwr.proto.exec_pb2.GetAuthTokensRequest,
-        context: grpc.ServicerContext,
-    ) -> flwr.proto.exec_pb2.GetAuthTokensResponse:
-        """Get auth tokens upon request"""
-        pass
-
-
-def add_ExecServicer_to_server(servicer: ExecServicer, server: grpc.Server) -> None: ...

flwr/superexec/app.py

@@ -1,45 +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 SuperExec app."""
-
-
-import argparse
-
-from flwr.common.object_ref import load_app, validate
-
-from .executor import Executor
-
-
-def load_executor(
-    args: argparse.Namespace,
-) -> Executor:
-    """Get the executor plugin."""
-    executor_ref: str = args.executor
-    valid, error_msg = validate(executor_ref, project_dir=args.executor_dir)
-    if not valid and error_msg:
-        raise LoadExecutorError(error_msg) from None
-
-    executor = load_app(executor_ref, LoadExecutorError, args.executor_dir)
-
-    if not isinstance(executor, Executor):
-        raise LoadExecutorError(
-            f"Attribute {executor_ref} is not of type {Executor}",
-        ) from None
-
-    return executor
-
-
-class LoadExecutorError(Exception):
-    """Error when trying to load `Executor`."""

flwr/superexec/deployment.py

@@ -1,191 +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.
-# ==============================================================================
-"""Deployment engine executor."""
-
-
-import hashlib
-from logging import ERROR, INFO
-from pathlib import Path
-from typing import Optional
-
-from typing_extensions import override
-
-from flwr.cli.config_utils import get_fab_metadata
-from flwr.common import ConfigRecord, Context, RecordDict
-from flwr.common.constant import (
-    SERVERAPPIO_API_DEFAULT_CLIENT_ADDRESS,
-    Status,
-    SubStatus,
-)
-from flwr.common.logger import log
-from flwr.common.typing import Fab, RunStatus, UserConfig
-from flwr.server.superlink.linkstate import LinkState, LinkStateFactory
-from flwr.supercore.ffs import Ffs, FfsFactory
-
-from .executor import Executor
-
-
-class DeploymentEngine(Executor):
-    """Deployment engine executor.
-
-    Parameters
-    ----------
-    serverappio_api_address: str (default: "127.0.0.1:9091")
-        Address of the SuperLink to connect to.
-    root_certificates: Optional[str] (default: None)
-        Specifies the path to the PEM-encoded root certificate file for
-        establishing secure HTTPS connections.
-    flwr_dir: Optional[str] (default: None)
-        The path containing installed Flower Apps.
-    """
-
-    def __init__(
-        self,
-        serverappio_api_address: str = SERVERAPPIO_API_DEFAULT_CLIENT_ADDRESS,
-        root_certificates: Optional[str] = None,
-        flwr_dir: Optional[str] = None,
-    ) -> None:
-        self.serverappio_api_address = serverappio_api_address
-        if root_certificates is None:
-            self.root_certificates = None
-            self.root_certificates_bytes = None
-        else:
-            self.root_certificates = root_certificates
-            self.root_certificates_bytes = Path(root_certificates).read_bytes()
-        self.flwr_dir = flwr_dir
-        self.linkstate_factory: Optional[LinkStateFactory] = None
-        self.ffs_factory: Optional[FfsFactory] = None
-
-    @override
-    def initialize(
-        self, linkstate_factory: LinkStateFactory, ffs_factory: FfsFactory
-    ) -> None:
-        """Initialize the executor with the necessary factories."""
-        self.linkstate_factory = linkstate_factory
-        self.ffs_factory = ffs_factory
-
-    @property
-    def linkstate(self) -> LinkState:
-        """Return the LinkState."""
-        if self.linkstate_factory is None:
-            raise RuntimeError("Executor is not initialized.")
-        return self.linkstate_factory.state()
-
-    @property
-    def ffs(self) -> Ffs:
-        """Return the Flower File Storage (FFS)."""
-        if self.ffs_factory is None:
-            raise RuntimeError("Executor is not initialized.")
-        return self.ffs_factory.ffs()
-
-    @override
-    def set_config(
-        self,
-        config: UserConfig,
-    ) -> None:
-        """Set executor config arguments.
-
-        Parameters
-        ----------
-        config : UserConfig
-            A dictionary for configuration values.
-            Supported configuration key/value pairs:
-            - "superlink": str
-                The address of the SuperLink ServerAppIo API.
-            - "root-certificates": str
-                The path to the root certificates.
-            - "flwr-dir": str
-                The path to the Flower directory.
-        """
-        if not config:
-            return
-        if superlink_address := config.get("superlink"):
-            if not isinstance(superlink_address, str):
-                raise ValueError("The `superlink` value should be of type `str`.")
-            self.serverappio_api_address = superlink_address
-        if root_certificates := config.get("root-certificates"):
-            if not isinstance(root_certificates, str):
-                raise ValueError(
-                    "The `root-certificates` value should be of type `str`."
-                )
-            self.root_certificates = root_certificates
-            self.root_certificates_bytes = Path(str(root_certificates)).read_bytes()
-        if flwr_dir := config.get("flwr-dir"):
-            if not isinstance(flwr_dir, str):
-                raise ValueError("The `flwr-dir` value should be of type `str`.")
-            self.flwr_dir = str(flwr_dir)
-
-    def _create_run(
-        self,
-        fab: Fab,
-        override_config: UserConfig,
-        flwr_aid: Optional[str],
-    ) -> int:
-        fab_hash = self.ffs.put(fab.content, {})
-        if fab_hash != fab.hash_str:
-            raise RuntimeError(
-                f"FAB ({fab.hash_str}) hash from request doesn't match contents"
-            )
-        fab_id, fab_version = get_fab_metadata(fab.content)
-
-        run_id = self.linkstate.create_run(
-            fab_id, fab_version, fab_hash, override_config, ConfigRecord(), flwr_aid
-        )
-        return run_id
-
-    def _create_context(self, run_id: int) -> None:
-        """Register a Context for a Run."""
-        # Create an empty context for the Run
-        context = Context(
-            run_id=run_id, node_id=0, node_config={}, state=RecordDict(), run_config={}
-        )
-
-        # Register the context at the LinkState
-        self.linkstate.set_serverapp_context(run_id=run_id, context=context)
-
-    @override
-    def start_run(
-        self,
-        fab_file: bytes,
-        override_config: UserConfig,
-        federation_options: ConfigRecord,
-        flwr_aid: Optional[str],
-    ) -> Optional[int]:
-        """Start run using the Flower Deployment Engine."""
-        run_id = None
-        try:
-
-            # Call SuperLink to create run
-            run_id = self._create_run(
-                Fab(hashlib.sha256(fab_file).hexdigest(), fab_file),
-                override_config,
-                flwr_aid,
-            )
-
-            # Register context for the Run
-            self._create_context(run_id=run_id)
-            log(INFO, "Created run %s", str(run_id))
-
-            return run_id
-        # pylint: disable-next=broad-except
-        except Exception as e:
-            log(ERROR, "Could not start run: %s", str(e))
-            if run_id:
-                run_status = RunStatus(Status.FINISHED, SubStatus.FAILED, str(e))
-                self.linkstate.update_run_status(run_id, new_status=run_status)
-            return None
-
-
-executor = DeploymentEngine()

flwr/superexec/executor.py

@@ -1,100 +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.
-# ==============================================================================
-"""Execute and monitor a Flower run."""
-
-
-from abc import ABC, abstractmethod
-from dataclasses import dataclass, field
-from subprocess import Popen
-from typing import Optional
-
-from flwr.common import ConfigRecord
-from flwr.common.typing import UserConfig
-from flwr.server.superlink.linkstate import LinkStateFactory
-from flwr.supercore.ffs import FfsFactory
-
-
-@dataclass
-class RunTracker:
-    """Track a Flower run (composed of a run_id and the associated process)."""
-
-    run_id: int
-    proc: Popen  # type: ignore
-    logs: list[str] = field(default_factory=list)
-
-
-class Executor(ABC):
-    """Execute and monitor a Flower run."""
-
-    @abstractmethod
-    def initialize(
-        self, linkstate_factory: LinkStateFactory, ffs_factory: FfsFactory
-    ) -> None:
-        """Initialize the executor with the necessary factories.
-
-        This method sets up the executor by providing it with the factories required
-        to access the LinkState and the Flower File Storage (FFS) in the SuperLink.
-
-        Parameters
-        ----------
-        linkstate_factory : LinkStateFactory
-            The factory to create access to the LinkState.
-        ffs_factory : FfsFactory
-            The factory to create access to the Flower File Storage (FFS).
-        """
-
-    @abstractmethod
-    def set_config(
-        self,
-        config: UserConfig,
-    ) -> None:
-        """Register provided config as class attributes.
-
-        Parameters
-        ----------
-        config : UserConfig
-            A dictionary for configuration values.
-        """
-
-    @abstractmethod
-    def start_run(
-        self,
-        fab_file: bytes,
-        override_config: UserConfig,
-        federation_options: ConfigRecord,
-        flwr_aid: Optional[str],
-    ) -> Optional[int]:
-        """Start a run using the given Flower FAB ID and version.
-
-        This method creates a new run on the SuperLink, returns its run_id
-        and also starts the run execution.
-
-        Parameters
-        ----------
-        fab_file : bytes
-            The Flower App Bundle file bytes.
-        override_config: UserConfig
-            The config overrides dict sent by the user (using `flwr run`).
-        federation_options: ConfigRecord
-            The federation options sent by the user (using `flwr run`).
-        flwr_aid : Optional[str]
-            The Flower Account ID of the user starting the run, if authentication is
-            enabled.
-
-        Returns
-        -------
-        run_id : Optional[int]
-            The run_id of the run created by the SuperLink, or `None` if it fails.
-        """

flwr/superexec/simulation.py

@@ -1,129 +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.
-# ==============================================================================
-"""Simulation engine executor."""
-
-
-import hashlib
-from logging import ERROR, INFO
-from typing import Optional
-
-from typing_extensions import override
-
-from flwr.cli.config_utils import get_fab_metadata
-from flwr.common import ConfigRecord, Context, RecordDict
-from flwr.common.logger import log
-from flwr.common.typing import Fab, UserConfig
-from flwr.server.superlink.linkstate import LinkState, LinkStateFactory
-from flwr.supercore.ffs import Ffs, FfsFactory
-
-from .executor import Executor
-
-
-class SimulationEngine(Executor):
-    """Simulation engine executor."""
-
-    def __init__(
-        self,
-    ) -> None:
-        self.linkstate_factory: Optional[LinkStateFactory] = None
-        self.ffs_factory: Optional[FfsFactory] = None
-
-    @override
-    def initialize(
-        self, linkstate_factory: LinkStateFactory, ffs_factory: FfsFactory
-    ) -> None:
-        """Initialize the executor with the necessary factories."""
-        self.linkstate_factory = linkstate_factory
-        self.ffs_factory = ffs_factory
-
-    @property
-    def linkstate(self) -> LinkState:
-        """Return the LinkState."""
-        if self.linkstate_factory is None:
-            raise RuntimeError("Executor is not initialized.")
-        return self.linkstate_factory.state()
-
-    @property
-    def ffs(self) -> Ffs:
-        """Return the Flower File Storage (FFS)."""
-        if self.ffs_factory is None:
-            raise RuntimeError("Executor is not initialized.")
-        return self.ffs_factory.ffs()
-
-    @override
-    def set_config(
-        self,
-        config: UserConfig,
-    ) -> None:
-        """Set executor config arguments."""
-
-    # pylint: disable=too-many-locals
-    @override
-    def start_run(
-        self,
-        fab_file: bytes,
-        override_config: UserConfig,
-        federation_options: ConfigRecord,
-        flwr_aid: Optional[str],
-    ) -> Optional[int]:
-        """Start run using the Flower Simulation Engine."""
-        try:
-            # Check that num-supernodes is set
-            if "num-supernodes" not in federation_options:
-                raise ValueError(
-                    "Federation options doesn't contain key `num-supernodes`."
-                )
-
-            # Create run
-            fab = Fab(hashlib.sha256(fab_file).hexdigest(), fab_file)
-            fab_hash = self.ffs.put(fab.content, {})
-            if fab_hash != fab.hash_str:
-                raise RuntimeError(
-                    f"FAB ({fab.hash_str}) hash from request doesn't match contents"
-                )
-            fab_id, fab_version = get_fab_metadata(fab.content)
-
-            run_id = self.linkstate.create_run(
-                fab_id,
-                fab_version,
-                fab_hash,
-                override_config,
-                federation_options,
-                flwr_aid,
-            )
-
-            # Create an empty context for the Run
-            context = Context(
-                run_id=run_id,
-                node_id=0,
-                node_config={},
-                state=RecordDict(),
-                run_config={},
-            )
-
-            # Register the context at the LinkState
-            self.linkstate.set_serverapp_context(run_id=run_id, context=context)
-
-            log(INFO, "Created run %s", str(run_id))
-
-            return run_id
-
-        # pylint: disable-next=broad-except
-        except Exception as e:
-            log(ERROR, "Could not start run: %s", str(e))
-            return None
-
-
-executor = SimulationEngine()