flwr 1.19.0__py3-none-any.whl → 1.21.0__py3-none-any.whl

flwr/proto/exec_pb2.py

@@ -1,62 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: flwr/proto/exec.proto
-# Protobuf Python Version: 4.25.1
-"""Generated protocol buffer code."""
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import symbol_database as _symbol_database
-from google.protobuf.internal import builder as _builder
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-from flwr.proto import fab_pb2 as flwr_dot_proto_dot_fab__pb2
-from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
-from flwr.proto import recorddict_pb2 as flwr_dot_proto_dot_recorddict__pb2
-from flwr.proto import run_pb2 as flwr_dot_proto_dot_run__pb2
-
-
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/exec.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x1a\x66lwr/proto/transport.proto\x1a\x1b\x66lwr/proto/recorddict.proto\x1a\x14\x66lwr/proto/run.proto\"\xfa\x01\n\x0fStartRunRequest\x12\x1c\n\x03\x66\x61\x62\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Fab\x12H\n\x0foverride_config\x18\x02 \x03(\x0b\x32/.flwr.proto.StartRunRequest.OverrideConfigEntry\x12\x34\n\x12\x66\x65\x64\x65ration_options\x18\x03 \x01(\x0b\x32\x18.flwr.proto.ConfigRecord\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"2\n\x10StartRunResponse\x12\x13\n\x06run_id\x18\x01 \x01(\x04H\x00\x88\x01\x01\x42\t\n\x07_run_id\"<\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x17\n\x0f\x61\x66ter_timestamp\x18\x02 \x01(\x01\"B\n\x12StreamLogsResponse\x12\x12\n\nlog_output\x18\x01 \x01(\t\x12\x18\n\x10latest_timestamp\x18\x02 \x01(\x01\"1\n\x0fListRunsRequest\x12\x13\n\x06run_id\x18\x01 \x01(\x04H\x00\x88\x01\x01\x42\t\n\x07_run_id\"\x9d\x01\n\x10ListRunsResponse\x12;\n\x08run_dict\x18\x01 \x03(\x0b\x32).flwr.proto.ListRunsResponse.RunDictEntry\x12\x0b\n\x03now\x18\x02 \x01(\t\x1a?\n\x0cRunDictEntry\x12\x0b\n\x03key\x18\x01 \x01(\x04\x12\x1e\n\x05value\x18\x02 \x01(\x0b\x32\x0f.flwr.proto.Run:\x02\x38\x01\"\x18\n\x16GetLoginDetailsRequest\"\x8a\x01\n\x17GetLoginDetailsResponse\x12\x11\n\tauth_type\x18\x01 \x01(\t\x12\x13\n\x0b\x64\x65vice_code\x18\x02 \x01(\t\x12!\n\x19verification_uri_complete\x18\x03 \x01(\t\x12\x12\n\nexpires_in\x18\x04 \x01(\x03\x12\x10\n\x08interval\x18\x05 \x01(\x03\"+\n\x14GetAuthTokensRequest\x12\x13\n\x0b\x64\x65vice_code\x18\x01 \x01(\t\"D\n\x15GetAuthTokensResponse\x12\x14\n\x0c\x61\x63\x63\x65ss_token\x18\x01 \x01(\t\x12\x15\n\rrefresh_token\x18\x02 \x01(\t\" \n\x0eStopRunRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"\"\n\x0fStopRunResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\x32\xe5\x03\n\x04\x45xec\x12G\n\x08StartRun\x12\x1b.flwr.proto.StartRunRequest\x1a\x1c.flwr.proto.StartRunResponse\"\x00\x12\x44\n\x07StopRun\x12\x1a.flwr.proto.StopRunRequest\x1a\x1b.flwr.proto.StopRunResponse\"\x00\x12O\n\nStreamLogs\x12\x1d.flwr.proto.StreamLogsRequest\x1a\x1e.flwr.proto.StreamLogsResponse\"\x00\x30\x01\x12G\n\x08ListRuns\x12\x1b.flwr.proto.ListRunsRequest\x1a\x1c.flwr.proto.ListRunsResponse\"\x00\x12\\\n\x0fGetLoginDetails\x12\".flwr.proto.GetLoginDetailsRequest\x1a#.flwr.proto.GetLoginDetailsResponse\"\x00\x12V\n\rGetAuthTokens\x12 .flwr.proto.GetAuthTokensRequest\x1a!.flwr.proto.GetAuthTokensResponse\"\x00\x62\x06proto3')
-
-_globals = globals()
-_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
-_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.exec_pb2', _globals)
-if _descriptor._USE_C_DESCRIPTORS == False:
-  DESCRIPTOR._options = None
-  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._options = None
-  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_options = b'8\001'
-  _globals['_LISTRUNSRESPONSE_RUNDICTENTRY']._options = None
-  _globals['_LISTRUNSRESPONSE_RUNDICTENTRY']._serialized_options = b'8\001'
-  _globals['_STARTRUNREQUEST']._serialized_start=139
-  _globals['_STARTRUNREQUEST']._serialized_end=389
-  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=316
-  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=389
-  _globals['_STARTRUNRESPONSE']._serialized_start=391
-  _globals['_STARTRUNRESPONSE']._serialized_end=441
-  _globals['_STREAMLOGSREQUEST']._serialized_start=443
-  _globals['_STREAMLOGSREQUEST']._serialized_end=503
-  _globals['_STREAMLOGSRESPONSE']._serialized_start=505
-  _globals['_STREAMLOGSRESPONSE']._serialized_end=571
-  _globals['_LISTRUNSREQUEST']._serialized_start=573
-  _globals['_LISTRUNSREQUEST']._serialized_end=622
-  _globals['_LISTRUNSRESPONSE']._serialized_start=625
-  _globals['_LISTRUNSRESPONSE']._serialized_end=782
-  _globals['_LISTRUNSRESPONSE_RUNDICTENTRY']._serialized_start=719
-  _globals['_LISTRUNSRESPONSE_RUNDICTENTRY']._serialized_end=782
-  _globals['_GETLOGINDETAILSREQUEST']._serialized_start=784
-  _globals['_GETLOGINDETAILSREQUEST']._serialized_end=808
-  _globals['_GETLOGINDETAILSRESPONSE']._serialized_start=811
-  _globals['_GETLOGINDETAILSRESPONSE']._serialized_end=949
-  _globals['_GETAUTHTOKENSREQUEST']._serialized_start=951
-  _globals['_GETAUTHTOKENSREQUEST']._serialized_end=994
-  _globals['_GETAUTHTOKENSRESPONSE']._serialized_start=996
-  _globals['_GETAUTHTOKENSRESPONSE']._serialized_end=1064
-  _globals['_STOPRUNREQUEST']._serialized_start=1066
-  _globals['_STOPRUNREQUEST']._serialized_end=1098
-  _globals['_STOPRUNRESPONSE']._serialized_start=1100
-  _globals['_STOPRUNRESPONSE']._serialized_end=1134
-  _globals['_EXEC']._serialized_start=1137
-  _globals['_EXEC']._serialized_end=1622
-# @@protoc_insertion_point(module_scope)

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,192 +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.ffs import Ffs
-from flwr.server.superlink.ffs.ffs_factory import FfsFactory
-from flwr.server.superlink.linkstate import LinkState, LinkStateFactory
-
-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.ffs.ffs_factory import FfsFactory
-from flwr.server.superlink.linkstate import LinkStateFactory
-
-
-@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,130 +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.ffs import Ffs
-from flwr.server.superlink.ffs.ffs_factory import FfsFactory
-from flwr.server.superlink.linkstate import LinkState, LinkStateFactory
-
-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()