add sub_name support to SimpleDictDocument

plq · plq · commit e4b97a15a54a · 2020-07-30T01:07:39.000+03:00
diff --git a/spyne/model/complex.py b/spyne/model/complex.py
@@ -1057,59 +1057,122 @@ def get_orig(cls):
         return cls.__orig__ or cls
 
     @staticmethod
-    @memoize
     def get_simple_type_info(cls, hier_delim="."):
         """Returns a _type_info dict that includes members from all base classes
         and whose types are only primitives. It will prefix field names in
         non-top-level complex objects with field name of its parent.
 
-        For example, given hier_delim='_'; the following hierarchy: ::
+        For example, given hier_delim='.'; the following hierarchy: ::
 
             {'some_object': [{'some_string': ['abc']}]}
 
         would be transformed to: ::
 
-            {'some_object_some_string': ['abc']}
+            {'some_object.some_string': ['abc']}
 
         :param hier_delim: String that will be used as delimiter between field
-            names. Default is ``'_'``.
+            names. Default is ``'.'``.
         """
+        return ComplexModelBase.get_simple_type_info_with_prot(
+                                                     cls, hier_delim=hier_delim)
 
+    @staticmethod
+    @memoize
+    def get_simple_type_info_with_prot(cls, prot=None, hier_delim="."):
+        """See :func:ComplexModelBase.get_simple_type_info"""
         fti = cls.get_flat_type_info(cls)
 
         retval = TypeInfo()
         tags = set()
-        queue = deque([(k, v, (k,), (_is_array(v),), cls)
-                                                        for k,v in fti.items()])
+
+        queue = deque()
+        if prot is None:
+            for k, v in fti.items():
+                sub_name = k
+
+                queue.append((
+                    (k,),
+                    v,
+                    (sub_name,),
+                    (_is_array(v),),
+                    cls,
+                ))
+
+        else:
+            for k, v in fti.items():
+                cls_attrs = prot.get_cls_attrs(v)
+                sub_name = cls_attrs.sub_name
+                if sub_name is None:
+                    sub_name = k
+
+                queue.append((
+                    (k,),
+                    v,
+                    (sub_name,),
+                    (_is_array(v),),
+                    cls,
+                ))
+
         tags.add(cls)
 
         while len(queue) > 0:
-            k, v, prefix, is_array, parent = queue.popleft()
+            keys, v, prefix, is_array, parent = queue.popleft()
+            k = keys[-1]
             if issubclass(v, Array) and v.Attributes.max_occurs == 1:
                 v, = v._type_info.values()
 
             key = hier_delim.join(prefix)
             if issubclass(v, ComplexModelBase):
-                retval[key] = _SimpleTypeInfoElement(path=tuple(prefix),
-                               parent=parent, type_=v, is_array=tuple(is_array),
-                                                              can_be_empty=True)
+                retval[key] = _SimpleTypeInfoElement(
+                    path=keys,
+                    parent=parent,
+                    type_=v,
+                    is_array=tuple(is_array),
+                    can_be_empty=True,
+                )
 
                 if not (v in tags):
                     tags.add(v)
-                    queue.extend([
-                        (k2, v2, prefix + (k2,),
-                            is_array + (v.Attributes.max_occurs > 1,), v)
-                                   for k2, v2 in v.get_flat_type_info(v).items()])
+                    if prot is None:
+                        for k2, v2 in v.get_flat_type_info(v).items():
+                            sub_name = k2
+                            queue.append((
+                                keys + (k2,),
+                                v2,
+                                prefix + (sub_name,),
+                                is_array + (_is_array(v),),
+                                v
+                            ))
+
+                    else:
+                        for k2, v2 in v.get_flat_type_info(v).items():
+                            cls_attrs = prot.get_cls_attrs(v2)
+                            sub_name = cls_attrs.sub_name
+                            if sub_name is None:
+                                sub_name = k2
+
+                            queue.append((
+                                keys + (k2,),
+                                v2,
+                                prefix + (sub_name,),
+                                is_array + (_is_array(v),),
+                                v,
+                            ))
+
             else:
                 value = retval.get(key, None)
 
                 if value is not None:
                     raise ValueError("%r.%s conflicts with %r" %
                                                        (cls, k, value.path))
 
-                retval[key] = _SimpleTypeInfoElement(path=tuple(prefix),
-                               parent=parent, type_=v, is_array=tuple(is_array),
-                                                             can_be_empty=False)
+                retval[key] = _SimpleTypeInfoElement(
+                    path=keys,
+                    parent=parent,
+                    type_=v,
+                    is_array=tuple(is_array),
+                    can_be_empty=False,
+                )
 
         return retval
 
@@ -1201,7 +1264,7 @@ def customize(cls, **kwargs):
         # during daemon initialization, so it's not really necessary.
         ComplexModelBase.get_subclasses.memo.clear()
         ComplexModelBase.get_flat_type_info.memo.clear()
-        ComplexModelBase.get_simple_type_info.memo.clear()
+        ComplexModelBase.get_simple_type_info_with_prot.memo.clear()
 
         return retval
 
@@ -1232,7 +1295,7 @@ def _append_field_impl(cls, field_name, field_type):
         cls._type_info[field_name] = field_type
 
         ComplexModelBase.get_flat_type_info.memo.clear()
-        ComplexModelBase.get_simple_type_info.memo.clear()
+        ComplexModelBase.get_simple_type_info_with_prot.memo.clear()
 
     @classmethod
     def _append_to_variants(cls, field_name, field_type):
@@ -1269,7 +1332,7 @@ def _insert_field_impl(cls, index, field_name, field_type):
         cls._type_info.insert(index, (field_name, field_type))
 
         ComplexModelBase.get_flat_type_info.memo.clear()
-        ComplexModelBase.get_simple_type_info.memo.clear()
+        ComplexModelBase.get_simple_type_info_with_prot.memo.clear()
 
     @classmethod
     def insert_field(cls, index, field_name, field_type):
@@ -1289,7 +1352,7 @@ def _replace_field_impl(cls, field_name, field_type):
         cls._type_info[field_name] = field_type
 
         ComplexModelBase.get_flat_type_info.memo.clear()
-        ComplexModelBase.get_simple_type_info.memo.clear()
+        ComplexModelBase.get_simple_type_info_with_prot.memo.clear()
 
     @classmethod
     def _replace_field(cls, field_name, field_type):
diff --git a/spyne/protocol/dictdoc/simple.py b/spyne/protocol/dictdoc/simple.py
@@ -171,7 +171,8 @@ def simple_dict_to_object(self, ctx, doc, cls, validator=None, req_enc=None):
             retval = cls.get_serialization_instance([])
         else:
             retval = cls.get_deserialization_instance(ctx)
-        simple_type_info = cls.get_simple_type_info(cls,
+
+        simple_type_info = cls.get_simple_type_info_with_prot(cls, self,
                                                      hier_delim=self.hier_delim)
 
         logger.debug("Simple type info key: %r", simple_type_info.keys())
@@ -350,7 +351,11 @@ def object_to_simple_dict(self, cls, inst, retval=None,
 
             for k, v in fti.items():
                 new_prefix = list(prefix)
-                new_prefix.append(k)
+                cls_attrs = self.get_cls_attrs(v)
+                sub_name = cls_attrs.sub_name
+                if sub_name is None:
+                    sub_name = k
+                new_prefix.append(sub_name)
                 subinst = getattr(inst, k, None)
 
                 if (issubclass(v, Array) or v.Attributes.max_occurs > 1) and \
diff --git a/spyne/test/model/test_complex.py b/spyne/test/model/test_complex.py
@@ -536,6 +536,36 @@ class CCM(ComplexModel):
 
         assert len(d) == 4
 
+    def test_sub_name_ser(self):
+        class CM(ComplexModel):
+            integer = Integer(sub_name='i')
+            string = String(sub_name='s')
+
+        val = CM(integer=7, string='b')
+
+        d = SimpleDictDocument().object_to_simple_dict(CM, val)
+
+        pprint(d)
+
+        assert d['i'] == 7
+        assert d['s'] == 'b'
+
+        assert len(d) == 2
+
+    def test_sub_name_deser(self):
+        class CM(ComplexModel):
+            integer = Integer(sub_name='i')
+            string = String(sub_name='s')
+
+        d = {'i': [7], 's': ['b']}
+
+        val = SimpleDictDocument().simple_dict_to_object(None, d, CM)
+
+        pprint(d)
+
+        assert val.integer == 7
+        assert val.string == 'b'
+
     def test_array_not_none(self):
         class CM(ComplexModel):
             i = Integer
