flwr-nightly 1.16.0.dev20250226__py3-none-any.whl → 1.16.0.dev20250228__py3-none-any.whl

flwr/cli/log.py

@@ -38,6 +38,10 @@ from flwr.proto.exec_pb2_grpc import ExecStub
 from .utils import init_channel, try_obtain_cli_auth_plugin, unauthenticated_exc_handler
 
 
+class AllLogsRetrieved(BaseException):
+    """Raised when all logs are retrieved."""
+
+
 def start_stream(
     run_id: int, channel: grpc.Channel, refresh_period: int = CONN_REFRESH_PERIOD
 ) -> None:
@@ -56,10 +60,10 @@ def start_stream(
         # pylint: disable=E1101
         if e.code() == grpc.StatusCode.NOT_FOUND:
             logger(ERROR, "Invalid run_id `%s`, exiting", run_id)
-        if e.code() == grpc.StatusCode.CANCELLED:
-            pass
         else:
             raise e
+    except AllLogsRetrieved:
+        pass
     finally:
         channel.close()
 
@@ -94,6 +98,7 @@ def stream_logs(
         with unauthenticated_exc_handler():
             for res in stub.StreamLogs(req, timeout=duration):
                 print(res.log_output, end="")
+        raise AllLogsRetrieved()
     except grpc.RpcError as e:
         # pylint: disable=E1101
         if e.code() != grpc.StatusCode.DEADLINE_EXCEEDED:
@@ -108,27 +113,21 @@ def stream_logs(
 def print_logs(run_id: int, channel: grpc.Channel, timeout: int) -> None:
     """Print logs from the beginning of a run."""
     stub = ExecStub(channel)
-    req = StreamLogsRequest(run_id=run_id)
+    req = StreamLogsRequest(run_id=run_id, after_timestamp=0.0)
 
     try:
-        while True:
-            try:
-                with unauthenticated_exc_handler():
-                    # Enforce timeout for graceful exit
-                    for res in stub.StreamLogs(req, timeout=timeout):
-                        print(res.log_output)
-            except grpc.RpcError as e:
-                # pylint: disable=E1101
-                if e.code() == grpc.StatusCode.DEADLINE_EXCEEDED:
-                    break
-                if e.code() == grpc.StatusCode.NOT_FOUND:
-                    logger(ERROR, "Invalid run_id `%s`, exiting", run_id)
-                    break
-                if e.code() == grpc.StatusCode.CANCELLED:
-                    break
-                raise e
-    except KeyboardInterrupt:
-        logger(DEBUG, "Stream interrupted by user")
+        with unauthenticated_exc_handler():
+            # Enforce timeout for graceful exit
+            for res in stub.StreamLogs(req, timeout=timeout):
+                print(res.log_output)
+                break
+    except grpc.RpcError as e:
+        if e.code() == grpc.StatusCode.NOT_FOUND:  # pylint: disable=E1101
+            logger(ERROR, "Invalid run_id `%s`, exiting", run_id)
+        elif e.code() == grpc.StatusCode.DEADLINE_EXCEEDED:  # pylint: disable=E1101
+            pass
+        else:
+            raise e
     finally:
         channel.close()
         logger(DEBUG, "Channel closed")

flwr/client/client_app.py

@@ -16,6 +16,8 @@
 
 
 import inspect
+from collections.abc import Iterator
+from contextlib import contextmanager
 from typing import Callable, Optional
 
 from flwr.client.client import Client
@@ -71,6 +73,11 @@ def _inspect_maybe_adapt_client_fn_signature(client_fn: ClientFnExt) -> ClientFn
     return client_fn
 
 
+@contextmanager
+def _empty_lifecycle(_: Context) -> Iterator[None]:
+    yield
+
+
 class ClientAppException(Exception):
     """Exception raised when an exception is raised while executing a ClientApp."""
 
@@ -135,29 +142,31 @@ class ClientApp:
         self._train: Optional[ClientAppCallable] = None
         self._evaluate: Optional[ClientAppCallable] = None
         self._query: Optional[ClientAppCallable] = None
+        self._lifecycle = _empty_lifecycle
 
     def __call__(self, message: Message, context: Context) -> Message:
         """Execute `ClientApp`."""
-        # Execute message using `client_fn`
-        if self._call:
-            return self._call(message, context)
-
-        # Execute message using a new
-        if message.metadata.message_type == MessageType.TRAIN:
-            if self._train:
-                return self._train(message, context)
-            raise ValueError("No `train` function registered")
-        if message.metadata.message_type == MessageType.EVALUATE:
-            if self._evaluate:
-                return self._evaluate(message, context)
-            raise ValueError("No `evaluate` function registered")
-        if message.metadata.message_type == MessageType.QUERY:
-            if self._query:
-                return self._query(message, context)
-            raise ValueError("No `query` function registered")
-
-        # Message type did not match one of the known message types abvoe
-        raise ValueError(f"Unknown message_type: {message.metadata.message_type}")
+        with self._lifecycle(context):
+            # Execute message using `client_fn`
+            if self._call:
+                return self._call(message, context)
+
+            # Execute message using a new
+            if message.metadata.message_type == MessageType.TRAIN:
+                if self._train:
+                    return self._train(message, context)
+                raise ValueError("No `train` function registered")
+            if message.metadata.message_type == MessageType.EVALUATE:
+                if self._evaluate:
+                    return self._evaluate(message, context)
+                raise ValueError("No `evaluate` function registered")
+            if message.metadata.message_type == MessageType.QUERY:
+                if self._query:
+                    return self._query(message, context)
+                raise ValueError("No `query` function registered")
+
+            # Message type did not match one of the known message types abvoe
+            raise ValueError(f"Unknown message_type: {message.metadata.message_type}")
 
     def train(
         self, mods: Optional[list[Mod]] = None
@@ -296,6 +305,66 @@ class ClientApp:
 
         return query_decorator
 
+    def lifecycle(
+        self,
+    ) -> Callable[
+        [Callable[[Context], Iterator[None]]], Callable[[Context], Iterator[None]]
+    ]:
+        """Return a decorator that registers the lifecycle fn with the client app.
+
+        The decorated function should accept a `Context` object and use `yield`
+        to define enter and exit behavior.
+
+        Examples
+        --------
+        >>> app = ClientApp()
+        >>>
+        >>> @app.lifecycle()
+        >>> def lifecycle(context: Context) -> None:
+        >>>     print("Initializing ClientApp")
+        >>>     yield
+        >>>     print("Cleaning up ClientApp")
+        """
+
+        def lifecycle_decorator(
+            lifecycle_fn: Callable[[Context], Iterator[None]]
+        ) -> Callable[[Context], Iterator[None]]:
+            """Register the lifecycle fn with the ServerApp object."""
+            warn_preview_feature("ClientApp-register-lifecycle-function")
+
+            @contextmanager
+            def decorated_lifecycle(context: Context) -> Iterator[None]:
+                # Execute the code before `yield` in lifecycle_fn
+                try:
+                    if not isinstance(it := lifecycle_fn(context), Iterator):
+                        raise StopIteration
+                    next(it)
+                except StopIteration:
+                    raise RuntimeError(
+                        "Lifecycle function should yield at least once."
+                    ) from None
+
+                try:
+                    # Enter the context
+                    yield
+                finally:
+                    try:
+                        # Execute the code after `yield` in lifecycle_fn
+                        next(it)
+                    except StopIteration:
+                        pass
+                    else:
+                        raise RuntimeError("Lifecycle function should only yield once.")
+
+            # Register provided function with the ClientApp object
+            # Ignore mypy error because of different argument names (`_` vs `context`)
+            self._lifecycle = decorated_lifecycle  # type: ignore
+
+            # Return provided function unmodified
+            return lifecycle_fn
+
+        return lifecycle_decorator
+
 
 class LoadClientAppError(Exception):
     """Error when trying to load `ClientApp`."""

flwr/common/auth_plugin/auth_plugin.py

@@ -20,6 +20,7 @@ from collections.abc import Sequence
 from pathlib import Path
 from typing import Optional, Union
 
+from flwr.common.typing import UserInfo
 from flwr.proto.exec_pb2_grpc import ExecStub
 
 from ..typing import UserAuthCredentials, UserAuthLoginDetails
@@ -49,7 +50,7 @@ class ExecAuthPlugin(ABC):
     @abstractmethod
     def validate_tokens_in_metadata(
         self, metadata: Sequence[tuple[str, Union[str, bytes]]]
-    ) -> bool:
+    ) -> tuple[bool, Optional[UserInfo]]:
         """Validate authentication tokens in the provided metadata."""
 
     @abstractmethod

flwr/common/constant.py

@@ -212,3 +212,19 @@ class AuthType:
     def __new__(cls) -> AuthType:
         """Prevent instantiation."""
         raise TypeError(f"{cls.__name__} cannot be instantiated.")
+
+
+class EventLogWriterType:
+    """Event log writer types."""
+
+    FALSE = "false"
+    STDOUT = "stdout"
+
+    def __new__(cls) -> EventLogWriterType:
+        """Prevent instantiation."""
+        raise TypeError(f"{cls.__name__} cannot be instantiated.")
+
+    @classmethod
+    def choices(cls) -> list[str]:
+        """Return a list of available log writer choices."""
+        return [cls.FALSE, cls.STDOUT]

flwr/common/event_log_plugin/__init__.py

@@ -0,0 +1,26 @@
+# 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.
+# ==============================================================================
+"""Event log plugin components."""
+
+
+from .event_log_plugin import EventLogRequest as EventLogRequest
+from .event_log_plugin import EventLogResponse as EventLogResponse
+from .event_log_plugin import EventLogWriterPlugin as EventLogWriterPlugin
+
+__all__ = [
+    "EventLogRequest",
+    "EventLogResponse",
+    "EventLogWriterPlugin",
+]

flwr/common/event_log_plugin/event_log_plugin.py

@@ -0,0 +1,87 @@
+# 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 class for Flower Event Log Writer Plugin."""
+
+
+from abc import ABC, abstractmethod
+from typing import Union
+
+import grpc
+
+from flwr.common.typing import LogEntry, UserInfo
+from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
+    GetLoginDetailsRequest,
+    GetLoginDetailsResponse,
+    ListRunsRequest,
+    ListRunsResponse,
+    StartRunRequest,
+    StartRunResponse,
+    StopRunRequest,
+    StopRunResponse,
+    StreamLogsRequest,
+    StreamLogsResponse,
+)
+
+# Type variables for request and response messages
+EventLogRequest = Union[
+    StartRunRequest,
+    ListRunsRequest,
+    StreamLogsRequest,
+    StopRunRequest,
+    GetLoginDetailsRequest,
+]
+EventLogResponse = Union[
+    StartRunResponse,
+    ListRunsResponse,
+    StreamLogsResponse,
+    StopRunResponse,
+    GetLoginDetailsResponse,
+]
+
+
+class EventLogWriterPlugin(ABC):
+    """Abstract Flower Event Log Writer Plugin class for ExecServicer."""
+
+    @abstractmethod
+    def __init__(self) -> None:
+        """Abstract constructor."""
+
+    @abstractmethod
+    def compose_log_before_event(  # pylint: disable=too-many-arguments
+        self,
+        request: EventLogRequest,
+        context: grpc.ServicerContext,
+        user_info: UserInfo,
+        method_name: str,
+    ) -> LogEntry:
+        """Compose pre-event log entry from the provided request and context."""
+
+    @abstractmethod
+    def compose_log_after_event(  # pylint: disable=too-many-arguments,R0917
+        self,
+        request: EventLogRequest,
+        context: grpc.ServicerContext,
+        user_info: UserInfo,
+        method_name: str,
+        response: EventLogResponse,
+    ) -> LogEntry:
+        """Compose post-event log entry from the provided response and context."""
+
+    @abstractmethod
+    def write_log(
+        self,
+        log_entry: LogEntry,
+    ) -> None:
+        """Write the event log to the specified data sink."""

flwr/common/object_ref.py

@@ -170,7 +170,6 @@ def load_app(  # pylint: disable= too-many-branches
                 module = importlib.import_module(module_str)
             else:
                 module = sys.modules[module_str]
-                _reload_modules(project_dir)
 
         except ModuleNotFoundError as err:
             raise error_type(
@@ -200,15 +199,6 @@ def _unload_modules(project_dir: Path) -> None:
             del sys.modules[name]
 
 
-def _reload_modules(project_dir: Path) -> None:
-    """Reload modules from the project directory."""
-    dir_str = str(project_dir.absolute())
-    for m in list(sys.modules.values()):
-        path: Optional[str] = getattr(m, "__file__", None)
-        if path is not None and path.startswith(dir_str):
-            importlib.reload(m)
-
-
 def _set_sys_path(directory: Optional[Union[str, Path]]) -> None:
     """Set the system path."""
     if directory is None:

flwr/common/record/recordset.py

@@ -17,82 +17,79 @@
 
 from __future__ import annotations
 
-from dataclasses import dataclass
-from typing import cast
+from logging import WARN
+from textwrap import indent
+from typing import TypeVar, Union, cast
 
+from ..logger import log
 from .configsrecord import ConfigsRecord
 from .metricsrecord import MetricsRecord
 from .parametersrecord import ParametersRecord
 from .typeddict import TypedDict
 
+RecordType = Union[ParametersRecord, MetricsRecord, ConfigsRecord]
 
-@dataclass
-class RecordSetData:
-    """Inner data container for the RecordSet class."""
+T = TypeVar("T")
 
-    parameters_records: TypedDict[str, ParametersRecord]
-    metrics_records: TypedDict[str, MetricsRecord]
-    configs_records: TypedDict[str, ConfigsRecord]
 
-    def __init__(
-        self,
-        parameters_records: dict[str, ParametersRecord] | None = None,
-        metrics_records: dict[str, MetricsRecord] | None = None,
-        configs_records: dict[str, ConfigsRecord] | None = None,
-    ) -> None:
-        self.parameters_records = TypedDict[str, ParametersRecord](
-            self._check_fn_str, self._check_fn_params
-        )
-        self.metrics_records = TypedDict[str, MetricsRecord](
-            self._check_fn_str, self._check_fn_metrics
+def _check_key(key: str) -> None:
+    if not isinstance(key, str):
+        raise TypeError(
+            f"Expected `{str.__name__}`, but "
+            f"received `{type(key).__name__}` for the key."
         )
-        self.configs_records = TypedDict[str, ConfigsRecord](
-            self._check_fn_str, self._check_fn_configs
+
+
+def _check_value(value: RecordType) -> None:
+    if not isinstance(value, (ParametersRecord, MetricsRecord, ConfigsRecord)):
+        raise TypeError(
+            f"Expected `{ParametersRecord.__name__}`, `{MetricsRecord.__name__}`, "
+            f"or `{ConfigsRecord.__name__}` but received "
+            f"`{type(value).__name__}` for the value."
         )
-        if parameters_records is not None:
-            self.parameters_records.update(parameters_records)
-        if metrics_records is not None:
-            self.metrics_records.update(metrics_records)
-        if configs_records is not None:
-            self.configs_records.update(configs_records)
-
-    def _check_fn_str(self, key: str) -> None:
-        if not isinstance(key, str):
-            raise TypeError(
-                f"Expected `{str.__name__}`, but "
-                f"received `{type(key).__name__}` for the key."
-            )
 
-    def _check_fn_params(self, record: ParametersRecord) -> None:
-        if not isinstance(record, ParametersRecord):
-            raise TypeError(
-                f"Expected `{ParametersRecord.__name__}`, but "
-                f"received `{type(record).__name__}` for the value."
-            )
 
-    def _check_fn_metrics(self, record: MetricsRecord) -> None:
-        if not isinstance(record, MetricsRecord):
-            raise TypeError(
-                f"Expected `{MetricsRecord.__name__}`, but "
-                f"received `{type(record).__name__}` for the value."
-            )
+class _SyncedDict(TypedDict[str, T]):
+    """A synchronized dictionary that mirrors changes to an underlying RecordSet.
 
-    def _check_fn_configs(self, record: ConfigsRecord) -> None:
-        if not isinstance(record, ConfigsRecord):
+    This dictionary ensures that any modifications (set or delete operations)
+    are automatically reflected in the associated `RecordSet`. Only values of
+    the specified `allowed_type` are permitted.
+    """
+
+    def __init__(self, ref_recordset: RecordSet, allowed_type: type[T]) -> None:
+        if not issubclass(
+            allowed_type, (ParametersRecord, MetricsRecord, ConfigsRecord)
+        ):
+            raise TypeError(f"{allowed_type} is not a valid type.")
+        super().__init__(_check_key, self.check_value)
+        self.recordset = ref_recordset
+        self.allowed_type = allowed_type
+
+    def __setitem__(self, key: str, value: T) -> None:
+        super().__setitem__(key, value)
+        self.recordset[key] = cast(RecordType, value)
+
+    def __delitem__(self, key: str) -> None:
+        super().__delitem__(key)
+        del self.recordset[key]
+
+    def check_value(self, value: T) -> None:
+        """Check if value is of expected type."""
+        if not isinstance(value, self.allowed_type):
             raise TypeError(
-                f"Expected `{ConfigsRecord.__name__}`, but "
-                f"received `{type(record).__name__}` for the value."
+                f"Expected `{self.allowed_type.__name__}`, but "
+                f"received `{type(value).__name__}` for the value."
             )
 
 
-class RecordSet:
+class RecordSet(TypedDict[str, RecordType]):
     """RecordSet stores groups of parameters, metrics and configs.
 
-    A :code:`RecordSet` is the unified mechanism by which parameters,
-    metrics and configs can be either stored as part of a
-    `flwr.common.Context <flwr.common.Context.html>`_ in your apps
-    or communicated as part of a
-    `flwr.common.Message <flwr.common.Message.html>`_ between your apps.
+    A :class:`RecordSet` is the unified mechanism by which parameters,
+    metrics and configs can be either stored as part of a :class:`Context`
+    in your apps or communicated as part of a :class:`Message` between
+    your apps.
 
     Parameters
     ----------
@@ -127,12 +124,12 @@ class RecordSet:
     >>>  # We can create a ConfigsRecord
     >>>  c_record = ConfigsRecord({"lr": 0.1, "batch-size": 128})
     >>>  # Adding it to the record_set would look like this
-    >>>  my_recordset.configs_records["my_config"] = c_record
+    >>>  my_recordset["my_config"] = c_record
     >>>
     >>>  # We can create a MetricsRecord following a similar process
     >>>  m_record = MetricsRecord({"accuracy": 0.93, "losses": [0.23, 0.1]})
     >>>  # Adding it to the record_set would look like this
-    >>>  my_recordset.metrics_records["my_metrics"] = m_record
+    >>>  my_recordset["my_metrics"] = m_record
 
     Adding a :code:`ParametersRecord` follows the same steps as above but first,
     the array needs to be serialized and represented as a :code:`flwr.common.Array`.
@@ -151,7 +148,7 @@ class RecordSet:
     >>>  p_record = ParametersRecord({"my_array": arr})
     >>>
     >>>  # Adding it to the record_set would look like this
-    >>>  my_recordset.parameters_records["my_parameters"] = p_record
+    >>>  my_recordset["my_parameters"] = p_record
 
     For additional examples on how to construct each of the records types shown
     above, please refer to the documentation for :code:`ConfigsRecord`,
@@ -164,39 +161,57 @@ class RecordSet:
         metrics_records: dict[str, MetricsRecord] | None = None,
         configs_records: dict[str, ConfigsRecord] | None = None,
     ) -> None:
-        data = RecordSetData(
-            parameters_records=parameters_records,
-            metrics_records=metrics_records,
-            configs_records=configs_records,
-        )
-        self.__dict__["_data"] = data
+        super().__init__(_check_key, _check_value)
+        for key, p_record in (parameters_records or {}).items():
+            self[key] = p_record
+        for key, m_record in (metrics_records or {}).items():
+            self[key] = m_record
+        for key, c_record in (configs_records or {}).items():
+            self[key] = c_record
 
     @property
     def parameters_records(self) -> TypedDict[str, ParametersRecord]:
-        """Dictionary holding ParametersRecord instances."""
-        data = cast(RecordSetData, self.__dict__["_data"])
-        return data.parameters_records
+        """Dictionary holding only ParametersRecord instances."""
+        synced_dict = _SyncedDict[ParametersRecord](self, ParametersRecord)
+        for key, record in self.items():
+            if isinstance(record, ParametersRecord):
+                synced_dict[key] = record
+        return synced_dict
 
     @property
     def metrics_records(self) -> TypedDict[str, MetricsRecord]:
-        """Dictionary holding MetricsRecord instances."""
-        data = cast(RecordSetData, self.__dict__["_data"])
-        return data.metrics_records
+        """Dictionary holding only MetricsRecord instances."""
+        synced_dict = _SyncedDict[MetricsRecord](self, MetricsRecord)
+        for key, record in self.items():
+            if isinstance(record, MetricsRecord):
+                synced_dict[key] = record
+        return synced_dict
 
     @property
     def configs_records(self) -> TypedDict[str, ConfigsRecord]:
-        """Dictionary holding ConfigsRecord instances."""
-        data = cast(RecordSetData, self.__dict__["_data"])
-        return data.configs_records
+        """Dictionary holding only ConfigsRecord instances."""
+        synced_dict = _SyncedDict[ConfigsRecord](self, ConfigsRecord)
+        for key, record in self.items():
+            if isinstance(record, ConfigsRecord):
+                synced_dict[key] = record
+        return synced_dict
 
     def __repr__(self) -> str:
         """Return a string representation of this instance."""
         flds = ("parameters_records", "metrics_records", "configs_records")
-        view = ", ".join([f"{fld}={getattr(self, fld)!r}" for fld in flds])
-        return f"{self.__class__.__qualname__}({view})"
-
-    def __eq__(self, other: object) -> bool:
-        """Compare two instances of the class."""
-        if not isinstance(other, self.__class__):
-            raise NotImplementedError
-        return self.__dict__ == other.__dict__
+        fld_views = [f"{fld}={dict(getattr(self, fld))!r}" for fld in flds]
+        view = indent(",\n".join(fld_views), "  ")
+        return f"{self.__class__.__qualname__}(\n{view}\n)"
+
+    def __setitem__(self, key: str, value: RecordType) -> None:
+        """Set the given key to the given value after type checking."""
+        original_value = self.get(key, None)
+        super().__setitem__(key, value)
+        if original_value is not None and not isinstance(value, type(original_value)):
+            log(
+                WARN,
+                "Key '%s' was overwritten: record of type `%s` replaced with type `%s`",
+                key,
+                type(original_value).__name__,
+                type(value).__name__,
+            )

flwr/common/secure_aggregation/quantization.py

@@ -25,7 +25,11 @@ from flwr.common.typing import NDArrayFloat, NDArrayInt
 def _stochastic_round(arr: NDArrayFloat) -> NDArrayInt:
     ret: NDArrayInt = np.ceil(arr).astype(np.int32)
     rand_arr = np.random.rand(*ret.shape)
-    ret[rand_arr < ret - arr] -= 1
+    if len(ret.shape) == 0:
+        if rand_arr < ret - arr:
+            ret -= 1
+    else:
+        ret[rand_arr < ret - arr] -= 1
     return ret
 
 

flwr/common/typing.py

@@ -286,3 +286,39 @@ class UserAuthCredentials:
 
     access_token: str
     refresh_token: str
+
+
+@dataclass
+class UserInfo:
+    """User information for event log."""
+
+    user_id: Optional[str]
+    user_name: Optional[str]
+
+
+@dataclass
+class Actor:
+    """Event log actor."""
+
+    actor_id: Optional[str]
+    description: Optional[str]
+    ip_address: str
+
+
+@dataclass
+class Event:
+    """Event log description."""
+
+    action: str
+    run_id: Optional[int]
+    fab_hash: Optional[str]
+
+
+@dataclass
+class LogEntry:
+    """Event log record."""
+
+    timestamp: str
+    actor: Actor
+    event: Event
+    status: str

flwr/server/app.py

@@ -90,7 +90,11 @@ BASE_DIR = get_flwr_dir() / "superlink" / "ffs"
 
 
 try:
-    from flwr.ee import add_ee_args_superlink, get_exec_auth_plugins
+    from flwr.ee import (
+        add_ee_args_superlink,
+        get_dashboard_server,
+        get_exec_auth_plugins,
+    )
 except ImportError:
 
     # pylint: disable-next=unused-argument
@@ -431,6 +435,17 @@ def run_superlink() -> None:
         scheduler_th.start()
         bckg_threads.append(scheduler_th)
 
+    # Add Dashboard server if available
+    if dashboard_address := getattr(args, "dashboard_address", None):
+        dashboard_address_str, _, _ = _format_address(dashboard_address)
+        dashboard_server = get_dashboard_server(
+            address=dashboard_address_str,
+            state_factory=state_factory,
+            certificates=None,
+        )
+
+        grpc_servers.append(dashboard_server)
+
     # Graceful shutdown
     register_exit_handlers(
         event_type=EventType.RUN_SUPERLINK_LEAVE,

flwr/server/server_app.py

@@ -15,6 +15,8 @@
 """Flower ServerApp."""
 
 
+from collections.abc import Iterator
+from contextlib import contextmanager
 from typing import Callable, Optional
 
 from flwr.common import Context
@@ -45,7 +47,12 @@ SERVER_FN_USAGE_EXAMPLE = """
 """
 
 
-class ServerApp:
+@contextmanager
+def _empty_lifecycle(_: Context) -> Iterator[None]:
+    yield
+
+
+class ServerApp:  # pylint: disable=too-many-instance-attributes
     """Flower ServerApp.
 
     Examples
@@ -105,29 +112,31 @@ class ServerApp:
         self._client_manager = client_manager
         self._server_fn = server_fn
         self._main: Optional[ServerAppCallable] = None
+        self._lifecycle = _empty_lifecycle
 
     def __call__(self, driver: Driver, context: Context) -> None:
         """Execute `ServerApp`."""
-        # Compatibility mode
-        if not self._main:
-            if self._server_fn:
-                # Execute server_fn()
-                components = self._server_fn(context)
-                self._server = components.server
-                self._config = components.config
-                self._strategy = components.strategy
-                self._client_manager = components.client_manager
-            start_driver(
-                server=self._server,
-                config=self._config,
-                strategy=self._strategy,
-                client_manager=self._client_manager,
-                driver=driver,
-            )
-            return
+        with self._lifecycle(context):
+            # Compatibility mode
+            if not self._main:
+                if self._server_fn:
+                    # Execute server_fn()
+                    components = self._server_fn(context)
+                    self._server = components.server
+                    self._config = components.config
+                    self._strategy = components.strategy
+                    self._client_manager = components.client_manager
+                start_driver(
+                    server=self._server,
+                    config=self._config,
+                    strategy=self._strategy,
+                    client_manager=self._client_manager,
+                    driver=driver,
+                )
+                return
 
-        # New execution mode
-        self._main(driver, context)
+            # New execution mode
+            self._main(driver, context)
 
     def main(self) -> Callable[[ServerAppCallable], ServerAppCallable]:
         """Return a decorator that registers the main fn with the server app.
@@ -177,6 +186,66 @@ class ServerApp:
 
         return main_decorator
 
+    def lifecycle(
+        self,
+    ) -> Callable[
+        [Callable[[Context], Iterator[None]]], Callable[[Context], Iterator[None]]
+    ]:
+        """Return a decorator that registers the lifecycle fn with the server app.
+
+        The decorated function should accept a `Context` object and use `yield`
+        to define enter and exit behavior.
+
+        Examples
+        --------
+        >>> app = ServerApp()
+        >>>
+        >>> @app.lifecycle()
+        >>> def lifecycle(context: Context) -> None:
+        >>>     print("Initializing ServerApp")
+        >>>     yield
+        >>>     print("Cleaning up ServerApp")
+        """
+
+        def lifecycle_decorator(
+            lifecycle_fn: Callable[[Context], Iterator[None]]
+        ) -> Callable[[Context], Iterator[None]]:
+            """Register the lifecycle fn with the ServerApp object."""
+            warn_preview_feature("ServerApp-register-lifecycle-function")
+
+            @contextmanager
+            def decorated_lifecycle(context: Context) -> Iterator[None]:
+                # Execute the code before `yield` in lifecycle_fn
+                try:
+                    if not isinstance(it := lifecycle_fn(context), Iterator):
+                        raise StopIteration
+                    next(it)
+                except StopIteration:
+                    raise RuntimeError(
+                        "Lifecycle function should yield at least once."
+                    ) from None
+
+                try:
+                    # Enter the context
+                    yield
+                finally:
+                    try:
+                        # Execute the code after `yield` in lifecycle_fn
+                        next(it)
+                    except StopIteration:
+                        pass
+                    else:
+                        raise RuntimeError("Lifecycle function should only yield once.")
+
+            # Register provided function with the ServerApp object
+            # Ignore mypy error because of different argument names (`_` vs `context`)
+            self._lifecycle = decorated_lifecycle  # type: ignore
+
+            # Return provided function unmodified
+            return lifecycle_fn
+
+        return lifecycle_decorator
+
 
 class LoadServerAppError(Exception):
     """Error when trying to load `ServerApp`."""

flwr/superexec/exec_servicer.py

@@ -120,7 +120,7 @@ class ExecServicer(exec_pb2_grpc.ExecServicer):
             run_status = state.get_run_status({run_id})[run_id]
             if run_status.status == Status.FINISHED:
                 log(INFO, "All logs for run ID `%s` returned", request.run_id)
-                context.cancel()
+                break
 
             time.sleep(LOG_STREAM_INTERVAL)  # Sleep briefly to avoid busy waiting
 

flwr/superexec/exec_user_auth_interceptor.py

@@ -77,9 +77,11 @@ class ExecUserAuthInterceptor(grpc.ServerInterceptor):  # type: ignore
         ) -> Response:
             call = method_handler.unary_unary or method_handler.unary_stream
             metadata = context.invocation_metadata()
-            if isinstance(
-                request, (GetLoginDetailsRequest, GetAuthTokensRequest)
-            ) or self.auth_plugin.validate_tokens_in_metadata(metadata):
+            if isinstance(request, (GetLoginDetailsRequest, GetAuthTokensRequest)):
+                return call(request, context)  # type: ignore
+
+            valid_tokens, _ = self.auth_plugin.validate_tokens_in_metadata(metadata)
+            if valid_tokens:
                 return call(request, context)  # type: ignore
 
             tokens = self.auth_plugin.refresh_tokens(context.invocation_metadata())

{flwr_nightly-1.16.0.dev20250226.dist-info → flwr_nightly-1.16.0.dev20250228.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.16.0.dev20250226
+Version: 1.16.0.dev20250228
 Summary: Flower: A Friendly Federated AI Framework
 Home-page: https://flower.ai
 License: Apache-2.0

{flwr_nightly-1.16.0.dev20250226.dist-info → flwr_nightly-1.16.0.dev20250228.dist-info}/RECORD

@@ -9,7 +9,7 @@ flwr/cli/config_utils.py,sha256=LelRR960I36n1IPw7BIu79fKoOh0JePA58kAtoXSTH0,7518
 flwr/cli/constant.py,sha256=g7Ad7o3DJDkJNrWS0T3SSJETWSTkkVJWGpLM8zlbpcY,1289
 flwr/cli/example.py,sha256=uk5CoD0ZITgpY_ffsTbEKf8XOOCSUzByjHPcMSPqV18,2216
 flwr/cli/install.py,sha256=-RnrYGejN_zyXXp_CoddSQwoQfRTWWyt9WYlxphJzyU,8180
-flwr/cli/log.py,sha256=vcO-r5EIc127mOQ26uxKVITX-w_Zib7AxSVuuN70_JY,6671
+flwr/cli/log.py,sha256=Huy02o2xGbbBVIBZhcC18qXEo_IUvPcVas77MnDE9Vo,6529
 flwr/cli/login/__init__.py,sha256=6_9zOzbPOAH72K2wX3-9dXTAbS7Mjpa5sEn2lA6eHHI,800
 flwr/cli/login/login.py,sha256=iNnNF1bvV0n8Z-vNc89azFNA73JqKZlO1s5OF2atsTc,3917
 flwr/cli/ls.py,sha256=cm3NuY1sFq51xVRhUG0MbAfVTrRSjJ1HMIubde80LuY,11433
@@ -74,7 +74,7 @@ flwr/cli/utils.py,sha256=D9XcpxzwkGPNdwX16o0kI-sYnRDMlWYyKNIpz6npRhQ,11236
 flwr/client/__init__.py,sha256=DGDoO0AEAfz-0CUFmLdyUUweAS64-07AOnmDfWUefK4,1192
 flwr/client/app.py,sha256=tNnef5wGVfqMiiGiWzAuULyy1QpvCKukiRmNi_a2cQc,34261
 flwr/client/client.py,sha256=8o58nd9o6ZFcMIaVYPGcV4MSjBG4H0oFgWiv8ZEO3oA,7895
-flwr/client/client_app.py,sha256=Vv4rfDcV9ycb9ZuUkhT_8wX7W1GIrALwlvRcUeVel3Y,12161
+flwr/client/client_app.py,sha256=WwKvP-22FRP1419oGYZdvRV5Z3JTNDDUse-Z8ikPkZA,14692
 flwr/client/clientapp/__init__.py,sha256=kZqChGnTChQ1WGSUkIlW2S5bc0d0mzDubCAmZUGRpEY,800
 flwr/client/clientapp/app.py,sha256=Us5Mw3wvGd_6P1zHOf3TNcRGBBulVZDo3LuZOs17WgM,8963
 flwr/client/clientapp/clientappio_servicer.py,sha256=5L6bjw_j3Mnx9kRFwYwxDNABKurBO5q1jZOWE_X11wQ,8522
@@ -115,14 +115,16 @@ flwr/common/__init__.py,sha256=TVaoFEJE158aui1TPZQiJCDZX4RNHRyI8I55VC80HhI,3901
 flwr/common/address.py,sha256=rRaN1JpiCJnit7ImEqZVxURQ69dPihRoyyWn_3I2wh4,4119
 flwr/common/args.py,sha256=MgkTUXACuySHyNdxrb7-pK0_R-S2Q7W5MnE3onYUf5I,5183
 flwr/common/auth_plugin/__init__.py,sha256=1Y8Oj3iB49IHDu9tvDih1J74Ygu7k85V9s2A4WORPyA,887
-flwr/common/auth_plugin/auth_plugin.py,sha256=wgDorBUB4IkK6twQ8vNawRVz7BDPmKdXZBNLqhU9RSs,3871
+flwr/common/auth_plugin/auth_plugin.py,sha256=dQU5U4uJIA5XqgOJ3PankHWq-uXCaMvO74khaMPGdiU,3938
 flwr/common/config.py,sha256=SAkG3BztnA6iupXxF3GAIpGmWVVCH0ptyMpC9yjr_14,13965
-flwr/common/constant.py,sha256=AdNCrHi4sgMCecdX7hHWxMFz3y9pWsjSGU25mA4OJyE,6619
+flwr/common/constant.py,sha256=6NtDbh_RgQebtPfn01a8yN_7poMOuwy6jbtVLQdBbQc,7026
 flwr/common/context.py,sha256=uJ-mnoC_8y_udEb3kAX-r8CPphNTWM72z1AlsvQEu54,2403
 flwr/common/date.py,sha256=NHHpESce5wYqEwoDXf09gp9U9l_5Bmlh2BsOcwS-kDM,1554
 flwr/common/differential_privacy.py,sha256=YA01NqjddKNAEVmf7hXmOVxOjhekgzvJudk3mBGq-2k,6148
 flwr/common/differential_privacy_constants.py,sha256=c7b7tqgvT7yMK0XN9ndiTBs4mQf6d3qk6K7KBZGlV4Q,1074
 flwr/common/dp.py,sha256=vddkvyjV2FhRoN4VuU2LeAM1UBn7dQB8_W-Qdiveal8,1978
+flwr/common/event_log_plugin/__init__.py,sha256=iLGSlmIta-qY4Jm5Os8IBl5cvVYXyFGlqkUiUXQDlU0,1017
+flwr/common/event_log_plugin/event_log_plugin.py,sha256=OdyYsBTqhLRRC0HL3_hv29LXJvHyhLCANXcLUqgAFTI,2568
 flwr/common/exit/__init__.py,sha256=-ZOJYLaNnR729a7VzZiFsLiqngzKQh3xc27svYStZ_Q,826
 flwr/common/exit/exit.py,sha256=DmZFyksp-w1sFDQekq5Z-qfnr-ivCAv78aQkqj-TDps,3458
 flwr/common/exit/exit_code.py,sha256=PNEnCrZfOILjfDAFu5m-2YWEJBrk97xglq4zCUlqV7E,3470
@@ -130,7 +132,7 @@ flwr/common/exit_handlers.py,sha256=yclujry30954o0lI7vtknTajskPCvK8TXw2V3RdldXU,
 flwr/common/grpc.py,sha256=K60AIvIqH0CvkkiqBfw5HoxQfbFOL2DrhKPjbZ8raIE,9786
 flwr/common/logger.py,sha256=Hund1C6bEhMw3GemlzuFK22tXZ27YeHLrFB0b4LP5f8,13041
 flwr/common/message.py,sha256=Zv4ID2BLQsbff0F03DI_MeFoHbSqVZAdDD9NcKYv6Zo,13832
-flwr/common/object_ref.py,sha256=Mv8OE6f9wmLs_KQWt8aPV5aw-g6fgWDfj28L2b8Jl-Y,9514
+flwr/common/object_ref.py,sha256=DXL8NtbN17DSYaR-Zc8WYhaG8rv0_D_cclvP7Sa66So,9134
 flwr/common/parameter.py,sha256=-bFAUayToYDF50FZGrBC1hQYJCQDtB2bbr3ZuVLMtdE,2095
 flwr/common/pyproject.py,sha256=vEAxl800XiJ1JNJDui8vuVV-08msnB6hLt7o95viZl0,1386
 flwr/common/record/__init__.py,sha256=LUixpq0Z-lMJwCIu1-4u5HfvRPjRMRgoAc6YJQ6UEOs,1055
@@ -138,7 +140,7 @@ flwr/common/record/configsrecord.py,sha256=i40jOzBx04ysZKECwaw4FdUXMdY9HgdY8GAqK
 flwr/common/record/conversion_utils.py,sha256=ZcsM-vTm_rVtLXLFD2RY3N47V_hUr3ywTdtnpVXnOGU,1202
 flwr/common/record/metricsrecord.py,sha256=UywkEPbifiu_IyPUFoDJCi8WEVLujlqZERUWAWpc3vs,5752
 flwr/common/record/parametersrecord.py,sha256=rR0LbeNrKrdK37CiAA56Z5WBq-ZzZ2YNSUkcmr5i2lI,12950
-flwr/common/record/recordset.py,sha256=qqIFdRZ0ivQhUhztpdxNIvCRDZQXY_zX0kKDEU9mhfM,8319
+flwr/common/record/recordset.py,sha256=gY3nmE--8sXSIPEFMReq7nh6hMiF-sr0HpfUtiB65E8,8890
 flwr/common/record/typeddict.py,sha256=q5hL2xkXymuiCprHWb69mUmLpWQk_XXQq0hGQ69YPaw,3599
 flwr/common/recordset_compat.py,sha256=ViSwA26h6Q55ZmV1LLjSJpcKiipV-p_JpCj4wxdE-Ow,14230
 flwr/common/retry_invoker.py,sha256=UIDKsn0AitS3fOr43WTqZAdD-TaHkBeTj1QxD7SGba0,14481
@@ -147,12 +149,12 @@ flwr/common/secure_aggregation/crypto/__init__.py,sha256=nlHesCWy8xxE5s6qHWnauCt
 flwr/common/secure_aggregation/crypto/shamir.py,sha256=wCSfEfeaPgJ9Om580-YPUF2ljiyRhq33TRC4HtwxYl8,2779
 flwr/common/secure_aggregation/crypto/symmetric_encryption.py,sha256=J_pRkxbogc7e1fxRZStZFBdzzG5jeUycshJPpvyCt6g,5333
 flwr/common/secure_aggregation/ndarrays_arithmetic.py,sha256=zvVAIrIyI6OSzGhpCi8NNaTvPXmoMYQIPJT-NkBg8RU,3013
-flwr/common/secure_aggregation/quantization.py,sha256=mC4uLf05zeONo8Ke-BY0Tj8UCMOS7VD93zHCzuv3MHU,2304
+flwr/common/secure_aggregation/quantization.py,sha256=NE_ltC3Fx5Z3bMKqJHA95wQf2tkGQlN0VZf3d1w5ABA,2400
 flwr/common/secure_aggregation/secaggplus_constants.py,sha256=9MF-oQh62uD7rt9VeNB-rHf2gBLd5GL3S9OejCxmILY,2183
 flwr/common/secure_aggregation/secaggplus_utils.py,sha256=OgYd68YBRaHQYLc-YdExj9CSpwL58bVTaPrdHoAj2AE,3214
 flwr/common/serde.py,sha256=iDVS5IXGKqEuzQAvnroH9c6KFEHxKFEWmkGP89PMOO0,31064
 flwr/common/telemetry.py,sha256=APKVubU_zJNrE-M_rip6S6Fsu41DxY3tAjFWNOgTmC0,9086
-flwr/common/typing.py,sha256=IMgs_7nDJWn8Eb7y16Hl4HC3imQV7_Hdla1IFs3B5u8,6382
+flwr/common/typing.py,sha256=Prl8_4tKnIl_Kh5UjJGbw1tnld543EkXrX0RWffJpiA,6900
 flwr/common/version.py,sha256=aNSxLL49RKeLz8sPcZrsTEWtrAeQ0uxu6tjmfba4O60,1325
 flwr/proto/__init__.py,sha256=hbY7JYakwZwCkYgCNlmHdc8rtvfoJbAZLalMdc--CGc,683
 flwr/proto/clientappio_pb2.py,sha256=aroQDv0D2GquQ5Ujqml7n7l6ObZoXqMvDa0XVO-_8Cc,3703
@@ -217,7 +219,7 @@ flwr/proto/transport_pb2_grpc.py,sha256=vLN3EHtx2aEEMCO4f1Upu-l27BPzd3-5pV-u8wPc
 flwr/proto/transport_pb2_grpc.pyi,sha256=AGXf8RiIiW2J5IKMlm_3qT3AzcDa4F3P5IqUjve_esA,766
 flwr/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flwr/server/__init__.py,sha256=cEg1oecBu4cKB69iJCqWEylC8b5XW47bl7rQiJsdTvM,1528
-flwr/server/app.py,sha256=CVj7lDAYJ4GYnBvAIa0R3A8JV5Dt-ATxDOrLxafLFV8,30545
+flwr/server/app.py,sha256=a_3hM-RktaPp3QTKDlBuHATB9oS2deGShZGEtmhlnX0,31005
 flwr/server/client_manager.py,sha256=7Ese0tgrH-i-ms363feYZJKwB8gWnXSmg_hYF2Bju4U,6227
 flwr/server/client_proxy.py,sha256=4G-oTwhb45sfWLx2uZdcXD98IZwdTS6F88xe3akCdUg,2399
 flwr/server/compat/__init__.py,sha256=VxnJtJyOjNFQXMNi9hIuzNlZM5n0Hj1p3aq_Pm2udw4,892
@@ -233,7 +235,7 @@ flwr/server/driver/inmemory_driver.py,sha256=7ZtWDDJa8xupPAHNaDdCE2DOIOIYgrffmJM
 flwr/server/history.py,sha256=qSb5_pPTrwofpSYGsZWzMPkl_4uJ4mJFWesxXDrEvDU,5026
 flwr/server/run_serverapp.py,sha256=vIPhvJx0i5sEZO4IKM6ruCXmx4ncat76rh0B4KhdhhM,2446
 flwr/server/server.py,sha256=1ZsFEptmAV-L2vP2etNC9Ed5CLSxpuKzUFkAPQ4l5Xc,17893
-flwr/server/server_app.py,sha256=RsgS6PRS5Z74cMUAHzsm8r3LWddwn00MjRs6rlacHt8,6297
+flwr/server/server_app.py,sha256=QtxZKdqP8GUDBIilKRLP7smLjabHPnzS8XhtdqRWbIU,8880
 flwr/server/server_config.py,sha256=CZaHVAsMvGLjpWVcLPkiYxgJN4xfIyAiUrCI3fETKY4,1349
 flwr/server/serverapp/__init__.py,sha256=L0K-94UDdTyEZ8LDtYybGIIIv3HW6AhSVjXMUfYJQnQ,800
 flwr/server/serverapp/app.py,sha256=5nFRYYzC2vh0l1fKJofBfKwFam93In4b80wvH9eFfQ8,8651
@@ -323,12 +325,12 @@ flwr/superexec/__init__.py,sha256=fcj366jh4RFby_vDwLroU4kepzqbnJgseZD_jUr_Mko,71
 flwr/superexec/app.py,sha256=Z6kYHWd62YL0Q4YKyCAbt_BcefNfbKH6V-jCC-1NkZM,1842
 flwr/superexec/deployment.py,sha256=wZ9G42gGS91knfplswh95MnQ83Fzu-rs6wcuNgDmmvY,6735
 flwr/superexec/exec_grpc.py,sha256=ttA9qoZzSLF0Mfk1L4hzOkMSNuj5rR58_kKBYwcyrAg,2864
-flwr/superexec/exec_servicer.py,sha256=X10ILT-AoGMrB3IgI2mBe9i-QcIVUAl9bucuqVOPYkU,8341
-flwr/superexec/exec_user_auth_interceptor.py,sha256=K06OU-l4LnYhTDg071hGJuOaQWEJbZsYi5qxUmmtiG0,3704
+flwr/superexec/exec_servicer.py,sha256=72AL60LBbWD-OTxTvtPBrnb_M5rccMtU_JAYcEVQVNg,8330
+flwr/superexec/exec_user_auth_interceptor.py,sha256=YtvcjrD2hMVmZ3y9wHuGI6FwmG_Y__q112t4fFnypy0,3793
 flwr/superexec/executor.py,sha256=_B55WW2TD1fBINpabSSDRenVHXYmvlfhv-k8hJKU4lQ,3115
 flwr/superexec/simulation.py,sha256=WQDon15oqpMopAZnwRZoTICYCfHqtkvFSqiTQ2hLD_g,4088
-flwr_nightly-1.16.0.dev20250226.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-flwr_nightly-1.16.0.dev20250226.dist-info/METADATA,sha256=9351LF7XOp_SkK7kJWKK2985bCbPYRocxMjwx2UE0bs,15877
-flwr_nightly-1.16.0.dev20250226.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-flwr_nightly-1.16.0.dev20250226.dist-info/entry_points.txt,sha256=JlNxX3qhaV18_2yj5a3kJW1ESxm31cal9iS_N_pf1Rk,538
-flwr_nightly-1.16.0.dev20250226.dist-info/RECORD,,
+flwr_nightly-1.16.0.dev20250228.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+flwr_nightly-1.16.0.dev20250228.dist-info/METADATA,sha256=UbfME6tkYpPD7ma1nlkMPd3lQY4A4rpArEPlyNQPp1w,15877
+flwr_nightly-1.16.0.dev20250228.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+flwr_nightly-1.16.0.dev20250228.dist-info/entry_points.txt,sha256=JlNxX3qhaV18_2yj5a3kJW1ESxm31cal9iS_N_pf1Rk,538
+flwr_nightly-1.16.0.dev20250228.dist-info/RECORD,,