flwr-nightly 1.19.0.dev20250507__py3-none-any.whl → 1.19.0.dev20250508__py3-none-any.whl

flwr/common/constant.py

@@ -127,6 +127,10 @@ GRPC_RETRY_MAX_DELAY = 20  # Maximum delay duration between two consecutive retr
 # Constants for ArrayRecord
 GC_THRESHOLD = 200_000_000  # 200 MB
 
+# Constants for Inflatable
+HEAD_BODY_DIVIDER = b"\x00"
+TYPE_BODY_LEN_DIVIDER = " "
+
 
 class MessageType:
     """Message type."""

flwr/common/inflatable.py

@@ -0,0 +1,80 @@
+# 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.
+# ==============================================================================
+"""InflatableObject base class."""
+
+
+import hashlib
+from typing import TypeVar
+
+from .constant import HEAD_BODY_DIVIDER, TYPE_BODY_LEN_DIVIDER
+
+T = TypeVar("T", bound="InflatableObject")
+
+
+class InflatableObject:
+    """Base class for inflatable objects."""
+
+    def deflate(self) -> bytes:
+        """Deflate object."""
+        raise NotImplementedError()
+
+    @property
+    def object_id(self) -> str:
+        """Get object_id."""
+        return get_object_id(self.deflate())
+
+
+def get_object_id(object_content: bytes) -> str:
+    """Return a SHA-256 hash of the (deflated) object content."""
+    return hashlib.sha256(object_content).hexdigest()
+
+
+def get_object_body(object_content: bytes, cls: type[T]) -> bytes:
+    """Return object body but raise an error if object type doesn't match class name."""
+    class_name = cls.__qualname__
+    object_type = get_object_type_from_object_content(object_content)
+    if not object_type == class_name:
+        raise ValueError(
+            f"Class name ({class_name}) and object type "
+            f"({object_type}) do not match."
+        )
+
+    # Return object body
+    return _get_object_body(object_content)
+
+
+def add_header_to_object_body(object_body: bytes, cls: T) -> bytes:
+    """Add header to object content."""
+    # Construct header
+    header = f"{cls.__class__.__qualname__}{TYPE_BODY_LEN_DIVIDER}{len(object_body)}"
+    enc_header = header.encode(encoding="utf-8")
+    # Concatenate header and object body
+    return enc_header + HEAD_BODY_DIVIDER + object_body
+
+
+def _get_object_head(object_content: bytes) -> bytes:
+    """Return object head from object content."""
+    return object_content.split(HEAD_BODY_DIVIDER, 1)[0]
+
+
+def _get_object_body(object_content: bytes) -> bytes:
+    """Return object body from object content."""
+    return object_content.split(HEAD_BODY_DIVIDER, 1)[1]
+
+
+def get_object_type_from_object_content(object_content: bytes) -> str:
+    """Return object type from bytes."""
+    obj_head: str = _get_object_head(object_content).decode(encoding="utf-8")
+    return obj_head.split(TYPE_BODY_LEN_DIVIDER, 1)[0]

{flwr_nightly-1.19.0.dev20250507.dist-info → flwr_nightly-1.19.0.dev20250508.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: flwr-nightly
-Version: 1.19.0.dev20250507
+Version: 1.19.0.dev20250508
 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.19.0.dev20250507.dist-info → flwr_nightly-1.19.0.dev20250508.dist-info}/RECORD

@@ -115,7 +115,7 @@ flwr/common/args.py,sha256=-aX_jVnSaDrJR2KZ8Wq0Y3dQHII4R4MJtJOIXzVUA0c,5417
 flwr/common/auth_plugin/__init__.py,sha256=m271m9YjK2QfKDOuIIhcTvGmv1GWh1PL97QB05NTSHs,887
 flwr/common/auth_plugin/auth_plugin.py,sha256=GaXw4IiU2DkVNkp5S9ue821sbkU9zWSu6HSVZetEdjs,3938
 flwr/common/config.py,sha256=glcZDjco-amw1YfQcYTFJ4S1pt9APoexT-mf1QscuHs,13960
-flwr/common/constant.py,sha256=_UFQfhBpDZ72uSRQqi3UNN4GlzEbog6sszA0it3m81Q,7132
+flwr/common/constant.py,sha256=fQeR6Hz6ezE5kK6b0vAw85fHED72-ZBv7SGHkGj9hug,7216
 flwr/common/context.py,sha256=Be8obQR_OvEDy1OmshuUKxGRQ7Qx89mf5F4xlhkR10s,2407
 flwr/common/date.py,sha256=1ZT2cRSpC2DJqprOVTLXYCR_O2_OZR0zXO_brJ3LqWc,1554
 flwr/common/differential_privacy.py,sha256=FdlpdpPl_H_2HJa8CQM1iCUGBBQ5Dc8CzxmHERM-EoE,6148
@@ -129,6 +129,7 @@ flwr/common/exit/exit_code.py,sha256=PNEnCrZfOILjfDAFu5m-2YWEJBrk97xglq4zCUlqV7E
 flwr/common/exit_handlers.py,sha256=MEk5_savTLphn-6lW57UQlos-XrFA39XEBn-OF1vXXg,3174
 flwr/common/grpc.py,sha256=manTaHaPiyYngUq1ErZvvV2B2GxlXUUUGRy3jc3TBIQ,9798
 flwr/common/heartbeat.py,sha256=yzi-gWH5wswdg0hfQwxwGkjI5twxIHBBVW45MD5QITI,3924
+flwr/common/inflatable.py,sha256=SPERmqeaUHeUr4JySWHQ7CUia8vCZxTC_S2OtwIsSXw,2779
 flwr/common/logger.py,sha256=JbRf6E2vQxXzpDBq1T8IDUJo_usu3gjWEBPQ6uKcmdg,13049
 flwr/common/message.py,sha256=znr205Erq2hkxwFbvNNCsQTRS2UKv_Qsyu0sFNEhEAw,23721
 flwr/common/object_ref.py,sha256=p3SfTeqo3Aj16SkB-vsnNn01zswOPdGNBitcbRnqmUk,9134
@@ -331,7 +332,7 @@ flwr/superexec/exec_servicer.py,sha256=Z0YYfs6eNPhqn8rY0x_R04XgR2mKFpggt07IH0EhU
 flwr/superexec/exec_user_auth_interceptor.py,sha256=iqygALkOMBUu_s_R9G0mFThZA7HTUzuXCLgxLCefiwI,4440
 flwr/superexec/executor.py,sha256=M5ucqSE53jfRtuCNf59WFLqQvA1Mln4741TySeZE7qQ,3112
 flwr/superexec/simulation.py,sha256=j6YwUvBN7EQ09ID7MYOCVZ70PGbuyBy8f9bXU0EszEM,4088
-flwr_nightly-1.19.0.dev20250507.dist-info/METADATA,sha256=2VAe3nq067aoWQnhHrtXYi8m9uT7Q1RJOLgGNoBy-zs,15880
-flwr_nightly-1.19.0.dev20250507.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-flwr_nightly-1.19.0.dev20250507.dist-info/entry_points.txt,sha256=2-1L-GNKhwGw2_7_RoH55vHw2SIHjdAQy3HAVAWl9PY,374
-flwr_nightly-1.19.0.dev20250507.dist-info/RECORD,,
+flwr_nightly-1.19.0.dev20250508.dist-info/METADATA,sha256=br7z9VS1iXUglNh4xLC9wnOQZeqosPkVn4HcPxEGMVs,15880
+flwr_nightly-1.19.0.dev20250508.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+flwr_nightly-1.19.0.dev20250508.dist-info/entry_points.txt,sha256=2-1L-GNKhwGw2_7_RoH55vHw2SIHjdAQy3HAVAWl9PY,374
+flwr_nightly-1.19.0.dev20250508.dist-info/RECORD,,