flwr 1.17.0__py3-none-any.whl → 1.19.0__py3-none-any.whl

flwr/cli/utils.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+# 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.
@@ -28,7 +28,12 @@ import typer
 
 from flwr.cli.cli_user_auth_interceptor import CliUserAuthInterceptor
 from flwr.common.auth_plugin import CliAuthPlugin
-from flwr.common.constant import AUTH_TYPE_JSON_KEY, CREDENTIALS_DIR, FLWR_DIR
+from flwr.common.constant import (
+    AUTH_TYPE_JSON_KEY,
+    CREDENTIALS_DIR,
+    FLWR_DIR,
+    RUN_ID_NOT_FOUND_MESSAGE,
+)
 from flwr.common.grpc import (
     GRPC_MAX_MESSAGE_LENGTH,
     create_channel,
@@ -220,17 +225,6 @@ def try_obtain_cli_auth_plugin(
     if not federation_config.get("enable-user-auth", False):
         return None
 
-    # Check if TLS is enabled. If not, raise an error
-    if federation_config.get("root-certificates") is None:
-        typer.secho(
-            "❌ User authentication requires TLS to be enabled. "
-            "Please provide 'root-certificates' in the federation"
-            " configuration.",
-            fg=typer.colors.RED,
-            bold=True,
-        )
-        raise typer.Exit(code=1)
-
     config_path = get_user_auth_config_path(root_dir, federation)
 
     # Get the auth type from the config if not provided
@@ -273,6 +267,16 @@ def init_channel(
     # Initialize the CLI-side user auth interceptor
     interceptors: list[grpc.UnaryUnaryClientInterceptor] = []
     if auth_plugin is not None:
+        # Check if TLS is enabled. If not, raise an error
+        if insecure:
+            typer.secho(
+                "❌ User authentication requires TLS to be enabled. "
+                "Remove `insecure = true` from the federation configuration.",
+                fg=typer.colors.RED,
+                bold=True,
+            )
+            raise typer.Exit(code=1)
+
         auth_plugin.load_tokens()
         interceptors.append(CliUserAuthInterceptor(auth_plugin))
 
@@ -289,11 +293,12 @@ def init_channel(
 
 
 @contextmanager
-def unauthenticated_exc_handler() -> Iterator[None]:
-    """Context manager to handle gRPC UNAUTHENTICATED errors.
+def flwr_cli_grpc_exc_handler() -> Iterator[None]:
+    """Context manager to handle specific gRPC errors.
 
-    It catches grpc.RpcError exceptions with UNAUTHENTICATED status, informs the user,
-    and exits the application. All other exceptions will be allowed to escape.
+    It catches grpc.RpcError exceptions with UNAUTHENTICATED, UNIMPLEMENTED, and
+    PERMISSION_DENIED statuses, informs the user, and exits the application. All other
+    exceptions will be allowed to escape.
     """
     try:
         yield
@@ -313,4 +318,24 @@ def unauthenticated_exc_handler() -> Iterator[None]:
                 bold=True,
             )
             raise typer.Exit(code=1) from None
+        if e.code() == grpc.StatusCode.PERMISSION_DENIED:
+            typer.secho(
+                "❌ Authorization failed. Please contact your administrator"
+                " to check your permissions.",
+                fg=typer.colors.RED,
+                bold=True,
+            )
+            # pylint: disable=E1101
+            typer.secho(e.details(), fg=typer.colors.RED, bold=True)
+            raise typer.Exit(code=1) from None
+        if (
+            e.code() == grpc.StatusCode.NOT_FOUND
+            and e.details() == RUN_ID_NOT_FOUND_MESSAGE
+        ):
+            typer.secho(
+                "❌ Run ID not found.",
+                fg=typer.colors.RED,
+                bold=True,
+            )
+            raise typer.Exit(code=1) from None
         raise

flwr/client/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# 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.
@@ -15,8 +15,8 @@
 """Flower client."""
 
 
-from .app import start_client as start_client
-from .app import start_numpy_client as start_numpy_client
+from ..compat.client.app import start_client as start_client  # Deprecated
+from ..compat.client.app import start_numpy_client as start_numpy_client  # Deprecated
 from .client import Client as Client
 from .client_app import ClientApp as ClientApp
 from .numpy_client import NumPyClient as NumPyClient

flwr/client/client.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# 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.

flwr/client/client_app.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+# 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.
@@ -20,6 +20,7 @@ from collections.abc import Iterator
 from contextlib import contextmanager
 from typing import Callable, Optional
 
+from flwr.app.metadata import validate_message_type
 from flwr.client.client import Client
 from flwr.client.message_handler.message_handler import (
     handle_legacy_message_from_msgtype,
@@ -28,7 +29,6 @@ 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.logger import warn_deprecated_feature
-from flwr.common.message import validate_message_type
 
 from .typing import ClientAppCallable
 
@@ -95,16 +95,16 @@ class ClientApp:
 
     Examples
     --------
-    Assuming a typical `Client` implementation named `FlowerClient`, you can wrap it in
-    a `ClientApp` as follows:
-
-    >>> class FlowerClient(NumPyClient):
-    >>>     # ...
-    >>>
-    >>> def client_fn(context: Context):
-    >>>    return FlowerClient().to_client()
-    >>>
-    >>> app = ClientApp(client_fn)
+    Assuming a typical ``Client`` implementation named ``FlowerClient``, you can wrap
+    it in a ``ClientApp`` as follows::
+
+        class FlowerClient(NumPyClient):
+            # ...
+
+        def client_fn(context: Context):
+           return FlowerClient().to_client()
+
+        app = ClientApp(client_fn)
     """
 
     def __init__(
@@ -181,39 +181,39 @@ class ClientApp:
 
         Examples
         --------
-        Registering a train function:
-
-        >>> app = ClientApp()
-        >>>
-        >>> @app.train()
-        >>> def train(message: Message, context: Context) -> Message:
-        >>>     print("Executing default train function")
-        >>>     # Create and return an echo reply message
-        >>>     return Message(message.content, reply_to=message)
-
-        Registering a train function with a custom action name:
-
-        >>> app = ClientApp()
-        >>>
-        >>> # Messages with `message_type="train.custom_action"` will be
-        >>> # routed to this function.
-        >>> @app.train("custom_action")
-        >>> def custom_action(message: Message, context: Context) -> Message:
-        >>>     print("Executing train function for custom action")
-        >>>     return Message(message.content, reply_to=message)
-
-        Registering a train function with a function-specific Flower Mod:
-
-        >>> from flwr.client.mod import message_size_mod
-        >>>
-        >>> app = ClientApp()
-        >>>
-        >>> # Using the `mods` argument to apply a function-specific mod.
-        >>> @app.train(mods=[message_size_mod])
-        >>> def train(message: Message, context: Context) -> Message:
-        >>>     print("Executing train function with message size mod")
-        >>>     # Create and return an echo reply message
-        >>>     return Message(message.content, reply_to=message)
+        Registering a train function::
+
+            app = ClientApp()
+
+            @app.train()
+            def train(message: Message, context: Context) -> Message:
+                print("Executing default train function")
+                # Create and return an echo reply message
+                return Message(message.content, reply_to=message)
+
+        Registering a train function with a custom action name::
+
+            app = ClientApp()
+
+            # Messages with `message_type="train.custom_action"` will be
+            # routed to this function.
+            @app.train("custom_action")
+            def custom_action(message: Message, context: Context) -> Message:
+                print("Executing train function for custom action")
+                return Message(message.content, reply_to=message)
+
+        Registering a train function with a function-specific Flower Mod::
+
+            from flwr.client.mod import message_size_mod
+
+            app = ClientApp()
+
+            # Using the `mods` argument to apply a function-specific mod.
+            @app.train(mods=[message_size_mod])
+            def train(message: Message, context: Context) -> Message:
+                print("Executing train function with message size mod")
+                # Create and return an echo reply message
+                return Message(message.content, reply_to=message)
         """
         return _get_decorator(self, MessageType.TRAIN, action, mods)
 
@@ -236,39 +236,39 @@ class ClientApp:
 
         Examples
         --------
-        Registering an evaluate function:
-
-        >>> app = ClientApp()
-        >>>
-        >>> @app.evaluate()
-        >>> def evaluate(message: Message, context: Context) -> Message:
-        >>>     print("Executing default evaluate function")
-        >>>     # Create and return an echo reply message
-        >>>     return Message(message.content, reply_to=message)
-
-        Registering an evaluate function with a custom action name:
-
-        >>> app = ClientApp()
-        >>>
-        >>> # Messages with `message_type="evaluate.custom_action"` will be
-        >>> # routed to this function.
-        >>> @app.evaluate("custom_action")
-        >>> def custom_action(message: Message, context: Context) -> Message:
-        >>>     print("Executing evaluate function for custom action")
-        >>>     return Message(message.content, reply_to=message)
-
-        Registering an evaluate function with a function-specific Flower Mod:
-
-        >>> from flwr.client.mod import message_size_mod
-        >>>
-        >>> app = ClientApp()
-        >>>
-        >>> # Using the `mods` argument to apply a function-specific mod.
-        >>> @app.evaluate(mods=[message_size_mod])
-        >>> def evaluate(message: Message, context: Context) -> Message:
-        >>>     print("Executing evaluate function with message size mod")
-        >>>     # Create and return an echo reply message
-        >>>     return Message(message.content, reply_to=message)
+        Registering an evaluate function::
+
+            app = ClientApp()
+
+            @app.evaluate()
+            def evaluate(message: Message, context: Context) -> Message:
+                print("Executing default evaluate function")
+                # Create and return an echo reply message
+                return Message(message.content, reply_to=message)
+
+        Registering an evaluate function with a custom action name::
+
+            app = ClientApp()
+
+            # Messages with `message_type="evaluate.custom_action"` will be
+            # routed to this function.
+            @app.evaluate("custom_action")
+            def custom_action(message: Message, context: Context) -> Message:
+                print("Executing evaluate function for custom action")
+                return Message(message.content, reply_to=message)
+
+        Registering an evaluate function with a function-specific Flower Mod::
+
+            from flwr.client.mod import message_size_mod
+
+            app = ClientApp()
+
+            # Using the `mods` argument to apply a function-specific mod.
+            @app.evaluate(mods=[message_size_mod])
+            def evaluate(message: Message, context: Context) -> Message:
+                print("Executing evaluate function with message size mod")
+                # Create and return an echo reply message
+                return Message(message.content, reply_to=message)
         """
         return _get_decorator(self, MessageType.EVALUATE, action, mods)
 
@@ -291,39 +291,39 @@ class ClientApp:
 
         Examples
         --------
-        Registering a query function:
-
-        >>> app = ClientApp()
-        >>>
-        >>> @app.query()
-        >>> def query(message: Message, context: Context) -> Message:
-        >>>     print("Executing default query function")
-        >>>     # Create and return an echo reply message
-        >>>     return Message(message.content, reply_to=message)
-
-        Registering a query function with a custom action name:
-
-        >>> app = ClientApp()
-        >>>
-        >>> # Messages with `message_type="query.custom_action"` will be
-        >>> # routed to this function.
-        >>> @app.query("custom_action")
-        >>> def custom_action(message: Message, context: Context) -> Message:
-        >>>     print("Executing query function for custom action")
-        >>>     return Message(message.content, reply_to=message)
-
-        Registering a query function with a function-specific Flower Mod:
-
-        >>> from flwr.client.mod import message_size_mod
-        >>>
-        >>> app = ClientApp()
-        >>>
-        >>> # Using the `mods` argument to apply a function-specific mod.
-        >>> @app.query(mods=[message_size_mod])
-        >>> def query(message: Message, context: Context) -> Message:
-        >>>     print("Executing query function with message size mod")
-        >>>     # Create and return an echo reply message
-        >>>     return Message(message.content, reply_to=message)
+        Registering a query function::
+
+            app = ClientApp()
+
+            @app.query()
+            def query(message: Message, context: Context) -> Message:
+                print("Executing default query function")
+                # Create and return an echo reply message
+                return Message(message.content, reply_to=message)
+
+        Registering a query function with a custom action name::
+
+            app = ClientApp()
+
+            # Messages with `message_type="query.custom_action"` will be
+            # routed to this function.
+            @app.query("custom_action")
+            def custom_action(message: Message, context: Context) -> Message:
+                print("Executing query function for custom action")
+                return Message(message.content, reply_to=message)
+
+        Registering a query function with a function-specific Flower Mod::
+
+            from flwr.client.mod import message_size_mod
+
+            app = ClientApp()
+
+            # Using the `mods` argument to apply a function-specific mod.
+            @app.query(mods=[message_size_mod])
+            def query(message: Message, context: Context) -> Message:
+                print("Executing query function with message size mod")
+                # Create and return an echo reply message
+                return Message(message.content, reply_to=message)
         """
         return _get_decorator(self, MessageType.QUERY, action, mods)
 
@@ -339,17 +339,19 @@ class ClientApp:
 
         Examples
         --------
-        >>> app = ClientApp()
-        >>>
-        >>> @app.lifespan()
-        >>> def lifespan(context: Context) -> None:
-        >>>     # Perform initialization tasks before the app starts
-        >>>     print("Initializing ClientApp")
-        >>>
-        >>>     yield  # ClientApp is running
-        >>>
-        >>>     # Perform cleanup tasks after the app stops
-        >>>     print("Cleaning up ClientApp")
+        ::
+
+                app = ClientApp()
+
+                @app.lifespan()
+                def lifespan(context: Context) -> None:
+                    # Perform initialization tasks before the app starts
+                    print("Initializing ClientApp")
+
+                    yield  # ClientApp is running
+
+                    # Perform cleanup tasks after the app stops
+                    print("Cleaning up ClientApp")
         """
 
         def lifespan_decorator(
@@ -436,24 +438,24 @@ def _registration_error(fn_name: str) -> ValueError:
 
         Use the `ClientApp` with an existing `client_fn`:
 
-        >>> class FlowerClient(NumPyClient):
-        >>>     # ...
-        >>>
-        >>> def client_fn(context: Context):
-        >>>     return FlowerClient().to_client()
-        >>>
-        >>> app = ClientApp(
-        >>>     client_fn=client_fn,
-        >>> )
+        class FlowerClient(NumPyClient):
+            # ...
+
+            def client_fn(context: Context):
+                return FlowerClient().to_client()
+
+            app = ClientApp(
+                client_fn=client_fn,
+            )
 
         Use the `ClientApp` with a custom {fn_name} function:
 
-        >>> app = ClientApp()
-        >>>
-        >>> @app.{fn_name}()
-        >>> def {fn_name}(message: Message, context: Context) -> Message:
-        >>>    print("ClientApp {fn_name} running")
-        >>>    # Create and return an echo reply message
-        >>>    return Message(message.content, reply_to=message)
+            app = ClientApp()
+
+            @app.{fn_name}()
+            def {fn_name}(message: Message, context: Context) -> Message:
+                print("ClientApp {fn_name} running")
+                # Create and return an echo reply message
+                return Message(message.content, reply_to=message)
         """,
     )

flwr/client/clientapp/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+# 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.
@@ -13,10 +13,3 @@
 # limitations under the License.
 # ==============================================================================
 """Flower AppIO service."""
-
-
-from .app import flwr_clientapp as flwr_clientapp
-
-__all__ = [
-    "flwr_clientapp",
-]

flwr/client/clientapp/utils.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+# 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.

flwr/client/dpfedavg_numpy_client.py

@@ -1,4 +1,4 @@
-# Copyright 2022 Flower Labs GmbH. All Rights Reserved.
+# 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.

flwr/client/grpc_adapter_client/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+# 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.

flwr/client/grpc_adapter_client/connection.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+# 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.
@@ -45,10 +45,10 @@ def grpc_adapter(  # pylint: disable=R0913,too-many-positional-arguments
     tuple[
         Callable[[], Optional[Message]],
         Callable[[Message], None],
-        Optional[Callable[[], Optional[int]]],
-        Optional[Callable[[], None]],
-        Optional[Callable[[int], Run]],
-        Optional[Callable[[str, int], Fab]],
+        Callable[[], Optional[int]],
+        Callable[[], None],
+        Callable[[int], Run],
+        Callable[[str, int], Fab],
     ]
 ]:
     """Primitives for request/response-based interaction with a server via GrpcAdapter.

flwr/client/grpc_rere_client/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2023 Flower Labs GmbH. All Rights Reserved.
+# 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.

flwr/client/grpc_rere_client/client_interceptor.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+# 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.