Merge pull request #1951 from bagerard/fix_cls_in_constructor

Regression bug fix - _cls not set in constructor

docs/changelog.rst

@@ -5,6 +5,7 @@ Changelog
 Development
 ===========
 - (Fill this out as you fix issues and develop your features).
+- Fix `_cls` that is not set properly in Document constructor (regression) #1950
 - Fix bug in _delta method - Update of a ListField depends on an unrelated dynamic field update #1733
 - Remove deprecated `save()` method and used `insert_one()` #1899
 

mongoengine/base/document.py

@@ -91,6 +91,9 @@ class BaseDocument(object):
             value = getattr(self, key, None)
             setattr(self, key, value)
 
+        if '_cls' not in values:
+            self._cls = self._class_name
+
         # Set passed values after initialisation
         if self._dynamic:
             dynamic_data = {}

tests/document/inheritance.py

@@ -2,11 +2,11 @@
 import unittest
 import warnings
 
-from tests.fixtures import Base
-
-from mongoengine import Document, EmbeddedDocument, connect, ReferenceField,\
-    BooleanField, GenericReferenceField, IntField, StringField
+from mongoengine import (BooleanField, Document, EmbeddedDocument,
+                         EmbeddedDocumentField, GenericReferenceField,
+                         IntField, ReferenceField, StringField, connect)
 from mongoengine.connection import get_db
+from tests.fixtures import Base
 
 __all__ = ('InheritanceTest', )
 
@@ -23,6 +23,27 @@ class InheritanceTest(unittest.TestCase):
                 continue
             self.db.drop_collection(collection)
 
+    def test_constructor_cls(self):
+        # Ensures _cls is properly set during construction
+        # and when object gets reloaded (prevent regression of #1950)
+        class EmbedData(EmbeddedDocument):
+            data = StringField()
+            meta = {'allow_inheritance': True}
+
+        class DataDoc(Document):
+            name = StringField()
+            embed = EmbeddedDocumentField(EmbedData)
+            meta = {'allow_inheritance': True}
+
+        test_doc = DataDoc(name='test', embed=EmbedData(data='data'))
+        assert test_doc._cls == 'DataDoc'
+        assert test_doc.embed._cls == 'EmbedData'
+        test_doc.save()
+        saved_doc = DataDoc.objects.with_id(test_doc.id)
+        assert test_doc._cls == saved_doc._cls
+        assert test_doc.embed._cls == saved_doc.embed._cls
+        test_doc.delete()
+
     def test_superclasses(self):
         """Ensure that the correct list of superclasses is assembled.
         """