Merge pull request #2 from minormending/fix-non-repeated-msg-nullable

Fix non-repeated message defaults

protobuf2arr/serializer.py

@@ -34,7 +34,10 @@ def msg_to_arr(obj: Message) -> List[Any]:
                         list_vals.append(msg_to_arr(item))
                 val = list_vals
             else:
-                val = msg_to_arr(val)
+                if default_values and str(val).strip() in default_values:
+                    val = None
+                else:
+                    val = msg_to_arr(val)
         elif default_values:
             if field.type == field.TYPE_BYTES and str(val, "UTF-8") in default_values:
                 val = None
@@ -51,8 +54,8 @@ def arr_to_msg(arr: List[Any], msg: Message) -> Message:
         num = idx + 1
         field = msg.DESCRIPTOR.fields_by_number[num]
         if field.type == field.TYPE_MESSAGE:
+            cls = field.message_type._concrete_class
             if field.label == field.LABEL_REPEATED:
-                cls = field.message_type._concrete_class
                 models = []
                 for sub_item in item:
                     # None-type is Message with default values
@@ -66,8 +69,10 @@ def arr_to_msg(arr: List[Any], msg: Message) -> Message:
                     models.append(model)
                 _assign_field_value(msg, field, models)
             else:
+                # None-type is Message with default values
+                value = [None for _ in cls.DESCRIPTOR.fields] if item is None else item
                 model = getattr(msg, field.name)
-                arr_to_msg(item, model)  # fill model
+                arr_to_msg(value, model)  # fill model
         elif field.type == field.TYPE_BYTES and isinstance(item, str):
             _assign_field_value(msg, field, item.encode("UTF-8"))
         elif item == None and (options := field.GetOptions()):

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "protobuf2arr"
-version = "0.1.3"
+version = "0.1.4"
 description = "Translate a protobuf message to Google's RPC array format."
 authors = ["Kevin Ramdath <krpent@gmail.com>"]
 repository = "https://github.com/minormending/protobuf2arr"

tests/test_basic.proto

@@ -24,6 +24,7 @@ message TestQueue {
     repeated int32 repeated_int = 7 [(nullable) = '[]'];
 
     repeated TestItem items = 8 [(nullable) = ''];
+    TestItem field_item = 9 [(nullable) = ''];
 
     message TestItem {
         int32 item_field_int = 1 [(nullable) = '0'];

tests/test_serializer.py

@@ -25,22 +25,24 @@ def _test_deserialization(
 
     def test_serialization_basic_default_empty(self):
         queue = TestQueueBasic()
+        queue.field_item.item_field_int = 0
         arr = msg_to_arr(queue)
-        self.assertEqual(arr, [None, None, None, None, None, None, None, []])
+        self.assertEqual(arr, [None, None, None, None, None, None, None, [], None])
 
         serial = serialize_msg2arr(queue)
-        self.assertEqual(serial, "[null,null,null,null,null,null,null,[]]")
+        self.assertEqual(serial, "[null,null,null,null,null,null,null,[],null]")
 
         self._test_deserialization(queue, arr, serial, TestQueueBasic)
 
     def test_serialization_basic_default_empty_subitems(self):
         queue = TestQueueBasic()
         queue.items.append(TestQueueBasic.TestItem())
+        queue.field_item.item_field_int = 0
         arr = msg_to_arr(queue)
-        self.assertEqual(arr, [None, None, None, None, None, None, None, [None]])
+        self.assertEqual(arr, [None, None, None, None, None, None, None, [None], None])
 
         serial = serialize_msg2arr(queue)
-        self.assertEqual(serial, "[null,null,null,null,null,null,null,[null]]")
+        self.assertEqual(serial, "[null,null,null,null,null,null,null,[null],null]")
 
         self._test_deserialization(queue, arr, serial, TestQueueBasic)
 
@@ -54,12 +56,13 @@ def test_serialization_basic_default_filled(self):
         queue.field_enum = TestQueueBasic.TestEnum.TEST_ENUM_0
         queue.repeated_int.append(1)
         queue.repeated_int.pop()
+        queue.field_item.item_field_int = 0
 
         arr = msg_to_arr(queue)
-        self.assertEqual(arr, [None, None, None, None, None, None, None, []])
+        self.assertEqual(arr, [None, None, None, None, None, None, None, [], None])
 
         serial = serialize_msg2arr(queue)
-        self.assertEqual(serial, "[null,null,null,null,null,null,null,[]]")
+        self.assertEqual(serial, "[null,null,null,null,null,null,null,[],null]")
 
         self._test_deserialization(queue, arr, serial, TestQueueBasic)
 
@@ -73,14 +76,29 @@ def test_serialization_basic(self):
         queue.field_enum = TestQueueBasic.TestEnum.TEST_ENUM_1
         queue.repeated_int.append(24)
         queue.repeated_int.append(37)
+        queue.field_item.item_field_int = 43
 
         arr = msg_to_arr(queue)
         self.assertEqual(
-            arr, [100, 77.89, "Hello World", True, b"bytes", 1, [24, 37], []]
+            arr,
+            [
+                100,
+                77.89,
+                "Hello World",
+                True,
+                b"bytes",
+                1,
+                [24, 37],
+                [],
+                [43, None, None, None, None, None],
+            ],
         )
 
         serial = serialize_msg2arr(queue)
-        self.assertEqual(serial, '[100,77.89,"Hello World",true,"bytes",1,[24,37],[]]')
+        self.assertEqual(
+            serial,
+            '[100,77.89,"Hello World",true,"bytes",1,[24,37],[],[43,null,null,null,null,null]]',
+        )
 
         self._test_deserialization(queue, arr, serial, TestQueueBasic)
 
@@ -104,6 +122,8 @@ def test_serialization_basic_with_subitems(self):
         subitem.item_field_enum = TestQueueBasic.TestEnum.TEST_ENUM_2
         queue.items.append(subitem)
 
+        queue.field_item.item_field_int = 0
+
         arr = msg_to_arr(queue)
         self.assertEqual(
             arr,
@@ -116,13 +136,14 @@ def test_serialization_basic_with_subitems(self):
                 1,
                 [24, 37],
                 [[45, 23.67, "Hello Inner World", True, b"bytes inner", 2]],
+                None,
             ],
         )
 
         serial = serialize_msg2arr(queue)
         self.assertEqual(
             serial,
-            '[100,77.89,"Hello World",true,"bytes",1,[24,37],[[45,23.67,"Hello Inner World",true,"bytes inner",2]]]',
+            '[100,77.89,"Hello World",true,"bytes",1,[24,37],[[45,23.67,"Hello Inner World",true,"bytes inner",2]],null]',
         )
 
         self._test_deserialization(queue, arr, serial, TestQueueBasic)