Additional test cases for shadow fields

Author: timsavage

tests/resources.py

@@ -29,6 +29,7 @@ class Meta:
 class Book(LibraryBook):
     class Meta:
         key_field_name = "isbn"
+        allow_field_shadowing = True
 
     title = odin.StringField()
     isbn = odin.StringField()
@@ -54,6 +55,17 @@ def __eq__(self, other):
         return False
 
 
+class AltBook(Book):
+    """A special case of book.
+
+    This is a special case of book that has a limit on the length of the title.
+
+    And to test overriding fields.
+    """
+
+    title = odin.StringField(max_length=10)
+
+
 class From(enum.Enum):
     Dumpster = "dumpster"
     Shop = "shop"

tests/resources_annotated.py

@@ -36,6 +36,7 @@ class Book(LibraryBook):
     class Meta:
         namespace = "annotated"
         key_field_name = "isbn"
+        allow_field_shadowing = True
 
     title: str
     isbn: str = odin.Options(
@@ -70,6 +71,17 @@ def __eq__(self, other):
         return False
 
 
+class AltBook(Book):
+    """A special case of book.
+
+    This is a special case of book that has a limit on the length of the title.
+
+    And to test overriding fields.
+    """
+
+    title: str = odin.Options(max_length=10)
+
+
 class From(enum.Enum):
     Dumpster = "dumpster"
     Shop = "shop"

tests/test_annotated_resources.py

@@ -10,6 +10,7 @@
     InheritedCamelCaseResource,
     Library,
     Publisher,
+    AltBook,
 )
 
 
@@ -32,9 +33,13 @@ def test_fields_are_identified_in_correct_order(self):
 
 class TestAnnotatedResource:
     def test_fields_are_inherited_from_parent_resources(self):
-        meta = getmeta(IdentifiableBook)
+        target = getmeta(IdentifiableBook)
 
-        assert [f.name for f in meta.fields] == [
+        actual = target.fields
+
+        assert [f.name for f in actual] == [
+            "id",
+            "purchased_from",
             "title",
             "isbn",
             "num_pages",
@@ -44,8 +49,6 @@ def test_fields_are_inherited_from_parent_resources(self):
             "published",
             "authors",
             "publisher",
-            "id",
-            "purchased_from",
         ]
 
     def test_cached_properties_work_as_expected(self):
@@ -64,7 +67,15 @@ def test_field_name_format(self):
 
         actual = [field.name for field in options.fields]
 
-        assert actual == ["fullName", "yearOfBirth", "emailAddress"]
+        assert actual == ["emailAddress", "fullName", "yearOfBirth"]
+
+    def test_shadow_fields_are_identified(self):
+        target = getmeta(AltBook)
+
+        actual = target.shadow_fields
+
+        assert isinstance(actual, tuple)
+        assert [f.name for f in actual] == ["title"]
 
 
 class TestAnnotatedKitchenSink:

tests/test_resources.py

@@ -11,7 +11,14 @@
 )
 from odin.utils import getmeta, snake_to_camel
 
-from .resources import Book, BookProxy, InheritedCamelCaseResource, Library, Subscriber
+from .resources import (
+    Book,
+    BookProxy,
+    InheritedCamelCaseResource,
+    Library,
+    Subscriber,
+    AltBook,
+)
 
 
 class Author(odin.Resource):
@@ -226,6 +233,14 @@ def test_use_a_reserved_field(self):
             class InvalidFieldsResource(Resource):
                 fields = odin.StringField()
 
+    def test_shadow_fields_are_identified(self):
+        target = getmeta(AltBook)
+
+        actual = target.shadow_fields
+
+        assert isinstance(actual, tuple)
+        assert [f.name for f in actual] == ["title"]
+
 
 class TestConstructionMethods:
     def test_build_object_graph_empty_dict_no_clean(self):
@@ -393,3 +408,13 @@ def test_field_name_format(self):
         actual = [field.name for field in options.fields]
 
         assert actual == ["fullName", "yearOfBirth", "emailAddress"]
+
+    def test_shadowing(self):
+        actual = AltBook(title="Foo", isbn="123456")
+
+        getmeta(actual)
+
+        book = Book(title="Foo", isbn="123456")
+
+        assert book.isbn == "123456"
+        assert book.title == "Foo"