pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve the error message that mentions that Document cant be subclassed

Browse Source
This commit is contained in:
Bastien Gérard 2018-10-10 23:13:34 +02:00
parent 55fc04752a
commit 556f7e85fc
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
mongoengine/base/metaclasses.py
View File

@ -121,7 +121,8 @@ class DocumentMetaclass(type):
# inheritance of classes where inheritance is set to False # inheritance of classes where inheritance is set to False
allow_inheritance = base._meta.get('allow_inheritance') allow_inheritance = base._meta.get('allow_inheritance')
if not allow_inheritance and not base._meta.get('abstract'): if not allow_inheritance and not base._meta.get('abstract'):
raise ValueError('Document %s may not be subclassed' % raise ValueError('Document %s may not be subclassed. '
'To enable inheritance, use the "allow_inheritance" meta attribute.' %
base.__name__) base.__name__)
# Get superclasses from last base superclass # Get superclasses from last base superclass

8
tests/document/inheritance.py
View File

@ -258,9 +258,10 @@ class InheritanceTest(unittest.TestCase):
name = StringField() name = StringField()
# can't inherit because Animal didn't explicitly allow inheritance # can't inherit because Animal didn't explicitly allow inheritance
with self.assertRaises(ValueError): with self.assertRaises(ValueError) as cm:
class Dog(Animal): class Dog(Animal):
pass pass
self.assertIn("Document Animal may not be subclassed", str(cm.exception))
# Check that _cls etc aren't present on simple documents # Check that _cls etc aren't present on simple documents
dog = Animal(name='dog').save() dog = Animal(name='dog').save()
@ -277,9 +278,10 @@ class InheritanceTest(unittest.TestCase):
name = StringField() name = StringField()
meta = {'allow_inheritance': True} meta = {'allow_inheritance': True}
with self.assertRaises(ValueError): with self.assertRaises(ValueError) as cm:
class Mammal(Animal): class Mammal(Animal):
meta = {'allow_inheritance': False} meta = {'allow_inheritance': False}
self.assertEqual(str(cm.exception), 'Only direct subclasses of Document may set "allow_inheritance" to False')
def test_allow_inheritance_abstract_document(self): def test_allow_inheritance_abstract_document(self):
"""Ensure that abstract documents can set inheritance rules and that """Ensure that abstract documents can set inheritance rules and that
@ -292,7 +294,7 @@ class InheritanceTest(unittest.TestCase):
class Animal(FinalDocument): class Animal(FinalDocument):
name = StringField() name = StringField()
with self.assertRaises(ValueError): with self.assertRaises(ValueError) as cm:
class Mammal(Animal): class Mammal(Animal):
pass pass