flwr-nightly 1.22.0.dev20250916__py3-none-any.whl → 1.22.0.dev20250918__py3-none-any.whl

flwr/simulation/run_simulation.py

@@ -143,6 +143,15 @@ def run_simulation_from_cli() -> None:
     run = Run.create_empty(run_id)
     run.override_config = override_config
 
+    # Create Context
+    server_app_context = Context(
+        run_id=run_id,
+        node_id=0,
+        node_config=UserConfig(),
+        state=RecordDict(),
+        run_config=fused_config,
+    )
+
     _ = _run_simulation(
         server_app_attr=server_app_attr,
         client_app_attr=client_app_attr,
@@ -153,7 +162,7 @@ def run_simulation_from_cli() -> None:
         run=run,
         enable_tf_gpu_growth=args.enable_tf_gpu_growth,
         verbose_logging=args.verbose,
-        server_app_run_config=fused_config,
+        server_app_context=server_app_context,
         is_app=True,
         exit_event=EventType.CLI_FLOWER_SIMULATION_LEAVE,
     )
@@ -241,13 +250,12 @@ def run_simulation(
 def run_serverapp_th(
     server_app_attr: Optional[str],
     server_app: Optional[ServerApp],
-    server_app_run_config: UserConfig,
+    server_app_context: Context,
     grid: Grid,
     app_dir: str,
     f_stop: threading.Event,
     has_exception: threading.Event,
     enable_tf_gpu_growth: bool,
-    run_id: int,
     ctx_queue: "Queue[Context]",
 ) -> threading.Thread:
     """Run SeverApp in a thread."""
@@ -258,7 +266,6 @@ def run_serverapp_th(
         exception_event: threading.Event,
         _grid: Grid,
         _server_app_dir: str,
-        _server_app_run_config: UserConfig,
         _server_app_attr: Optional[str],
         _server_app: Optional[ServerApp],
         _ctx_queue: "Queue[Context]",
@@ -272,19 +279,10 @@ def run_serverapp_th(
                 log(INFO, "Enabling GPU growth for Tensorflow on the server thread.")
                 enable_gpu_growth()
 
-            # Initialize Context
-            context = Context(
-                run_id=run_id,
-                node_id=0,
-                node_config={},
-                state=RecordDict(),
-                run_config=_server_app_run_config,
-            )
-
             # Run ServerApp
             updated_context = _run(
                 grid=_grid,
-                context=context,
+                context=server_app_context,
                 server_app_dir=_server_app_dir,
                 server_app_attr=_server_app_attr,
                 loaded_server_app=_server_app,
@@ -310,7 +308,6 @@ def run_serverapp_th(
             has_exception,
             grid,
             app_dir,
-            server_app_run_config,
             server_app_attr,
             server_app,
             ctx_queue,
@@ -335,7 +332,7 @@ def _main_loop(
     client_app_attr: Optional[str] = None,
     server_app: Optional[ServerApp] = None,
     server_app_attr: Optional[str] = None,
-    server_app_run_config: Optional[UserConfig] = None,
+    server_app_context: Optional[Context] = None,
 ) -> Context:
     """Start ServerApp on a separate thread, then launch Simulation Engine."""
     # Initialize StateFactory
@@ -346,13 +343,15 @@ def _main_loop(
     server_app_thread_has_exception = threading.Event()
     serverapp_th = None
     success = True
-    updated_context = Context(
-        run_id=run.run_id,
-        node_id=0,
-        node_config=UserConfig(),
-        state=RecordDict(),
-        run_config=UserConfig(),
-    )
+    if server_app_context is None:
+        server_app_context = Context(
+            run_id=run.run_id,
+            node_id=0,
+            node_config=UserConfig(),
+            state=RecordDict(),
+            run_config=UserConfig(),
+        )
+    updated_context = server_app_context
     try:
         # Register run
         log(DEBUG, "Pre-registering run with id %s", run.run_id)
@@ -361,9 +360,6 @@ def _main_loop(
         run.running_at = run.starting_at
         state_factory.state().run_ids[run.run_id] = RunRecord(run=run)  # type: ignore
 
-        if server_app_run_config is None:
-            server_app_run_config = {}
-
         # Initialize Grid
         grid = InMemoryGrid(state_factory=state_factory)
         grid.set_run(run_id=run.run_id)
@@ -373,13 +369,12 @@ def _main_loop(
         serverapp_th = run_serverapp_th(
             server_app_attr=server_app_attr,
             server_app=server_app,
-            server_app_run_config=server_app_run_config,
+            server_app_context=server_app_context,
             grid=grid,
             app_dir=app_dir,
             f_stop=f_stop,
             has_exception=server_app_thread_has_exception,
             enable_tf_gpu_growth=enable_tf_gpu_growth,
-            run_id=run.run_id,
             ctx_queue=output_context_queue,
         )
 
@@ -438,7 +433,7 @@ def _run_simulation(
     backend_config: Optional[BackendConfig] = None,
     client_app_attr: Optional[str] = None,
     server_app_attr: Optional[str] = None,
-    server_app_run_config: Optional[UserConfig] = None,
+    server_app_context: Optional[Context] = None,
     app_dir: str = "",
     flwr_dir: Optional[str] = None,
     run: Optional[Run] = None,
@@ -502,7 +497,7 @@ def _run_simulation(
         client_app_attr,
         server_app,
         server_app_attr,
-        server_app_run_config,
+        server_app_context,
     )
     # Detect if there is an Asyncio event loop already running.
     # If yes, disable logger propagation. In environmnets

flwr/supercore/cli/flower_superexec.py

@@ -17,7 +17,9 @@
 
 import argparse
 from logging import INFO
-from typing import Optional
+from typing import Any, Optional
+
+import yaml
 
 from flwr.common import EventType, event
 from flwr.common.constant import ExecPluginType
@@ -26,6 +28,7 @@ from flwr.common.logger import log
 from flwr.proto.clientappio_pb2_grpc import ClientAppIoStub
 from flwr.proto.serverappio_pb2_grpc import ServerAppIoStub
 from flwr.proto.simulationio_pb2_grpc import SimulationIoStub
+from flwr.supercore.constant import EXEC_PLUGIN_SECTION
 from flwr.supercore.grpc_health import add_args_health
 from flwr.supercore.superexec.plugin import (
     ClientAppExecPlugin,
@@ -36,6 +39,7 @@ from flwr.supercore.superexec.plugin import (
 from flwr.supercore.superexec.run_superexec import run_superexec
 
 try:
+    from flwr.ee import add_ee_args_superexec
     from flwr.ee.constant import ExecEePluginType
     from flwr.ee.exec_plugin import get_ee_plugin_and_stub_class
 except ImportError:
@@ -54,6 +58,10 @@ except ImportError:
         """Get the EE plugin class and stub class based on the plugin type."""
         return None
 
+    # pylint: disable-next=unused-argument
+    def add_ee_args_superexec(parser: argparse.ArgumentParser) -> None:
+        """Add EE-specific arguments to the parser."""
+
 
 def flower_superexec() -> None:
     """Run `flower-superexec` command."""
@@ -70,12 +78,28 @@ def flower_superexec() -> None:
     # Trigger telemetry event
     event(EventType.RUN_SUPEREXEC_ENTER, {"plugin_type": args.plugin_type})
 
+    # Load plugin config from YAML file if provided
+    plugin_config = None
+    if plugin_config_path := getattr(args, "plugin_config", None):
+        try:
+            with open(plugin_config_path, encoding="utf-8") as file:
+                yaml_config: Optional[dict[str, Any]] = yaml.safe_load(file)
+                if yaml_config is None or EXEC_PLUGIN_SECTION not in yaml_config:
+                    raise ValueError(f"Missing '{EXEC_PLUGIN_SECTION}' section.")
+                plugin_config = yaml_config[EXEC_PLUGIN_SECTION]
+        except (FileNotFoundError, yaml.YAMLError, ValueError) as e:
+            flwr_exit(
+                ExitCode.SUPEREXEC_INVALID_PLUGIN_CONFIG,
+                f"Failed to load plugin config from '{plugin_config_path}': {e!r}",
+            )
+
     # Get the plugin class and stub class based on the plugin type
     plugin_class, stub_class = _get_plugin_and_stub_class(args.plugin_type)
     run_superexec(
         plugin_class=plugin_class,
         stub_class=stub_class,  # type: ignore
         appio_api_address=args.appio_api_address,
+        plugin_config=plugin_config,
         flwr_dir=args.flwr_dir,
         parent_pid=args.parent_pid,
         health_server_address=args.health_server_address,
@@ -122,6 +146,7 @@ def _parse_args() -> argparse.ArgumentParser:
         help="The PID of the parent process. When set, the process will terminate "
         "when the parent process exits.",
     )
+    add_ee_args_superexec(parser)
     add_args_health(parser)
     return parser
 

flwr/supercore/constant.py

@@ -0,0 +1,19 @@
+# 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.
+# ==============================================================================
+"""Constants for Flower infrastructure."""
+
+
+# Top-level key in YAML config for exec plugin settings
+EXEC_PLUGIN_SECTION = "exec_plugin"

flwr/supercore/superexec/plugin/exec_plugin.py

@@ -17,7 +17,7 @@
 
 from abc import ABC, abstractmethod
 from collections.abc import Sequence
-from typing import Callable, Optional
+from typing import Any, Callable, Optional
 
 from flwr.common.typing import Run
 
@@ -69,3 +69,13 @@ class ExecPlugin(ABC):
            The ID of the run associated with the token, used for tracking or
            logging purposes.
         """
+
+    # This method is optional to implement
+    def load_config(self, yaml_config: dict[str, Any]) -> None:
+        """Load configuration from a YAML dictionary.
+
+        Parameters
+        ----------
+        yaml_config : dict[str, Any]
+            A dictionary representing the YAML configuration.
+        """

flwr/supercore/superexec/run_superexec.py

@@ -17,10 +17,10 @@
 
 import time
 from logging import WARN
-from typing import Optional, Union
+from typing import Any, Optional, Union
 
 from flwr.common.config import get_flwr_dir
-from flwr.common.exit import register_signal_handlers
+from flwr.common.exit import ExitCode, flwr_exit, register_signal_handlers
 from flwr.common.grpc import create_channel, on_channel_state_change
 from flwr.common.logger import log
 from flwr.common.retry_invoker import _make_simple_grpc_retry_invoker, _wrap_stub
@@ -47,6 +47,7 @@ def run_superexec(  # pylint: disable=R0913,R0914,R0917
         type[ClientAppIoStub], type[ServerAppIoStub], type[SimulationIoStub]
     ],
     appio_api_address: str,
+    plugin_config: Optional[dict[str, Any]] = None,
     flwr_dir: Optional[str] = None,
     parent_pid: Optional[int] = None,
     health_server_address: Optional[str] = None,
@@ -61,6 +62,9 @@ def run_superexec(  # pylint: disable=R0913,R0914,R0917
         The gRPC stub class for the AppIO API.
     appio_api_address : str
         The address of the AppIO API.
+    plugin_config : Optional[dict[str, Any]] (default: None)
+        The configuration dictionary for the plugin. If `None`, the plugin will use
+        its default configuration.
     flwr_dir : Optional[str] (default: None)
         The Flower directory.
     parent_pid : Optional[int] (default: None)
@@ -113,6 +117,16 @@ def run_superexec(  # pylint: disable=R0913,R0914,R0917
         get_run=get_run,
     )
 
+    # Load plugin configuration from file if provided
+    try:
+        if plugin_config is not None:
+            plugin.load_config(plugin_config)
+    except (KeyError, ValueError) as e:
+        flwr_exit(
+            code=ExitCode.SUPEREXEC_INVALID_PLUGIN_CONFIG,
+            message=f"Invalid plugin config: {e!r}",
+        )
+
     # Start the main loop
     try:
         while True:

flwr/superlink/artifact_provider/__init__.py

@@ -0,0 +1,22 @@
+# 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.
+# ==============================================================================
+"""ArtifactProvider for SuperLink."""
+
+
+from .artifact_provider import ArtifactProvider
+
+__all__ = [
+    "ArtifactProvider",
+]

flwr/superlink/artifact_provider/artifact_provider.py

@@ -0,0 +1,37 @@
+# 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.
+# ==============================================================================
+"""Abstract base class for ArtifactProvider."""
+
+
+from abc import ABC, abstractmethod
+from typing import Optional
+
+
+class ArtifactProvider(ABC):
+    """ArtifactProvider interface for providing artifact download links."""
+
+    @abstractmethod
+    def get_url(self, run_id: int) -> Optional[str]:
+        """Return the artifact download link for the given run ID."""
+
+    @property
+    @abstractmethod
+    def output_dir(self) -> str:
+        """Permanent storage directory."""
+
+    @property
+    @abstractmethod
+    def tmp_dir(self) -> str:
+        """Temporary storage directory."""

flwr/superlink/servicer/control/control_grpc.py

@@ -31,6 +31,7 @@ from flwr.server.superlink.linkstate import LinkStateFactory
 from flwr.supercore.ffs import FfsFactory
 from flwr.supercore.license_plugin import LicensePlugin
 from flwr.supercore.object_store import ObjectStoreFactory
+from flwr.superlink.artifact_provider import ArtifactProvider
 
 from .control_event_log_interceptor import ControlEventLogInterceptor
 from .control_license_interceptor import ControlLicenseInterceptor
@@ -56,6 +57,7 @@ def run_control_api_grpc(
     auth_plugin: Optional[ControlAuthPlugin] = None,
     authz_plugin: Optional[ControlAuthzPlugin] = None,
     event_log_plugin: Optional[EventLogWriterPlugin] = None,
+    artifact_provider: Optional[ArtifactProvider] = None,
 ) -> grpc.Server:
     """Run Control API (gRPC, request-response)."""
     license_plugin: Optional[LicensePlugin] = get_license_plugin()
@@ -68,6 +70,7 @@ def run_control_api_grpc(
         objectstore_factory=objectstore_factory,
         is_simulation=is_simulation,
         auth_plugin=auth_plugin,
+        artifact_provider=artifact_provider,
     )
     interceptors: list[grpc.ServerInterceptor] = []
     if license_plugin is not None:

flwr/superlink/servicer/control/control_servicer.py

@@ -29,7 +29,9 @@ from flwr.common.auth_plugin import ControlAuthPlugin
 from flwr.common.constant import (
     FAB_MAX_SIZE,
     LOG_STREAM_INTERVAL,
+    NO_ARTIFACT_PROVIDER_MESSAGE,
     NO_USER_AUTH_MESSAGE,
+    PULL_UNFINISHED_RUN_MESSAGE,
     RUN_ID_NOT_FOUND_MESSAGE,
     Status,
     SubStatus,
@@ -49,6 +51,8 @@ from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     GetLoginDetailsResponse,
     ListRunsRequest,
     ListRunsResponse,
+    PullArtifactsRequest,
+    PullArtifactsResponse,
     StartRunRequest,
     StartRunResponse,
     StopRunRequest,
@@ -59,6 +63,7 @@ from flwr.proto.control_pb2 import (  # pylint: disable=E0611
 from flwr.server.superlink.linkstate import LinkState, LinkStateFactory
 from flwr.supercore.ffs import FfsFactory
 from flwr.supercore.object_store import ObjectStore, ObjectStoreFactory
+from flwr.superlink.artifact_provider import ArtifactProvider
 
 from .control_user_auth_interceptor import shared_account_info
 
@@ -73,14 +78,16 @@ class ControlServicer(control_pb2_grpc.ControlServicer):
         objectstore_factory: ObjectStoreFactory,
         is_simulation: bool,
         auth_plugin: Optional[ControlAuthPlugin] = None,
+        artifact_provider: Optional[ArtifactProvider] = None,
     ) -> None:
         self.linkstate_factory = linkstate_factory
         self.ffs_factory = ffs_factory
         self.objectstore_factory = objectstore_factory
         self.is_simulation = is_simulation
         self.auth_plugin = auth_plugin
+        self.artifact_provider = artifact_provider
 
-    def StartRun(
+    def StartRun(  # pylint: disable=too-many-locals
         self, request: StartRunRequest, context: grpc.ServicerContext
     ) -> StartRunResponse:
         """Create run ID."""
@@ -126,11 +133,20 @@ class ControlServicer(control_pb2_grpc.ControlServicer):
                 flwr_aid,
             )
 
+            # Initialize node config
+            node_config = {}
+            if self.artifact_provider is not None:
+                node_config = {
+                    "output_dir": self.artifact_provider.output_dir,
+                    "tmp_dir": self.artifact_provider.tmp_dir,
+                }
+
             # Create an empty context for the Run
             context = Context(
                 run_id=run_id,
                 node_id=0,
-                node_config={},
+                # Dict is invariant in mypy
+                node_config=node_config,  # type: ignore[arg-type]
                 state=RecordDict(),
                 run_config={},
             )
@@ -335,6 +351,47 @@ class ControlServicer(control_pb2_grpc.ControlServicer):
             refresh_token=credentials.refresh_token,
         )
 
+    def PullArtifacts(
+        self, request: PullArtifactsRequest, context: grpc.ServicerContext
+    ) -> PullArtifactsResponse:
+        """Pull artifacts for a given run ID."""
+        log(INFO, "ControlServicer.PullArtifacts")
+
+        # Check if artifact provider is configured
+        if self.artifact_provider is None:
+            context.abort(
+                grpc.StatusCode.UNIMPLEMENTED,
+                NO_ARTIFACT_PROVIDER_MESSAGE,
+            )
+            raise grpc.RpcError()  # This line is unreachable
+
+        # Init link state
+        state = self.linkstate_factory.state()
+
+        # Retrieve run ID and run
+        run_id = request.run_id
+        run = state.get_run(run_id)
+
+        # Exit if `run_id` not found
+        if not run:
+            context.abort(grpc.StatusCode.NOT_FOUND, RUN_ID_NOT_FOUND_MESSAGE)
+            raise grpc.RpcError()  # This line is unreachable
+
+        # Exit if the run is not finished yet
+        if run.status.status != Status.FINISHED:
+            context.abort(
+                grpc.StatusCode.FAILED_PRECONDITION, PULL_UNFINISHED_RUN_MESSAGE
+            )
+
+        # Check if `flwr_aid` matches the run's `flwr_aid` when user auth is enabled
+        if self.auth_plugin:
+            flwr_aid = shared_account_info.get().flwr_aid
+            _check_flwr_aid_in_run(flwr_aid=flwr_aid, run=run, context=context)
+
+        # Call artifact provider
+        download_url = self.artifact_provider.get_url(run_id)
+        return PullArtifactsResponse(url=download_url)
+
 
 def _create_list_runs_response(
     run_ids: set[int], state: LinkState, store: ObjectStore

{flwr_nightly-1.22.0.dev20250916.dist-info → flwr_nightly-1.22.0.dev20250918.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: flwr-nightly
-Version: 1.22.0.dev20250916
+Version: 1.22.0.dev20250918
 Summary: Flower: A Friendly Federated AI Framework
 License: Apache-2.0
 Keywords: Artificial Intelligence,Federated AI,Federated Analytics,Federated Evaluation,Federated Learning,Flower,Machine Learning