flwr-nightly 1.23.0.dev20250930__py3-none-any.whl → 1.26.0.dev20260121__py3-none-any.whl

flwr/client/rest_client/connection.py

@@ -15,10 +15,10 @@
 """Contextmanager for a REST request-response channel to the Flower server."""
 
 
-from collections.abc import Iterator
+from collections.abc import Callable, Iterator
 from contextlib import contextmanager
 from logging import ERROR, WARN
-from typing import Callable, Optional, TypeVar, Union
+from typing import TypeVar
 
 from cryptography.hazmat.primitives.asymmetric import ec
 from google.protobuf.message import Message as GrpcMessage
@@ -27,7 +27,6 @@ from requests.exceptions import ConnectionError as RequestsConnectionError
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
 from flwr.common.constant import HEARTBEAT_DEFAULT_INTERVAL
 from flwr.common.exit import ExitCode, flwr_exit
-from flwr.common.heartbeat import HeartbeatSender
 from flwr.common.inflatable_protobuf_utils import (
     make_confirm_message_received_fn_protobuf,
     make_pull_object_fn_protobuf,
@@ -36,18 +35,27 @@ from flwr.common.inflatable_protobuf_utils import (
 from flwr.common.logger import log
 from flwr.common.message import Message, remove_content_from_message
 from flwr.common.retry_invoker import RetryInvoker
-from flwr.common.serde import message_from_proto, message_to_proto, run_from_proto
+from flwr.common.serde import (
+    fab_from_proto,
+    message_from_proto,
+    message_to_proto,
+    run_from_proto,
+)
 from flwr.common.typing import Fab, Run
 from flwr.proto.fab_pb2 import GetFabRequest, GetFabResponse  # pylint: disable=E0611
 from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
-    CreateNodeRequest,
-    CreateNodeResponse,
-    DeleteNodeRequest,
-    DeleteNodeResponse,
+    ActivateNodeRequest,
+    ActivateNodeResponse,
+    DeactivateNodeRequest,
+    DeactivateNodeResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
     PushMessagesResponse,
+    RegisterNodeFleetRequest,
+    RegisterNodeFleetResponse,
+    UnregisterNodeFleetRequest,
+    UnregisterNodeFleetResponse,
 )
 from flwr.proto.heartbeat_pb2 import (  # pylint: disable=E0611
     SendNodeHeartbeatRequest,
@@ -64,6 +72,8 @@ from flwr.proto.message_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
+from flwr.supercore.heartbeat import HeartbeatSender
+from flwr.supercore.primitives.asymmetric import generate_key_pairs, public_key_to_bytes
 
 try:
     import requests
@@ -71,8 +81,10 @@ except ModuleNotFoundError:
     flwr_exit(ExitCode.COMMON_MISSING_EXTRA_REST)
 
 
-PATH_CREATE_NODE: str = "api/v0/fleet/create-node"
-PATH_DELETE_NODE: str = "api/v0/fleet/delete-node"
+PATH_REGISTER_NODE: str = "/api/v0/fleet/register-node"
+PATH_ACTIVATE_NODE: str = "/api/v0/fleet/activate-node"
+PATH_DEACTIVATE_NODE: str = "/api/v0/fleet/deactivate-node"
+PATH_UNREGISTER_NODE: str = "/api/v0/fleet/unregister-node"
 PATH_PULL_MESSAGES: str = "/api/v0/fleet/pull-messages"
 PATH_PUSH_MESSAGES: str = "/api/v0/fleet/push-messages"
 PATH_PULL_OBJECT: str = "/api/v0/fleet/pull-object"
@@ -91,18 +103,15 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     insecure: bool,  # pylint: disable=unused-argument
     retry_invoker: RetryInvoker,
     max_message_length: int = GRPC_MAX_MESSAGE_LENGTH,  # pylint: disable=W0613
-    root_certificates: Optional[
-        Union[bytes, str]
-    ] = None,  # pylint: disable=unused-argument
-    authentication_keys: Optional[  # pylint: disable=unused-argument
-        tuple[ec.EllipticCurvePrivateKey, ec.EllipticCurvePublicKey]
-    ] = None,
+    root_certificates: bytes | str | None = None,  # pylint: disable=unused-argument
+    authentication_keys: (
+        tuple[ec.EllipticCurvePrivateKey, ec.EllipticCurvePublicKey] | None
+    ) = None,
 ) -> Iterator[
     tuple[
-        Callable[[], Optional[tuple[Message, ObjectTree]]],
-        Callable[[Message, ObjectTree], set[str]],
-        Callable[[], Optional[int]],
-        Callable[[], None],
+        int,
+        Callable[[], tuple[Message, ObjectTree] | None],
+        Callable[[Message, ObjectTree, float], set[str]],
         Callable[[int], Run],
         Callable[[str, int], Fab],
         Callable[[int, str], bytes],
@@ -134,15 +143,15 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         connection using the certificates will be established to an SSL-enabled
         Flower server. Bytes won't work for the REST API.
     authentication_keys : Optional[Tuple[PrivateKey, PublicKey]] (default: None)
-        Client authentication is not supported for this transport type.
+        SuperNode authentication is not supported for this transport type.
 
     Returns
     -------
-    receive : Callable
-    send : Callable
-    create_node : Optional[Callable]
-    delete_node : Optional[Callable]
-    get_run : Optional[Callable]
+    node_id : int
+    receive : Callable[[], Optional[tuple[Message, ObjectTree]]]
+    send : Callable[[Message, ObjectTree, float], set[str]]
+    get_run : Callable[[int], Run]
+    get_fab : Callable[[str, int], Fab]
     pull_object : Callable[[str], bytes]
     push_object : Callable[[str, bytes], None]
     confirm_message_received : Callable[[str], None]
@@ -161,7 +170,7 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     # Otherwise any server can fake its identity
     # Please refer to:
     # https://requests.readthedocs.io/en/latest/user/advanced/#ssl-cert-verification
-    verify: Union[bool, str] = True
+    verify: bool | str = True
     if isinstance(root_certificates, str):
         verify = root_certificates
     elif isinstance(root_certificates, bytes):
@@ -171,21 +180,28 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             "must be provided as a string path to the client.",
         )
     if authentication_keys is not None:
-        log(ERROR, "Client authentication is not supported for this transport type.")
+        log(ERROR, "SuperNode authentication is not supported for this transport type.")
+
+    # REST does NOT support node authentication
+    self_registered = False
+    if authentication_keys is None:
+        self_registered = True
+        authentication_keys = generate_key_pairs()
+    node_pk = public_key_to_bytes(authentication_keys[1])
 
     # Shared variables for inner functions
-    node: Optional[Node] = None
+    node: Node | None = None
 
     # Remove should_giveup from RetryInvoker as REST does not support gRPC status codes
     retry_invoker.should_giveup = None
 
     ###########################################################################
-    # heartbeat/create_node/delete_node/receive/send/get_run functions
+    # SuperNode functions
     ###########################################################################
 
     def _request(
         req: GrpcMessage, res_type: type[T], api_path: str, retry: bool = True
-    ) -> Optional[T]:
+    ) -> T | None:
         # Serialize the request
         req_bytes = req.SerializeToString()
 
@@ -290,23 +306,35 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
 
     heartbeat_sender = HeartbeatSender(send_node_heartbeat)
 
-    def create_node() -> Optional[int]:
-        """Set create_node."""
-        req = CreateNodeRequest(heartbeat_interval=HEARTBEAT_DEFAULT_INTERVAL)
+    def register_node() -> None:
+        """Register node with SuperLink."""
+        req = RegisterNodeFleetRequest(public_key=node_pk)
 
         # Send the request
-        res = _request(req, CreateNodeResponse, PATH_CREATE_NODE)
+        res = _request(req, RegisterNodeFleetResponse, PATH_REGISTER_NODE)
         if res is None:
-            return None
+            raise RuntimeError("Failed to register node")
+
+    def activate_node() -> int:
+        """Activate node and start heartbeat."""
+        req = ActivateNodeRequest(
+            public_key=node_pk,
+            heartbeat_interval=HEARTBEAT_DEFAULT_INTERVAL,
+        )
+
+        # Send the request
+        res = _request(req, ActivateNodeResponse, PATH_ACTIVATE_NODE)
+        if res is None:
+            raise RuntimeError("Failed to activate node")
 
         # Remember the node and start the heartbeat sender
         nonlocal node
-        node = res.node
+        node = Node(node_id=res.node_id)
         heartbeat_sender.start()
         return node.node_id
 
-    def delete_node() -> None:
-        """Set delete_node."""
+    def deactivate_node() -> None:
+        """Deactivate node and stop heartbeat."""
         nonlocal node
         if node is None:
             raise RuntimeError("Node instance missing")
@@ -314,18 +342,32 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         # Stop the heartbeat sender
         heartbeat_sender.stop()
 
-        # Send DeleteNode request
-        req = DeleteNodeRequest(node=node)
+        # Send DeactivateNode request
+        req = DeactivateNodeRequest(node_id=node.node_id)
+
+        # Send the request
+        res = _request(req, DeactivateNodeResponse, PATH_DEACTIVATE_NODE)
+        if res is None:
+            raise RuntimeError("Failed to deactivate node")
+
+    def unregister_node() -> None:
+        """Unregister node from SuperLink."""
+        nonlocal node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        # Send UnregisterNode request
+        req = UnregisterNodeFleetRequest(node_id=node.node_id)
 
         # Send the request
-        res = _request(req, DeleteNodeResponse, PATH_DELETE_NODE)
+        res = _request(req, UnregisterNodeFleetResponse, PATH_UNREGISTER_NODE)
         if res is None:
-            return
+            raise RuntimeError("Failed to unregister node")
 
         # Cleanup
         node = None
 
-    def receive() -> Optional[tuple[Message, ObjectTree]]:
+    def receive() -> tuple[Message, ObjectTree] | None:
         """Pull a message with its ObjectTree from SuperLink."""
         # Get Node
         if node is None:
@@ -351,12 +393,13 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         # Return the Message and its object tree
         return in_message, object_tree
 
-    def send(message: Message, object_tree: ObjectTree) -> set[str]:
+    def send(
+        message: Message, object_tree: ObjectTree, clientapp_runtime: float
+    ) -> set[str]:
         """Send the message with its ObjectTree to SuperLink."""
         # Get Node
         if node is None:
             raise RuntimeError("Node instance missing")
-
         # Remove the content from the message if it has
         if message.has_content():
             message = remove_content_from_message(message)
@@ -366,6 +409,7 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             node=node,
             messages_list=[message_to_proto(message)],
             message_object_trees=[object_tree],
+            clientapp_runtime_list=[clientapp_runtime],
         )
         res = _request(req, PushMessagesResponse, PATH_PUSH_MESSAGES)
         if res is None:
@@ -392,12 +436,9 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         # Send the request
         res = _request(req, GetFabResponse, PATH_GET_FAB)
         if res is None:
-            return Fab("", b"")
+            return Fab("", b"", {})
 
-        return Fab(
-            res.fab.hash_str,
-            res.fab.content,
-        )
+        return fab_from_proto(res.fab)
 
     def pull_object(run_id: int, object_id: str) -> bytes:
         """Pull the object from the SuperLink."""
@@ -439,12 +480,14 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         fn(object_id)
 
     try:
+        if self_registered:
+            register_node()
+        node_id = activate_node()
         # Yield methods
         yield (
+            node_id,
             receive,
             send,
-            create_node,
-            delete_node,
             get_run,
             get_fab,
             pull_object,
@@ -459,6 +502,8 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             if node is not None:
                 # Disable retrying
                 retry_invoker.max_tries = 1
-                delete_node()
+                deactivate_node()
+                if self_registered:
+                    unregister_node()
         except RequestsConnectionError:
             pass

flwr/client/run_info_store.py

@@ -17,15 +17,15 @@
 
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Optional
 
+from flwr.app.user_config import UserConfig
 from flwr.common import Context, RecordDict
 from flwr.common.config import (
     get_fused_config,
     get_fused_config_from_dir,
     get_fused_config_from_fab,
 )
-from flwr.common.typing import Fab, Run, UserConfig
+from flwr.common.typing import Fab, Run
 
 
 @dataclass()
@@ -52,10 +52,10 @@ class DeprecatedRunInfoStore:
     def register_context(
         self,
         run_id: int,
-        run: Optional[Run] = None,
-        flwr_path: Optional[Path] = None,
-        app_dir: Optional[str] = None,
-        fab: Optional[Fab] = None,
+        run: Run | None = None,
+        flwr_path: Path | None = None,
+        app_dir: str | None = None,
+        fab: Fab | None = None,
     ) -> None:
         """Register new run context for this node."""
         if run_id not in self.run_infos:

flwr/client/typing.py

@@ -15,7 +15,7 @@
 """Custom types for Flower clients."""
 
 
-from typing import Callable
+from collections.abc import Callable
 
 from flwr.common import Context, Message
 

flwr/clientapp/__init__.py

@@ -15,9 +15,8 @@
 """Public Flower ClientApp APIs."""
 
 
-from flwr.client.client_app import ClientApp
-
 from . import mod
+from .client_app import ClientApp as ClientApp
 
 __all__ = [
     "ClientApp",

flwr/{client → clientapp}/client_app.py

@@ -16,10 +16,10 @@
 
 
 import inspect
-from collections.abc import Iterator
+from collections.abc import Callable, Iterator
 from contextlib import contextmanager
-from typing import Callable, Optional
 
+from flwr.app.message_type import MessageType
 from flwr.app.metadata import validate_message_type
 from flwr.client.client import Client
 from flwr.client.message_handler.message_handler import (
@@ -27,7 +27,7 @@ from flwr.client.message_handler.message_handler import (
 )
 from flwr.client.mod.utils import make_ffn
 from flwr.client.typing import ClientFnExt, Mod
-from flwr.common import Context, Message, MessageType
+from flwr.common import Context, Message
 from flwr.common.logger import warn_deprecated_feature
 
 from .typing import ClientAppCallable
@@ -109,14 +109,14 @@ class ClientApp:
 
     def __init__(
         self,
-        client_fn: Optional[ClientFnExt] = None,  # Only for backward compatibility
-        mods: Optional[list[Mod]] = None,
+        client_fn: ClientFnExt | None = None,  # Only for backward compatibility
+        mods: list[Mod] | None = None,
     ) -> None:
         self._mods: list[Mod] = mods if mods is not None else []
         self._registered_funcs: dict[str, ClientAppCallable] = {}
 
         # Create wrapper function for `handle`
-        self._call: Optional[ClientAppCallable] = None
+        self._call: ClientAppCallable | None = None
         if client_fn is not None:
 
             client_fn = _inspect_maybe_adapt_client_fn_signature(client_fn)
@@ -163,7 +163,7 @@ class ClientApp:
             raise ValueError(f"No {category} function registered with name '{action}'")
 
     def train(
-        self, action: str = DEFAULT_ACTION, *, mods: Optional[list[Mod]] = None
+        self, action: str = DEFAULT_ACTION, *, mods: list[Mod] | None = None
     ) -> Callable[[ClientAppCallable], ClientAppCallable]:
         """Register a train function with the ``ClientApp``.
 
@@ -218,7 +218,7 @@ class ClientApp:
         return _get_decorator(self, MessageType.TRAIN, action, mods)
 
     def evaluate(
-        self, action: str = DEFAULT_ACTION, *, mods: Optional[list[Mod]] = None
+        self, action: str = DEFAULT_ACTION, *, mods: list[Mod] | None = None
     ) -> Callable[[ClientAppCallable], ClientAppCallable]:
         """Register an evaluate function with the ``ClientApp``.
 
@@ -273,7 +273,7 @@ class ClientApp:
         return _get_decorator(self, MessageType.EVALUATE, action, mods)
 
     def query(
-        self, action: str = DEFAULT_ACTION, *, mods: Optional[list[Mod]] = None
+        self, action: str = DEFAULT_ACTION, *, mods: list[Mod] | None = None
     ) -> Callable[[ClientAppCallable], ClientAppCallable]:
         """Register a query function with the ``ClientApp``.
 
@@ -355,7 +355,7 @@ class ClientApp:
         """
 
         def lifespan_decorator(
-            lifespan_fn: Callable[[Context], Iterator[None]]
+            lifespan_fn: Callable[[Context], Iterator[None]],
         ) -> Callable[[Context], Iterator[None]]:
             """Register the lifespan fn with the ServerApp object."""
 
@@ -398,7 +398,7 @@ class LoadClientAppError(Exception):
 
 
 def _get_decorator(
-    app: ClientApp, category: str, action: str, mods: Optional[list[Mod]]
+    app: ClientApp, category: str, action: str, mods: list[Mod] | None
 ) -> Callable[[ClientAppCallable], ClientAppCallable]:
     """Get the decorator for the given category and action."""
     # pylint: disable=protected-access

flwr/clientapp/mod/centraldp_mods.py

@@ -15,7 +15,6 @@
 """Clipping modifiers for central DP with client-side clipping."""
 
 
-from collections import OrderedDict
 from logging import ERROR, INFO
 from typing import cast
 
@@ -105,14 +104,14 @@ def fixedclipping_mod(
     )
     # Replace outgoing ArrayRecord's Array while preserving their keys
     out_msg.content.array_records[new_array_record_key] = ArrayRecord(
-        OrderedDict(
-            {
-                k: Array(v)
-                for k, v in zip(
-                    client_to_server_arrecord.keys(), client_to_server_ndarrays
-                )
-            }
-        )
+        {
+            k: Array(v)
+            for k, v in zip(
+                client_to_server_arrecord.keys(),
+                client_to_server_ndarrays,
+                strict=True,
+            )
+        }
     )
     return out_msg
 
@@ -192,14 +191,14 @@ def adaptiveclipping_mod(
     )
     # Replace outgoing ArrayRecord's Array while preserving their keys
     out_msg.content.array_records[new_array_record_key] = ArrayRecord(
-        OrderedDict(
-            {
-                k: Array(v)
-                for k, v in zip(
-                    client_to_server_arrecord.keys(), client_to_server_ndarrays
-                )
-            }
-        )
+        {
+            k: Array(v)
+            for k, v in zip(
+                client_to_server_arrecord.keys(),
+                client_to_server_ndarrays,
+                strict=True,
+            )
+        }
     )
     # Add to the MetricRecords the norm bit (recall reply messages only contain
     # one MetricRecord)

flwr/clientapp/mod/localdp_mod.py

@@ -15,7 +15,6 @@
 """Local DP modifier."""
 
 
-from collections import OrderedDict
 from logging import INFO
 
 import numpy as np
@@ -157,13 +156,13 @@ class LocalDpMod:
 
         # Replace outgoing ArrayRecord's Array while preserving their keys
         out_msg.content[new_array_record_key] = ArrayRecord(
-            OrderedDict(
-                {
-                    k: Array(v)
-                    for k, v in zip(
-                        client_to_server_arrecord.keys(), client_to_server_ndarrays
-                    )
-                }
-            )
+            {
+                k: Array(v)
+                for k, v in zip(
+                    client_to_server_arrecord.keys(),
+                    client_to_server_ndarrays,
+                    strict=True,
+                )
+            }
         )
         return out_msg

flwr/clientapp/typing.py

@@ -15,7 +15,7 @@
 """Custom types for Flower clients."""
 
 
-from typing import Callable
+from collections.abc import Callable
 
 from flwr.common import Context, Message
 

flwr/{client/clientapp → clientapp}/utils.py

@@ -15,11 +15,11 @@
 """Flower ClientApp loading utils."""
 
 
+from collections.abc import Callable
 from logging import DEBUG
 from pathlib import Path
-from typing import Callable, Optional
 
-from flwr.client.client_app import ClientApp, LoadClientAppError
+from flwr.clientapp.client_app import ClientApp, LoadClientAppError
 from flwr.common.config import (
     get_flwr_dir,
     get_metadata_from_config,
@@ -32,9 +32,9 @@ from flwr.common.object_ref import load_app, validate
 
 def get_load_client_app_fn(
     default_app_ref: str,
-    app_path: Optional[str],
+    app_path: str | None,
     multi_app: bool,
-    flwr_dir: Optional[str] = None,
+    flwr_dir: str | None = None,
 ) -> Callable[[str, str, str], ClientApp]:
     """Get the load_client_app_fn function.
 

flwr/common/__init__.py

@@ -15,12 +15,13 @@
 """Common components shared between server and client."""
 
 
+from flwr.app.message_type import MessageType as MessageType
+
 from ..app.error import Error as Error
 from ..app.metadata import Metadata as Metadata
-from .constant import MessageType as MessageType
+from ..supercore.date import now as now
 from .constant import MessageTypeLegacy as MessageTypeLegacy
 from .context import Context as Context
-from .date import now as now
 from .grpc import GRPC_MAX_MESSAGE_LENGTH
 from .logger import configure as configure
 from .logger import log as log

flwr/common/args.py

@@ -20,7 +20,6 @@ import sys
 from logging import DEBUG, ERROR, INFO, WARN
 from os.path import isfile
 from pathlib import Path
-from typing import Optional, Union
 
 from flwr.common.constant import TRANSPORT_TYPE_REST
 from flwr.common.logger import log
@@ -70,9 +69,9 @@ def add_args_flwr_app_common(parser: argparse.ArgumentParser) -> None:
 def try_obtain_root_certificates(
     args: argparse.Namespace,
     grpc_server_address: str,
-) -> Optional[Union[bytes, str]]:
+) -> bytes | str | None:
     """Validate and return the root certificates."""
-    root_cert_path: Optional[str] = args.root_certificates
+    root_cert_path: str | None = args.root_certificates
     if args.insecure:
         if root_cert_path is not None:
             sys.exit(
@@ -111,7 +110,7 @@ def try_obtain_root_certificates(
 
 def try_obtain_server_certificates(
     args: argparse.Namespace,
-) -> Optional[tuple[bytes, bytes, bytes]]:
+) -> tuple[bytes, bytes, bytes] | None:
     """Validate and return the CA cert, server cert, and server private key."""
     if args.insecure:
         log(