Issue #43

update to 1.33

Author: loyada

coverage.svg

@@ -4,8 +4,8 @@ typedpy\__init__.py                     6      0      0      0   100%
 typedpy\extfields.py                   77      0     19      0   100%
 typedpy\fields.py                     521     10    190      4    98%   265, 465, 475-477, 565, 811, 1275, 1278, 1290, 398->exit, 460->465, 564->565, 810->811
 typedpy\json_schema_mapping.py        175      1     63      0    99%   346
-typedpy\serialization.py              227      7    146      6    96%   244, 338, 354, 386-387, 520, 528, 243->244, 320->338, 353->354, 384->386, 519->520, 527->528
+typedpy\serialization.py              224      1    140      1    99%   561, 560->561
 typedpy\serialization_wrappers.py      37      0     20      2    96%   141->exit, 143->exit
 typedpy\structures.py                 228      7    118      5    96%   307-310, 316, 318, 320, 338, 345, 315->316, 317->318, 319->320, 337->338, 344->345
 -------------------------------------------------------------------------------
-TOTAL                                1271     25    556     17    97%
+TOTAL                                1268     19    550     12    98%

coverage.txt

@@ -60,9 +60,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.32'
+version = '1.33'
 # The full version, including alpha/beta/rc tags.
-release = '1.32'
+release = '1.33'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py

@@ -177,6 +177,8 @@ or a :class:`FunctionCall` (a function and a list of keys in the source dict tha
 
 * When the mapping is using a function call, the provided function is expected to return the value that will be used as the input of the deserialization.
 
+* To determine mapping for an embedded field/structure, use the notation: "<field name>._mapper". See example below.
+
 An example can demonstrate the usage:
 
 
@@ -205,6 +207,53 @@ An example can demonstrate the usage:
     # keep_undefined=False ensures it does not also create attributes a, name, j in the deserialized instance
     assert foo == Foo(i=7, m={'x': 1, 'y': 2}, s='the string is Joe')
 
+An example of mapping of a field item within a list:
+
+.. code-block:: python
+
+    class Foo(Structure):
+        a = String
+        i = Integer
+
+    class Bar(Structure):
+        wrapped = Array[Foo]
+
+    mapper = {'wrapped._mapper': {'a': 'aaa', 'i': 'iii'}, 'wrapped': 'other'}
+    deserializer = Deserializer(target_class=Bar, mapper=mapper)
+    deserialized = deserializer.deserialize(
+        {
+            'other': [
+                {'aaa': 'string1', 'iii': 1},
+                {'aaa': 'string2', 'iii': 2}
+            ]
+        },
+        keep_undefined=False)
+
+    assert deserialized == Bar(wrapped=[Foo(a='string1', i=1), Foo(a='string2', i=2)])
+
+An example of nested mapping:
+
+.. code-block:: python
+
+    class Foo(Structure):
+        a = String
+        i = Integer
+        s = StructureReference(st=String, arr=Array)
+
+    mapper = {
+        'a': 'aaa',
+        'i': 'iii',
+        's._mapper': {"arr": FunctionCall(func=lambda x: x * 3, args=['xxx'])}
+    }
+    deserializer = Deserializer(target_class=Foo, mapper=mapper)
+    deserialized = deserializer.deserialize({
+            'aaa': 'string',
+            'iii': 1,
+            's': {'st': 'string', 'xxx': [1, 2, 3]}},
+        keep_undefined=False)
+
+    assert deserialized == Foo(a='string', i=1, s={'st': 'string', 'arr': [1, 2, 3, 1, 2, 3, 1, 2, 3]})
+
 
 Custom mapping in the serialization
 ===================================

docs/serialization.rst

@@ -30,7 +30,7 @@
     url="http://github.com/loyada/typedpy",
     download_url ="https://github.com/loyada/typedpy/archive/v1.30.tar.gz",
     keywords=['testing', 'type-safe', 'strict', 'schema', 'validation'],
-    version='1.32'
+    version='1.33'
 )
 
 # coverage run --source=typedpy/ setup.py test

pylint.svg

@@ -266,7 +266,7 @@ class Foo(Structure):
 
     with raises(ValueError) as excinfo:
         deserialize_structure(Foo, {'bar': 1})
-    assert "could not deserialize bar: value 1 did not match <Array>. reason: bar: must be an iterable; got 1" in str(
+    assert "could not deserialize bar: value 1 did not match <Array>. reason: bar: must be list, set, or tuple; got 1" in str(
         excinfo.value)
 
 
@@ -328,7 +328,7 @@ def test_invalid_type_for_array_err():
     }
     with raises(ValueError) as excinfo:
         deserialize_structure(Example, data)
-    assert "array: must be an iterable" in str(excinfo.value)
+    assert "array: must be list, set, or tuple" in str(excinfo.value)
 
 
 def test_array_has_simple_item_in_definition():
@@ -403,7 +403,7 @@ class Foo(Structure):
 
 def test_multifield_with_diffrerent_types_no_match():
     class Foo(Structure):
-        any = AnyOf[Map, Set, String]
+        any = AnyOf[Map, Set[String], String]
 
     with raises(ValueError) as excinfo:
         deserialize_structure(Foo, {'any': [1, 2, 3]})
@@ -538,7 +538,7 @@ class Foo(Structure):
     serialized = {'a': 3, 't': 4}
     with raises(ValueError) as excinfo:
         deserialize_structure(Foo, serialized)
-    assert "t: must be an iterable" in str(excinfo.value)
+    assert "t: must be list, set, or tuple" in str(excinfo.value)
 
 
 def test_deserialize_set_err2():
@@ -684,7 +684,7 @@ class Foo(Structure):
     assert foo == Foo(i=6, m={'x': 1, 'y': 2}, s='the string is Joe')
 
 
-def test_mapper_error():
+def test_mapper_error1():
     class Foo(Structure):
         m = Map
         s = String
@@ -708,6 +708,24 @@ class Foo(Structure):
                               keep_undefined=False)
     assert "s: Got {'first': 'Joe', 'last': 'smith'}; Expected a string" in str(excinfo.value)
 
+def test_mapper_error1():
+    class Foo(Structure):
+        m = Map
+        s = String
+
+    mapper = ['m']
+
+    with raises(TypeError) as excinfo:
+        deserialize_structure(Foo,
+                              {
+                                  'a': {'b': {'x': 1, 'y': 2}},
+                                  'name': {'first': 'Joe', 'last': 'smith'},
+                                  'i': 3,
+                                  'j': 4
+                              },
+                              mapper=mapper)
+    assert "Mapper must be a mapping" in str(excinfo.value)
+
 
 def test_bad_path_in_mapper():
     class Foo(Structure):
@@ -785,6 +803,78 @@ class Foo(Structure):
     assert foo == Foo(i=7, m={'x': 1, 'y': 2}, s='the string is Joe')
 
 
+def test_mapper_in_list():
+    class Foo(Structure):
+        a = String
+        i = Integer
+
+    class Bar(Structure):
+        wrapped = Array[Foo]
+
+    mapper = {'wrapped._mapper': {'a': 'aaa', 'i': 'iii'}, 'wrapped': 'other'}
+    deserializer = Deserializer(target_class=Bar, mapper=mapper)
+    deserialized = deserializer.deserialize(
+        {
+            'other': [
+                {'aaa': 'string1', 'iii': 1},
+                {'aaa': 'string2', 'iii': 2}
+            ]
+        },
+        keep_undefined=False)
+
+    assert deserialized == Bar(wrapped=[Foo(a='string1', i=1), Foo(a='string2', i=2)])
+
+
+def test_mapper_in_embedded_structure():
+    class Foo(Structure):
+        a = String
+        i = Integer
+        s = StructureReference(st=String, arr=Array)
+
+    mapper = {'a': 'aaa', 'i': 'iii', 's._mapper':
+        {"arr": FunctionCall(func=lambda x: x * 2, args=['xxx'])}}
+    deserializer = Deserializer(target_class=Foo, mapper=mapper)
+    deserialized = deserializer.deserialize(
+        {
+            'aaa': 'string',
+            'iii': 1,
+            's': {'st': 'string', 'xxx': [1, 2, 3]}},
+        keep_undefined=False)
+
+    assert deserialized == Foo(a='string', i=1, s={'st': 'string', 'arr': [1, 2, 3, 1, 2, 3]})
+
+
+def test_deserialize_with_deep_mapper():
+    class Foo(Structure):
+        a = String
+        i = Integer
+
+    class Bar(Structure):
+        foo = Foo
+        array = Array
+
+    class Example(Structure):
+        bar = Bar
+        number = Integer
+
+    mapper = {'bar._mapper': {'foo._mapper': {"i": FunctionCall(func=lambda x: x * 2)}}}
+    deserializer = Deserializer(target_class=Example, mapper=mapper)
+    deserialized = deserializer.deserialize(
+        {
+            "number": 1,
+            "bar":
+                {
+                    "foo": {
+                        "a": "string",
+                        "i": 10
+                    },
+                    "array": [1, 2]
+                }
+        },
+        keep_undefined=False)
+    assert deserialized == Example(number=1, bar=Bar(foo=Foo(a="string", i=20), array=[1, 2]))
+
+
 def test_deserializer_no_mapper():
     class Foo(Structure):
         m = Map
@@ -840,6 +930,6 @@ class Foo(Structure):
         a = Integer
         blah = Blah
 
-    input_dict = {'a': 3, 'blah': {'x': 3, 'y':4, 'z': 5}}
+    input_dict = {'a': 3, 'blah': {'x': 3, 'y': 4, 'z': 5}}
     bar = deserialize_structure(Foo, input_dict)
     assert bar.blah.z == 5

setup.py

@@ -233,6 +233,16 @@ class Foo(Structure):
     assert serialize(foo.m) == original
 
 
+def test_serialize_with_anything_field():
+    class Foo(Structure):
+        m = Map[String, Anything]
+
+    original = {'a': [1, 2, 3], 'b': 1}
+
+    foo = Foo(m=original)
+    assert serialize(foo.m) == original
+
+
 def test_serialize_with_number(example, serialized_source):
     assert serialize(example.i) == serialized_source['i']
 
@@ -358,6 +368,15 @@ class Foo(Structure):
     assert serialize(foo, mapper=mapper) == {'f': [999], 'i': '5.5'}
 
 
+def test_serialize_invalid_mapper_type():
+    class Foo(Structure):
+        i = Integer
+
+    with raises(TypeError) as excinfo:
+        serialize(Foo(i=1), mapper=[1,2])
+    assert 'Mapper must be a mapping' in str(excinfo.value)
+
+
 def test_serialize_with_mapper_error():
     def my_func(): pass
 
@@ -478,3 +497,17 @@ class Foo(Structure):
     assert Serializer(source=foo.bar1).serialize() == {'x': 3, 'y': 4, 'z': 5}
     s = Serializer(source=foo.bar2)
     assert s.serialize() == None
+
+
+def test_serialize_enum_field_directly():
+    class Values(enum.Enum):
+        ABC = enum.auto()
+        DEF = enum.auto()
+        GHI = enum.auto()
+
+
+    class Foo(Structure):
+        arr = Array[Enum[Values]]
+
+    foo = Foo(arr=[Values.ABC, Values.DEF])
+    assert serialize(foo.arr[0]) == 'ABC'

tests/test_deserialization.py

@@ -26,9 +26,9 @@ deps =
 commands =
     coverage erase
     coverage run --source {toxinidir}/typedpy/ -m pytest {toxinidir}/tests/
-    coverage report --m > coverage.txt
+    coverage report -m > coverage.txt
     coverage html
-    coverage-badge -o coverage.svg
+ #   coverage-badge -o coverage.svg
 deps =
     coverage-badge
     pytest-cov