flwr-nightly 1.14.0.dev20241211__py3-none-any.whl → 1.14.0.dev20241213__py3-none-any.whl

flwr/cli/app.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface."""
 
+
 import typer
 from typer.main import get_command
 

flwr/cli/build.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `build` command."""
 
+
 import hashlib
 import os
 import shutil

flwr/cli/config_utils.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Utility to validate the `pyproject.toml` file."""
 
+
 import zipfile
 from io import BytesIO
 from pathlib import Path

flwr/cli/example.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `example` command."""
 
+
 import json
 import os
 import subprocess

flwr/cli/install.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `install` command."""
 
+
 import hashlib
 import shutil
 import tempfile

flwr/cli/log.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `log` command."""
 
+
 import time
 from logging import DEBUG, ERROR, INFO
 from pathlib import Path

flwr/cli/login/__init__.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `login` command."""
 
+
 from .login import login as login
 
 __all__ = [

flwr/cli/login/login.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `login` command."""
 
+
 from pathlib import Path
 from typing import Annotated, Optional
 

flwr/cli/new/__init__.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `new` command."""
 
+
 from .new import new as new
 
 __all__ = [

flwr/cli/new/new.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `new` command."""
 
+
 import re
 from enum import Enum
 from pathlib import Path
@@ -81,7 +82,7 @@ def render_template(template: str, data: dict[str, str]) -> str:
 def create_file(file_path: Path, content: str) -> None:
     """Create file including all nessecary directories and write content into file."""
     file_path.parent.mkdir(exist_ok=True)
-    file_path.write_text(content)
+    file_path.write_text(content, encoding="utf-8")
 
 
 def render_and_create(file_path: Path, template: str, context: dict[str, str]) -> None:

flwr/cli/new/templates/app/pyproject.mlx.toml.tpl

@@ -10,8 +10,7 @@ license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
-    "mlx==0.16.1",
-    "numpy==1.24.4",
+    "mlx==0.21.1",
 ]
 
 [tool.hatch.build.targets.wheel]

flwr/cli/run/__init__.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `run` command."""
 
+
 from .run import run as run
 
 __all__ = [

flwr/cli/run/run.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface `run` command."""
 
+
 import io
 import json
 import subprocess

flwr/cli/utils.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower command line interface utils."""
 
+
 import hashlib
 import json
 import re

flwr/client/app.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower client app."""
 
+
 import signal
 import subprocess
 import sys
@@ -474,7 +475,7 @@ def start_client_internal(
 
                     run: Run = runs[run_id]
                     if get_fab is not None and run.fab_hash:
-                        fab = get_fab(run.fab_hash)
+                        fab = get_fab(run.fab_hash, run_id)
                         if not isolation:
                             # If `ClientApp` runs in the same process, install the FAB
                             install_from_fab(fab.content, flwr_path, True)
@@ -752,7 +753,7 @@ def _init_connection(transport: Optional[str], server_address: str) -> tuple[
                 Optional[Callable[[], Optional[int]]],
                 Optional[Callable[[], None]],
                 Optional[Callable[[int], Run]],
-                Optional[Callable[[str], Fab]],
+                Optional[Callable[[str, int], Fab]],
             ]
         ],
     ],

flwr/client/client.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower client (abstract base class)."""
 
+
 # Needed to `Client` class can return a type of `Client` (not needed in py3.11+)
 from __future__ import annotations
 

flwr/client/clientapp/app.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower ClientApp process."""
 
+
 import argparse
 import sys
 import time

flwr/client/clientapp/utils.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower ClientApp loading utils."""
 
+
 from logging import DEBUG
 from pathlib import Path
 from typing import Callable, Optional

flwr/client/grpc_adapter_client/connection.py

@@ -48,7 +48,7 @@ def grpc_adapter(  # pylint: disable=R0913,too-many-positional-arguments
         Optional[Callable[[], Optional[int]]],
         Optional[Callable[[], None]],
         Optional[Callable[[int], Run]],
-        Optional[Callable[[str], Fab]],
+        Optional[Callable[[str, int], Fab]],
     ]
 ]:
     """Primitives for request/response-based interaction with a server via GrpcAdapter.

flwr/client/grpc_client/connection.py

@@ -76,7 +76,7 @@ def grpc_connection(  # pylint: disable=R0913,R0915,too-many-positional-argument
         Optional[Callable[[], Optional[int]]],
         Optional[Callable[[], None]],
         Optional[Callable[[int], Run]],
-        Optional[Callable[[str], Fab]],
+        Optional[Callable[[str, int], Fab]],
     ]
 ]:
     """Establish a gRPC connection to a gRPC server.

flwr/client/grpc_rere_client/connection.py

@@ -84,7 +84,7 @@ def grpc_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         Optional[Callable[[], Optional[int]]],
         Optional[Callable[[], None]],
         Optional[Callable[[int], Run]],
-        Optional[Callable[[str], Fab]],
+        Optional[Callable[[str, int], Fab]],
     ]
 ]:
     """Primitives for request/response-based interaction with a server.
@@ -290,9 +290,9 @@ def grpc_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         # Return fab_id and fab_version
         return run_from_proto(get_run_response.run)
 
-    def get_fab(fab_hash: str) -> Fab:
+    def get_fab(fab_hash: str, run_id: int) -> Fab:
         # Call FleetAPI
-        get_fab_request = GetFabRequest(node=node, hash_str=fab_hash)
+        get_fab_request = GetFabRequest(node=node, hash_str=fab_hash, run_id=run_id)
         get_fab_response: GetFabResponse = retry_invoker.invoke(
             stub.GetFab,
             request=get_fab_request,

flwr/client/message_handler/message_handler.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Client-side message handler."""
 
+
 from logging import WARN
 from typing import Optional, cast
 

flwr/client/mod/comms_mods.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Mods that report statistics about message communication."""
 
+
 from logging import INFO
 
 import numpy as np

flwr/client/mod/localdp_mod.py

@@ -136,7 +136,7 @@ class LocalDpMod:
         fit_res.parameters = ndarrays_to_parameters(client_to_server_params)
 
         # Add noise to model params
-        add_localdp_gaussian_noise_to_params(
+        fit_res.parameters = add_localdp_gaussian_noise_to_params(
             fit_res.parameters, self.sensitivity, self.epsilon, self.delta
         )
 

flwr/client/nodestate/__init__.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower NodeState."""
 
+
 from .in_memory_nodestate import InMemoryNodeState as InMemoryNodeState
 from .nodestate import NodeState as NodeState
 from .nodestate_factory import NodeStateFactory as NodeStateFactory

flwr/client/nodestate/nodestate.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Abstract base class NodeState."""
 
+
 import abc
 from typing import Optional
 

flwr/client/nodestate/nodestate_factory.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Factory class that creates NodeState instances."""
 
+
 import threading
 from typing import Optional
 

flwr/client/rest_client/connection.py

@@ -96,7 +96,7 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         Optional[Callable[[], Optional[int]]],
         Optional[Callable[[], None]],
         Optional[Callable[[int], Run]],
-        Optional[Callable[[str], Fab]],
+        Optional[Callable[[str, int], Fab]],
     ]
 ]:
     """Primitives for request/response-based interaction with a server.
@@ -361,9 +361,9 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
 
         return run_from_proto(res.run)
 
-    def get_fab(fab_hash: str) -> Fab:
+    def get_fab(fab_hash: str, run_id: int) -> Fab:
         # Construct the request
-        req = GetFabRequest(node=node, hash_str=fab_hash)
+        req = GetFabRequest(node=node, hash_str=fab_hash, run_id=run_id)
 
         # Send the request
         res = _request(req, GetFabResponse, PATH_GET_FAB)

flwr/client/supernode/app.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower SuperNode."""
 
+
 import argparse
 import sys
 from logging import DEBUG, ERROR, INFO, WARN

flwr/common/address.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower IP address utils."""
 
+
 import socket
 from ipaddress import ip_address
 from typing import Optional

flwr/common/args.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Common Flower arguments."""
 
+
 import argparse
 import sys
 from logging import DEBUG, ERROR, WARN

flwr/common/config.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Provide functions for managing global Flower config."""
 
+
 import os
 import re
 from pathlib import Path

flwr/common/logger.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower Logger."""
 
+
 import logging
 import re
 import sys

flwr/common/message.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Message."""
 
+
 from __future__ import annotations
 
 import time

flwr/common/object_ref.py

@@ -21,6 +21,7 @@ import sys
 from importlib.util import find_spec
 from logging import WARN
 from pathlib import Path
+from threading import Lock
 from typing import Any, Optional, Union
 
 from .logger import log
@@ -34,6 +35,7 @@ attribute.
 
 
 _current_sys_path: Optional[str] = None
+_import_lock = Lock()
 
 
 def validate(
@@ -146,60 +148,61 @@ def load_app(  # pylint: disable= too-many-branches
     - This function will modify `sys.path` by inserting the provided `project_dir`
       and removing the previously inserted `project_dir`.
     """
-    valid, error_msg = validate(module_attribute_str, check_module=False)
-    if not valid and error_msg:
-        raise error_type(error_msg) from None
-
-    module_str, _, attributes_str = module_attribute_str.partition(":")
-
-    try:
-        # Initialize project path
-        if project_dir is None:
-            project_dir = Path.cwd()
-        project_dir = Path(project_dir).absolute()
-
-        # Unload modules if the project directory has changed
-        if _current_sys_path and _current_sys_path != str(project_dir):
-            _unload_modules(Path(_current_sys_path))
-
-        # Set the system path
-        _set_sys_path(project_dir)
-
-        # Import the module
-        if module_str not in sys.modules:
-            module = importlib.import_module(module_str)
-        # Hack: `tabnet` does not work with `importlib.reload`
-        elif "tabnet" in sys.modules:
-            log(
-                WARN,
-                "Cannot reload module `%s` from disk due to compatibility issues "
-                "with the `tabnet` library. The module will be loaded from the "
-                "cache instead. If you experience issues, consider restarting "
-                "the application.",
-                module_str,
-            )
-            module = sys.modules[module_str]
-        else:
-            module = sys.modules[module_str]
-            _reload_modules(project_dir)
-
-    except ModuleNotFoundError as err:
-        raise error_type(
-            f"Unable to load module {module_str}{OBJECT_REF_HELP_STR}",
-        ) from err
-
-    # Recursively load attribute
-    attribute = module
-    try:
-        for attribute_str in attributes_str.split("."):
-            attribute = getattr(attribute, attribute_str)
-    except AttributeError as err:
-        raise error_type(
-            f"Unable to load attribute {attributes_str} from module {module_str}"
-            f"{OBJECT_REF_HELP_STR}",
-        ) from err
-
-    return attribute
+    with _import_lock:
+        valid, error_msg = validate(module_attribute_str, check_module=False)
+        if not valid and error_msg:
+            raise error_type(error_msg) from None
+
+        module_str, _, attributes_str = module_attribute_str.partition(":")
+
+        try:
+            # Initialize project path
+            if project_dir is None:
+                project_dir = Path.cwd()
+            project_dir = Path(project_dir).absolute()
+
+            # Unload modules if the project directory has changed
+            if _current_sys_path and _current_sys_path != str(project_dir):
+                _unload_modules(Path(_current_sys_path))
+
+            # Set the system path
+            _set_sys_path(project_dir)
+
+            # Import the module
+            if module_str not in sys.modules:
+                module = importlib.import_module(module_str)
+            # Hack: `tabnet` does not work with `importlib.reload`
+            elif "tabnet" in sys.modules:
+                log(
+                    WARN,
+                    "Cannot reload module `%s` from disk due to compatibility issues "
+                    "with the `tabnet` library. The module will be loaded from the "
+                    "cache instead. If you experience issues, consider restarting "
+                    "the application.",
+                    module_str,
+                )
+                module = sys.modules[module_str]
+            else:
+                module = sys.modules[module_str]
+                _reload_modules(project_dir)
+
+        except ModuleNotFoundError as err:
+            raise error_type(
+                f"Unable to load module {module_str}{OBJECT_REF_HELP_STR}",
+            ) from err
+
+        # Recursively load attribute
+        attribute = module
+        try:
+            for attribute_str in attributes_str.split("."):
+                attribute = getattr(attribute, attribute_str)
+        except AttributeError as err:
+            raise error_type(
+                f"Unable to load attribute {attributes_str} from module {module_str}"
+                f"{OBJECT_REF_HELP_STR}",
+            ) from err
+
+        return attribute
 
 
 def _unload_modules(project_dir: Path) -> None:

flwr/common/pyproject.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Validates the project's name property."""
 
+
 import re
 
 

flwr/common/record/__init__.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Record APIs."""
 
+
 from .configsrecord import ConfigsRecord
 from .conversion_utils import array_from_numpy
 from .metricsrecord import MetricsRecord

flwr/common/record/parametersrecord.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """ParametersRecord and Array."""
 
+
 from collections import OrderedDict
 from dataclasses import dataclass
 from io import BytesIO

flwr/common/retry_invoker.py

@@ -20,8 +20,17 @@ import random
 import time
 from collections.abc import Generator, Iterable
 from dataclasses import dataclass
+from logging import INFO, WARN
 from typing import Any, Callable, Optional, Union, cast
 
+import grpc
+
+from flwr.common.constant import MAX_RETRY_DELAY
+from flwr.common.logger import log
+from flwr.common.typing import RunNotRunningException
+from flwr.proto.clientappio_pb2_grpc import ClientAppIoStub
+from flwr.proto.serverappio_pb2_grpc import ServerAppIoStub
+
 
 def exponential(
     base_delay: float = 1,
@@ -303,3 +312,69 @@ class RetryInvoker:
                 # Trigger success event
                 try_call_event_handler(self.on_success)
                 return ret
+
+
+def _make_simple_grpc_retry_invoker() -> RetryInvoker:
+    """Create a simple gRPC retry invoker."""
+
+    def _on_sucess(retry_state: RetryState) -> None:
+        if retry_state.tries > 1:
+            log(
+                INFO,
+                "Connection successful after %.2f seconds and %s tries.",
+                retry_state.elapsed_time,
+                retry_state.tries,
+            )
+
+    def _on_backoff(retry_state: RetryState) -> None:
+        if retry_state.tries == 1:
+            log(WARN, "Connection attempt failed, retrying...")
+        else:
+            log(
+                WARN,
+                "Connection attempt failed, retrying in %.2f seconds",
+                retry_state.actual_wait,
+            )
+
+    def _on_giveup(retry_state: RetryState) -> None:
+        if retry_state.tries > 1:
+            log(
+                WARN,
+                "Giving up reconnection after %.2f seconds and %s tries.",
+                retry_state.elapsed_time,
+                retry_state.tries,
+            )
+
+    def _should_giveup_fn(e: Exception) -> bool:
+        if e.code() == grpc.StatusCode.PERMISSION_DENIED:  # type: ignore
+            raise RunNotRunningException
+        if e.code() == grpc.StatusCode.UNAVAILABLE:  # type: ignore
+            return False
+        return True
+
+    return RetryInvoker(
+        wait_gen_factory=lambda: exponential(max_delay=MAX_RETRY_DELAY),
+        recoverable_exceptions=grpc.RpcError,
+        max_tries=None,
+        max_time=None,
+        on_success=_on_sucess,
+        on_backoff=_on_backoff,
+        on_giveup=_on_giveup,
+        should_giveup=_should_giveup_fn,
+    )
+
+
+def _wrap_stub(
+    stub: Union[ServerAppIoStub, ClientAppIoStub], retry_invoker: RetryInvoker
+) -> None:
+    """Wrap a gRPC stub with a retry invoker."""
+
+    def make_lambda(original_method: Any) -> Any:
+        return lambda *args, **kwargs: retry_invoker.invoke(
+            original_method, *args, **kwargs
+        )
+
+    for method_name in vars(stub):
+        method = getattr(stub, method_name)
+        if callable(method):
+            setattr(stub, method_name, make_lambda(method))

flwr/common/typing.py

@@ -254,3 +254,7 @@ class Fab:
 
     hash_str: str
     content: bytes
+
+
+class RunNotRunningException(BaseException):
+    """Raised when a run is not running."""

flwr/common/version.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower package version helper."""
 
+
 import importlib.metadata as importlib_metadata