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

flwr/common/__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.

flwr/common/address.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/common/args.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/common/auth_plugin/__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/common/auth_plugin/auth_plugin.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/common/config.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/common/constant.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/common/context.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/common/date.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/common/differential_privacy.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/common/differential_privacy_constants.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/common/dp.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/common/exit/exit.py

@@ -37,13 +37,13 @@ def flwr_exit(
 ) -> NoReturn:
     """Handle application exit with an optional message.
 
-    The exit message logged and displayed will follow this structure:
+    The exit message logged and displayed will follow this structure::
 
-    >>> Exit Code: <code>
-    >>> <message>
-    >>> <short-help-message>
-    >>>
-    >>> For more information, visit: <help-page-url>
+        Exit Code: <code>
+        <message>
+        <short-help-message>
+
+        For more information, visit: <help-page-url>
 
     - `<code>`: The unique exit code representing the termination reason.
     - `<message>`: Optional context or additional information about the exit.

flwr/common/exit_handlers.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/common/grpc.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/common/logger.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/common/message.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.
@@ -36,6 +36,19 @@ MESSAGE_INIT_ERROR_MESSAGE = (
 )
 
 
+class _WarningTracker:
+    """A class to track warnings for deprecated properties."""
+
+    def __init__(self) -> None:
+        # These variables are used to ensure that the deprecation warnings
+        # for the deprecated properties/class are logged only once.
+        self.create_error_reply_logged = False
+        self.create_reply_logged = False
+
+
+_warning_tracker = _WarningTracker()
+
+
 class MessageInitializationError(TypeError):
     """Error raised when initializing a message with invalid arguments."""
 
@@ -456,11 +469,13 @@ class Message:
         message : Message
             A Message containing only the relevant error and metadata.
         """
-        warn_deprecated_feature(
-            "`Message.create_error_reply` is deprecated. "
-            "Instead of calling `some_message.create_error_reply(some_error, ttl=...)`"
-            ", use `Message(some_error, reply_to=some_message, ttl=...)`."
-        )
+        if not _warning_tracker.create_error_reply_logged:
+            _warning_tracker.create_error_reply_logged = True
+            warn_deprecated_feature(
+                "`Message.create_error_reply` is deprecated. "
+                "Instead of calling `some_message.create_error_reply(some_error, "
+                "ttl=...)`, use `Message(some_error, reply_to=some_message, ttl=...)`."
+            )
         if ttl is not None:
             return Message(error, reply_to=self, ttl=ttl)
         return Message(error, reply_to=self)
@@ -488,11 +503,13 @@ class Message:
         Message
             A new `Message` instance representing the reply.
         """
-        warn_deprecated_feature(
-            "`Message.create_reply` is deprecated. "
-            "Instead of calling `some_message.create_reply(some_content, ttl=...)`"
-            ", use `Message(some_content, reply_to=some_message, ttl=...)`."
-        )
+        if not _warning_tracker.create_reply_logged:
+            _warning_tracker.create_reply_logged = True
+            warn_deprecated_feature(
+                "`Message.create_reply` is deprecated. "
+                "Instead of calling `some_message.create_reply(some_content, ttl=...)`"
+                ", use `Message(some_content, reply_to=some_message, ttl=...)`."
+            )
         if ttl is not None:
             return Message(content, reply_to=self, ttl=ttl)
         return Message(content, reply_to=self)

flwr/common/object_ref.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/common/parameter.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/common/pyproject.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/common/record/__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/common/record/arrayrecord.py

@@ -96,24 +96,24 @@ class Array:
 
     Examples
     --------
-    Initializing by specifying all fields directly:
+    Initializing by specifying all fields directly::
 
-    >>> arr1 = Array(
-    >>>     dtype="float32",
-    >>>     shape=[3, 3],
-    >>>     stype="numpy.ndarray",
-    >>>     data=b"serialized_data...",
-    >>> )
+        arr1 = Array(
+            dtype="float32",
+            shape=[3, 3],
+            stype="numpy.ndarray",
+            data=b"serialized_data...",
+        )
 
-    Initializing with a NumPy ndarray:
+    Initializing with a NumPy ndarray::
 
-    >>> import numpy as np
-    >>> arr2 = Array(np.random.randn(3, 3))
+        import numpy as np
+        arr2 = Array(np.random.randn(3, 3))
 
-    Initializing with a PyTorch tensor:
+    Initializing with a PyTorch tensor::
 
-    >>> import torch
-    >>> arr3 = Array(torch.randn(3, 3))
+        import torch
+        arr3 = Array(torch.randn(3, 3))
     """
 
     dtype: str
@@ -315,33 +315,33 @@ class ArrayRecord(TypedDict[str, Array]):
 
     Examples
     --------
-    Initializing an empty ArrayRecord:
+    Initializing an empty ArrayRecord::
 
-    >>> record = ArrayRecord()
+        record = ArrayRecord()
 
-    Initializing with a dictionary of :class:`Array`:
+    Initializing with a dictionary of :class:`Array`::
 
-    >>> arr = Array("float32", [5, 5], "numpy.ndarray", b"serialized_data...")
-    >>> record = ArrayRecord({"weight": arr})
+        arr = Array("float32", [5, 5], "numpy.ndarray", b"serialized_data...")
+        record = ArrayRecord({"weight": arr})
 
-    Initializing with a list of NumPy arrays:
+    Initializing with a list of NumPy arrays::
 
-    >>> import numpy as np
-    >>> arr1 = np.random.randn(3, 3)
-    >>> arr2 = np.random.randn(2, 2)
-    >>> record = ArrayRecord([arr1, arr2])
+        import numpy as np
+        arr1 = np.random.randn(3, 3)
+        arr2 = np.random.randn(2, 2)
+        record = ArrayRecord([arr1, arr2])
 
-    Initializing with a PyTorch model state_dict:
+    Initializing with a PyTorch model state_dict::
 
-    >>> import torch.nn as nn
-    >>> model = nn.Linear(10, 5)
-    >>> record = ArrayRecord(model.state_dict())
+        import torch.nn as nn
+        model = nn.Linear(10, 5)
+        record = ArrayRecord(model.state_dict())
 
-    Initializing with a TensorFlow model weights (a list of NumPy arrays):
+    Initializing with a TensorFlow model weights (a list of NumPy arrays)::
 
-    >>> import tensorflow as tf
-    >>> model = tf.keras.Sequential([tf.keras.layers.Dense(5, input_shape=(10,))])
-    >>> record = ArrayRecord(model.get_weights())
+        import tensorflow as tf
+        model = tf.keras.Sequential([tf.keras.layers.Dense(5, input_shape=(10,))])
+        record = ArrayRecord(model.get_weights())
     """
 
     @overload

flwr/common/record/configrecord.py

@@ -60,7 +60,7 @@ def _check_value(value: ConfigRecordValues) -> None:
 
 
 class ConfigRecord(TypedDict[str, ConfigRecordValues]):
-    """Configs record.
+    """Config record.
 
     A :code:`ConfigRecord` is a Python dictionary designed to ensure that
     each key-value pair adheres to specified data types. A :code:`ConfigRecord`
@@ -90,18 +90,18 @@ class ConfigRecord(TypedDict[str, ConfigRecordValues]):
     encourage you to use a :code:`ArrayRecord` instead if these are of high
     dimensionality.
 
-    Let's see some examples of how to construct a :code:`ConfigRecord` from scratch:
-
-    >>> from flwr.common import ConfigRecord
-    >>>
-    >>> # A `ConfigRecord` is a specialized Python dictionary
-    >>> record = ConfigRecord({"lr": 0.1, "batch-size": 128})
-    >>> # You can add more content to an existing record
-    >>> record["compute-average"] = True
-    >>> # It also supports lists
-    >>> record["loss-fn-coefficients"] = [0.4, 0.25, 0.35]
-    >>> # And string values (among other types)
-    >>> record["path-to-S3"] = "s3://bucket_name/folder1/fileA.json"
+    Let's see some examples of how to construct a :code:`ConfigRecord` from scratch::
+
+        from flwr.common import ConfigRecord
+
+        # A `ConfigRecord` is a specialized Python dictionary
+        record = ConfigRecord({"lr": 0.1, "batch-size": 128})
+        # You can add more content to an existing record
+        record["compute-average"] = True
+        # It also supports lists
+        record["loss-fn-coefficients"] = [0.4, 0.25, 0.35]
+        # And string values (among other types)
+        record["path-to-S3"] = "s3://bucket_name/folder1/fileA.json"
 
     Just like the other types of records in a :code:`flwr.common.RecordDict`, types are
     enforced. If you need to add a custom data structure or object, we recommend to

flwr/common/record/conversion_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/common/record/metricrecord.py

@@ -60,7 +60,7 @@ def _check_value(value: MetricRecordValues) -> None:
 
 
 class MetricRecord(TypedDict[str, MetricRecordValues]):
-    """Metrics recod.
+    """Metric record.
 
     A :code:`MetricRecord` is a Python dictionary designed to ensure that
     each key-value pair adheres to specified data types. A :code:`MetricRecord`
@@ -89,27 +89,27 @@ class MetricRecord(TypedDict[str, MetricRecordValues]):
     Common to these examples is that the output can be typically represented by
     a single scalar (:code:`int`, :code:`float`) or list of scalars.
 
-    Let's see some examples of how to construct a :code:`MetricRecord` from scratch:
+    Let's see some examples of how to construct a :code:`MetricRecord` from scratch::
 
-    >>> from flwr.common import MetricRecord
-    >>>
-    >>> # A `MetricRecord` is a specialized Python dictionary
-    >>> record = MetricRecord({"accuracy": 0.94})
-    >>> # You can add more content to an existing record
-    >>> record["loss"] = 0.01
-    >>> # It also supports lists
-    >>> record["loss-historic"] = [0.9, 0.5, 0.01]
+        from flwr.common import MetricRecord
+
+        # A `MetricRecord` is a specialized Python dictionary
+        record = MetricRecord({"accuracy": 0.94})
+        # You can add more content to an existing record
+        record["loss"] = 0.01
+        # It also supports lists
+        record["loss-historic"] = [0.9, 0.5, 0.01]
 
     Since types are enforced, the types of the objects inserted are checked. For a
     :code:`MetricRecord`, value types allowed are those in defined in
     :code:`flwr.common.MetricRecordValues`. Similarly, only :code:`str` keys are
-    allowed.
+    allowed::
+
+        from flwr.common import MetricRecord
 
-    >>> from flwr.common import MetricRecord
-    >>>
-    >>> record = MetricRecord() # an empty record
-    >>> # Add unsupported value
-    >>> record["something-unsupported"] = {'a': 123} # Will throw a `TypeError`
+        record = MetricRecord() # an empty record
+        # Add unsupported value
+        record["something-unsupported"] = {'a': 123} # Will throw a `TypeError`
 
     If you need a more versatily type of record try :code:`ConfigRecord` or
     :code:`ArrayRecord`.