flwr-nightly 1.20.0.dev20250717__tar.gz → 1.20.0.dev20250720__tar.gz

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: flwr-nightly
-Version: 1.20.0.dev20250717
+Version: 1.20.0.dev20250720
 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

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/py/flwr/cli/build.py

@@ -184,7 +184,7 @@ def build_fab(app: Path) -> tuple[bytes, str, dict[str, Any]]:
             # Read the file content manually
             file_contents = file_path.read_bytes()
 
-            archive_path = str(file_path.relative_to(app))
+            archive_path = str(file_path.relative_to(app)).replace("\\", "/")
             write_to_zip(fab_file, archive_path, file_contents)
 
             # Calculate file info

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/py/flwr/client/grpc_adapter_client/connection.py

@@ -49,6 +49,9 @@ def grpc_adapter(  # pylint: disable=R0913,too-many-positional-arguments
         Callable[[], None],
         Callable[[int], Run],
         Callable[[str, int], Fab],
+        Callable[[int, str], bytes],
+        Callable[[int, str, bytes], None],
+        Callable[[int, str], None],
     ]
 ]:
     """Primitives for request/response-based interaction with a server via GrpcAdapter.
@@ -83,6 +86,9 @@ def grpc_adapter(  # pylint: disable=R0913,too-many-positional-arguments
     delete_node : Optional[Callable]
     get_run : Optional[Callable]
     get_fab : Optional[Callable]
+    pull_object : Callable[[str], bytes]
+    push_object : Callable[[str, bytes], None]
+    confirm_message_received : Callable[[str], None]
     """
     if authentication_keys is not None:
         log(ERROR, "Client authentication is not supported for this transport type.")

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/py/flwr/client/grpc_rere_client/connection.py

@@ -35,6 +35,7 @@ from flwr.common.inflatable import (
     no_object_id_recompute,
 )
 from flwr.common.inflatable_protobuf_utils import (
+    make_confirm_message_received_fn_protobuf,
     make_pull_object_fn_protobuf,
     make_push_object_fn_protobuf,
 )
@@ -94,6 +95,9 @@ def grpc_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         Callable[[], None],
         Callable[[int], Run],
         Callable[[str, int], Fab],
+        Callable[[int, str], bytes],
+        Callable[[int, str, bytes], None],
+        Callable[[int, str], None],
     ]
 ]:
     """Primitives for request/response-based interaction with a server.
@@ -136,6 +140,9 @@ def grpc_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     create_node : Optional[Callable]
     delete_node : Optional[Callable]
     get_run : Optional[Callable]
+    pull_object : Callable[[str], bytes]
+    push_object : Callable[[str, bytes], None]
+    confirm_message_received : Callable[[str], None]
     """
     if isinstance(root_certificates, str):
         root_certificates = Path(root_certificates).read_bytes()
@@ -354,9 +361,58 @@ def grpc_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
 
         return Fab(get_fab_response.fab.hash_str, get_fab_response.fab.content)
 
+    def pull_object(run_id: int, object_id: str) -> bytes:
+        """Pull the object from the SuperLink."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_pull_object_fn_protobuf(
+            pull_object_protobuf=stub.PullObject,
+            node=node,
+            run_id=run_id,
+        )
+        return fn(object_id)
+
+    def push_object(run_id: int, object_id: str, contents: bytes) -> None:
+        """Push the object to the SuperLink."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_push_object_fn_protobuf(
+            push_object_protobuf=stub.PushObject,
+            node=node,
+            run_id=run_id,
+        )
+        fn(object_id, contents)
+
+    def confirm_message_received(run_id: int, object_id: str) -> None:
+        """Confirm that the message has been received."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_confirm_message_received_fn_protobuf(
+            confirm_message_received_protobuf=stub.ConfirmMessageReceived,
+            node=node,
+            run_id=run_id,
+        )
+        fn(object_id)
+
     try:
         # Yield methods
-        yield (receive, send, create_node, delete_node, get_run, get_fab)
+        yield (
+            receive,
+            send,
+            create_node,
+            delete_node,
+            get_run,
+            get_fab,
+            pull_object,
+            push_object,
+            confirm_message_received,
+        )
     except Exception as exc:  # pylint: disable=broad-except
         log(ERROR, exc)
     # Cleanup

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/py/flwr/client/rest_client/connection.py

@@ -35,6 +35,7 @@ from flwr.common.inflatable import (
     no_object_id_recompute,
 )
 from flwr.common.inflatable_protobuf_utils import (
+    make_confirm_message_received_fn_protobuf,
     make_pull_object_fn_protobuf,
     make_push_object_fn_protobuf,
 )
@@ -114,6 +115,9 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         Callable[[], None],
         Callable[[int], Run],
         Callable[[str, int], Fab],
+        Callable[[int, str], bytes],
+        Callable[[int, str, bytes], None],
+        Callable[[int, str], None],
     ]
 ]:
     """Primitives for request/response-based interaction with a server.
@@ -149,6 +153,9 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     create_node : Optional[Callable]
     delete_node : Optional[Callable]
     get_run : Optional[Callable]
+    pull_object : Callable[[str], bytes]
+    push_object : Callable[[str, bytes], None]
+    confirm_message_received : Callable[[str], None]
     """
     log(
         WARN,
@@ -230,6 +237,38 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         grpc_res.ParseFromString(res.content)
         return grpc_res
 
+    def _pull_object_protobuf(request: PullObjectRequest) -> PullObjectResponse:
+        res = _request(
+            req=request,
+            res_type=PullObjectResponse,
+            api_path=PATH_PULL_OBJECT,
+        )
+        if res is None:
+            raise ValueError(f"{PullObjectResponse.__name__} is None.")
+        return res
+
+    def _push_object_protobuf(request: PushObjectRequest) -> PushObjectResponse:
+        res = _request(
+            req=request,
+            res_type=PushObjectResponse,
+            api_path=PATH_PUSH_OBJECT,
+        )
+        if res is None:
+            raise ValueError(f"{PushObjectResponse.__name__} is None.")
+        return res
+
+    def _confirm_message_received_protobuf(
+        request: ConfirmMessageReceivedRequest,
+    ) -> ConfirmMessageReceivedResponse:
+        res = _request(
+            req=request,
+            res_type=ConfirmMessageReceivedResponse,
+            api_path=PATH_CONFIRM_MESSAGE_RECEIVED,
+        )
+        if res is None:
+            raise ValueError(f"{ConfirmMessageReceivedResponse.__name__} is None.")
+        return res
+
     def send_node_heartbeat() -> bool:
         # Get Node
         if node is None:
@@ -326,20 +365,12 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             msg_id = message_proto.metadata.message_id
             run_id = message_proto.metadata.run_id
 
-            def fn(request: PullObjectRequest) -> PullObjectResponse:
-                res = _request(
-                    req=request, res_type=PullObjectResponse, api_path=PATH_PULL_OBJECT
-                )
-                if res is None:
-                    raise ValueError("PushObjectResponse is None.")
-                return res
-
             try:
                 object_tree = res.message_object_trees[0]
                 all_object_contents = pull_objects(
                     [tree.object_id for tree in iterate_object_tree(object_tree)],
                     pull_object_fn=make_pull_object_fn_protobuf(
-                        pull_object_protobuf=fn,
+                        pull_object_protobuf=_pull_object_protobuf,
                         node=node,
                         run_id=run_id,
                     ),
@@ -403,21 +434,11 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             if res and res.objects_to_push:
                 objs_to_push = set(res.objects_to_push[message.object_id].object_ids)
 
-                def fn(request: PushObjectRequest) -> PushObjectResponse:
-                    res = _request(
-                        req=request,
-                        res_type=PushObjectResponse,
-                        api_path=PATH_PUSH_OBJECT,
-                    )
-                    if res is None:
-                        raise ValueError("PushObjectResponse is None.")
-                    return res
-
                 try:
                     push_objects(
                         all_objects,
                         push_object_fn=make_push_object_fn_protobuf(
-                            push_object_protobuf=fn,
+                            push_object_protobuf=_push_object_protobuf,
                             node=node,
                             run_id=message_proto.metadata.run_id,
                         ),
@@ -457,9 +478,58 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             res.fab.content,
         )
 
+    def pull_object(run_id: int, object_id: str) -> bytes:
+        """Pull the object from the SuperLink."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_pull_object_fn_protobuf(
+            pull_object_protobuf=_pull_object_protobuf,
+            node=node,
+            run_id=run_id,
+        )
+        return fn(object_id)
+
+    def push_object(run_id: int, object_id: str, contents: bytes) -> None:
+        """Push the object to the SuperLink."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_push_object_fn_protobuf(
+            push_object_protobuf=_push_object_protobuf,
+            node=node,
+            run_id=run_id,
+        )
+        fn(object_id, contents)
+
+    def confirm_message_received(run_id: int, object_id: str) -> None:
+        """Confirm that the message has been received."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_confirm_message_received_fn_protobuf(
+            confirm_message_received_protobuf=_confirm_message_received_protobuf,
+            node=node,
+            run_id=run_id,
+        )
+        fn(object_id)
+
     try:
         # Yield methods
-        yield (receive, send, create_node, delete_node, get_run, get_fab)
+        yield (
+            receive,
+            send,
+            create_node,
+            delete_node,
+            get_run,
+            get_fab,
+            pull_object,
+            push_object,
+            confirm_message_received,
+        )
     except Exception as exc:  # pylint: disable=broad-except
         log(ERROR, exc)
     # Cleanup

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/py/flwr/common/inflatable_protobuf_utils.py

@@ -18,6 +18,8 @@
 from typing import Callable
 
 from flwr.proto.message_pb2 import (  # pylint: disable=E0611
+    ConfirmMessageReceivedRequest,
+    ConfirmMessageReceivedResponse,
     PullObjectRequest,
     PullObjectResponse,
     PushObjectRequest,
@@ -27,6 +29,10 @@ from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 
 from .inflatable_utils import ObjectIdNotPreregisteredError, ObjectUnavailableError
 
+ConfirmMessageReceivedProtobuf = Callable[
+    [ConfirmMessageReceivedRequest], ConfirmMessageReceivedResponse
+]
+
 
 def make_pull_object_fn_protobuf(
     pull_object_protobuf: Callable[[PullObjectRequest], PullObjectResponse],
@@ -99,3 +105,37 @@ def make_push_object_fn_protobuf(
             raise ObjectIdNotPreregisteredError(object_id)
 
     return push_object_fn
+
+
+def make_confirm_message_received_fn_protobuf(
+    confirm_message_received_protobuf: ConfirmMessageReceivedProtobuf,
+    node: Node,
+    run_id: int,
+) -> Callable[[str], None]:
+    """Create a confirm message received function that uses protobuf.
+
+    Parameters
+    ----------
+    confirm_message_received_protobuf : ConfirmMessageReceivedProtobuf
+        A callable that takes a `ConfirmMessageReceivedRequest` and returns a
+        `ConfirmMessageReceivedResponse`, confirming message receipt.
+        This function is typically backed by a gRPC client stub.
+    node : Node
+        The node making the request.
+    run_id : int
+        The run ID for the current message.
+
+    Returns
+    -------
+    Callable[[str], None]
+        A wrapper function that takes an object ID and confirms that
+        the message has been received.
+    """
+
+    def confirm_message_received_fn(object_id: str) -> None:
+        request = ConfirmMessageReceivedRequest(
+            node=node, run_id=run_id, message_object_id=object_id
+        )
+        confirm_message_received_protobuf(request)
+
+    return confirm_message_received_fn

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/py/flwr/common/inflatable_utils.py

@@ -19,7 +19,10 @@ import os
 import random
 import threading
 import time
-from typing import Callable, Optional
+from collections.abc import Iterable, Iterator
+from typing import Callable, Optional, TypeVar
+
+from flwr.proto.message_pb2 import ObjectTree  # pylint: disable=E0611
 
 from .constant import (
     HEAD_BODY_DIVIDER,
@@ -38,6 +41,7 @@ from .inflatable import (
     get_object_head_values_from_object_content,
     get_object_id,
     is_valid_sha256_hash,
+    iterate_object_tree,
 )
 from .message import Message
 from .record import Array, ArrayRecord, ConfigRecord, MetricRecord, RecordDict
@@ -54,6 +58,8 @@ inflatable_class_registry: dict[str, type[InflatableObject]] = {
     RecordDict.__qualname__: RecordDict,
 }
 
+T = TypeVar("T", bound=InflatableObject)
+
 
 class ObjectUnavailableError(Exception):
     """Exception raised when an object has been pre-registered but is not yet
@@ -105,24 +111,61 @@ def push_objects(
     max_concurrent_pushes : int (default: MAX_CONCURRENT_PUSHES)
         The maximum number of concurrent pushes to perform.
     """
-    if object_ids_to_push is not None:
-        # Filter objects to push only those with IDs in the set
-        objects = {k: v for k, v in objects.items() if k in object_ids_to_push}
-
     lock = threading.Lock()
 
-    def push(obj_id: str) -> None:
+    def iter_dict_items() -> Iterator[tuple[str, bytes]]:
+        """Iterate over the dictionary items."""
+        for obj_id in list(objects.keys()):
+            # Skip the object if no need to push it
+            if object_ids_to_push is not None and obj_id not in object_ids_to_push:
+                continue
+
+            # Deflate the object content
+            object_content = objects[obj_id].deflate()
+            if not keep_objects:
+                with lock:
+                    del objects[obj_id]
+
+            yield obj_id, object_content
+
+    push_object_contents_from_iterable(
+        iter_dict_items(),
+        push_object_fn,
+        max_concurrent_pushes=max_concurrent_pushes,
+    )
+
+
+def push_object_contents_from_iterable(
+    object_contents: Iterable[tuple[str, bytes]],
+    push_object_fn: Callable[[str, bytes], None],
+    *,
+    max_concurrent_pushes: int = MAX_CONCURRENT_PUSHES,
+) -> None:
+    """Push multiple object contents to the servicer.
+
+    Parameters
+    ----------
+    object_contents : Iterable[tuple[str, bytes]]
+        An iterable of `(object_id, object_content)` pairs.
+        `object_id` is the object ID, and `object_content` is the object content.
+    push_object_fn : Callable[[str, bytes], None]
+        A function that takes an object ID and its content as bytes, and pushes
+        it to the servicer. This function should raise `ObjectIdNotPreregisteredError`
+        if the object ID is not pre-registered.
+    max_concurrent_pushes : int (default: MAX_CONCURRENT_PUSHES)
+        The maximum number of concurrent pushes to perform.
+    """
+
+    def push(args: tuple[str, bytes]) -> None:
         """Push a single object."""
-        object_content = objects[obj_id].deflate()
-        if not keep_objects:
-            with lock:
-                del objects[obj_id]
-        push_object_fn(obj_id, object_content)
+        obj_id, obj_content = args
+        # Push the object using the provided function
+        push_object_fn(obj_id, obj_content)
 
-    # Push all objects concurrently
+    # Push all object contents concurrently
     num_workers = get_num_workers(max_concurrent_pushes)
     with concurrent.futures.ThreadPoolExecutor(max_workers=num_workers) as executor:
-        list(executor.map(push, list(objects.keys())))
+        list(executor.map(push, object_contents))
 
 
 def pull_objects(  # pylint: disable=too-many-arguments,too-many-locals
@@ -348,3 +391,75 @@ def validate_object_content(content: bytes) -> None:
         raise UnexpectedObjectContentError(
             object_id=get_object_id(content), reason=str(err)
         ) from err
+
+
+def pull_and_inflate_object_from_tree(  # pylint: disable=R0913
+    object_tree: ObjectTree,
+    pull_object_fn: Callable[[str], bytes],
+    confirm_object_received_fn: Callable[[str], None],
+    *,
+    return_type: type[T] = InflatableObject,  # type: ignore
+    max_concurrent_pulls: int = MAX_CONCURRENT_PULLS,
+    max_time: Optional[float] = PULL_MAX_TIME,
+    max_tries_per_object: Optional[int] = PULL_MAX_TRIES_PER_OBJECT,
+    initial_backoff: float = PULL_INITIAL_BACKOFF,
+    backoff_cap: float = PULL_BACKOFF_CAP,
+) -> T:
+    """Pull and inflate the head object from the provided object tree.
+
+    Parameters
+    ----------
+    object_tree : ObjectTree
+        The object tree containing the object ID and its descendants.
+    pull_object_fn : Callable[[str], bytes]
+        A function that takes an object ID and returns the object content as bytes.
+    confirm_object_received_fn : Callable[[str], None]
+        A function to confirm that the object has been received.
+    return_type : type[T] (default: InflatableObject)
+        The type of the object to return. Must be a subclass of `InflatableObject`.
+    max_concurrent_pulls : int (default: MAX_CONCURRENT_PULLS)
+        The maximum number of concurrent pulls to perform.
+    max_time : Optional[float] (default: PULL_MAX_TIME)
+        The maximum time to wait for all pulls to complete. If `None`, waits
+        indefinitely.
+    max_tries_per_object : Optional[int] (default: PULL_MAX_TRIES_PER_OBJECT)
+        The maximum number of attempts to pull each object. If `None`, pulls
+        indefinitely until the object is available.
+    initial_backoff : float (default: PULL_INITIAL_BACKOFF)
+        The initial backoff time in seconds for retrying pulls after an
+        `ObjectUnavailableError`.
+    backoff_cap : float (default: PULL_BACKOFF_CAP)
+        The maximum backoff time in seconds. Backoff times will not exceed this value.
+
+    Returns
+    -------
+    T
+        An instance of the specified return type containing the inflated object.
+    """
+    # Pull the main object and all its descendants
+    pulled_object_contents = pull_objects(
+        [tree.object_id for tree in iterate_object_tree(object_tree)],
+        pull_object_fn,
+        max_concurrent_pulls=max_concurrent_pulls,
+        max_time=max_time,
+        max_tries_per_object=max_tries_per_object,
+        initial_backoff=initial_backoff,
+        backoff_cap=backoff_cap,
+    )
+
+    # Confirm that all objects were pulled
+    confirm_object_received_fn(object_tree.object_id)
+
+    # Inflate the main object
+    inflated_object = inflate_object_from_contents(
+        object_tree.object_id, pulled_object_contents, keep_object_contents=False
+    )
+
+    # Check if the inflated object is of the expected type
+    if not isinstance(inflated_object, return_type):
+        raise TypeError(
+            f"Expected object of type {return_type.__name__}, "
+            f"but got {type(inflated_object).__name__}."
+        )
+
+    return inflated_object

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/py/flwr/server/superlink/fleet/message_handler/message_handler.py

@@ -61,8 +61,7 @@ from flwr.server.superlink.linkstate import LinkState
 from flwr.server.superlink.utils import check_abort
 from flwr.supercore.ffs import Ffs
 from flwr.supercore.object_store import NoObjectInStoreError, ObjectStore
-
-from ...utils import store_mapping_and_register_objects
+from flwr.supercore.object_store.utils import store_mapping_and_register_objects
 
 
 def create_node(

{flwr_nightly-1.20.0.dev20250717 → flwr_nightly-1.20.0.dev20250720}/py/flwr/server/superlink/serverappio/serverappio_servicer.py

@@ -87,8 +87,7 @@ from flwr.server.superlink.utils import abort_if
 from flwr.server.utils.validator import validate_message
 from flwr.supercore.ffs import Ffs, FfsFactory
 from flwr.supercore.object_store import NoObjectInStoreError, ObjectStoreFactory
-
-from ..utils import store_mapping_and_register_objects
+from flwr.supercore.object_store.utils import store_mapping_and_register_objects
 
 
 class ServerAppIoServicer(serverappio_pb2_grpc.ServerAppIoServicer):

flwr_nightly-1.20.0.dev20250720/py/flwr/supercore/object_store/utils.py

@@ -0,0 +1,48 @@
+# 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.
+# ==============================================================================
+"""Utils for ObjectStore."""
+
+
+from typing import Union
+
+from flwr.proto.appio_pb2 import PushAppMessagesRequest  # pylint: disable=E0611
+from flwr.proto.fleet_pb2 import PushMessagesRequest  # pylint: disable=E0611
+from flwr.proto.message_pb2 import ObjectIDs  # pylint: disable=E0611
+
+from . import ObjectStore
+
+
+def store_mapping_and_register_objects(
+    store: ObjectStore, request: Union[PushAppMessagesRequest, PushMessagesRequest]
+) -> dict[str, ObjectIDs]:
+    """Store Message object to descendants mapping and preregister objects."""
+    if not request.messages_list:
+        return {}
+
+    objects_to_push: dict[str, ObjectIDs] = {}
+
+    # Get run_id from the first message in the list
+    # All messages of a request should in the same run
+    run_id = request.messages_list[0].metadata.run_id
+
+    for object_tree in request.message_object_trees:
+        # Preregister
+        object_ids_just_registered = store.preregister(run_id, object_tree)
+        # Keep track of objects that need to be pushed
+        objects_to_push[object_tree.object_id] = ObjectIDs(
+            object_ids=object_ids_just_registered
+        )
+
+    return objects_to_push