flwr-nightly 1.12.0.dev20241009__py3-none-any.whl → 1.12.0.dev20241011__py3-none-any.whl

flwr/common/logger.py

@@ -111,7 +111,7 @@ FLOWER_LOGGER.addHandler(console_handler)
 class CustomHTTPHandler(HTTPHandler):
     """Custom HTTPHandler which overrides the mapLogRecords method."""
 
-    # pylint: disable=too-many-arguments,bad-option-value,R1725
+    # pylint: disable=too-many-arguments,bad-option-value,R1725,R0917
     def __init__(
         self,
         identifier: str,

flwr/common/message.py

@@ -52,7 +52,7 @@ class Metadata:  # pylint: disable=too-many-instance-attributes
         the receiving end.
     """
 
-    def __init__(  # pylint: disable=too-many-arguments
+    def __init__(  # pylint: disable=too-many-arguments,too-many-positional-arguments
         self,
         run_id: int,
         message_id: str,
@@ -290,6 +290,11 @@ class Message:
             follows the equation:
 
             ttl = msg.meta.ttl - (reply.meta.created_at - msg.meta.created_at)
+
+        Returns
+        -------
+        message : Message
+            A Message containing only the relevant error and metadata.
         """
         # If no TTL passed, use default for message creation (will update after
         # message creation)

flwr/common/record/configsrecord.py

@@ -128,6 +128,7 @@ class ConfigsRecord(TypedDict[str, ConfigsRecordValues]):
 
         def get_var_bytes(value: ConfigsScalar) -> int:
             """Return Bytes of value passed."""
+            var_bytes = 0
             if isinstance(value, bool):
                 var_bytes = 1
             elif isinstance(value, (int, float)):
@@ -136,6 +137,11 @@ class ConfigsRecord(TypedDict[str, ConfigsRecordValues]):
                 )
             if isinstance(value, (str, bytes)):
                 var_bytes = len(value)
+            if var_bytes == 0:
+                raise ValueError(
+                    "Config values must be either `bool`, `int`, `float`, "
+                    "`str`, or `bytes`"
+                )
             return var_bytes
 
         num_bytes = 0

flwr/common/recordset_compat.py

@@ -59,6 +59,11 @@ def parametersrecord_to_parameters(
     keep_input : bool
         A boolean indicating whether entries in the record should be deleted from the
         input dictionary immediately after adding them to the record.
+
+    Returns
+    -------
+    parameters : Parameters
+        The parameters in the legacy format Parameters.
     """
     parameters = Parameters(tensors=[], tensor_type="")
 
@@ -94,6 +99,11 @@ def parameters_to_parametersrecord(
         A boolean indicating whether parameters should be deleted from the input
         Parameters object (i.e. a list of serialized NumPy arrays) immediately after
         adding them to the record.
+
+    Returns
+    -------
+    ParametersRecord
+        The ParametersRecord containing the provided parameters.
     """
     tensor_type = parameters.tensor_type
 

flwr/common/retry_invoker.py

@@ -38,6 +38,11 @@ def exponential(
         Factor by which the delay is multiplied after each retry.
     max_delay: Optional[float] (default: None)
         The maximum delay duration between two consecutive retries.
+
+    Returns
+    -------
+    Generator[float, None, None]
+        A generator for the delay between 2 retries.
     """
     delay = base_delay if max_delay is None else min(base_delay, max_delay)
     while True:
@@ -56,6 +61,11 @@ def constant(
     ----------
     interval: Union[float, Iterable[float]] (default: 1)
         A constant value to yield or an iterable of such values.
+
+    Returns
+    -------
+    Generator[float, None, None]
+        A generator for the delay between 2 retries.
     """
     if not isinstance(interval, Iterable):
         interval = itertools.repeat(interval)
@@ -73,6 +83,11 @@ def full_jitter(max_value: float) -> float:
     ----------
     max_value : float
         The upper limit for the randomized value.
+
+    Returns
+    -------
+    float
+        A random float that is less than max_value.
     """
     return random.uniform(0, max_value)
 

flwr/server/app.py

@@ -542,6 +542,7 @@ def _run_fleet_api_grpc_adapter(
 
 
 # pylint: disable=import-outside-toplevel,too-many-arguments
+# pylint: disable=too-many-positional-arguments
 def _run_fleet_api_rest(
     host: str,
     port: int,

flwr/server/client_manager.py

@@ -47,6 +47,7 @@ class ClientManager(ABC):
         Parameters
         ----------
         client : flwr.server.client_proxy.ClientProxy
+            The ClientProxy of the Client to register.
 
         Returns
         -------
@@ -64,6 +65,7 @@ class ClientManager(ABC):
         Parameters
         ----------
         client : flwr.server.client_proxy.ClientProxy
+            The ClientProxy of the Client to unregister.
         """
 
     @abstractmethod

flwr/server/driver/driver.py

@@ -32,7 +32,7 @@ class Driver(ABC):
         """Run information."""
 
     @abstractmethod
-    def create_message(  # pylint: disable=too-many-arguments
+    def create_message(  # pylint: disable=too-many-arguments,R0917
         self,
         content: RecordSet,
         message_type: str,

flwr/server/driver/grpc_driver.py

@@ -158,7 +158,7 @@ class GrpcDriver(Driver):
         ):
             raise ValueError(f"Invalid message: {message}")
 
-    def create_message(  # pylint: disable=too-many-arguments
+    def create_message(  # pylint: disable=too-many-arguments,R0917
         self,
         content: RecordSet,
         message_type: str,

flwr/server/driver/inmemory_driver.py

@@ -82,7 +82,7 @@ class InMemoryDriver(Driver):
         self._init_run()
         return Run(**vars(cast(Run, self._run)))
 
-    def create_message(  # pylint: disable=too-many-arguments
+    def create_message(  # pylint: disable=too-many-arguments,R0917
         self,
         content: RecordSet,
         message_type: str,
@@ -150,7 +150,7 @@ class InMemoryDriver(Driver):
         """
         msg_ids = {UUID(msg_id) for msg_id in message_ids}
         # Pull TaskRes
-        task_res_list = self.state.get_task_res(task_ids=msg_ids, limit=len(msg_ids))
+        task_res_list = self.state.get_task_res(task_ids=msg_ids)
         # Delete tasks in state
         self.state.delete_tasks(msg_ids)
         # Convert TaskRes to Message

flwr/server/run_serverapp.py

@@ -181,19 +181,17 @@ def run_server_app() -> None:
         )
         flwr_dir = get_flwr_dir(args.flwr_dir)
         run_ = driver.run
-        if run_.fab_hash:
-            fab_req = GetFabRequest(hash_str=run_.fab_hash)
-            # pylint: disable-next=W0212
-            fab_res: GetFabResponse = driver._stub.GetFab(fab_req)
-            if fab_res.fab.hash_str != run_.fab_hash:
-                raise ValueError("FAB hashes don't match.")
-
-            install_from_fab(fab_res.fab.content, flwr_dir, True)
-            fab_id, fab_version = get_fab_metadata(fab_res.fab.content)
-        else:
-            fab_id, fab_version = run_.fab_id, run_.fab_version
-
-        app_path = str(get_project_dir(fab_id, fab_version, flwr_dir))
+        if not run_.fab_hash:
+            raise ValueError("FAB hash not provided.")
+        fab_req = GetFabRequest(hash_str=run_.fab_hash)
+        # pylint: disable-next=W0212
+        fab_res: GetFabResponse = driver._stub.GetFab(fab_req)
+        if fab_res.fab.hash_str != run_.fab_hash:
+            raise ValueError("FAB hashes don't match.")
+        install_from_fab(fab_res.fab.content, flwr_dir, True)
+        fab_id, fab_version = get_fab_metadata(fab_res.fab.content)
+
+        app_path = str(get_project_dir(fab_id, fab_version, run_.fab_hash, flwr_dir))
         config = get_project_config(app_path)
     else:
         # User provided `app_dir`, but not `--run-id`

flwr/server/server_app.py

@@ -71,7 +71,7 @@ class ServerApp:
     >>>    print("ServerApp running")
     """
 
-    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-arguments,too-many-positional-arguments
     def __init__(
         self,
         server: Optional[Server] = None,

flwr/server/strategy/dp_adaptive_clipping.py

@@ -88,7 +88,7 @@ class DifferentialPrivacyServerSideAdaptiveClipping(Strategy):
     >>> )
     """
 
-    # pylint: disable=too-many-arguments,too-many-instance-attributes
+    # pylint: disable=too-many-arguments,too-many-instance-attributes,too-many-positional-arguments
     def __init__(
         self,
         strategy: Strategy,
@@ -307,7 +307,7 @@ class DifferentialPrivacyClientSideAdaptiveClipping(Strategy):
     >>> )
     """
 
-    # pylint: disable=too-many-arguments,too-many-instance-attributes
+    # pylint: disable=too-many-arguments,too-many-instance-attributes,too-many-positional-arguments
     def __init__(
         self,
         strategy: Strategy,

flwr/server/strategy/dpfedavg_adaptive.py

@@ -39,7 +39,7 @@ class DPFedAvgAdaptive(DPFedAvgFixed):
     This class is deprecated and will be removed in a future release.
     """
 
-    # pylint: disable=too-many-arguments,too-many-instance-attributes
+    # pylint: disable=too-many-arguments,too-many-instance-attributes,too-many-positional-arguments
     def __init__(
         self,
         strategy: Strategy,

flwr/server/strategy/dpfedavg_fixed.py

@@ -36,7 +36,7 @@ class DPFedAvgFixed(Strategy):
     This class is deprecated and will be removed in a future release.
     """
 
-    # pylint: disable=too-many-arguments,too-many-instance-attributes
+    # pylint: disable=too-many-arguments,too-many-instance-attributes,too-many-positional-arguments
     def __init__(
         self,
         strategy: Strategy,

flwr/server/superlink/driver/driver_servicer.py

@@ -155,7 +155,7 @@ class DriverServicer(driver_pb2_grpc.DriverServicer):
         context.add_callback(on_rpc_done)
 
         # Read from state
-        task_res_list: list[TaskRes] = state.get_task_res(task_ids=task_ids, limit=None)
+        task_res_list: list[TaskRes] = state.get_task_res(task_ids=task_ids)
 
         context.set_code(grpc.StatusCode.OK)
         return PullTaskResResponse(task_res_list=task_res_list)

flwr/server/superlink/fleet/grpc_bidi/grpc_server.py

@@ -60,7 +60,7 @@ def valid_certificates(certificates: tuple[bytes, bytes, bytes]) -> bool:
     return is_valid
 
 
-def start_grpc_server(  # pylint: disable=too-many-arguments
+def start_grpc_server(  # pylint: disable=too-many-arguments,R0917
     client_manager: ClientManager,
     server_address: str,
     max_concurrent_workers: int = 1000,
@@ -156,7 +156,7 @@ def start_grpc_server(  # pylint: disable=too-many-arguments
     return server
 
 
-def generic_create_grpc_server(  # pylint: disable=too-many-arguments
+def generic_create_grpc_server(  # pylint: disable=too-many-arguments,R0917
     servicer_and_add_fn: Union[
         tuple[FleetServicer, AddServicerToServerFn],
         tuple[GrpcAdapterServicer, AddServicerToServerFn],
@@ -174,7 +174,7 @@ def generic_create_grpc_server(  # pylint: disable=too-many-arguments
 
     Parameters
     ----------
-    servicer_and_add_fn : Tuple
+    servicer_and_add_fn : tuple
         A tuple holding a servicer implementation and a matching
         add_Servicer_to_server function.
     server_address : str
@@ -214,6 +214,8 @@ def generic_create_grpc_server(  # pylint: disable=too-many-arguments
             * CA certificate.
             * server certificate.
             * server private key.
+    interceptors : Optional[Sequence[grpc.ServerInterceptor]] (default: None)
+        A list of gRPC interceptors.
 
     Returns
     -------

flwr/server/superlink/fleet/vce/vce_api.py

@@ -172,6 +172,7 @@ def put_taskres_into_state(
             pass
 
 
+# pylint: disable=too-many-positional-arguments
 def run_api(
     app_fn: Callable[[], ClientApp],
     backend_fn: Callable[[], Backend],
@@ -251,7 +252,7 @@ def run_api(
 
 
 # pylint: disable=too-many-arguments,unused-argument,too-many-locals,too-many-branches
-# pylint: disable=too-many-statements
+# pylint: disable=too-many-statements,too-many-positional-arguments
 def start_vce(
     backend_name: str,
     backend_config_json_stream: str,
@@ -267,6 +268,8 @@ def start_vce(
     existing_nodes_mapping: Optional[NodeToPartitionMapping] = None,
 ) -> None:
     """Start Fleet API with the Simulation Engine."""
+    nodes_mapping = {}
+
     if client_app_attr is not None and client_app is not None:
         raise ValueError(
             "Both `client_app_attr` and `client_app` are provided, "
@@ -340,17 +343,17 @@ def start_vce(
     # Load ClientApp if needed
     def _load() -> ClientApp:
 
+        if client_app:
+            return client_app
         if client_app_attr:
-            app = get_load_client_app_fn(
+            return get_load_client_app_fn(
                 default_app_ref=client_app_attr,
                 app_path=app_dir,
                 flwr_dir=flwr_dir,
                 multi_app=False,
-            )(run.fab_id, run.fab_version)
+            )(run.fab_id, run.fab_version, run.fab_hash)
 
-        if client_app:
-            app = client_app
-        return app
+        raise ValueError("Either `client_app_attr` or `client_app` must be provided")
 
     app_fn = _load
 

flwr/server/superlink/state/in_memory_state.py

@@ -190,11 +190,8 @@ class InMemoryState(State):  # pylint: disable=R0902,R0904
         # Return the new task_id
         return task_id
 
-    def get_task_res(self, task_ids: set[UUID], limit: Optional[int]) -> list[TaskRes]:
+    def get_task_res(self, task_ids: set[UUID]) -> list[TaskRes]:
         """Get all TaskRes that have not been delivered yet."""
-        if limit is not None and limit < 1:
-            raise AssertionError("`limit` must be >= 1")
-
         with self.lock:
             # Find TaskRes that were not delivered yet
             task_res_list: list[TaskRes] = []
@@ -217,13 +214,9 @@ class InMemoryState(State):  # pylint: disable=R0902,R0904
                 if reply_to in task_ids and task_res.task.delivered_at == "":
                     task_res_list.append(task_res)
                     replied_task_ids.add(reply_to)
-                if limit and len(task_res_list) == limit:
-                    break
 
             # Check if the node is offline
             for task_id in task_ids - replied_task_ids:
-                if limit and len(task_res_list) == limit:
-                    break
                 task_ins = self.task_ins_store.get(task_id)
                 if task_ins is None:
                     continue

flwr/server/superlink/state/sqlite_state.py

@@ -151,6 +151,11 @@ class SqliteState(State):  # pylint: disable=R0904
         ----------
         log_queries : bool
             Log each query which is executed.
+
+        Returns
+        -------
+        list[tuple[str]]
+            The list of all tables in the DB.
         """
         self.conn = sqlite3.connect(self.database_path)
         self.conn.execute("PRAGMA foreign_keys = ON;")
@@ -444,7 +449,7 @@ class SqliteState(State):  # pylint: disable=R0904
         return task_id
 
     # pylint: disable-next=R0912,R0915,R0914
-    def get_task_res(self, task_ids: set[UUID], limit: Optional[int]) -> list[TaskRes]:
+    def get_task_res(self, task_ids: set[UUID]) -> list[TaskRes]:
         """Get TaskRes for task_ids.
 
         Usually, the Driver API calls this method to get results for instructions it has
@@ -459,9 +464,6 @@ class SqliteState(State):  # pylint: disable=R0904
         will only take effect if enough task_ids are in the set AND are currently
         available. If `limit` is set, it has to be greater than zero.
         """
-        if limit is not None and limit < 1:
-            raise AssertionError("`limit` must be >= 1")
-
         # Check if corresponding TaskIns exists and is not expired
         task_ids_placeholders = ",".join([f":id_{i}" for i in range(len(task_ids))])
         query = f"""
@@ -505,10 +507,6 @@ class SqliteState(State):  # pylint: disable=R0904
 
         data: dict[str, Union[str, float, int]] = {}
 
-        if limit is not None:
-            query += " LIMIT :limit"
-            data["limit"] = limit
-
         query += ";"
 
         for index, task_id in enumerate(task_ids):
@@ -583,9 +581,6 @@ class SqliteState(State):  # pylint: disable=R0904
 
         # Make TaskRes containing node unavailabe error
         for row in task_ins_rows:
-            if limit and len(result) == limit:
-                break
-
             for row in rows:
                 # Convert values from sint64 to uint64
                 convert_sint64_values_in_dict_to_uint64(

flwr/server/superlink/state/state.py

@@ -98,7 +98,7 @@ class State(abc.ABC):  # pylint: disable=R0904
         """
 
     @abc.abstractmethod
-    def get_task_res(self, task_ids: set[UUID], limit: Optional[int]) -> list[TaskRes]:
+    def get_task_res(self, task_ids: set[UUID]) -> list[TaskRes]:
         """Get TaskRes for task_ids.
 
         Usually, the Driver API calls this method to get results for instructions it has
@@ -106,12 +106,6 @@ class State(abc.ABC):  # pylint: disable=R0904
 
         Retrieves all TaskRes for the given `task_ids` and returns and empty list of
         none could be found.
-
-        Constraints
-        -----------
-        If `limit` is not `None`, return, at most, `limit` number of TaskRes. The limit
-        will only take effect if enough task_ids are in the set AND are currently
-        available. If `limit` is set, it has to be greater zero.
         """
 
     @abc.abstractmethod

flwr/server/superlink/state/utils.py

@@ -100,11 +100,6 @@ def convert_uint64_values_in_dict_to_sint64(
         A dictionary where the values are integers to be converted.
     keys : list[str]
         A list of keys in the dictionary whose values need to be converted.
-
-    Returns
-    -------
-    None
-        This function does not return a value. It modifies `data_dict` in place.
     """
     for key in keys:
         if key in data_dict:
@@ -122,11 +117,6 @@ def convert_sint64_values_in_dict_to_uint64(
         A dictionary where the values are integers to be converted.
     keys : list[str]
         A list of keys in the dictionary whose values need to be converted.
-
-    Returns
-    -------
-    None
-        This function does not return a value. It modifies `data_dict` in place.
     """
     for key in keys:
         if key in data_dict:

flwr/simulation/ray_transport/ray_client_proxy.py

@@ -48,7 +48,7 @@ from flwr.simulation.ray_transport.ray_actor import VirtualClientEngineActorPool
 class RayActorClientProxy(ClientProxy):
     """Flower client proxy which delegates work using Ray."""
 
-    def __init__(  # pylint: disable=too-many-arguments
+    def __init__(  # pylint: disable=too-many-arguments,too-many-positional-arguments
         self,
         client_fn: ClientFnExt,
         node_id: int,

flwr/simulation/run_simulation.py

@@ -225,7 +225,7 @@ def run_simulation_from_cli() -> None:
 
 
 # Entry point from Python session (script or notebook)
-# pylint: disable=too-many-arguments
+# pylint: disable=too-many-arguments,too-many-positional-arguments
 def run_simulation(
     server_app: ServerApp,
     client_app: ClientApp,
@@ -300,7 +300,7 @@ def run_simulation(
     )
 
 
-# pylint: disable=too-many-arguments
+# pylint: disable=too-many-arguments,too-many-positional-arguments
 def run_serverapp_th(
     server_app_attr: Optional[str],
     server_app: Optional[ServerApp],
@@ -369,7 +369,7 @@ def run_serverapp_th(
     return serverapp_th
 
 
-# pylint: disable=too-many-locals
+# pylint: disable=too-many-locals,too-many-positional-arguments
 def _main_loop(
     num_supernodes: int,
     backend_name: str,
@@ -455,7 +455,7 @@ def _main_loop(
     log(DEBUG, "Stopping Simulation Engine now.")
 
 
-# pylint: disable=too-many-arguments,too-many-locals
+# pylint: disable=too-many-arguments,too-many-locals,too-many-positional-arguments
 def _run_simulation(
     num_supernodes: int,
     exit_event: EventType,

{flwr_nightly-1.12.0.dev20241009.dist-info → flwr_nightly-1.12.0.dev20241011.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.12.0.dev20241009
+Version: 1.12.0.dev20241011
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0