Fix ReferenceField dbref = False

Update docs/index.rst

docs/changelog.rst

@@ -2,6 +2,27 @@
 Changelog
 =========
 
+Changes in 0.7.5
+================
+- ReferenceFields with dbref=False use ObjectId instead of strings (MongoEngine/mongoengine#134)
+  See ticket for upgrade notes (https://github.com/MongoEngine/mongoengine/issues/134)
+
+Changes in 0.7.4
+================
+- Fixed index inheritance issues - firmed up testcases (MongoEngine/mongoengine#123) (MongoEngine/mongoengine#125)
+
+Changes in 0.7.3
+================
+- Reverted EmbeddedDocuments meta handling - now can turn off inheritance (MongoEngine/mongoengine#119)
+
+Changes in 0.7.2
+================
+- Update index spec generation so its not destructive (MongoEngine/mongoengine#113)
+
+Changes in 0.7.1
+=================
+- Fixed index spec inheritance (MongoEngine/mongoengine#111)
+
 Changes in 0.7.0
 =================
 - Updated queryset.delete so you can use with skip / limit (MongoEngine/mongoengine#107)

docs/guide/defining-documents.rst

@@ -344,6 +344,10 @@ Its value can take any of the following constants:
    their :file:`models.py` in the :const:`INSTALLED_APPS` tuple.
 
 
+.. warning::
+   Signals are not triggered when doing cascading updates / deletes - if this
+   is required you must manually handle the update / delete.
+
 Generic reference fields
 ''''''''''''''''''''''''
 A second kind of reference field also exists,

docs/guide/signals.rst

@@ -50,4 +50,11 @@ Example usage::
     signals.post_save.connect(Author.post_save, sender=Author)
 
 
+ReferenceFields and signals
+---------------------------
+
+Currently `reverse_delete_rules` do not trigger signals on the other part of
+the relationship.  If this is required you must manually handled the
+reverse deletion.
+
 .. _blinker: http://pypi.python.org/pypi/blinker

docs/index.rst

@@ -34,10 +34,10 @@ To get help with using MongoEngine, use the `MongoEngine Users mailing list
 Contributing
 ------------
 
-The source is available on `GitHub <http://github.com/hmarr/mongoengine>`_ and
+The source is available on `GitHub <http://github.com/MongoEngine/mongoengine>`_ and
 contributions are always encouraged. Contributions can be as simple as
 minor tweaks to this documentation. To contribute, fork the project on
-`GitHub <http://github.com/hmarr/mongoengine>`_ and send a
+`GitHub <http://github.com/MongoEngine/mongoengine>`_ and send a
 pull request.
 
 Also, you can join the developers' `mailing list

docs/upgrade.rst

@@ -61,6 +61,13 @@ stored in rather than as string representations.  Your code may need to be
 updated to handle native types rather than strings keys for the results of
 item frequency queries.
 
+BinaryFields
+------------
+
+Binary fields have been updated so that they are native binary types.  If you
+previously were doing `str` comparisons with binary field values you will have
+to update and wrap the value in a `str`.
+
 0.5 to 0.6
 ==========
 

mongoengine/__init__.py

@@ -12,7 +12,7 @@ from signals import *
 __all__ = (document.__all__ + fields.__all__ + connection.__all__ +
            queryset.__all__ + signals.__all__)
 
-VERSION = (0, 7, 0)
+VERSION = (0, 7, 5)
 
 
 def get_version():

mongoengine/base.py

@@ -508,6 +508,10 @@ class DocumentMetaclass(type):
 
         attrs['_is_document'] = attrs.get('_is_document', False)
 
+        # EmbeddedDocuments could have meta data for inheritance
+        if 'meta' in attrs:
+            attrs['_meta'] = attrs.pop('meta')
+
         # Handle document Fields
 
         # Merge all fields from subclasses
@@ -571,6 +575,24 @@ class DocumentMetaclass(type):
                 superclasses[base._class_name] = base
                 superclasses.update(base._superclasses)
 
+            if hasattr(base, '_meta'):
+                # Warn if allow_inheritance isn't set and prevent
+                # inheritance of classes where inheritance is set to False
+                allow_inheritance = base._meta.get('allow_inheritance',
+                                                    ALLOW_INHERITANCE)
+                if (not getattr(base, '_is_base_cls', True)
+                    and allow_inheritance is None):
+                    warnings.warn(
+                        "%s uses inheritance, the default for "
+                        "allow_inheritance is changing to off by default. "
+                        "Please add it to the document meta." % name,
+                        FutureWarning
+                    )
+                elif (allow_inheritance == False and
+                      not base._meta.get('abstract')):
+                    raise ValueError('Document %s may not be subclassed' %
+                                      base.__name__)
+
         attrs['_class_name'] = '.'.join(reversed(class_name))
         attrs['_superclasses'] = superclasses
 
@@ -745,21 +767,6 @@ class TopLevelDocumentMetaclass(DocumentMetaclass):
             if hasattr(base, 'meta'):
                 meta.merge(base.meta)
             elif hasattr(base, '_meta'):
-                # Warn if allow_inheritance isn't set and prevent
-                # inheritance of classes where inheritance is set to False
-                allow_inheritance = base._meta.get('allow_inheritance',
-                                                    ALLOW_INHERITANCE)
-                if not base._is_base_cls and allow_inheritance is None:
-                    warnings.warn(
-                        "%s uses inheritance, the default for "
-                        "allow_inheritance is changing to off by default. "
-                        "Please add it to the document meta." % name,
-                        FutureWarning
-                    )
-                elif (allow_inheritance == False and
-                      not base._meta.get('abstract')):
-                    raise ValueError('Document %s may not be subclassed' %
-                                      base.__name__)
                 meta.merge(base._meta)
 
             # Set collection in the meta if its callable

mongoengine/document.py

@@ -25,6 +25,14 @@ class EmbeddedDocument(BaseDocument):
     collection.  :class:`~mongoengine.EmbeddedDocument`\ s should be used as
     fields on :class:`~mongoengine.Document`\ s through the
     :class:`~mongoengine.EmbeddedDocumentField` field type.
+
+    A :class:`~mongoengine.EmbeddedDocument` subclass may be itself subclassed,
+    to create a specialised version of the embedded document that will be
+    stored in the same collection. To facilitate this behaviour, `_cls` and
+    `_types` fields are added to documents (hidden though the MongoEngine
+    interface though). To disable this behaviour and remove the dependence on
+    the presence of `_cls` and `_types`, set :attr:`allow_inheritance` to
+    ``False`` in the :attr:`meta` dictionary.
     """
 
     # The __metaclass__ attribute is removed by 2to3 when running with Python3

mongoengine/fields.py

@@ -709,6 +709,10 @@ class ReferenceField(BaseField):
 
         Bar.register_delete_rule(Foo, 'bar', NULLIFY)
 
+    .. note ::
+        `reverse_delete_rules` do not trigger pre / post delete signals to be
+        triggered.
+
     .. versionchanged:: 0.5 added `reverse_delete_rule`
     """
 
@@ -788,7 +792,7 @@ class ReferenceField(BaseField):
             collection = self.document_type._get_collection_name()
             return DBRef(collection, id_)
 
-        return "%s" % id_
+        return id_
 
     def to_python(self, value):
         """Convert a MongoDB-compatible type to a Python type.

mongoengine/queryset.py

@@ -398,6 +398,7 @@ class QuerySet(object):
             or a **-** to determine the index ordering
         """
         index_spec = QuerySet._build_index_spec(self._document, key_or_list)
+        index_spec = index_spec.copy()
         fields = index_spec.pop('fields')
         index_spec['drop_dups'] = drop_dups
         index_spec['background'] = background
@@ -472,7 +473,9 @@ class QuerySet(object):
 
         # Ensure document-defined indexes are created
         if self._document._meta['index_specs']:
-            for spec in self._document._meta['index_specs']:
+            index_spec = self._document._meta['index_specs']
+            for spec in index_spec:
+                spec = spec.copy()
                 fields = spec.pop('fields')
                 types_indexed = types_indexed or includes_types(fields)
                 opts = index_opts.copy()
@@ -498,8 +501,10 @@ class QuerySet(object):
         """
         if isinstance(spec, basestring):
             spec = {'fields': [spec]}
-        if isinstance(spec, (list, tuple)):
-            spec = {'fields': spec}
+        elif isinstance(spec, (list, tuple)):
+            spec = {'fields': list(spec)}
+        elif isinstance(spec, dict):
+            spec = dict(spec)
 
         index_list = []
         direction = None
@@ -510,6 +515,10 @@ class QuerySet(object):
         use_types = allow_inheritance and not spec.get('sparse', False)
 
         for key in spec['fields']:
+            # If inherited spec continue
+            if isinstance(key, (list, tuple)):
+                continue
+
             # Get ASCENDING direction from +, DESCENDING from -, and GEO2D from *
             direction = pymongo.ASCENDING
             if key.startswith("-"):

python-mongoengine.spec

@@ -5,7 +5,7 @@
 %define srcname mongoengine
 
 Name:           python-%{srcname}
-Version:        0.7.0
+Version:        0.7.5
 Release:        1%{?dist}
 Summary:        A Python Document-Object Mapper for working with MongoDB
 

tests/test_dereference.py

@@ -1,7 +1,7 @@
 from __future__ import with_statement
 import unittest
 
-from bson import DBRef
+from bson import DBRef, ObjectId
 
 from mongoengine import *
 from mongoengine.connection import get_db
@@ -187,8 +187,8 @@ class FieldTest(unittest.TestCase):
         self.assertEqual(group.members, [user])
 
         raw_data = Group._get_collection().find_one()
-        self.assertTrue(isinstance(raw_data['author'], basestring))
-        self.assertTrue(isinstance(raw_data['members'][0], basestring))
+        self.assertTrue(isinstance(raw_data['author'], ObjectId))
+        self.assertTrue(isinstance(raw_data['members'][0], ObjectId))
 
     def test_recursive_reference(self):
         """Ensure that ReferenceFields can reference their own documents.

tests/test_document.py

@@ -338,7 +338,6 @@ class DocumentTest(unittest.TestCase):
                 meta = {'allow_inheritance': False}
         self.assertRaises(ValueError, create_employee_class)
 
-
     def test_allow_inheritance_abstract_document(self):
         """Ensure that abstract documents can set inheritance rules and that
         _cls and _types will not be used.
@@ -366,6 +365,31 @@ class DocumentTest(unittest.TestCase):
 
         Animal.drop_collection()
 
+    def test_allow_inheritance_embedded_document(self):
+
+        # Test the same for embedded documents
+        class Comment(EmbeddedDocument):
+            content = StringField()
+            meta = {'allow_inheritance': False}
+
+        def create_special_comment():
+            class SpecialComment(Comment):
+                pass
+
+        self.assertRaises(ValueError, create_special_comment)
+
+        comment = Comment(content='test')
+        self.assertFalse('_cls' in comment.to_mongo())
+        self.assertFalse('_types' in comment.to_mongo())
+
+        class Comment(EmbeddedDocument):
+            content = StringField()
+            meta = {'allow_inheritance': True}
+
+        comment = Comment(content='test')
+        self.assertTrue('_cls' in comment.to_mongo())
+        self.assertTrue('_types' in comment.to_mongo())
+
     def test_document_inheritance(self):
         """Ensure mutliple inheritance of abstract docs works
         """
@@ -396,6 +420,9 @@ class DocumentTest(unittest.TestCase):
                 'indexes': ['name']
             }
 
+        self.assertEqual(Animal._meta['index_specs'],
+                         [{'fields': [('_types', 1), ('name', 1)]}])
+
         Animal.drop_collection()
 
         dog = Animal(name='dog')
@@ -417,6 +444,9 @@ class DocumentTest(unittest.TestCase):
                 'allow_inheritance': False,
                 'indexes': ['name']
             }
+
+        self.assertEqual(Animal._meta['index_specs'],
+                         [{'fields': [('name', 1)]}])
         collection.update({}, {"$unset": {"_types": 1, "_cls": 1}},  multi=True)
 
         # Confirm extra data is removed
@@ -634,6 +664,12 @@ class DocumentTest(unittest.TestCase):
                 'allow_inheritance': True
             }
 
+        self.assertEqual(BlogPost._meta['index_specs'],
+                         [{'fields': [('_types', 1), ('addDate', -1)]},
+                          {'fields': [('tags', 1)]},
+                          {'fields': [('_types', 1), ('category', 1),
+                                      ('addDate', -1)]}])
+
         BlogPost.drop_collection()
 
         info = BlogPost.objects._collection.index_information()
@@ -657,6 +693,13 @@ class DocumentTest(unittest.TestCase):
             title = StringField()
             meta = {'indexes': ['title']}
 
+        self.assertEqual(ExtendedBlogPost._meta['index_specs'],
+                         [{'fields': [('_types', 1), ('addDate', -1)]},
+                          {'fields': [('tags', 1)]},
+                          {'fields': [('_types', 1), ('category', 1),
+                                      ('addDate', -1)]},
+                          {'fields': [('_types', 1), ('title', 1)]}])
+
         BlogPost.drop_collection()
 
         list(ExtendedBlogPost.objects)
@@ -669,6 +712,46 @@ class DocumentTest(unittest.TestCase):
 
         BlogPost.drop_collection()
 
+    def test_inherited_index(self):
+        """Ensure index specs are inhertited correctly"""
+
+        class A(Document):
+            title = StringField()
+            meta = {
+                'indexes': [
+                        {
+                        'fields': ('title',),
+                        },
+                ],
+                'allow_inheritance': True,
+                }
+
+        class B(A):
+            description = StringField()
+
+        self.assertEqual(A._meta['index_specs'], B._meta['index_specs'])
+        self.assertEqual([{'fields': [('_types', 1), ('title', 1)]}],
+                         A._meta['index_specs'])
+
+    def test_build_index_spec_is_not_destructive(self):
+
+        class MyDoc(Document):
+            keywords = StringField()
+
+            meta = {
+                'indexes': ['keywords'],
+                'allow_inheritance': False
+            }
+
+        self.assertEqual(MyDoc._meta['index_specs'],
+                         [{'fields': [('keywords', 1)]}])
+
+        # Force index creation
+        MyDoc.objects._ensure_indexes()
+
+        self.assertEqual(MyDoc._meta['index_specs'],
+                        [{'fields': [('keywords', 1)]}])
+
     def test_db_field_load(self):
         """Ensure we load data correctly
         """
@@ -729,6 +812,9 @@ class DocumentTest(unittest.TestCase):
                 'allow_inheritance': False
             }
 
+        self.assertEqual([{'fields': [('rank.title', 1)]}],
+                        Person._meta['index_specs'])
+
         Person.drop_collection()
 
         # Indexes are lazy so use list() to perform query
@@ -747,6 +833,10 @@ class DocumentTest(unittest.TestCase):
                     '*location.point',
                 ],
             }
+
+        self.assertEqual([{'fields': [('location.point', '2d')]}],
+                        Place._meta['index_specs'])
+
         Place.drop_collection()
 
         info = Place.objects._collection.index_information()
@@ -772,6 +862,10 @@ class DocumentTest(unittest.TestCase):
                 ],
             }
 
+        self.assertEqual([{'fields': [('addDate', -1)], 'unique': True,
+                          'sparse': True, 'types': False}],
+                        BlogPost._meta['index_specs'])
+
         BlogPost.drop_collection()
 
         info = BlogPost.objects._collection.index_information()

tests/test_fields.py

@@ -7,7 +7,7 @@ import tempfile
 
 from decimal import Decimal
 
-from bson import Binary, DBRef
+from bson import Binary, DBRef, ObjectId
 import gridfs
 
 from nose.plugins.skip import SkipTest
@@ -1104,7 +1104,7 @@ class FieldTest(unittest.TestCase):
         p = Person.objects.get(name="Ross")
         self.assertEqual(p.parent, p1)
 
-    def test_str_reference_fields(self):
+    def test_objectid_reference_fields(self):
 
         class Person(Document):
             name = StringField()
@@ -1117,7 +1117,7 @@ class FieldTest(unittest.TestCase):
 
         col = Person._get_collection()
         data = col.find_one({'name': 'Ross'})
-        self.assertEqual(data['parent'], "%s" % p1.pk)
+        self.assertEqual(data['parent'], p1.pk)
 
         p = Person.objects.get(name="Ross")
         self.assertEqual(p.parent, p1)