Merge pull request #125 from python-odin/development

Release 1.8

Author: timsavage

HISTORY

@@ -1,3 +1,11 @@
+1.8.0
+=====
+
+- Allow types to be resolved by assuming a types names space (simplifies
+  specification of types where the full name space can be assumed)
+- Inherit a custom type_field (this could cause unexpected side effects,
+  although unlikely as this is a required change)
+
 1.7.3
 =====
 

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "odin"
-version = "1.7.3"
+version = "1.8.0"
 description = "Data-structure definition/validation/traversal, mapping and serialisation toolkit for Python"
 authors = ["Tim Savage <tim@savage.company>"]
 license = "BSD-3-Clause"

pyproject.toml

@@ -8,7 +8,7 @@
 
 class CurriedAdapter(object):
     """
-    Curry wrapper for a Adapter to allow for pre-config of include/exclude and
+    Curry wrapper for an Adapter to allow for pre-config of include/exclude and
     any other user defined arguments provided in kwargs.
     """
 

src/odin/adapters.py

@@ -11,7 +11,7 @@
 resource will be exported (if multiple are defined they will all be exported
 into the one text block).
 
-The TextField is for all intensive purposes just a StringField, other codecs
+The TextField is for all intents and purposes just a StringField, other codecs
 will export any value as a String.
 
 """

src/odin/codecs/xml_codec.py

@@ -54,7 +54,7 @@ def __init__(self, meta):
         self.verbose_name_plural = None
         self.abstract = False
         self.doc_group = None
-        self.type_field = DEFAULT_TYPE_FIELD
+        self.type_field = NotProvided
         self.key_field_names = None
         self.field_sorting = NotProvided
         self.user_data = None
@@ -292,14 +292,18 @@ def __new__(mcs, name, bases, attrs):
         new_meta = mcs.meta_options(meta)
         new_class.add_to_class("_meta", new_meta)
 
-        # Namespace is inherited
+        # Namespace is inherited and default if not provided
         if base_meta and new_meta.name_space is NotProvided:
             new_meta.name_space = base_meta.name_space
-
-        # Generate a namespace if one is not provided
         if new_meta.name_space is NotProvided:
             new_meta.name_space = module
 
+        # Type field is inherited and default if not provided
+        if base_meta and new_meta.type_field is NotProvided:
+            new_meta.type_field = base_meta.type_field
+        if new_meta.type_field is NotProvided:
+            new_meta.type_field = DEFAULT_TYPE_FIELD
+
         # Key field is inherited
         if base_meta and new_meta.key_field_names is None:
             new_meta.key_field_names = base_meta.key_field_names
@@ -570,9 +574,9 @@ class Resource(six.with_metaclass(ResourceType, ResourceBase)):
 def resolve_resource_type(resource):
     if isinstance(resource, type) and issubclass(resource, ResourceBase):
         meta = getmeta(resource)
-        return meta.resource_name, meta.type_field
+        return meta.resource_name, meta.type_field, meta.name_space
     else:
-        return resource, DEFAULT_TYPE_FIELD
+        return resource, DEFAULT_TYPE_FIELD, ""
 
 
 def create_resource_from_iter(
@@ -647,11 +651,16 @@ def _resolve_type_from_resource(data, resource):
     else:
         resources = [resolve_resource_type(resource)]
 
-    for resource_name, type_field in resources:
+    for resource_name, type_field, name_space in resources:
         # See if the input includes a type field and check it's registered
         document_resource_name = data.get(type_field, None)
         if document_resource_name:
             resource_type = registration.get_resource(document_resource_name)
+            # Fall back to try applying a prefix
+            if not resource_type and name_space:
+                resource_type = registration.get_resource(
+                    "{}.{}".format(name_space, document_resource_name)
+                )
         else:
             resource_type = registration.get_resource(resource_name)
 
@@ -702,9 +711,12 @@ def _resolve_type_from_data(data):
 
 
 def create_resource_from_dict(
-    d, resource=None, full_clean=True, copy_dict=True, default_to_not_provided=False
+    d,  # type: Dict[str, Any]
+    resource=None,  # type: Type[R]
+    full_clean=True,  # type: bool
+    copy_dict=True,  # type: bool
+    default_to_not_provided=False,  # type: bool
 ):
-    # type: (Dict[str, Any], Type[R], bool, bool, bool) -> R
     """
     Create a resource from a dict.
 
@@ -764,7 +776,11 @@ def create_resource_from_dict(
 
 
 def build_object_graph(
-    d, resource=None, full_clean=True, copy_dict=True, default_to_not_supplied=False
+    d,  # type: Dict[str, Any]
+    resource=None,  # type: Type[R]
+    full_clean=True,  # type: bool
+    copy_dict=True,  # type: bool
+    default_to_not_supplied=False,  # type: bool
 ):
     """
     Generate an object graph from a dict

src/odin/resources.py

@@ -0,0 +1,60 @@
+"""
+Tests of polymorphic behaviours
+"""
+import pytest
+
+import odin
+from odin.resources import create_resource_from_dict
+from odin.utils import getmeta
+
+
+class AbstractResource(odin.Resource):
+    class Meta:
+        abstract = True
+        namespace = "au.com.example.abstracts"
+        type_field = "type"
+
+
+class ResourceA(AbstractResource):
+    class Meta:
+        type_field = "type"
+
+
+class ResourceB(AbstractResource):
+    pass
+
+
+def test_resolve_resource_using_full_type_field():
+    actual = create_resource_from_dict(
+        {"type": "au.com.example.abstracts.ResourceA"},
+        AbstractResource,
+        full_clean=False,
+    )
+
+    assert isinstance(actual, ResourceA)
+
+
+def test_resolve_resource_using_partial_type_field():
+    actual = create_resource_from_dict(
+        {"type": "ResourceB"},
+        AbstractResource,
+        full_clean=False,
+    )
+
+    assert isinstance(actual, ResourceB)
+
+
+@pytest.mark.parametrize("resource", (ResourceA, ResourceB))
+def test_type_field_is_inherited(resource):
+    expected = getmeta(AbstractResource).type_field
+    actual = getmeta(resource).type_field
+
+    assert actual == expected
+
+
+@pytest.mark.parametrize("resource", (ResourceA, ResourceB))
+def test_name_space_is_inherited(resource):
+    expected = getmeta(AbstractResource).name_space
+    actual = getmeta(resource).name_space
+
+    assert actual == expected