Merge pull request #270 from Scille/remove_allow_inheritance

Remove allow_inheritance

docs/userguide.rst

@@ -105,7 +105,6 @@ Object orientation means inheritance, of course you can do that
         birthday = fields.DateTimeField()
 
         class Meta:
-            allow_inheritance = True
             abstract = True
 
     @instance.register
@@ -125,9 +124,9 @@ Here we use this to allow ``Animal`` to be inheritable and to make it abstract.
 .. code-block:: python
 
     >>> Animal.opts
-    <DocumentOpts(instance=<umongo.frameworks.PyMongoInstance object at 0x7efe7daa9320>, template=<Document template class '__main__.Animal'>, abstract=True, allow_inheritance=True, collection_name=None, is_child=False, base_schema_cls=<class 'umongo.schema.Schema'>, indexes=[], offspring={<Implementation class '__main__.Duck'>, <Implementation class '__main__.Dog'>})>
+    <DocumentOpts(instance=<umongo.frameworks.PyMongoInstance object at 0x7efe7daa9320>, template=<Document template class '__main__.Animal'>, abstract=True, collection_name=None, is_child=False, base_schema_cls=<class 'umongo.schema.Schema'>, indexes=[], offspring={<Implementation class '__main__.Duck'>, <Implementation class '__main__.Dog'>})>
     >>> Dog.opts
-    <DocumentOpts(instance=<umongo.frameworks.PyMongoInstance object at 0x7efe7daa9320>, template=<Document template class '__main__.Dog'>, abstract=False, allow_inheritance=False, collection_name=dog, is_child=False, base_schema_cls=<class 'umongo.schema.Schema'>, indexes=[], offspring=set())>
+    <DocumentOpts(instance=<umongo.frameworks.PyMongoInstance object at 0x7efe7daa9320>, template=<Document template class '__main__.Dog'>, abstract=False, collection_name=dog, is_child=False, base_schema_cls=<class 'umongo.schema.Schema'>, indexes=[], offspring=set())>
     >>> class NotAllowedSubDog(Dog): pass
     [...]
     DocumentDefinitionError: Document <class '__main__.Dog'> doesn't allow inheritance
@@ -349,8 +348,6 @@ Inheritance inside the same collection is achieve by adding a ``_cls`` field
     >>> @instance.register
     ... class Parent(Document):
     ...     unique_in_parent = fields.IntField(unique=True)
-    ...     class Meta:
-    ...         allow_inheritance = True
     >>> @instance.register
     ... class Child(Parent):
     ...     unique_in_child = fields.StrField(unique=True)
@@ -435,8 +432,6 @@ compounded with the ``_cls``
       >>> @instance.register
       ... class Parent(Document):
       ...     unique_in_parent = fields.IntField(unique=True)
-      ...     class Meta:
-      ...         allow_inheritance = True
       >>> @instance.register
       ... class Child(Parent):
       ...     unique_in_child = fields.StrField(unique=True)

examples/inheritance/app.py

@@ -14,7 +14,6 @@ class Vehicle(Document):
 
     class Meta:
         collection_name = "vehicle"
-        allow_inheritance = True
 
 
 @instance.register

tests/conftest.py

@@ -29,7 +29,4 @@ class Student(Document):
         birthday = fields.DateTimeField()
         courses = fields.ListField(fields.ReferenceField(Course))
 
-        class Meta:
-            allow_inheritance = True
-
     return namedtuple('Mapping', ('Teacher', 'Course', 'Student'))(Teacher, Course, Student)

tests/frameworks/test_motor_asyncio.py

@@ -654,9 +654,6 @@ class UniqueIndexParentDoc(Document):
                 not_unique = fields.StrField(unique=False)
                 unique = fields.IntField(unique=True)
 
-                class Meta:
-                    allow_inheritance = True
-
             @instance.register
             class UniqueIndexChildDoc(UniqueIndexParentDoc):
                 child_not_unique = fields.StrField(unique=False)
@@ -718,16 +715,10 @@ async def do_test():
             class InheritanceSearchParent(Document):
                 pf = fields.IntField()
 
-                class Meta:
-                    allow_inheritance = True
-
             @instance.register
             class InheritanceSearchChild1(InheritanceSearchParent):
                 c1f = fields.IntField()
 
-                class Meta:
-                    allow_inheritance = True
-
             @instance.register
             class InheritanceSearchChild1Child(InheritanceSearchChild1):
                 sc1f = fields.IntField()

tests/frameworks/test_pymongo.py

@@ -503,9 +503,6 @@ class UniqueIndexParentDoc(Document):
             not_unique = fields.StrField(unique=False)
             unique = fields.IntField(unique=True)
 
-            class Meta:
-                allow_inheritance = True
-
         @instance.register
         class UniqueIndexChildDoc(UniqueIndexParentDoc):
             child_not_unique = fields.StrField(unique=False)
@@ -563,16 +560,10 @@ def test_inheritance_search(self, instance):
         class InheritanceSearchParent(Document):
             pf = fields.IntField()
 
-            class Meta:
-                allow_inheritance = True
-
         @instance.register
         class InheritanceSearchChild1(InheritanceSearchParent):
             c1f = fields.IntField()
 
-            class Meta:
-                allow_inheritance = True
-
         @instance.register
         class InheritanceSearchChild1Child(InheritanceSearchChild1):
             sc1f = fields.IntField()

tests/frameworks/test_txmongo.py

@@ -589,9 +589,6 @@ class UniqueIndexParentDoc(Document):
             not_unique = fields.StrField(unique=False)
             unique = fields.IntField(unique=True)
 
-            class Meta:
-                allow_inheritance = True
-
         @instance.register
         class UniqueIndexChildDoc(UniqueIndexParentDoc):
             child_not_unique = fields.StrField(unique=False)
@@ -655,16 +652,10 @@ def test_inheritance_search(self, instance):
         class InheritanceSearchParent(Document):
             pf = fields.IntField()
 
-            class Meta:
-                allow_inheritance = True
-
         @instance.register
         class InheritanceSearchChild1(InheritanceSearchParent):
             c1f = fields.IntField()
 
-            class Meta:
-                allow_inheritance = True
-
         @instance.register
         class InheritanceSearchChild1Child(InheritanceSearchChild1):
             sc1f = fields.IntField()

tests/test_document.py

@@ -217,9 +217,7 @@ def test_auto_id_field(self):
 
         @self.instance.register
         class AutoId(Document):
-
-            class Meta:
-                allow_inheritance = True
+            pass
 
         assert 'id' in AutoId.schema.fields
 
@@ -245,9 +243,6 @@ def test_custom_id_field(self):
         class CustomId(Document):
             int_id = fields.IntField(attribute='_id')
 
-            class Meta:
-                allow_inheritance = True
-
         assert 'id' not in CustomId.schema.fields
         with pytest.raises(ma.ValidationError):
             CustomId(id=my_id)
@@ -310,8 +305,7 @@ def test_inheritance_from_template(self):
         # a template instead of from an implementation
 
         class ParentAsTemplate(Document):
-            class Meta:
-                allow_inheritance = True
+            pass
 
         Parent = self.instance.register(ParentAsTemplate)
 
@@ -324,18 +318,15 @@ class Child(ParentAsTemplate):
     def test_grand_child_inheritance(self):
         @self.instance.register
         class GrandParent(Document):
-            class Meta:
-                allow_inheritance = True
+            pass
 
         @self.instance.register
         class Parent(GrandParent):
-            class Meta:
-                allow_inheritance = True
+            pass
 
         @self.instance.register
         class Uncle(GrandParent):
-            class Meta:
-                allow_inheritance = True
+            pass
 
         @self.instance.register
         class Child(Parent):
@@ -462,7 +453,6 @@ class Doc(Document):
 
         assert Doc.opts.collection_name == 'doc'
         assert Doc.opts.abstract is False
-        assert Doc.opts.allow_inheritance is False
         assert Doc.opts.instance is self.instance
         assert Doc.opts.is_child is False
         assert Doc.opts.indexes == []
@@ -480,7 +470,6 @@ class Meta:
         class DocChild1(AbsDoc):
 
             class Meta:
-                allow_inheritance = True
                 collection_name = 'col1'
 
         @self.instance.register
@@ -495,7 +484,6 @@ class Meta:
 
         assert DocChild1.opts.collection_name is 'col1'
         assert DocChild1Child.opts.collection_name is 'col1'
-        assert DocChild1Child.opts.allow_inheritance is False
         assert DocChild2.opts.collection_name == 'col2'
 
     def test_marshmallow_tags_build(self):
@@ -516,9 +504,6 @@ def test_marshmallow_tags(self):
         class Animal(Document):
             name = fields.StrField(attribute='_id')  # Overwrite automatic pk
 
-            class Meta:
-                allow_inheritance = True
-
         @self.instance.register
         class Dog(Animal):
             pass
@@ -553,32 +538,9 @@ def custom_validate(self, data, original_data, **kwargs):
         exc.value.args[0] == {'name': 'Not suitable name for duck !'}
 
     def test_bad_inheritance(self):
-        with pytest.raises(exceptions.DocumentDefinitionError) as exc:
-            @self.instance.register
-            class BadAbstractDoc(Document):
-                class Meta:
-                    allow_inheritance = False
-                    abstract = True
-        assert exc.value.args[0] == "Abstract document cannot disable inheritance"
-
-        @self.instance.register
-        class NotParent(Document):
-            pass
-
-        assert not NotParent.opts.allow_inheritance
-
-        with pytest.raises(exceptions.DocumentDefinitionError) as exc:
-            @self.instance.register
-            class ImpossibleChildDoc1(NotParent):
-                pass
-        assert exc.value.args[0] == ("Document"
-            " <Implementation class 'tests.test_document.NotParent'>"
-            " doesn't allow inheritance")
-
         @self.instance.register
         class NotAbstractParent(Document):
-            class Meta:
-                allow_inheritance = True
+            pass
 
         with pytest.raises(exceptions.DocumentDefinitionError) as exc:
             @self.instance.register
@@ -590,13 +552,11 @@ class Meta:
         @self.instance.register
         class ParentWithCol1(Document):
             class Meta:
-                allow_inheritance = True
                 collection_name = 'col1'
 
         @self.instance.register
         class ParentWithCol2(Document):
             class Meta:
-                allow_inheritance = True
                 collection_name = 'col2'
 
         with pytest.raises(exceptions.DocumentDefinitionError) as exc:

tests/test_embedded_document.py

@@ -273,9 +273,6 @@ class Meta:
         class ConcreteChild(AbstractParent, AlienClass):
             c = fields.IntField()
 
-            class Meta:
-                allow_inheritance = True
-
         @self.instance.register
         class ConcreteGrandChild(AbstractChild):
             d = fields.IntField()
@@ -317,34 +314,9 @@ class MyDoc(Document):
 
 
     def test_bad_inheritance(self):
-        with pytest.raises(exceptions.DocumentDefinitionError) as exc:
-            @self.instance.register
-            class BadAbstract(EmbeddedDocument):
-                class Meta:
-                    allow_inheritance = False
-                    abstract = True
-        assert exc.value.args[0] == "Abstract embedded document cannot disable inheritance"
-
-        @self.instance.register
-        class NotParent(EmbeddedDocument):
-            class Meta:
-                allow_inheritance = False
-
-        with pytest.raises(exceptions.DocumentDefinitionError) as exc:
-            @self.instance.register
-            class ImpossibleChild1(NotParent):
-                pass
-        assert exc.value.args[0] == ("EmbeddedDocument"
-            " <Implementation class 'tests.test_embedded_document.NotParent'>"
-            " doesn't allow inheritance")
-
         @self.instance.register
         class NotAbstractParent(EmbeddedDocument):
-            class Meta:
-                allow_inheritance = True
-
-        # Unlike Document, EmbeddedDocument should allow inheritance by default
-        assert NotAbstractParent.opts.allow_inheritance
+            pass
 
         with pytest.raises(exceptions.DocumentDefinitionError) as exc:
             @self.instance.register

tests/test_indexes.py

@@ -68,7 +68,6 @@ class Parent(Document):
             last_name = fields.StrField()
 
             class Meta:
-                allow_inheritance = True
                 indexes = ['last_name']
 
         @self.instance.register

tests/test_inheritance.py

@@ -13,9 +13,6 @@ def test_cls_field(self):
         class Parent(Document):
             last_name = fields.StrField()
 
-            class Meta:
-                allow_inheritance = True
-
         @self.instance.register
         class Child(Parent):
             first_name = fields.StrField()
@@ -36,18 +33,15 @@ class Parent(Document):
             last_name = fields.StrField()
 
             class Meta:
-                allow_inheritance = True
                 collection_name = 'parent_col'
 
         assert Parent.opts.abstract is False
-        assert Parent.opts.allow_inheritance is True
 
         @self.instance.register
         class Child(Parent):
             first_name = fields.StrField()
 
         assert Child.opts.abstract is False
-        assert Child.opts.allow_inheritance is False
         assert Child.opts.collection_name == 'parent_col'
         assert Child.collection.name == 'parent_col'
         Child(first_name='John', last_name='Doe')
@@ -70,7 +64,6 @@ class Meta:
                 abstract = True
 
         assert AbstractDoc.opts.abstract is True
-        assert AbstractDoc.opts.allow_inheritance is True
         # Cannot instanciate also an abstract document
         with pytest.raises(exceptions.AbstractDocumentError):
             AbstractDoc()
@@ -81,14 +74,12 @@ class Meta:
                 abstract = True
 
         assert StillAbstractDoc.opts.abstract is True
-        assert StillAbstractDoc.opts.allow_inheritance is True
 
         @self.instance.register
         class ConcreteDoc(AbstractDoc):
             pass
 
         assert ConcreteDoc.opts.abstract is False
-        assert ConcreteDoc.opts.allow_inheritance is False
         assert ConcreteDoc().abs_field == 'from abstract'
 
     def test_non_document_inheritance(self):