extra note in the docstring [ci skip]

.install_mongodb_on_travis.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 7F0CEB10
+
+if [ "$MONGODB" = "2.4" ]; then
+    echo "deb http://downloads-distro.mongodb.org/repo/ubuntu-upstart dist 10gen" | sudo tee /etc/apt/sources.list.d/mongodb.list
+    sudo apt-get update
+    sudo apt-get install mongodb-10gen=2.4.14
+    sudo service mongodb start
+elif [ "$MONGODB" = "2.6" ]; then
+    echo "deb http://downloads-distro.mongodb.org/repo/ubuntu-upstart dist 10gen" | sudo tee /etc/apt/sources.list.d/mongodb.list
+    sudo apt-get update
+    sudo apt-get install mongodb-org-server=2.6.12
+    # service should be started automatically
+elif [ "$MONGODB" = "3.0" ]; then
+    echo "deb http://repo.mongodb.org/apt/ubuntu precise/mongodb-org/3.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb.list
+    sudo apt-get update
+    sudo apt-get install mongodb-org-server=3.0.14
+    # service should be started automatically
+else
+    echo "Invalid MongoDB version, expected 2.4, 2.6, or 3.0."
+    exit 1
+fi;

.travis.yml

@@ -2,73 +2,67 @@
 # PyMongo combinations. However, that would result in an overly long build
 # with a very large number of jobs, hence we only test a subset of all the
 # combinations:
-# * MongoDB v3.4 & the latest PyMongo v3.x is currently the "main" setup,
-#   tested against Python v2.7, v3.5, v3.6, and PyPy.
-# * Besides that, we test the lowest actively supported Python/MongoDB/PyMongo
-#   combination: MongoDB v3.4, PyMongo v3.4, Python v2.7.
-# * MongoDB v3.6 is tested against Python v3.6, and PyMongo v3.6, v3.7, v3.8.
-#
-# We should periodically check MongoDB Server versions supported by MongoDB
-# Inc., add newly released versions to the test matrix, and remove versions
-# which have reached their End of Life. See:
-# 1. https://www.mongodb.com/support-policy.
-# 2. https://docs.mongodb.com/ecosystem/drivers/driver-compatibility-reference/#python-driver-compatibility
+# * MongoDB v2.4 & v3.0 are only tested against Python v2.7 & v3.5.
+# * MongoDB v2.4 is tested against PyMongo v2.7 & v3.x.
+# * MongoDB v3.0 is tested against PyMongo v3.x.
+# * MongoDB v2.6 is currently the "main" version tested against Python v2.7,
+#   v3.5, PyPy & PyPy3, and PyMongo v2.7, v2.8 & v3.x.
 #
 # Reminder: Update README.rst if you change MongoDB versions we test.
 
-
 language: python
+
 python:
 - 2.7
 - 3.5
-- 3.6
 - pypy
 
-dist: xenial
-
 env:
-  global:
-    - MONGODB_3_4=3.4.17
-    - MONGODB_3_6=3.6.12
-  matrix:
-    - MONGODB=${MONGODB_3_4} PYMONGO=3.x
+- MONGODB=2.6 PYMONGO=2.7
+- MONGODB=2.6 PYMONGO=2.8
+- MONGODB=2.6 PYMONGO=3.0
 
 matrix:
-
   # Finish the build as soon as one job fails
   fast_finish: true
 
   include:
   - python: 2.7
-    env: MONGODB=${MONGODB_3_4} PYMONGO=3.4.x
-  - python: 3.6
-    env: MONGODB=${MONGODB_3_6} PYMONGO=3.x
-  - python: 3.7
-    env: MONGODB=${MONGODB_3_6} PYMONGO=3.x
+    env: MONGODB=2.4 PYMONGO=2.7
+  - python: 2.7
+    env: MONGODB=2.4 PYMONGO=3.0
+  - python: 2.7
+    env: MONGODB=3.0 PYMONGO=3.0
+  - python: 3.5
+    env: MONGODB=2.4 PYMONGO=2.7
+  - python: 3.5
+    env: MONGODB=2.4 PYMONGO=3.0
+  - python: 3.5
+    env: MONGODB=3.0 PYMONGO=3.0
 
+before_install:
+- bash .install_mongodb_on_travis.sh
 
 install:
-  # Install Mongo
-  - wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-${MONGODB}.tgz
-  - tar xzf mongodb-linux-x86_64-${MONGODB}.tgz
-  - ${PWD}/mongodb-linux-x86_64-${MONGODB}/bin/mongod --version
-  # Install python dependencies
-  - pip install --upgrade pip
-  - pip install coveralls
-  - pip install flake8 flake8-import-order
-  - pip install tox         # tox 3.11.0 has requirement virtualenv>=14.0.0
-  - pip install virtualenv  # virtualenv>=14.0.0 has dropped Python 3.2 support (and pypy3 is based on py32)
-  # Install the tox venv
-  - tox -e $(echo py$TRAVIS_PYTHON_VERSION-mg$PYMONGO | tr -d . | sed -e 's/pypypy/pypy/') -- -e test
+- sudo apt-get install python-dev python3-dev libopenjpeg-dev zlib1g-dev libjpeg-turbo8-dev
+  libtiff4-dev libjpeg8-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.5-dev tk8.5-dev
+  python-tk
+- travis_retry pip install --upgrade pip
+- travis_retry pip install coveralls
+- travis_retry pip install flake8 flake8-import-order
+- travis_retry pip install tox>=1.9
+- travis_retry pip install "virtualenv<14.0.0"  # virtualenv>=14.0.0 has dropped Python 3.2 support (and pypy3 is based on py32)
+- travis_retry tox -e $(echo py$TRAVIS_PYTHON_VERSION-mg$PYMONGO | tr -d . | sed -e 's/pypypy/pypy/') -- -e test
 
+# Cache dependencies installed via pip
+cache: pip
+
+# Run flake8 for py27
 before_script:
-  - mkdir ${PWD}/mongodb-linux-x86_64-${MONGODB}/data
-  - ${PWD}/mongodb-linux-x86_64-${MONGODB}/bin/mongod --dbpath ${PWD}/mongodb-linux-x86_64-${MONGODB}/data --logpath ${PWD}/mongodb-linux-x86_64-${MONGODB}/mongodb.log --fork
-  - if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then flake8 .; else echo "flake8 only runs on py27"; fi   # Run flake8 for py27
-  - mongo --eval 'db.version();'    # Make sure mongo is awake
+- if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then flake8 .; else echo "flake8 only runs on py27"; fi
 
 script:
-  - tox -e $(echo py$TRAVIS_PYTHON_VERSION-mg$PYMONGO | tr -d . | sed -e 's/pypypy/pypy/') -- --with-coverage
+- tox -e $(echo py$TRAVIS_PYTHON_VERSION-mg$PYMONGO | tr -d . | sed -e 's/pypypy/pypy/') -- --with-coverage
 
 # For now only submit coveralls for Python v2.7. Python v3.x currently shows
 # 0% coverage. That's caused by 'use_2to3', which builds the py3-compatible
@@ -92,15 +86,15 @@ deploy:
   password:
     secure: QMyatmWBnC6ZN3XLW2+fTBDU4LQcp1m/LjR2/0uamyeUzWKdlOoh/Wx5elOgLwt/8N9ppdPeG83ose1jOz69l5G0MUMjv8n/RIcMFSpCT59tGYqn3kh55b0cIZXFT9ar+5cxlif6a5rS72IHm5li7QQyxexJIII6Uxp0kpvUmek=
 
-  # Create a source distribution and a pure python wheel for faster installs.
+  # create a source distribution and a pure python wheel for faster installs
   distributions: "sdist bdist_wheel"
 
-  # Only deploy on tagged commits (aka GitHub releases) and only for the parent
-  # repo's builds running Python v2.7 along with PyMongo v3.x and MongoDB v3.4.
-  # We run Travis against many different Python, PyMongo, and MongoDB versions
-  # and we don't want the deploy to occur multiple times).
+  # only deploy on tagged commits (aka GitHub releases) and only for the
+  # parent repo's builds running Python 2.7 along with dev PyMongo (we run
+  # Travis against many different Python and PyMongo versions and we don't
+  # want the deploy to occur multiple times).
   on:
     tags: true
     repo: MongoEngine/mongoengine
-    condition: ($PYMONGO = 3.x) && ($MONGODB = 3.4)
+    condition: "$PYMONGO = 3.0"
     python: 2.7

AUTHORS

@@ -243,12 +243,3 @@ that much better:
  * Victor Varvaryuk
  * Stanislav Kaledin (https://github.com/sallyruthstruik)
  * Dmitry Yantsen (https://github.com/mrTable)
- * Renjianxin (https://github.com/Davidrjx)
- * Erdenezul Batmunkh (https://github.com/erdenezul)
- * Andy Yankovsky (https://github.com/werat)
- * Bastien Gérard (https://github.com/bagerard)
- * Trevor Hall (https://github.com/tjhall13)
- * Gleb Voropaev (https://github.com/buggyspace)
- * Paulo Amaral (https://github.com/pauloAmaral)
- * Gaurav Dadhania (https://github.com/GVRV)
- * Yurii Andrieiev (https://github.com/yandrieiev)

CONTRIBUTING.rst

@@ -22,11 +22,8 @@ Supported Interpreters
 
 MongoEngine supports CPython 2.7 and newer. Language
 features not supported by all interpreters can not be used.
-The codebase is written in python 2 so you must be using python 2
-when developing new features. Compatibility of the library with Python 3
-relies on the 2to3 package that gets executed as part of the installation
-build. You should ensure that your code is properly converted by
-`2to3 <http://docs.python.org/library/2to3.html>`_.
+Please also ensure that your code is properly converted by
+`2to3 <http://docs.python.org/library/2to3.html>`_ for Python 3 support.
 
 Style Guide
 -----------

README.rst

@@ -26,28 +26,26 @@ an `API reference <https://mongoengine-odm.readthedocs.io/apireference.html>`_.
 
 Supported MongoDB Versions
 ==========================
-MongoEngine is currently tested against MongoDB v3.4 and v3.6. Future versions
-should be supported as well, but aren't actively tested at the moment. Make
-sure to open an issue or submit a pull request if you experience any problems
-with MongoDB version > 3.6.
+MongoEngine is currently tested against MongoDB v2.4, v2.6, and v3.0. Future
+versions should be supported as well, but aren't actively tested at the moment.
+Make sure to open an issue or submit a pull request if you experience any
+problems with MongoDB v3.2+.
 
 Installation
 ============
 We recommend the use of `virtualenv <https://virtualenv.pypa.io/>`_ and of
 `pip <https://pip.pypa.io/>`_. You can then use ``pip install -U mongoengine``.
 You may also have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
-and thus you can use ``easy_install -U mongoengine``. Another option is
-`pipenv <https://docs.pipenv.org/>`_. You can then use ``pipenv install mongoengine``
-to both create the virtual environment and install the package. Otherwise, you can
-download the source from `GitHub <http://github.com/MongoEngine/mongoengine>`_ and
-run ``python setup.py install``.
+and thus you can use ``easy_install -U mongoengine``. Otherwise, you can download the
+source from `GitHub <http://github.com/MongoEngine/mongoengine>`_ and run ``python
+setup.py install``.
 
 Dependencies
 ============
 All of the dependencies can easily be installed via `pip <https://pip.pypa.io/>`_.
 At the very least, you'll need these two packages to use MongoEngine:
 
-- pymongo>=3.4
+- pymongo>=2.7.1
 - six>=1.10.0
 
 If you utilize a ``DateTimeField``, you might also use a more flexible date parser:

benchmark.py

@@ -0,0 +1,207 @@
+#!/usr/bin/env python
+
+"""
+Simple benchmark comparing PyMongo and MongoEngine.
+
+Sample run on a mid 2015 MacBook Pro (commit b282511):
+
+Benchmarking...
+----------------------------------------------------------------------------------------------------
+Creating 10000 dictionaries - Pymongo
+2.58979988098
+----------------------------------------------------------------------------------------------------
+Creating 10000 dictionaries - Pymongo write_concern={"w": 0}
+1.26657605171
+----------------------------------------------------------------------------------------------------
+Creating 10000 dictionaries - MongoEngine
+8.4351580143
+----------------------------------------------------------------------------------------------------
+Creating 10000 dictionaries without continual assign - MongoEngine
+7.20191693306
+----------------------------------------------------------------------------------------------------
+Creating 10000 dictionaries - MongoEngine - write_concern={"w": 0}, cascade = True
+6.31104588509
+----------------------------------------------------------------------------------------------------
+Creating 10000 dictionaries - MongoEngine, write_concern={"w": 0}, validate=False, cascade=True
+6.07083487511
+----------------------------------------------------------------------------------------------------
+Creating 10000 dictionaries - MongoEngine, write_concern={"w": 0}, validate=False
+5.97704291344
+----------------------------------------------------------------------------------------------------
+Creating 10000 dictionaries - MongoEngine, force_insert=True, write_concern={"w": 0}, validate=False
+5.9111430645
+"""
+
+import timeit
+
+
+def main():
+    print("Benchmarking...")
+
+    setup = """
+from pymongo import MongoClient
+connection = MongoClient()
+connection.drop_database('timeit_test')
+"""
+
+    stmt = """
+from pymongo import MongoClient
+connection = MongoClient()
+
+db = connection.timeit_test
+noddy = db.noddy
+
+for i in range(10000):
+    example = {'fields': {}}
+    for j in range(20):
+        example['fields']['key' + str(j)] = 'value ' + str(j)
+
+    noddy.save(example)
+
+myNoddys = noddy.find()
+[n for n in myNoddys] # iterate
+"""
+
+    print("-" * 100)
+    print("""Creating 10000 dictionaries - Pymongo""")
+    t = timeit.Timer(stmt=stmt, setup=setup)
+    print(t.timeit(1))
+
+    stmt = """
+from pymongo import MongoClient
+from pymongo.write_concern import WriteConcern
+connection = MongoClient()
+
+db = connection.get_database('timeit_test', write_concern=WriteConcern(w=0))
+noddy = db.noddy
+
+for i in range(10000):
+    example = {'fields': {}}
+    for j in range(20):
+        example['fields']["key"+str(j)] = "value "+str(j)
+
+    noddy.save(example)
+
+myNoddys = noddy.find()
+[n for n in myNoddys] # iterate
+"""
+
+    print("-" * 100)
+    print("""Creating 10000 dictionaries - Pymongo write_concern={"w": 0}""")
+    t = timeit.Timer(stmt=stmt, setup=setup)
+    print(t.timeit(1))
+
+    setup = """
+from pymongo import MongoClient
+connection = MongoClient()
+connection.drop_database('timeit_test')
+connection.close()
+
+from mongoengine import Document, DictField, connect
+connect('timeit_test')
+
+class Noddy(Document):
+    fields = DictField()
+"""
+
+    stmt = """
+for i in range(10000):
+    noddy = Noddy()
+    for j in range(20):
+        noddy.fields["key"+str(j)] = "value "+str(j)
+    noddy.save()
+
+myNoddys = Noddy.objects()
+[n for n in myNoddys] # iterate
+"""
+
+    print("-" * 100)
+    print("""Creating 10000 dictionaries - MongoEngine""")
+    t = timeit.Timer(stmt=stmt, setup=setup)
+    print(t.timeit(1))
+
+    stmt = """
+for i in range(10000):
+    noddy = Noddy()
+    fields = {}
+    for j in range(20):
+        fields["key"+str(j)] = "value "+str(j)
+    noddy.fields = fields
+    noddy.save()
+
+myNoddys = Noddy.objects()
+[n for n in myNoddys] # iterate
+"""
+
+    print("-" * 100)
+    print("""Creating 10000 dictionaries without continual assign - MongoEngine""")
+    t = timeit.Timer(stmt=stmt, setup=setup)
+    print(t.timeit(1))
+
+    stmt = """
+for i in range(10000):
+    noddy = Noddy()
+    for j in range(20):
+        noddy.fields["key"+str(j)] = "value "+str(j)
+    noddy.save(write_concern={"w": 0}, cascade=True)
+
+myNoddys = Noddy.objects()
+[n for n in myNoddys] # iterate
+"""
+
+    print("-" * 100)
+    print("""Creating 10000 dictionaries - MongoEngine - write_concern={"w": 0}, cascade = True""")
+    t = timeit.Timer(stmt=stmt, setup=setup)
+    print(t.timeit(1))
+
+    stmt = """
+for i in range(10000):
+    noddy = Noddy()
+    for j in range(20):
+        noddy.fields["key"+str(j)] = "value "+str(j)
+    noddy.save(write_concern={"w": 0}, validate=False, cascade=True)
+
+myNoddys = Noddy.objects()
+[n for n in myNoddys] # iterate
+"""
+
+    print("-" * 100)
+    print("""Creating 10000 dictionaries - MongoEngine, write_concern={"w": 0}, validate=False, cascade=True""")
+    t = timeit.Timer(stmt=stmt, setup=setup)
+    print(t.timeit(1))
+
+    stmt = """
+for i in range(10000):
+    noddy = Noddy()
+    for j in range(20):
+        noddy.fields["key"+str(j)] = "value "+str(j)
+    noddy.save(validate=False, write_concern={"w": 0})
+
+myNoddys = Noddy.objects()
+[n for n in myNoddys] # iterate
+"""
+
+    print("-" * 100)
+    print("""Creating 10000 dictionaries - MongoEngine, write_concern={"w": 0}, validate=False""")
+    t = timeit.Timer(stmt=stmt, setup=setup)
+    print(t.timeit(1))
+
+    stmt = """
+for i in range(10000):
+    noddy = Noddy()
+    for j in range(20):
+        noddy.fields["key"+str(j)] = "value "+str(j)
+    noddy.save(force_insert=True, write_concern={"w": 0}, validate=False)
+
+myNoddys = Noddy.objects()
+[n for n in myNoddys] # iterate
+"""
+
+    print("-" * 100)
+    print("""Creating 10000 dictionaries - MongoEngine, force_insert=True, write_concern={"w": 0}, validate=False""")
+    t = timeit.Timer(stmt=stmt, setup=setup)
+    print(t.timeit(1))
+
+
+if __name__ == "__main__":
+    main()

benchmarks/test_basic_doc_ops.py

@@ -1,148 +0,0 @@
-from timeit import repeat
-
-import mongoengine
-from mongoengine import (BooleanField, Document, EmailField, EmbeddedDocument,
-                         EmbeddedDocumentField, IntField, ListField,
-                         StringField)
-
-mongoengine.connect(db='mongoengine_benchmark_test')
-
-
-def timeit(f, n=10000):
-    return min(repeat(f, repeat=3, number=n)) / float(n)
-
-
-def test_basic():
-    class Book(Document):
-        name = StringField()
-        pages = IntField()
-        tags = ListField(StringField())
-        is_published = BooleanField()
-        author_email = EmailField()
-
-    Book.drop_collection()
-
-    def init_book():
-        return Book(
-            name='Always be closing',
-            pages=100,
-            tags=['self-help', 'sales'],
-            is_published=True,
-            author_email='alec@example.com',
-        )
-
-    print('Doc initialization: %.3fus' % (timeit(init_book, 1000) * 10**6))
-
-    b = init_book()
-    print('Doc getattr: %.3fus' % (timeit(lambda: b.name, 10000) * 10**6))
-
-    print(
-        'Doc setattr: %.3fus' % (
-            timeit(lambda: setattr(b, 'name', 'New name'), 10000) * 10**6
-        )
-    )
-
-    print('Doc to mongo: %.3fus' % (timeit(b.to_mongo, 1000) * 10**6))
-
-    print('Doc validation: %.3fus' % (timeit(b.validate, 1000) * 10**6))
-
-    def save_book():
-        b._mark_as_changed('name')
-        b._mark_as_changed('tags')
-        b.save()
-
-    print('Save to database: %.3fus' % (timeit(save_book, 100) * 10**6))
-
-    son = b.to_mongo()
-    print(
-        'Load from SON: %.3fus' % (
-            timeit(lambda: Book._from_son(son), 1000) * 10**6
-        )
-    )
-
-    print(
-        'Load from database: %.3fus' % (
-            timeit(lambda: Book.objects[0], 100) * 10**6
-        )
-    )
-
-    def create_and_delete_book():
-        b = init_book()
-        b.save()
-        b.delete()
-
-    print(
-        'Init + save to database + delete: %.3fms' % (
-            timeit(create_and_delete_book, 10) * 10**3
-        )
-    )
-
-
-def test_big_doc():
-    class Contact(EmbeddedDocument):
-        name = StringField()
-        title = StringField()
-        address = StringField()
-
-    class Company(Document):
-        name = StringField()
-        contacts = ListField(EmbeddedDocumentField(Contact))
-
-    Company.drop_collection()
-
-    def init_company():
-        return Company(
-            name='MongoDB, Inc.',
-            contacts=[
-                Contact(
-                    name='Contact %d' % x,
-                    title='CEO',
-                    address='Address %d' % x,
-                )
-                for x in range(1000)
-            ]
-        )
-
-    company = init_company()
-    print('Big doc to mongo: %.3fms' % (timeit(company.to_mongo, 100) * 10**3))
-
-    print('Big doc validation: %.3fms' % (timeit(company.validate, 1000) * 10**3))
-
-    company.save()
-
-    def save_company():
-        company._mark_as_changed('name')
-        company._mark_as_changed('contacts')
-        company.save()
-
-    print('Save to database: %.3fms' % (timeit(save_company, 100) * 10**3))
-
-    son = company.to_mongo()
-    print(
-        'Load from SON: %.3fms' % (
-            timeit(lambda: Company._from_son(son), 100) * 10**3
-        )
-    )
-
-    print(
-        'Load from database: %.3fms' % (
-            timeit(lambda: Company.objects[0], 100) * 10**3
-        )
-    )
-
-    def create_and_delete_company():
-        c = init_company()
-        c.save()
-        c.delete()
-
-    print(
-        'Init + save to database + delete: %.3fms' % (
-            timeit(create_and_delete_company, 10) * 10**3
-        )
-    )
-
-
-if __name__ == '__main__':
-    test_basic()
-    print('-' * 100)
-    test_big_doc()

benchmarks/test_inserts.py

@@ -1,154 +0,0 @@
-import timeit
-
-
-def main():
-    setup = """
-from pymongo import MongoClient
-connection = MongoClient()
-connection.drop_database('mongoengine_benchmark_test')
-"""
-
-    stmt = """
-from pymongo import MongoClient
-connection = MongoClient()
-
-db = connection.mongoengine_benchmark_test
-noddy = db.noddy
-
-for i in range(10000):
-    example = {'fields': {}}
-    for j in range(20):
-        example['fields']["key"+str(j)] = "value "+str(j)
-
-    noddy.insert_one(example)
-
-myNoddys = noddy.find()
-[n for n in myNoddys]  # iterate
-"""
-
-    print('-' * 100)
-    print('PyMongo: Creating 10000 dictionaries.')
-    t = timeit.Timer(stmt=stmt, setup=setup)
-    print('{}s'.format(t.timeit(1)))
-
-    stmt = """
-from pymongo import MongoClient, WriteConcern
-connection = MongoClient()
-
-db = connection.mongoengine_benchmark_test
-noddy = db.noddy.with_options(write_concern=WriteConcern(w=0))
-
-for i in range(10000):
-    example = {'fields': {}}
-    for j in range(20):
-        example['fields']["key"+str(j)] = "value "+str(j)
-
-    noddy.insert_one(example)
-
-myNoddys = noddy.find()
-[n for n in myNoddys]  # iterate
-"""
-
-    print('-' * 100)
-    print('PyMongo: Creating 10000 dictionaries (write_concern={"w": 0}).')
-    t = timeit.Timer(stmt=stmt, setup=setup)
-    print('{}s'.format(t.timeit(1)))
-
-    setup = """
-from pymongo import MongoClient
-connection = MongoClient()
-connection.drop_database('mongoengine_benchmark_test')
-connection.close()
-
-from mongoengine import Document, DictField, connect
-connect("mongoengine_benchmark_test")
-
-class Noddy(Document):
-    fields = DictField()
-"""
-
-    stmt = """
-for i in range(10000):
-    noddy = Noddy()
-    for j in range(20):
-        noddy.fields["key"+str(j)] = "value "+str(j)
-    noddy.save()
-
-myNoddys = Noddy.objects()
-[n for n in myNoddys]  # iterate
-"""
-
-    print('-' * 100)
-    print('MongoEngine: Creating 10000 dictionaries.')
-    t = timeit.Timer(stmt=stmt, setup=setup)
-    print('{}s'.format(t.timeit(1)))
-
-    stmt = """
-for i in range(10000):
-    noddy = Noddy()
-    fields = {}
-    for j in range(20):
-        fields["key"+str(j)] = "value "+str(j)
-    noddy.fields = fields
-    noddy.save()
-
-myNoddys = Noddy.objects()
-[n for n in myNoddys]  # iterate
-"""
-
-    print('-' * 100)
-    print('MongoEngine: Creating 10000 dictionaries (using a single field assignment).')
-    t = timeit.Timer(stmt=stmt, setup=setup)
-    print('{}s'.format(t.timeit(1)))
-
-    stmt = """
-for i in range(10000):
-    noddy = Noddy()
-    for j in range(20):
-        noddy.fields["key"+str(j)] = "value "+str(j)
-    noddy.save(write_concern={"w": 0})
-
-myNoddys = Noddy.objects()
-[n for n in myNoddys] # iterate
-"""
-
-    print('-' * 100)
-    print('MongoEngine: Creating 10000 dictionaries (write_concern={"w": 0}).')
-    t = timeit.Timer(stmt=stmt, setup=setup)
-    print('{}s'.format(t.timeit(1)))
-
-    stmt = """
-for i in range(10000):
-    noddy = Noddy()
-    for j in range(20):
-        noddy.fields["key"+str(j)] = "value "+str(j)
-    noddy.save(write_concern={"w": 0}, validate=False)
-
-myNoddys = Noddy.objects()
-[n for n in myNoddys] # iterate
-"""
-
-    print('-' * 100)
-    print('MongoEngine: Creating 10000 dictionaries (write_concern={"w": 0}, validate=False).')
-    t = timeit.Timer(stmt=stmt, setup=setup)
-    print('{}s'.format(t.timeit(1)))
-
-    stmt = """
-for i in range(10000):
-    noddy = Noddy()
-    for j in range(20):
-        noddy.fields["key"+str(j)] = "value "+str(j)
-    noddy.save(force_insert=True, write_concern={"w": 0}, validate=False)
-
-myNoddys = Noddy.objects()
-[n for n in myNoddys] # iterate
-"""
-
-    print('-' * 100)
-    print('MongoEngine: Creating 10000 dictionaries (force_insert=True, write_concern={"w": 0}, validate=False).')
-    t = timeit.Timer(stmt=stmt, setup=setup)
-    print('{}s'.format(t.timeit(1)))
-
-
-if __name__ == "__main__":
-    main()

docs/apireference.rst

@@ -13,7 +13,6 @@ Documents
 
 .. autoclass:: mongoengine.Document
    :members:
-   :inherited-members:
 
    .. attribute:: objects
 
@@ -22,18 +21,15 @@ Documents
 
 .. autoclass:: mongoengine.EmbeddedDocument
    :members:
-   :inherited-members:
 
 .. autoclass:: mongoengine.DynamicDocument
    :members:
-   :inherited-members:
 
 .. autoclass:: mongoengine.DynamicEmbeddedDocument
    :members:
-   :inherited-members:
 
 .. autoclass:: mongoengine.document.MapReduceDocument
-   :members:
+  :members:
 
 .. autoclass:: mongoengine.ValidationError
   :members:
@@ -91,9 +87,7 @@ Fields
 .. autoclass:: mongoengine.fields.DictField
 .. autoclass:: mongoengine.fields.MapField
 .. autoclass:: mongoengine.fields.ReferenceField
-.. autoclass:: mongoengine.fields.LazyReferenceField
 .. autoclass:: mongoengine.fields.GenericReferenceField
-.. autoclass:: mongoengine.fields.GenericLazyReferenceField
 .. autoclass:: mongoengine.fields.CachedReferenceField
 .. autoclass:: mongoengine.fields.BinaryField
 .. autoclass:: mongoengine.fields.FileField

docs/changelog.rst

@@ -1,4 +1,3 @@
-
 =========
 Changelog
 =========
@@ -6,134 +5,6 @@ Changelog
 Development
 ===========
 - (Fill this out as you fix issues and develop your features).
-- Add a `BaseDocument.to_dict` method #2101
-
-Changes in 0.18.1
-=================
-- Fix a bug introduced in 0.18.0 which was causing `.save()` to update all the fields
-    instead of updating only the modified fields. This bug only occurs when using custom pk #2082
-- Add Python 3.7 in travis #2058
-
-Changes in 0.18.0
-=================
-- Drop support for EOL'd MongoDB v2.6, v3.0, and v3.2.
-- MongoEngine now requires PyMongo >= v3.4. Travis CI now tests against MongoDB v3.4 – v3.6 and PyMongo v3.4 – v3.6 (#2017 #2066).
-- Improve performance by avoiding a call to `to_mongo` in `Document.save()` #2049
-- Connection/disconnection improvements:
-    - Expose `mongoengine.connection.disconnect` and `mongoengine.connection.disconnect_all`
-    - Fix disconnecting #566 #1599 #605 #607 #1213 #565
-    - Improve documentation of `connect`/`disconnect`
-    - Fix issue when using multiple connections to the same mongo with different credentials #2047
-    - `connect` fails immediately when db name contains invalid characters #2031 #1718
-- Fix the default write concern of `Document.save` that was overwriting the connection write concern #568
-- Fix querying on `List(EmbeddedDocument)` subclasses fields #1961 #1492
-- Fix querying on `(Generic)EmbeddedDocument` subclasses fields #475
-- Fix `QuerySet.aggregate` so that it takes limit and skip value into account #2029
-- Generate unique indices for `SortedListField` and `EmbeddedDocumentListFields` #2020
-- BREAKING CHANGE: Changed the behavior of a custom field validator (i.e `validation` parameter of a `Field`). It is now expected to raise a `ValidationError` instead of returning True/False #2050
-- BREAKING CHANGES (associated with connect/disconnect fixes):
-    - Calling `connect` 2 times with the same alias and different parameter will raise an error (should call `disconnect` first).
-    - `disconnect` now clears `mongoengine.connection._connection_settings`.
-    - `disconnect` now clears the cached attribute `Document._collection`.
-- BREAKING CHANGE: `EmbeddedDocument.save` & `.reload` is no longier exist #1552
-
-Changes in 0.17.0
-=================
-- Fix .only() working improperly after using .count() of the same instance of QuerySet
-- Fix batch_size that was not copied when cloning a queryset object #2011
-- POTENTIAL BREAKING CHANGE: All result fields are now passed, including internal fields (_cls, _id) when using `QuerySet.as_pymongo` #1976
-- Document a BREAKING CHANGE introduced in 0.15.3 and not reported at that time (#1995)
-- Fix InvalidStringData error when using modify on a BinaryField #1127
-- DEPRECATION: `EmbeddedDocument.save` & `.reload` are marked as deprecated and will be removed in a next version of mongoengine #1552
-- Fix test suite and CI to support MongoDB 3.4 #1445
-- Fix reference fields querying the database on each access if value contains orphan DBRefs
-
-=================
-Changes in 0.16.3
-=================
-- Fix $push with $position operator not working with lists in embedded document #1965
-
-=================
-Changes in 0.16.2
-=================
-- Fix .save() that fails when called with write_concern=None (regression of 0.16.1) #1958
-
-=================
-Changes in 0.16.1
-=================
-- 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
-
-=================
-Changes in 0.16.0
-=================
-- Various improvements to the doc
-- Improvement to code quality
-- POTENTIAL BREAKING CHANGES:
-    - EmbeddedDocumentField will no longer accept references to Document classes in its constructor #1661
-    - Get rid of the `basecls` parameter from the DictField constructor (dead code) #1876
-    - default value of ComplexDateTime is now None (and no longer the current datetime) #1368
-- Fix unhashable TypeError when referencing a Document with a compound key in an EmbeddedDocument #1685
-- Fix bug where an EmbeddedDocument with the same id as its parent would not be tracked for changes #1768
-- Fix the fact that bulk `insert()` was not setting primary keys of inserted documents instances #1919
-- Fix bug when referencing the abstract class in a ReferenceField #1920
-- Allow modification to the document made in pre_save_post_validation to be taken into account #1202
-- Replaced MongoDB 2.4 tests in CI by MongoDB 3.2 #1903
-- Fix side effects of using queryset.`no_dereference` on other documents #1677
-- Fix TypeError when using lazy django translation objects as translated choices #1879
-- Improve 2-3 codebase compatibility #1889
-- Fix the support for changing the default value of ComplexDateTime #1368
-- Improves error message in case an EmbeddedDocumentListField receives an EmbeddedDocument instance
-    instead of a list #1877
-- Fix the Decimal operator inc/dec #1517 #1320
-- Ignore killcursors queries in `query_counter` context manager #1869
-- Fix the fact that `query_counter` was modifying the initial profiling_level in case it was != 0 #1870
-- Repaired the `no_sub_classes` context manager + fix the fact that it was swallowing exceptions #1865
-- Fix index creation error that was swallowed by hasattr under python2 #1688
-- QuerySet limit function behaviour: Passing 0 as parameter will return all the documents in the cursor #1611
-- bulk insert updates the ids of the input documents instances #1919
-- Fix an harmless bug related to GenericReferenceField where modifications in the generic-referenced document
-    were tracked in the parent #1934
-- Improve validator of BinaryField #273
-- Implemented lazy regex compiling in Field classes to improve 'import mongoengine' performance #1806
-- Updated GridFSProxy.__str__  so that it would always print both the filename and grid_id #710
-- Add __repr__ to Q and QCombination #1843
-- fix bug in BaseList.__iter__ operator (was occuring when modifying a BaseList while iterating over it) #1676
-- Added field `DateField`#513
-
-Changes in 0.15.3
-=================
--  BREAKING CHANGES: `Queryset.update/update_one` methods now returns an UpdateResult when `full_result=True` is provided and no longer a dict (relates to #1491)
--  Subfield resolve error in generic_emdedded_document query #1651 #1652
--  use each modifier only with $position #1673 #1675
--  Improve LazyReferenceField and GenericLazyReferenceField with nested fields #1704
--  Fix validation error instance in GenericEmbeddedDocumentField #1067
--  Update cached fields when fields argument is given #1712
--  Add a db parameter to register_connection for compatibility with connect
--  Use insert_one, insert_many in Document.insert #1491
--  Use new update_one, update_many on document/queryset update #1491
--  Use insert_one, insert_many in Document.insert #1491
--  Fix reload(fields) affect changed fields #1371
--  Fix Read-only access to database fails when trying to create indexes #1338
-
-Changes in 0.15.0
-=================
-- Add LazyReferenceField and GenericLazyReferenceField to address #1230
-
-Changes in 0.14.1
-=================
-- Removed SemiStrictDict and started using a regular dict for `BaseDocument._data` #1630
-- Added support for the `$position` param in the `$push` operator #1566
-- Fixed `DateTimeField` interpreting an empty string as today #1533
-- Added a missing `__ne__` method to the `GridFSProxy` class #1632
-- Fixed `BaseQuerySet._fields_to_db_fields` #1553
-
-Changes in 0.14.0
-=================
-- BREAKING CHANGE: Removed the `coerce_types` param from `QuerySet.as_pymongo` #1549
-- POTENTIAL BREAKING CHANGE: Made EmbeddedDocument not hashable by default #1528
-- Improved code quality #1531, #1540, #1541, #1547
 
 Changes in 0.13.0
 =================

docs/code/tumblelog.py

@@ -45,27 +45,27 @@ post2.link_url = 'http://tractiondigital.com/labs/mongoengine/docs'
 post2.tags = ['mongoengine']
 post2.save()
 
-print('ALL POSTS')
-print()
+print 'ALL POSTS'
+print
 for post in Post.objects:
-    print(post.title)
+    print post.title
     #print '=' * post.title.count()
-    print("=" * 20)
+    print "=" * 20
 
     if isinstance(post, TextPost):
-        print(post.content)
+        print post.content
 
     if isinstance(post, LinkPost):
-        print('Link:', post.link_url)
+        print 'Link:', post.link_url
 
-    print()
-print()
+    print
+print
 
-print('POSTS TAGGED \'MONGODB\'')
-print()
+print 'POSTS TAGGED \'MONGODB\''
+print
 for post in Post.objects(tags='mongodb'):
-    print(post.title)
-print()
+    print post.title
+print
 
 num_posts = Post.objects(tags='mongodb').count()
-print('Found %d posts with tag "mongodb"' % num_posts)
+print 'Found %d posts with tag "mongodb"' % num_posts

docs/guide/connecting.rst

@@ -4,11 +4,9 @@
 Connecting to MongoDB
 =====================
 
-Connections in MongoEngine are registered globally and are identified with aliases.
-If no `alias` is provided during the connection, it will use "default" as alias.
-
-To connect to a running instance of :program:`mongod`, use the :func:`~mongoengine.connect`
-function. The first argument is the name of the database to connect to::
+To connect to a running instance of :program:`mongod`, use the
+:func:`~mongoengine.connect` function. The first argument is the name of the
+database to connect to::
 
     from mongoengine import connect
     connect('project1')
@@ -20,10 +18,10 @@ provide the :attr:`host` and :attr:`port` arguments to
 
     connect('project1', host='192.168.1.35', port=12345)
 
-If the database requires authentication, :attr:`username`, :attr:`password`
-and :attr:`authentication_source` arguments should be provided::
+If the database requires authentication, :attr:`username` and :attr:`password`
+arguments should be provided::
 
-    connect('project1', username='webapp', password='pwd123', authentication_source='admin')
+    connect('project1', username='webapp', password='pwd123')
 
 URI style connections are also supported -- just supply the URI as
 the :attr:`host` to
@@ -44,9 +42,6 @@ the :attr:`host` to
     will establish connection to ``production`` database using
     ``admin`` username and ``qwerty`` password.
 
-.. note:: Calling :func:`~mongoengine.connect` without argument will establish
-    a connection to the "test" database by default
-
 Replica Sets
 ============
 
@@ -76,61 +71,28 @@ is used.
 In the background this uses :func:`~mongoengine.register_connection` to
 store the data and you can register all aliases up front if required.
 
-Documents defined in different database
----------------------------------------
-Individual documents can be attached to different databases by providing a
+Individual documents can also support multiple databases by providing a
 `db_alias` in their meta data. This allows :class:`~pymongo.dbref.DBRef`
 objects to point across databases and collections. Below is an example schema,
 using 3 different databases to store data::
 
-        connect(alias='user-db-alias', db='user-db')
-        connect(alias='book-db-alias', db='book-db')
-        connect(alias='users-books-db-alias', db='users-books-db')
-        
         class User(Document):
             name = StringField()
 
-            meta = {'db_alias': 'user-db-alias'}
+            meta = {'db_alias': 'user-db'}
 
         class Book(Document):
             name = StringField()
 
-            meta = {'db_alias': 'book-db-alias'}
+            meta = {'db_alias': 'book-db'}
 
         class AuthorBooks(Document):
             author = ReferenceField(User)
             book = ReferenceField(Book)
 
-            meta = {'db_alias': 'users-books-db-alias'}
+            meta = {'db_alias': 'users-books-db'}
 
 
-Disconnecting an existing connection
-------------------------------------
-The function :func:`~mongoengine.disconnect` can be used to
-disconnect a particular connection. This can be used to change a
-connection globally::
-
-        from mongoengine import connect, disconnect
-        connect('a_db', alias='db1')
-
-        class User(Document):
-            name = StringField()
-            meta = {'db_alias': 'db1'}
-
-        disconnect(alias='db1')
-
-        connect('another_db', alias='db1')
-
-.. note:: Calling :func:`~mongoengine.disconnect` without argument
-    will disconnect the "default" connection
-
-.. note:: Since connections gets registered globally, it is important
-    to use the `disconnect` function from MongoEngine and not the
-    `disconnect()` method of an existing connection (pymongo.MongoClient)
-
-.. note:: :class:`~mongoengine.Document` are caching the pymongo collection.
-    using `disconnect` ensures that it gets cleaned as well
-
 Context Managers
 ================
 Sometimes you may want to switch the database or collection to query against.
@@ -157,7 +119,7 @@ access to the same User document across databases::
 
 Switch Collection
 -----------------
-The :func:`~mongoengine.context_managers.switch_collection` context manager
+The :class:`~mongoengine.context_managers.switch_collection` context manager
 allows you to change the collection for a given class allowing quick and easy
 access to the same Group document across collection::
 

docs/guide/defining-documents.rst

@@ -22,7 +22,7 @@ objects** as class attributes to the document class::
 
     class Page(Document):
         title = StringField(max_length=200, required=True)
-        date_modified = DateTimeField(default=datetime.datetime.utcnow)
+        date_modified = DateTimeField(default=datetime.datetime.now)
 
 As BSON (the binary format for storing data in mongodb) is order dependent,
 documents are serialized based on their field order.
@@ -80,16 +80,13 @@ are as follows:
 * :class:`~mongoengine.fields.FloatField`
 * :class:`~mongoengine.fields.GenericEmbeddedDocumentField`
 * :class:`~mongoengine.fields.GenericReferenceField`
-* :class:`~mongoengine.fields.GenericLazyReferenceField`
 * :class:`~mongoengine.fields.GeoPointField`
 * :class:`~mongoengine.fields.ImageField`
 * :class:`~mongoengine.fields.IntField`
 * :class:`~mongoengine.fields.ListField`
-* :class:`~mongoengine.fields.LongField`
 * :class:`~mongoengine.fields.MapField`
 * :class:`~mongoengine.fields.ObjectIdField`
 * :class:`~mongoengine.fields.ReferenceField`
-* :class:`~mongoengine.fields.LazyReferenceField`
 * :class:`~mongoengine.fields.SequenceField`
 * :class:`~mongoengine.fields.SortedListField`
 * :class:`~mongoengine.fields.StringField`
@@ -156,7 +153,7 @@ arguments can be set on all fields:
     An iterable (e.g. list, tuple or set) of choices to which the value of this
     field should be limited.
 
-    Can either be nested tuples of value (stored in mongo) and a
+    Can be either be a nested tuples of value (stored in mongo) and a
     human readable key ::
 
         SIZE = (('S', 'Small'),
@@ -176,21 +173,6 @@ arguments can be set on all fields:
         class Shirt(Document):
             size = StringField(max_length=3, choices=SIZE)
 
-:attr:`validation` (Optional)
-    A callable to validate the value of the field.
-    The callable takes the value as parameter and should raise a ValidationError
-    if validation fails
-
-    e.g ::
-
-        def _not_empty(val):
-            if not val:
-                raise ValidationError('value can not be empty')
-
-        class Person(Document):
-            name = StringField(validation=_not_empty)
-
-
 :attr:`**kwargs` (Optional)
     You can supply additional metadata as arbitrary additional keyword
     arguments.  You can not override existing attributes, however.  Common
@@ -242,7 +224,7 @@ store; in this situation a :class:`~mongoengine.fields.DictField` is appropriate
         user = ReferenceField(User)
         answers = DictField()
 
-    survey_response = SurveyResponse(date=datetime.utcnow(), user=request.user)
+    survey_response = SurveyResponse(date=datetime.now(), user=request.user)
     response_form = ResponseForm(request.POST)
     survey_response.answers = response_form.cleaned_data()
     survey_response.save()
@@ -508,9 +490,7 @@ the field name with a **#**::
             ]
         }
 
-If a dictionary is passed then additional options become available. Valid options include,
-but are not limited to:
-
+If a dictionary is passed then the following options are available:
 
 :attr:`fields` (Default: None)
     The fields to index. Specified in the same format as described above.
@@ -531,15 +511,8 @@ but are not limited to:
     Allows you to automatically expire data from a collection by setting the
     time in seconds to expire the a field.
 
-:attr:`name` (Optional)
-    Allows you to specify a name for the index
-
-:attr:`collation` (Optional)
-    Allows to create case insensitive indexes (MongoDB v3.4+ only)
-
 .. note::
 
-    Additional options are forwarded as **kwargs to pymongo's create_index method.
     Inheritance adds extra fields indices see: :ref:`document-inheritance`.
 
 Global index default options
@@ -551,16 +524,15 @@ There are a few top level defaults for all indexes that can be set::
         title = StringField()
         rating = StringField()
         meta = {
-            'index_opts': {},
+            'index_options': {},
             'index_background': True,
-            'index_cls': False,
-            'auto_create_index': True,
             'index_drop_dups': True,
+            'index_cls': False
         }
 
 
-:attr:`index_opts` (Optional)
-    Set any default index options - see the `full options list <https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#db.collection.createIndex>`_
+:attr:`index_options` (Optional)
+    Set any default index options - see the `full options list <http://docs.mongodb.org/manual/reference/method/db.collection.ensureIndex/#db.collection.ensureIndex>`_
 
 :attr:`index_background` (Optional)
     Set the default value for if an index should be indexed in the background
@@ -568,15 +540,10 @@ There are a few top level defaults for all indexes that can be set::
 :attr:`index_cls` (Optional)
     A way to turn off a specific index for _cls.
 
-:attr:`auto_create_index` (Optional)
-    When this is True (default), MongoEngine will ensure that the correct
-    indexes exist in MongoDB each time a command is run. This can be disabled
-    in systems where indexes are managed separately. Disabling this will improve
-    performance.
-
 :attr:`index_drop_dups` (Optional)
     Set the default value for if an index should drop duplicates
-    Since MongoDB 3.0 drop_dups is not supported anymore. Raises a Warning
+
+.. note:: Since MongoDB 3.0 drop_dups is not supported anymore. Raises a Warning
     and has no effect
 
 
@@ -651,7 +618,7 @@ collection after a given period. See the official
 documentation for more information.  A common usecase might be session data::
 
     class Session(Document):
-        created = DateTimeField(default=datetime.utcnow)
+        created = DateTimeField(default=datetime.now)
         meta = {
             'indexes': [
                 {'fields': ['created'], 'expireAfterSeconds': 3600}
@@ -714,16 +681,11 @@ subsequent calls to :meth:`~mongoengine.queryset.QuerySet.order_by`. ::
 Shard keys
 ==========
 
-If your collection is sharded by multiple keys, then you can improve shard
-routing (and thus the performance of your application) by specifying the shard
-key, using the :attr:`shard_key` attribute of
-:attr:`~mongoengine.Document.meta`. The shard key should be defined as a tuple.
-
-This ensures that the full shard key is sent with the query when calling
-methods such as :meth:`~mongoengine.document.Document.save`,
-:meth:`~mongoengine.document.Document.update`,
-:meth:`~mongoengine.document.Document.modify`, or
-:meth:`~mongoengine.document.Document.delete` on an existing
+If your collection is sharded, then you need to specify the shard key as a tuple,
+using the :attr:`shard_key` attribute of :attr:`~mongoengine.Document.meta`.
+This ensures that the shard key is sent with the query when calling the
+:meth:`~mongoengine.document.Document.save` or
+:meth:`~mongoengine.document.Document.update` method on an existing
 :class:`~mongoengine.Document` instance::
 
     class LogEntry(Document):
@@ -733,8 +695,7 @@ methods such as :meth:`~mongoengine.document.Document.save`,
         data = StringField()
 
         meta = {
-            'shard_key': ('machine', 'timestamp'),
-            'indexes': ('machine', 'timestamp'),
+            'shard_key': ('machine', 'timestamp',)
         }
 
 .. _document-inheritance:
@@ -764,9 +725,6 @@ document.::
 .. note:: From 0.8 onwards :attr:`allow_inheritance` defaults
           to False, meaning you must set it to True to use inheritance.
 
-          Setting :attr:`allow_inheritance` to True should also be used in
-          :class:`~mongoengine.EmbeddedDocument` class in case you need to subclass it
-
 Working with existing data
 --------------------------
 As MongoEngine no longer defaults to needing :attr:`_cls`, you can quickly and

docs/guide/document-instances.rst

@@ -57,8 +57,7 @@ document values for example::
 
         def clean(self):
             """Ensures that only published essays have a `pub_date` and
-            automatically sets `pub_date` if essay is published and `pub_date`
-            is not set"""
+            automatically sets the pub_date if published and not set"""
             if self.status == 'Draft' and self.pub_date is not None:
                 msg = 'Draft entries should not have a publication date.'
                 raise ValidationError(msg)

docs/guide/gridfs.rst

@@ -53,8 +53,7 @@ Deletion
 
 Deleting stored files is achieved with the :func:`delete` method::
 
-    marmot.photo.delete()    # Deletes the GridFS document
-    marmot.save()            # Saves the GridFS reference (being None) contained in the marmot instance
+    marmot.photo.delete()
 
 .. warning::
 
@@ -72,5 +71,4 @@ Files can be replaced with the :func:`replace` method. This works just like
 the :func:`put` method so even metadata can (and should) be replaced::
 
     another_marmot = open('another_marmot.png', 'rb')
-    marmot.photo.replace(another_marmot, content_type='image/png')  # Replaces the GridFS document
-    marmot.save()                                                   # Replaces the GridFS reference contained in marmot instance
+    marmot.photo.replace(another_marmot, content_type='image/png')

docs/guide/mongomock.rst

@@ -19,30 +19,3 @@ or with an alias:
 
     connect('mongoenginetest', host='mongomock://localhost', alias='testdb')
     conn = get_connection('testdb')
-
-Example of test file:
---------
-.. code-block:: python
-
-    import unittest
-    from mongoengine import connect, disconnect
-
-    class Person(Document):
-        name = StringField()
-
-    class TestPerson(unittest.TestCase):
-
-        @classmethod
-        def setUpClass(cls):
-            connect('mongoenginetest', host='mongomock://localhost')
-
-        @classmethod
-        def tearDownClass(cls):
-           disconnect()
-
-        def test_thing(self):
-            pers = Person(name='John')
-            pers.save()
-
-            fresh_pers = Person.objects().first()
-            self.assertEqual(fresh_pers.name, 'John')

docs/guide/querying.rst

@@ -64,7 +64,7 @@ Available operators are as follows:
 * ``gt`` -- greater than
 * ``gte`` -- greater than or equal to
 * ``not`` -- negate a standard check, may be used before other operators (e.g.
-  ``Q(age__not__mod=(5, 0))``)
+  ``Q(age__not__mod=5)``)
 * ``in`` -- value is in list (a list of values should be provided)
 * ``nin`` -- value is not in list (a list of values should be provided)
 * ``mod`` -- ``value % x == y``, where ``x`` and ``y`` are two provided values
@@ -456,14 +456,14 @@ data. To turn off dereferencing of the results of a query use
 :func:`~mongoengine.queryset.QuerySet.no_dereference` on the queryset like so::
 
     post = Post.objects.no_dereference().first()
-    assert(isinstance(post.author, DBRef))
+    assert(isinstance(post.author, ObjectId))
 
 You can also turn off all dereferencing for a fixed period by using the
 :class:`~mongoengine.context_managers.no_dereference` context manager::
 
     with no_dereference(Post) as Post:
         post = Post.objects.first()
-        assert(isinstance(post.author, DBRef))
+        assert(isinstance(post.author, ObjectId))
 
     # Outside the context manager dereferencing occurs.
     assert(isinstance(post.author, User))
@@ -565,15 +565,6 @@ cannot use the `$` syntax in keyword arguments it has been mapped to `S`::
     >>> post.tags
     ['database', 'mongodb']
 
-From MongoDB version 2.6, push operator supports $position value which allows
-to push values with index.
-    >>> post = BlogPost(title="Test", tags=["mongo"])
-    >>> post.save()
-    >>> post.update(push__tags__0=["database", "code"])
-    >>> post.reload()
-    >>> post.tags
-    ['database', 'code', 'mongo']
-
 .. note::
     Currently only top level lists are handled, future versions of mongodb /
     pymongo plan to support nested positional operators.  See `The $ positional

docs/guide/signals.rst

@@ -43,10 +43,10 @@ Available signals include:
   has taken place but before saving.
 
 `post_save`
-  Called within :meth:`~mongoengine.Document.save` after most actions
-  (validation, insert/update, and cascades, but not clearing dirty flags) have 
-  completed successfully.  Passed the additional boolean keyword argument 
-  `created` to indicate if the save was an insert or an update.
+  Called within :meth:`~mongoengine.Document.save` after all actions
+  (validation, insert/update, cascades, clearing dirty flags) have completed
+  successfully.  Passed the additional boolean keyword argument `created` to
+  indicate if the save was an insert or an update.
 
 `pre_delete`
   Called within :meth:`~mongoengine.Document.delete` prior to
@@ -113,10 +113,6 @@ handlers within your subclass::
     signals.pre_save.connect(Author.pre_save, sender=Author)
     signals.post_save.connect(Author.post_save, sender=Author)
 
-.. warning::
-
-    Note that EmbeddedDocument only supports pre/post_init signals. pre/post_save, etc should be attached to Document's class only. Attaching pre_save to an EmbeddedDocument is ignored silently.
-
 Finally, you can also use this small decorator to quickly create a number of
 signals and attach them to your :class:`~mongoengine.Document` or
 :class:`~mongoengine.EmbeddedDocument` subclasses as class decorators::

docs/guide/text-indexes.rst

@@ -48,4 +48,4 @@ Ordering by text score
 
 ::
 
-  objects = News.objects.search_text('mongo').order_by('$text_score')
+  objects = News.objects.search('mongo').order_by('$text_score')

docs/tutorial.rst

@@ -86,7 +86,7 @@ of them stand out as particularly intuitive solutions.
 Posts
 ^^^^^
 
-Happily MongoDB *isn't* a relational database, so we're not going to do it that
+Happily mongoDB *isn't* a relational database, so we're not going to do it that
 way. As it turns out, we can use MongoDB's schemaless nature to provide us with
 a much nicer solution. We will store all of the posts in *one collection* and
 each post type will only store the fields it needs. If we later want to add
@@ -153,7 +153,7 @@ post. This works, but there is no real reason to be storing the comments
 separately from their associated posts, other than to work around the
 relational model. Using MongoDB we can store the comments as a list of
 *embedded documents* directly on a post document. An embedded document should
-be treated no differently than a regular document; it just doesn't have its own
+be treated no differently that a regular document; it just doesn't have its own
 collection in the database. Using MongoEngine, we can define the structure of
 embedded documents, along with utility methods, in exactly the same way we do
 with regular documents::

docs/upgrade.rst

@@ -6,23 +6,6 @@ Development
 ***********
 (Fill this out whenever you introduce breaking changes to MongoEngine)
 
-URLField's constructor no longer takes `verify_exists`
-
-0.15.0
-******
-
-0.14.0
-******
-This release includes a few bug fixes and a significant code cleanup. The most
-important change is that `QuerySet.as_pymongo` no longer supports a
-`coerce_types` mode. If you used it in the past, a) please let us know of your
-use case, b) you'll need to override `as_pymongo` to get the desired outcome.
-
-This release also makes the EmbeddedDocument not hashable by default. If you
-use embedded documents in sets or dictionaries, you might have to override
-`__hash__` and implement a hashing logic specific to your use case. See #1528
-for the reason behind this change.
-
 0.13.0
 ******
 This release adds Unicode support to the `EmailField` and changes its

mongoengine/__init__.py

@@ -23,13 +23,12 @@ __all__ = (list(document.__all__) + list(fields.__all__) +
            list(signals.__all__) + list(errors.__all__))
 
 
-VERSION = (0, 18, 1)
+VERSION = (0, 13, 0)
 
 
 def get_version():
-    """Return the VERSION as a string.
-
-    For example, if `VERSION == (0, 10, 7)`, return '0.10.7'.
+    """Return the VERSION as a string, e.g. for VERSION == (0, 10, 7),
+    return '0.10.7'.
     """
     return '.'.join(map(str, VERSION))
 

mongoengine/base/__init__.py

@@ -15,7 +15,7 @@ __all__ = (
     'UPDATE_OPERATORS', '_document_registry', 'get_document',
 
     # datastructures
-    'BaseDict', 'BaseList', 'EmbeddedDocumentList', 'LazyReference',
+    'BaseDict', 'BaseList', 'EmbeddedDocumentList',
 
     # document
     'BaseDocument',

mongoengine/base/common.py

@@ -3,23 +3,22 @@ from mongoengine.errors import NotRegistered
 __all__ = ('UPDATE_OPERATORS', 'get_document', '_document_registry')
 
 
-UPDATE_OPERATORS = {'set', 'unset', 'inc', 'dec', 'mul',
-                    'pop', 'push', 'push_all', 'pull',
-                    'pull_all', 'add_to_set', 'set_on_insert',
-                    'min', 'max', 'rename'}
+UPDATE_OPERATORS = set(['set', 'unset', 'inc', 'dec', 'pop', 'push',
+                        'push_all', 'pull', 'pull_all', 'add_to_set',
+                        'set_on_insert', 'min', 'max', 'rename'])
 
 
 _document_registry = {}
 
 
 def get_document(name):
-    """Get a registered Document class by name."""
+    """Get a document class by name."""
     doc = _document_registry.get(name, None)
     if not doc:
         # Possible old style name
         single_end = name.split('.')[-1]
         compound_end = '.%s' % single_end
-        possible_match = [k for k in _document_registry
+        possible_match = [k for k in _document_registry.keys()
                           if k.endswith(compound_end) or k == single_end]
         if len(possible_match) == 1:
             doc = _document_registry.get(possible_match.pop(), None)
@@ -30,12 +29,3 @@ def get_document(name):
             been imported?
         """.strip() % name)
     return doc
-
-
-def _get_documents_by_db(connection_alias, default_connection_alias):
-    """Get all registered Documents class attached to a given database"""
-    def get_doc_alias(doc_cls):
-        return doc_cls._meta.get('db_alias', default_connection_alias)
-
-    return [doc_cls for doc_cls in _document_registry.values()
-            if get_doc_alias(doc_cls) == connection_alias]

mongoengine/base/datastructures.py

@@ -1,33 +1,12 @@
+import itertools
 import weakref
 
-from bson import DBRef
 import six
-from six import iteritems
 
 from mongoengine.common import _import_class
 from mongoengine.errors import DoesNotExist, MultipleObjectsReturned
 
-__all__ = ('BaseDict', 'StrictDict', 'BaseList', 'EmbeddedDocumentList', 'LazyReference')
-
-
-def mark_as_changed_wrapper(parent_method):
-    """Decorator that ensures _mark_as_changed method gets called."""
-    def wrapper(self, *args, **kwargs):
-        # Can't use super() in the decorator.
-        result = parent_method(self, *args, **kwargs)
-        self._mark_as_changed()
-        return result
-    return wrapper
-
-
-def mark_key_as_changed_wrapper(parent_method):
-    """Decorator that ensures _mark_as_changed method gets called with the key argument"""
-    def wrapper(self, key, *args, **kwargs):
-        # Can't use super() in the decorator.
-        result = parent_method(self, key, *args, **kwargs)
-        self._mark_as_changed(key)
-        return result
-    return wrapper
+__all__ = ('BaseDict', 'BaseList', 'EmbeddedDocumentList')
 
 
 class BaseDict(dict):
@@ -38,36 +17,46 @@ class BaseDict(dict):
     _name = None
 
     def __init__(self, dict_items, instance, name):
-        BaseDocument = _import_class('BaseDocument')
+        Document = _import_class('Document')
+        EmbeddedDocument = _import_class('EmbeddedDocument')
 
-        if isinstance(instance, BaseDocument):
+        if isinstance(instance, (Document, EmbeddedDocument)):
             self._instance = weakref.proxy(instance)
         self._name = name
         super(BaseDict, self).__init__(dict_items)
 
-    def get(self, key, default=None):
-        # get does not use __getitem__ by default so we must override it as well
-        try:
-            return self.__getitem__(key)
-        except KeyError:
-            return default
-
-    def __getitem__(self, key):
+    def __getitem__(self, key, *args, **kwargs):
         value = super(BaseDict, self).__getitem__(key)
 
         EmbeddedDocument = _import_class('EmbeddedDocument')
         if isinstance(value, EmbeddedDocument) and value._instance is None:
             value._instance = self._instance
-        elif isinstance(value, dict) and not isinstance(value, BaseDict):
+        elif not isinstance(value, BaseDict) and isinstance(value, dict):
             value = BaseDict(value, None, '%s.%s' % (self._name, key))
             super(BaseDict, self).__setitem__(key, value)
             value._instance = self._instance
-        elif isinstance(value, list) and not isinstance(value, BaseList):
+        elif not isinstance(value, BaseList) and isinstance(value, list):
             value = BaseList(value, None, '%s.%s' % (self._name, key))
             super(BaseDict, self).__setitem__(key, value)
             value._instance = self._instance
         return value
 
+    def __setitem__(self, key, value, *args, **kwargs):
+        self._mark_as_changed(key)
+        return super(BaseDict, self).__setitem__(key, value)
+
+    def __delete__(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseDict, self).__delete__(*args, **kwargs)
+
+    def __delitem__(self, key, *args, **kwargs):
+        self._mark_as_changed(key)
+        return super(BaseDict, self).__delitem__(key)
+
+    def __delattr__(self, key, *args, **kwargs):
+        self._mark_as_changed(key)
+        return super(BaseDict, self).__delattr__(key)
+
     def __getstate__(self):
         self.instance = None
         self._dereferenced = False
@@ -77,14 +66,25 @@ class BaseDict(dict):
         self = state
         return self
 
-    __setitem__ = mark_key_as_changed_wrapper(dict.__setitem__)
-    __delattr__ = mark_key_as_changed_wrapper(dict.__delattr__)
-    __delitem__ = mark_key_as_changed_wrapper(dict.__delitem__)
-    pop = mark_as_changed_wrapper(dict.pop)
-    clear = mark_as_changed_wrapper(dict.clear)
-    update = mark_as_changed_wrapper(dict.update)
-    popitem = mark_as_changed_wrapper(dict.popitem)
-    setdefault = mark_as_changed_wrapper(dict.setdefault)
+    def clear(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseDict, self).clear()
+
+    def pop(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseDict, self).pop(*args, **kwargs)
+
+    def popitem(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseDict, self).popitem()
+
+    def setdefault(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseDict, self).setdefault(*args, **kwargs)
+
+    def update(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseDict, self).update(*args, **kwargs)
 
     def _mark_as_changed(self, key=None):
         if hasattr(self._instance, '_mark_as_changed'):
@@ -102,39 +102,52 @@ class BaseList(list):
     _name = None
 
     def __init__(self, list_items, instance, name):
-        BaseDocument = _import_class('BaseDocument')
+        Document = _import_class('Document')
+        EmbeddedDocument = _import_class('EmbeddedDocument')
 
-        if isinstance(instance, BaseDocument):
+        if isinstance(instance, (Document, EmbeddedDocument)):
             self._instance = weakref.proxy(instance)
         self._name = name
         super(BaseList, self).__init__(list_items)
 
-    def __getitem__(self, key):
+    def __getitem__(self, key, *args, **kwargs):
         value = super(BaseList, self).__getitem__(key)
 
-        if isinstance(key, slice):
-            # When receiving a slice operator, we don't convert the structure and bind
-            # to parent's instance. This is buggy for now but would require more work to be handled properly
-            return value
-
         EmbeddedDocument = _import_class('EmbeddedDocument')
         if isinstance(value, EmbeddedDocument) and value._instance is None:
             value._instance = self._instance
-        elif isinstance(value, dict) and not isinstance(value, BaseDict):
-            # Replace dict by BaseDict
+        elif not isinstance(value, BaseDict) and isinstance(value, dict):
             value = BaseDict(value, None, '%s.%s' % (self._name, key))
             super(BaseList, self).__setitem__(key, value)
             value._instance = self._instance
-        elif isinstance(value, list) and not isinstance(value, BaseList):
-            # Replace list by BaseList
+        elif not isinstance(value, BaseList) and isinstance(value, list):
             value = BaseList(value, None, '%s.%s' % (self._name, key))
             super(BaseList, self).__setitem__(key, value)
             value._instance = self._instance
         return value
 
     def __iter__(self):
-        for v in super(BaseList, self).__iter__():
-            yield v
+        for i in xrange(self.__len__()):
+            yield self[i]
+
+    def __setitem__(self, key, value, *args, **kwargs):
+        if isinstance(key, slice):
+            self._mark_as_changed()
+        else:
+            self._mark_as_changed(key)
+        return super(BaseList, self).__setitem__(key, value)
+
+    def __delitem__(self, key, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).__delitem__(key)
+
+    def __setslice__(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).__setslice__(*args, **kwargs)
+
+    def __delslice__(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).__delslice__(*args, **kwargs)
 
     def __getstate__(self):
         self.instance = None
@@ -145,40 +158,41 @@ class BaseList(list):
         self = state
         return self
 
-    def __setitem__(self, key, value):
-        changed_key = key
-        if isinstance(key, slice):
-            # In case of slice, we don't bother to identify the exact elements being updated
-            # instead, we simply marks the whole list as changed
-            changed_key = None
+    def __iadd__(self, other):
+        self._mark_as_changed()
+        return super(BaseList, self).__iadd__(other)
 
-        result = super(BaseList, self).__setitem__(key, value)
-        self._mark_as_changed(changed_key)
-        return result
+    def __imul__(self, other):
+        self._mark_as_changed()
+        return super(BaseList, self).__imul__(other)
 
-    append = mark_as_changed_wrapper(list.append)
-    extend = mark_as_changed_wrapper(list.extend)
-    insert = mark_as_changed_wrapper(list.insert)
-    pop = mark_as_changed_wrapper(list.pop)
-    remove = mark_as_changed_wrapper(list.remove)
-    reverse = mark_as_changed_wrapper(list.reverse)
-    sort = mark_as_changed_wrapper(list.sort)
-    __delitem__ = mark_as_changed_wrapper(list.__delitem__)
-    __iadd__ = mark_as_changed_wrapper(list.__iadd__)
-    __imul__ = mark_as_changed_wrapper(list.__imul__)
+    def append(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).append(*args, **kwargs)
 
-    if six.PY2:
-        # Under py3 __setslice__, __delslice__ and __getslice__
-        # are replaced by __setitem__, __delitem__ and __getitem__ with a slice as parameter
-        # so we mimic this under python 2
-        def __setslice__(self, i, j, sequence):
-            return self.__setitem__(slice(i, j), sequence)
+    def extend(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).extend(*args, **kwargs)
 
-        def __delslice__(self, i, j):
-            return self.__delitem__(slice(i, j))
+    def insert(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).insert(*args, **kwargs)
 
-        def __getslice__(self, i, j):
-            return self.__getitem__(slice(i, j))
+    def pop(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).pop(*args, **kwargs)
+
+    def remove(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).remove(*args, **kwargs)
+
+    def reverse(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).reverse()
+
+    def sort(self, *args, **kwargs):
+        self._mark_as_changed()
+        return super(BaseList, self).sort(*args, **kwargs)
 
     def _mark_as_changed(self, key=None):
         if hasattr(self._instance, '_mark_as_changed'):
@@ -192,10 +206,6 @@ class BaseList(list):
 
 class EmbeddedDocumentList(BaseList):
 
-    def __init__(self, list_items, instance, name):
-        super(EmbeddedDocumentList, self).__init__(list_items, instance, name)
-        self._instance = instance
-
     @classmethod
     def __match_all(cls, embedded_doc, kwargs):
         """Return True if a given embedded doc matches all the filter
@@ -214,14 +224,15 @@ class EmbeddedDocumentList(BaseList):
             return embedded_docs
         return [doc for doc in embedded_docs if cls.__match_all(doc, kwargs)]
 
+    def __init__(self, list_items, instance, name):
+        super(EmbeddedDocumentList, self).__init__(list_items, instance, name)
+        self._instance = instance
+
     def filter(self, **kwargs):
         """
         Filters the list by only including embedded documents with the
         given keyword arguments.
 
-        This method only supports simple comparison (e.g: .filter(name='John Doe'))
-        and does not support operators like __gte, __lte, __icontains like queryset.filter does
-
         :param kwargs: The keyword arguments corresponding to the fields to
          filter on. *Multiple arguments are treated as if they are ANDed
          together.*
@@ -339,8 +350,7 @@ class EmbeddedDocumentList(BaseList):
 
     def update(self, **update):
         """
-        Updates the embedded documents with the given replacement values. This
-        function does not support mongoDB update operators such as ``inc__``.
+        Updates the embedded documents with the given update values.
 
         .. note::
             The embedded document changes are not automatically saved
@@ -362,11 +372,11 @@ class EmbeddedDocumentList(BaseList):
 
 class StrictDict(object):
     __slots__ = ()
-    _special_fields = {'get', 'pop', 'iteritems', 'items', 'keys', 'create'}
+    _special_fields = set(['get', 'pop', 'iteritems', 'items', 'keys', 'create'])
     _classes = {}
 
     def __init__(self, **kwargs):
-        for k, v in iteritems(kwargs):
+        for k, v in kwargs.iteritems():
             setattr(self, k, v)
 
     def __getitem__(self, key):
@@ -414,7 +424,7 @@ class StrictDict(object):
         return (key for key in self.__slots__ if hasattr(self, key))
 
     def __len__(self):
-        return len(list(iteritems(self)))
+        return len(list(self.iteritems()))
 
     def __eq__(self, other):
         return self.items() == other.items()
@@ -437,40 +447,40 @@ class StrictDict(object):
         return cls._classes[allowed_keys]
 
 
-class LazyReference(DBRef):
-    __slots__ = ('_cached_doc', 'passthrough', 'document_type')
+class SemiStrictDict(StrictDict):
+    __slots__ = ('_extras', )
+    _classes = {}
 
-    def fetch(self, force=False):
-        if not self._cached_doc or force:
-            self._cached_doc = self.document_type.objects.get(pk=self.pk)
-            if not self._cached_doc:
-                raise DoesNotExist('Trying to dereference unknown document %s' % (self))
-        return self._cached_doc
-
-    @property
-    def pk(self):
-        return self.id
-
-    def __init__(self, document_type, pk, cached_doc=None, passthrough=False):
-        self.document_type = document_type
-        self._cached_doc = cached_doc
-        self.passthrough = passthrough
-        super(LazyReference, self).__init__(self.document_type._get_collection_name(), pk)
-
-    def __getitem__(self, name):
-        if not self.passthrough:
-            raise KeyError()
-        document = self.fetch()
-        return document[name]
-
-    def __getattr__(self, name):
-        if not object.__getattribute__(self, 'passthrough'):
-            raise AttributeError()
-        document = self.fetch()
+    def __getattr__(self, attr):
         try:
-            return document[name]
-        except KeyError:
-            raise AttributeError()
+            super(SemiStrictDict, self).__getattr__(attr)
+        except AttributeError:
+            try:
+                return self.__getattribute__('_extras')[attr]
+            except KeyError as e:
+                raise AttributeError(e)
 
-    def __repr__(self):
-        return "<LazyReference(%s, %r)>" % (self.document_type, self.pk)
+    def __setattr__(self, attr, value):
+        try:
+            super(SemiStrictDict, self).__setattr__(attr, value)
+        except AttributeError:
+            try:
+                self._extras[attr] = value
+            except AttributeError:
+                self._extras = {attr: value}
+
+    def __delattr__(self, attr):
+        try:
+            super(SemiStrictDict, self).__delattr__(attr)
+        except AttributeError:
+            try:
+                del self._extras[attr]
+            except KeyError as e:
+                raise AttributeError(e)
+
+    def __iter__(self):
+        try:
+            extras_iter = iter(self.__getattribute__('_extras'))
+        except AttributeError:
+            extras_iter = ()
+        return itertools.chain(super(SemiStrictDict, self).__iter__(), extras_iter)

mongoengine/base/document.py

@@ -1,40 +1,30 @@
 import copy
 import numbers
+from collections import Hashable
 from functools import partial
 
-from bson import DBRef, ObjectId, SON, json_util
+from bson import ObjectId, json_util
+from bson.dbref import DBRef
+from bson.son import SON
 import pymongo
 import six
-from six import iteritems
 
 from mongoengine import signals
 from mongoengine.base.common import get_document
 from mongoengine.base.datastructures import (BaseDict, BaseList,
                                              EmbeddedDocumentList,
-                                             LazyReference,
-                                             StrictDict)
+                                             SemiStrictDict, StrictDict)
 from mongoengine.base.fields import ComplexBaseField
 from mongoengine.common import _import_class
 from mongoengine.errors import (FieldDoesNotExist, InvalidDocumentError,
                                 LookUpError, OperationError, ValidationError)
-from mongoengine.python_support import Hashable
 
-__all__ = ('BaseDocument', 'NON_FIELD_ERRORS')
+__all__ = ('BaseDocument',)
 
 NON_FIELD_ERRORS = '__all__'
 
 
 class BaseDocument(object):
-    # TODO simplify how `_changed_fields` is used.
-    # Currently, handling of `_changed_fields` seems unnecessarily convoluted:
-    # 1. `BaseDocument` defines `_changed_fields` in its `__slots__`, yet it's
-    #    not setting it to `[]` (or any other value) in `__init__`.
-    # 2. `EmbeddedDocument` sets `_changed_fields` to `[]` it its overloaded
-    #    `__init__`.
-    # 3. `Document` does NOT set `_changed_fields` upon initialization. The
-    #    field is primarily set via `_from_son` or `_clear_changed_fields`,
-    #    though there are also other methods that manipulate it.
-    # 4. The codebase is littered with `hasattr` calls for `_changed_fields`.
     __slots__ = ('_changed_fields', '_initialised', '_created', '_data',
                  '_dynamic_fields', '_auto_id_field', '_db_field_map',
                  '__weakref__')
@@ -45,20 +35,13 @@ class BaseDocument(object):
 
     def __init__(self, *args, **values):
         """
-        Initialise a document or an embedded document.
+        Initialise a document or embedded document
 
-        :param dict values: A dictionary of keys and values for the document.
-            It may contain additional reserved keywords, e.g. "__auto_convert".
-        :param bool __auto_convert: If True, supplied values will be converted
-            to Python-type values via each field's `to_python` method.
-        :param set __only_fields: A set of fields that have been loaded for
-            this document. Empty if all fields have been loaded.
-        :param bool _created: Indicates whether this is a brand new document
-            or whether it's already been persisted before. Defaults to true.
+        :param __auto_convert: Try and will cast python objects to Object types
+        :param values: A dictionary of values for the document
         """
         self._initialised = False
         self._created = True
-
         if args:
             # Combine positional arguments with named arguments.
             # We only want named arguments.
@@ -75,6 +58,7 @@ class BaseDocument(object):
 
         __auto_convert = values.pop('__auto_convert', True)
 
+        # 399: set default values only to fields loaded from DB
         __only_fields = set(values.pop('__only_fields', values))
 
         _created = values.pop('_created', True)
@@ -95,14 +79,13 @@ class BaseDocument(object):
         if self.STRICT and not self._dynamic:
             self._data = StrictDict.create(allowed_keys=self._fields_ordered)()
         else:
-            self._data = {}
+            self._data = SemiStrictDict.create(
+                allowed_keys=self._fields_ordered)()
 
         self._dynamic_fields = SON()
 
-        # Assign default values to the instance.
-        # We set default values only for fields loaded from DB. See
-        # https://github.com/mongoengine/mongoengine/issues/399 for more info.
-        for key, field in iteritems(self._fields):
+        # Assign default values to instance
+        for key, field in self._fields.iteritems():
             if self._db_field_map.get(key, key) in __only_fields:
                 continue
             value = getattr(self, key, None)
@@ -114,14 +97,16 @@ class BaseDocument(object):
         # Set passed values after initialisation
         if self._dynamic:
             dynamic_data = {}
-            for key, value in iteritems(values):
+            for key, value in values.iteritems():
                 if key in self._fields or key == '_id':
                     setattr(self, key, value)
-                else:
+                elif self._dynamic:
                     dynamic_data[key] = value
         else:
             FileField = _import_class('FileField')
-            for key, value in iteritems(values):
+            for key, value in values.iteritems():
+                if key == '__auto_convert':
+                    continue
                 key = self._reverse_db_field_map.get(key, key)
                 if key in self._fields or key in ('id', 'pk', '_cls'):
                     if __auto_convert and value is not None:
@@ -137,13 +122,12 @@ class BaseDocument(object):
 
         if self._dynamic:
             self._dynamic_lock = False
-            for key, value in iteritems(dynamic_data):
+            for key, value in dynamic_data.iteritems():
                 setattr(self, key, value)
 
         # Flag initialised
         self._initialised = True
         self._created = _created
-
         signals.post_init.send(self.__class__, document=self)
 
     def __delattr__(self, *args, **kwargs):
@@ -163,7 +147,7 @@ class BaseDocument(object):
 
             if not hasattr(self, name) and not name.startswith('_'):
                 DynamicField = _import_class('DynamicField')
-                field = DynamicField(db_field=name, null=True)
+                field = DynamicField(db_field=name)
                 field.name = name
                 self._dynamic_fields[name] = field
                 self._fields_ordered += (name,)
@@ -309,15 +293,18 @@ class BaseDocument(object):
         return self._data['_text_score']
 
     def to_mongo(self, use_db_field=True, fields=None):
-        """Return as SON data ready for use with MongoDB."""
-        fields = fields or []
+        """
+        Return as SON data ready for use with MongoDB.
+        """
+        if not fields:
+            fields = []
 
         data = SON()
         data['_id'] = None
         data['_cls'] = self._class_name
 
         # only root fields ['test1.a', 'test2'] => ['test1', 'test2']
-        root_fields = {f.split('.')[0] for f in fields}
+        root_fields = set([f.split('.')[0] for f in fields])
 
         for field_name in self:
             if root_fields and field_name not in root_fields:
@@ -350,7 +337,7 @@ class BaseDocument(object):
                 value = field.generate()
                 self._data[field_name] = value
 
-            if (value is not None) or (field.null):
+            if value is not None:
                 if use_db_field:
                     data[field.db_field] = value
                 else:
@@ -365,9 +352,6 @@ class BaseDocument(object):
     def validate(self, clean=True):
         """Ensure that all fields' values are valid and that required fields
         are present.
-
-        Raises :class:`ValidationError` if any of the fields' values are found
-        to be invalid.
         """
         # Ensure that each field is matched to a valid value
         errors = {}
@@ -410,51 +394,19 @@ class BaseDocument(object):
             message = 'ValidationError (%s:%s) ' % (self._class_name, pk)
             raise ValidationError(message, errors=errors)
 
-    def to_dict(self):
-        """Serialize this document into a dict.
-
-        Return field names as they're defined on the document (as opposed to
-        e.g. how they're stored in MongoDB). Return values in their
-        deserialized form (i.e. the same form that you get when you access
-        `doc.some_field_name`). Serialize embedded documents recursively.
-
-        The resultant dict can be consumed easily by other modules which
-        don't need to be aware of MongoEngine-specific object types.
-
-        :return dict: dictionary of field name & value pairs.
-        """
-        data_dict = {}
-        for field_name in self._fields:
-            value = getattr(self, field_name)
-            if isinstance(value, BaseDocument):
-                data_dict[field_name] = value.to_dict()
-            else:
-                data_dict[field_name] = value
-        return data_dict
-
     def to_json(self, *args, **kwargs):
         """Convert this document to JSON.
 
         :param use_db_field: Serialize field names as they appear in
             MongoDB (as opposed to attribute names on this document).
             Defaults to True.
-        :return str: string representing the jsonified document.
         """
         use_db_field = kwargs.pop('use_db_field', True)
         return json_util.dumps(self.to_mongo(use_db_field), *args, **kwargs)
 
     @classmethod
     def from_json(cls, json_data, created=False):
-        """Converts json data to a Document instance
-
-        :param str json_data: The json data to load into the Document
-        :param bool created: If True, the document will be considered as
-            a brand new document. If False and an ID is provided, it will
-            consider that the data being loaded corresponds to what's already
-            in the database (This has an impact of subsequent call to .save())
-            If False and no id is provided, it will consider the data as a new
-            document (default ``False``)
-        """
+        """Converts json data to an unsaved document instance"""
         return cls._from_son(json_util.loads(json_data), created=created)
 
     def __expand_dynamic_values(self, name, value):
@@ -537,7 +489,7 @@ class BaseDocument(object):
                 else:
                     data = getattr(data, part, None)
 
-                if not isinstance(data, LazyReference) and hasattr(data, '_changed_fields'):
+                if hasattr(data, '_changed_fields'):
                     if getattr(data, '_is_document', False):
                         continue
 
@@ -545,74 +497,76 @@ class BaseDocument(object):
 
         self._changed_fields = []
 
-    def _nestable_types_changed_fields(self, changed_fields, base_key, data):
-        """Inspect nested data for changed fields
-
-        :param changed_fields: Previously collected changed fields
-        :param base_key: The base key that must be used to prepend changes to this data
-        :param data: data to inspect for changes
-        """
+    def _nestable_types_changed_fields(self, changed_fields, key, data, inspected):
         # Loop list / dict fields as they contain documents
         # Determine the iterator to use
         if not hasattr(data, 'items'):
             iterator = enumerate(data)
         else:
-            iterator = iteritems(data)
+            iterator = data.iteritems()
 
-        for index_or_key, value in iterator:
-            item_key = '%s%s.' % (base_key, index_or_key)
+        for index, value in iterator:
+            list_key = '%s%s.' % (key, index)
             # don't check anything lower if this key is already marked
             # as changed.
-            if item_key[:-1] in changed_fields:
+            if list_key[:-1] in changed_fields:
                 continue
-
             if hasattr(value, '_get_changed_fields'):
-                changed = value._get_changed_fields()
-                changed_fields += ['%s%s' % (item_key, k) for k in changed if k]
+                changed = value._get_changed_fields(inspected)
+                changed_fields += ['%s%s' % (list_key, k)
+                                   for k in changed if k]
             elif isinstance(value, (list, tuple, dict)):
                 self._nestable_types_changed_fields(
-                    changed_fields, item_key, value)
+                    changed_fields, list_key, value, inspected)
 
-    def _get_changed_fields(self):
+    def _get_changed_fields(self, inspected=None):
         """Return a list of all fields that have explicitly been changed.
         """
         EmbeddedDocument = _import_class('EmbeddedDocument')
+        DynamicEmbeddedDocument = _import_class('DynamicEmbeddedDocument')
         ReferenceField = _import_class('ReferenceField')
-        GenericReferenceField = _import_class('GenericReferenceField')
         SortedListField = _import_class('SortedListField')
 
         changed_fields = []
         changed_fields += getattr(self, '_changed_fields', [])
 
+        inspected = inspected or set()
+        if hasattr(self, 'id') and isinstance(self.id, Hashable):
+            if self.id in inspected:
+                return changed_fields
+            inspected.add(self.id)
+
         for field_name in self._fields_ordered:
             db_field_name = self._db_field_map.get(field_name, field_name)
             key = '%s.' % db_field_name
             data = self._data.get(field_name, None)
             field = self._fields.get(field_name)
 
-            if db_field_name in changed_fields:
-                # Whole field already marked as changed, no need to go further
+            if hasattr(data, 'id'):
+                if data.id in inspected:
+                    continue
+            if isinstance(field, ReferenceField):
                 continue
-
-            if isinstance(field, ReferenceField):   # Don't follow referenced documents
-                continue
-
-            if isinstance(data, EmbeddedDocument):
+            elif (
+                isinstance(data, (EmbeddedDocument, DynamicEmbeddedDocument)) and
+                db_field_name not in changed_fields
+            ):
                 # Find all embedded fields that have been changed
-                changed = data._get_changed_fields()
+                changed = data._get_changed_fields(inspected)
                 changed_fields += ['%s%s' % (key, k) for k in changed if k]
-            elif isinstance(data, (list, tuple, dict)):
+            elif (isinstance(data, (list, tuple, dict)) and
+                    db_field_name not in changed_fields):
                 if (hasattr(field, 'field') and
-                        isinstance(field.field, (ReferenceField, GenericReferenceField))):
+                        isinstance(field.field, ReferenceField)):
                     continue
                 elif isinstance(field, SortedListField) and field._ordering:
                     # if ordering is affected whole list is changed
-                    if any(field._ordering in d._changed_fields for d in data):
+                    if any(map(lambda d: field._ordering in d._changed_fields, data)):
                         changed_fields.append(db_field_name)
                         continue
 
                 self._nestable_types_changed_fields(
-                    changed_fields, key, data)
+                    changed_fields, key, data, inspected)
         return changed_fields
 
     def _delta(self):
@@ -624,6 +578,7 @@ class BaseDocument(object):
 
         set_fields = self._get_changed_fields()
         unset_data = {}
+        parts = []
         if hasattr(self, '_changed_fields'):
             set_data = {}
             # Fetch each set item from its path
@@ -633,13 +588,15 @@ class BaseDocument(object):
                 new_path = []
                 for p in parts:
                     if isinstance(d, (ObjectId, DBRef)):
-                        # Don't dig in the references
                         break
-                    elif isinstance(d, list) and p.isdigit():
-                        # An item of a list (identified by its index) is updated
-                        d = d[int(p)]
+                    elif isinstance(d, list) and p.lstrip('-').isdigit():
+                        if p[0] == '-':
+                            p = str(len(d) + int(p))
+                        try:
+                            d = d[int(p)]
+                        except IndexError:
+                            d = None
                     elif hasattr(d, 'get'):
-                        # dict-like (dict, embedded document)
                         d = d.get(p)
                     new_path.append(p)
                 path = '.'.join(new_path)
@@ -651,26 +608,26 @@ class BaseDocument(object):
 
         # Determine if any changed items were actually unset.
         for path, value in set_data.items():
-            if value or isinstance(value, (numbers.Number, bool)):  # Account for 0 and True that are truthy
+            if value or isinstance(value, (numbers.Number, bool)):
                 continue
 
-            parts = path.split('.')
-
+            # If we've set a value that ain't the default value don't unset it.
+            default = None
             if (self._dynamic and len(parts) and parts[0] in
                     self._dynamic_fields):
                 del set_data[path]
                 unset_data[path] = 1
                 continue
-
-            # If we've set a value that ain't the default value don't unset it.
-            default = None
-            if path in self._fields:
+            elif path in self._fields:
                 default = self._fields[path].default
             else:  # Perform a full lookup for lists / embedded lookups
                 d = self
+                parts = path.split('.')
                 db_field_name = parts.pop()
                 for p in parts:
-                    if isinstance(d, list) and p.isdigit():
+                    if isinstance(d, list) and p.lstrip('-').isdigit():
+                        if p[0] == '-':
+                            p = str(len(d) + int(p))
                         d = d[int(p)]
                     elif (hasattr(d, '__getattribute__') and
                           not isinstance(d, dict)):
@@ -688,9 +645,10 @@ class BaseDocument(object):
                         default = None
 
             if default is not None:
-                default = default() if callable(default) else default
+                if callable(default):
+                    default = default()
 
-            if value != default:
+            if default != value:
                 continue
 
             del set_data[path]
@@ -706,7 +664,9 @@ class BaseDocument(object):
 
     @classmethod
     def _from_son(cls, son, _auto_dereference=True, only_fields=None, created=False):
-        """Create an instance of a Document (subclass) from a PyMongo SON."""
+        """Create an instance of a Document (subclass) from a PyMongo
+        SON.
+        """
         if not only_fields:
             only_fields = []
 
@@ -720,7 +680,7 @@ class BaseDocument(object):
         # Convert SON to a data dict, making sure each key is a string and
         # corresponds to the right db field.
         data = {}
-        for key, value in iteritems(son):
+        for key, value in son.iteritems():
             key = str(key)
             key = cls._db_field_map.get(key, key)
             data[key] = value
@@ -729,13 +689,14 @@ class BaseDocument(object):
         if class_name != cls._class_name:
             cls = get_document(class_name)
 
+        changed_fields = []
         errors_dict = {}
 
         fields = cls._fields
         if not _auto_dereference:
-            fields = copy.deepcopy(fields)
+            fields = copy.copy(fields)
 
-        for field_name, field in iteritems(fields):
+        for field_name, field in fields.iteritems():
             field._auto_dereference = _auto_dereference
             if field.db_field in data:
                 value = data[field.db_field]
@@ -756,15 +717,10 @@ class BaseDocument(object):
 
         # In STRICT documents, remove any keys that aren't in cls._fields
         if cls.STRICT:
-            data = {k: v for k, v in iteritems(data) if k in cls._fields}
+            data = {k: v for k, v in data.iteritems() if k in cls._fields}
 
-        obj = cls(
-            __auto_convert=False,
-            _created=created,
-            __only_fields=only_fields,
-            **data
-        )
-        obj._changed_fields = []
+        obj = cls(__auto_convert=False, _created=created, __only_fields=only_fields, **data)
+        obj._changed_fields = changed_fields
         if not _auto_dereference:
             obj._fields = fields
 
@@ -928,8 +884,7 @@ class BaseDocument(object):
                 index = {'fields': fields, 'unique': True, 'sparse': sparse}
                 unique_indexes.append(index)
 
-            if field.__class__.__name__ in {'EmbeddedDocumentListField',
-                                            'ListField', 'SortedListField'}:
+            if field.__class__.__name__ == 'ListField':
                 field = field.field
 
             # Grab any embedded document field unique indexes
@@ -1125,11 +1080,5 @@ class BaseDocument(object):
         """Return the display value for a choice field"""
         value = getattr(self, field.name)
         if field.choices and isinstance(field.choices[0], (list, tuple)):
-            if value is None:
-                return None
-            sep = getattr(field, 'display_sep', ' ')
-            values = value if field.__class__.__name__ in ('ListField', 'SortedListField') else [value]
-            return sep.join([
-                six.text_type(dict(field.choices).get(val, val))
-                for val in values or []])
+            return dict(field.choices).get(value, value)
         return value

mongoengine/base/fields.py

@@ -5,13 +5,13 @@ import weakref
 from bson import DBRef, ObjectId, SON
 import pymongo
 import six
-from six import iteritems
 
 from mongoengine.base.common import UPDATE_OPERATORS
 from mongoengine.base.datastructures import (BaseDict, BaseList,
                                              EmbeddedDocumentList)
 from mongoengine.common import _import_class
-from mongoengine.errors import DeprecatedError, ValidationError
+from mongoengine.errors import ValidationError
+
 
 __all__ = ('BaseField', 'ComplexBaseField', 'ObjectIdField',
            'GeoJsonBaseField')
@@ -52,10 +52,10 @@ class BaseField(object):
             unique with.
         :param primary_key: Mark this field as the primary key. Defaults to False.
         :param validation: (optional) A callable to validate the value of the
-            field.  The callable takes the value as parameter and should raise
-            a ValidationError if validation fails
+            field.  Generally this is deprecated in favour of the
+            `FIELD.validate` method
         :param choices: (optional) The valid choices
-        :param null: (optional) If the field value can be null. If no and there is a default value
+        :param null: (optional) Is the field value can be null. If no and there is a default value
             then the default value is set
         :param sparse: (optional) `sparse=True` combined with `unique=True` and `required=False`
             means that uniqueness won't be enforced for `None` values
@@ -128,9 +128,11 @@ class BaseField(object):
         return instance._data.get(self.name)
 
     def __set__(self, instance, value):
-        """Descriptor for assigning a value to a field in a document."""
-        # If setting to None and there is a default value provided for this
-        # field, then set the value to the default value.
+        """Descriptor for assigning a value to a field in a document.
+        """
+
+        # If setting to None and there is a default
+        # Then set the value to the default value
         if value is None:
             if self.null:
                 value = None
@@ -141,16 +143,12 @@ class BaseField(object):
 
         if instance._initialised:
             try:
-                value_has_changed = (
-                    self.name not in instance._data or
-                    instance._data[self.name] != value
-                )
-                if value_has_changed:
+                if (self.name not in instance._data or
+                        instance._data[self.name] != value):
                     instance._mark_as_changed(self.name)
             except Exception:
-                # Some values can't be compared and throw an error when we
-                # attempt to do so (e.g. tz-naive and tz-aware datetimes).
-                # Mark the field as changed in such cases.
+                # Values cant be compared eg: naive and tz datetimes
+                # So mark it as changed
                 instance._mark_as_changed(self.name)
 
         EmbeddedDocument = _import_class('EmbeddedDocument')
@@ -160,7 +158,6 @@ class BaseField(object):
             for v in value:
                 if isinstance(v, EmbeddedDocument):
                     v._instance = weakref.proxy(instance)
-
         instance._data[self.name] = value
 
     def error(self, message='', errors=None, field_name=None):
@@ -216,10 +213,8 @@ class BaseField(object):
                     )
                 )
         # Choices which are types other than Documents
-        else:
-            values = value if isinstance(value, (list, tuple)) else [value]
-            if len(set(values) - set(choice_list)):
-                self.error('Value must be one of %s' % six.text_type(choice_list))
+        elif value not in choice_list:
+            self.error('Value must be one of %s' % six.text_type(choice_list))
 
     def _validate(self, value, **kwargs):
         # Check the Choices Constraint
@@ -229,18 +224,10 @@ class BaseField(object):
         # check validation argument
         if self.validation is not None:
             if callable(self.validation):
-                try:
-                    # breaking change of 0.18
-                    # Get rid of True/False-type return for the validation method
-                    # in favor of having validation raising a ValidationError
-                    ret = self.validation(value)
-                    if ret is not None:
-                        raise DeprecatedError('validation argument for `%s` must not return anything, '
-                                              'it should raise a ValidationError if validation fails' % self.name)
-                except ValidationError as ex:
-                    self.error(str(ex))
+                if not self.validation(value):
+                    self.error('Value does not match custom validation method')
             else:
-                raise ValueError('validation argument for `"%s"` must be a '
+                raise ValueError('validation argument for "%s" must be a '
                                  'callable.' % self.name)
 
         self.validate(value, **kwargs)
@@ -278,25 +265,18 @@ class ComplexBaseField(BaseField):
         ReferenceField = _import_class('ReferenceField')
         GenericReferenceField = _import_class('GenericReferenceField')
         EmbeddedDocumentListField = _import_class('EmbeddedDocumentListField')
-
-        auto_dereference = instance._fields[self.name]._auto_dereference
-
-        dereference = (auto_dereference and
+        dereference = (self._auto_dereference and
                        (self.field is None or isinstance(self.field,
                                                          (GenericReferenceField, ReferenceField))))
 
         _dereference = _import_class('DeReference')()
 
-        if (instance._initialised and
-                dereference and
-                instance._data.get(self.name) and
-                not getattr(instance._data[self.name], '_dereferenced', False)):
+        self._auto_dereference = instance._fields[self.name]._auto_dereference
+        if instance._initialised and dereference and instance._data.get(self.name):
             instance._data[self.name] = _dereference(
                 instance._data.get(self.name), max_depth=1, instance=instance,
                 name=self.name
             )
-            if hasattr(instance._data[self.name], '_dereferenced'):
-                instance._data[self.name]._dereferenced = True
 
         value = super(ComplexBaseField, self).__get__(instance, owner)
 
@@ -312,7 +292,7 @@ class ComplexBaseField(BaseField):
             value = BaseDict(value, instance, self.name)
             instance._data[self.name] = value
 
-        if (auto_dereference and instance._initialised and
+        if (self._auto_dereference and instance._initialised and
                 isinstance(value, (BaseList, BaseDict)) and
                 not value._dereferenced):
             value = _dereference(
@@ -331,16 +311,11 @@ class ComplexBaseField(BaseField):
         if hasattr(value, 'to_python'):
             return value.to_python()
 
-        BaseDocument = _import_class('BaseDocument')
-        if isinstance(value, BaseDocument):
-            # Something is wrong, return the value as it is
-            return value
-
         is_list = False
         if not hasattr(value, 'items'):
             try:
                 is_list = True
-                value = {idx: v for idx, v in enumerate(value)}
+                value = {k: v for k, v in enumerate(value)}
             except TypeError:  # Not iterable return the value
                 return value
 
@@ -399,11 +374,11 @@ class ComplexBaseField(BaseField):
         if self.field:
             value_dict = {
                 key: self.field._to_mongo_safe_call(item, use_db_field, fields)
-                for key, item in iteritems(value)
+                for key, item in value.iteritems()
             }
         else:
             value_dict = {}
-            for k, v in iteritems(value):
+            for k, v in value.iteritems():
                 if isinstance(v, Document):
                     # We need the id from the saved object to create the DBRef
                     if v.pk is None:
@@ -440,7 +415,7 @@ class ComplexBaseField(BaseField):
         errors = {}
         if self.field:
             if hasattr(value, 'iteritems') or hasattr(value, 'items'):
-                sequence = iteritems(value)
+                sequence = value.iteritems()
             else:
                 sequence = enumerate(value)
             for k, v in sequence:
@@ -525,7 +500,7 @@ class GeoJsonBaseField(BaseField):
     def validate(self, value):
         """Validate the GeoJson object based on its type."""
         if isinstance(value, dict):
-            if set(value.keys()) == {'type', 'coordinates'}:
+            if set(value.keys()) == set(['type', 'coordinates']):
                 if value['type'] != self._type:
                     self.error('%s type must be "%s"' %
                                (self._name, self._type))

mongoengine/base/metaclasses.py

@@ -1,7 +1,6 @@
 import warnings
 
 import six
-from six import iteritems, itervalues
 
 from mongoengine.base.common import _document_registry
 from mongoengine.base.fields import BaseField, ComplexBaseField, ObjectIdField
@@ -19,14 +18,14 @@ class DocumentMetaclass(type):
     """Metaclass for all documents."""
 
     # TODO lower complexity of this method
-    def __new__(mcs, name, bases, attrs):
-        flattened_bases = mcs._get_bases(bases)
-        super_new = super(DocumentMetaclass, mcs).__new__
+    def __new__(cls, name, bases, attrs):
+        flattened_bases = cls._get_bases(bases)
+        super_new = super(DocumentMetaclass, cls).__new__
 
         # If a base class just call super
         metaclass = attrs.get('my_metaclass')
         if metaclass and issubclass(metaclass, DocumentMetaclass):
-            return super_new(mcs, name, bases, attrs)
+            return super_new(cls, name, bases, attrs)
 
         attrs['_is_document'] = attrs.get('_is_document', False)
         attrs['_cached_reference_fields'] = []
@@ -63,7 +62,7 @@ class DocumentMetaclass(type):
             # Standard object mixin - merge in any Fields
             if not hasattr(base, '_meta'):
                 base_fields = {}
-                for attr_name, attr_value in iteritems(base.__dict__):
+                for attr_name, attr_value in base.__dict__.iteritems():
                     if not isinstance(attr_value, BaseField):
                         continue
                     attr_value.name = attr_name
@@ -75,7 +74,7 @@ class DocumentMetaclass(type):
 
         # Discover any document fields
         field_names = {}
-        for attr_name, attr_value in iteritems(attrs):
+        for attr_name, attr_value in attrs.iteritems():
             if not isinstance(attr_value, BaseField):
                 continue
             attr_value.name = attr_name
@@ -104,7 +103,7 @@ class DocumentMetaclass(type):
 
         attrs['_fields_ordered'] = tuple(i[1] for i in sorted(
                                          (v.creation_counter, v.name)
-                                         for v in itervalues(doc_fields)))
+                                         for v in doc_fields.itervalues()))
 
         #
         # Set document hierarchy
@@ -122,8 +121,7 @@ class DocumentMetaclass(type):
                 # inheritance of classes where inheritance is set to False
                 allow_inheritance = base._meta.get('allow_inheritance')
                 if not allow_inheritance and not base._meta.get('abstract'):
-                    raise ValueError('Document %s may not be subclassed. '
-                                     'To enable inheritance, use the "allow_inheritance" meta attribute.' %
+                    raise ValueError('Document %s may not be subclassed' %
                                      base.__name__)
 
         # Get superclasses from last base superclass
@@ -140,7 +138,7 @@ class DocumentMetaclass(type):
         attrs['_types'] = attrs['_subclasses']  # TODO depreciate _types
 
         # Create the new_class
-        new_class = super_new(mcs, name, bases, attrs)
+        new_class = super_new(cls, name, bases, attrs)
 
         # Set _subclasses
         for base in document_bases:
@@ -149,7 +147,7 @@ class DocumentMetaclass(type):
             base._types = base._subclasses  # TODO depreciate _types
 
         (Document, EmbeddedDocument, DictField,
-         CachedReferenceField) = mcs._import_classes()
+         CachedReferenceField) = cls._import_classes()
 
         if issubclass(new_class, Document):
             new_class._collection = None
@@ -174,7 +172,7 @@ class DocumentMetaclass(type):
                         f.__dict__.update({'im_self': getattr(f, '__self__')})
 
         # Handle delete rules
-        for field in itervalues(new_class._fields):
+        for field in new_class._fields.itervalues():
             f = field
             if f.owner_document is None:
                 f.owner_document = new_class
@@ -184,6 +182,9 @@ class DocumentMetaclass(type):
                 if issubclass(new_class, EmbeddedDocument):
                     raise InvalidDocumentError('CachedReferenceFields is not '
                                                'allowed in EmbeddedDocuments')
+                if not f.document_type:
+                    raise InvalidDocumentError(
+                        'Document is not available to sync')
 
                 if f.auto_sync:
                     f.start_listener()
@@ -218,26 +219,29 @@ class DocumentMetaclass(type):
 
         return new_class
 
+    def add_to_class(self, name, value):
+        setattr(self, name, value)
+
     @classmethod
-    def _get_bases(mcs, bases):
+    def _get_bases(cls, bases):
         if isinstance(bases, BasesTuple):
             return bases
         seen = []
-        bases = mcs.__get_bases(bases)
+        bases = cls.__get_bases(bases)
         unique_bases = (b for b in bases if not (b in seen or seen.append(b)))
         return BasesTuple(unique_bases)
 
     @classmethod
-    def __get_bases(mcs, bases):
+    def __get_bases(cls, bases):
         for base in bases:
             if base is object:
                 continue
             yield base
-            for child_base in mcs.__get_bases(base.__bases__):
+            for child_base in cls.__get_bases(base.__bases__):
                 yield child_base
 
     @classmethod
-    def _import_classes(mcs):
+    def _import_classes(cls):
         Document = _import_class('Document')
         EmbeddedDocument = _import_class('EmbeddedDocument')
         DictField = _import_class('DictField')
@@ -250,9 +254,9 @@ class TopLevelDocumentMetaclass(DocumentMetaclass):
     collection in the database.
     """
 
-    def __new__(mcs, name, bases, attrs):
-        flattened_bases = mcs._get_bases(bases)
-        super_new = super(TopLevelDocumentMetaclass, mcs).__new__
+    def __new__(cls, name, bases, attrs):
+        flattened_bases = cls._get_bases(bases)
+        super_new = super(TopLevelDocumentMetaclass, cls).__new__
 
         # Set default _meta data if base class, otherwise get user defined meta
         if attrs.get('my_metaclass') == TopLevelDocumentMetaclass:
@@ -315,7 +319,7 @@ class TopLevelDocumentMetaclass(DocumentMetaclass):
                     not parent_doc_cls._meta.get('abstract', False)):
                 msg = 'Abstract document cannot have non-abstract base'
                 raise ValueError(msg)
-            return super_new(mcs, name, bases, attrs)
+            return super_new(cls, name, bases, attrs)
 
         # Merge base class metas.
         # Uses a special MetaDict that handles various merging rules
@@ -356,7 +360,7 @@ class TopLevelDocumentMetaclass(DocumentMetaclass):
         attrs['_meta'] = meta
 
         # Call super and get the new class
-        new_class = super_new(mcs, name, bases, attrs)
+        new_class = super_new(cls, name, bases, attrs)
 
         meta = new_class._meta
 
@@ -373,7 +377,7 @@ class TopLevelDocumentMetaclass(DocumentMetaclass):
             new_class.objects = QuerySetManager()
 
         # Validate the fields and set primary key if needed
-        for field_name, field in iteritems(new_class._fields):
+        for field_name, field in new_class._fields.iteritems():
             if field.primary_key:
                 # Ensure only one primary key is set
                 current_pk = new_class._meta.get('id_field')
@@ -390,7 +394,7 @@ class TopLevelDocumentMetaclass(DocumentMetaclass):
                                            '_auto_id_field', False)
         if not new_class._meta.get('id_field'):
             # After 0.10, find not existing names, instead of overwriting
-            id_name, id_db_name = mcs.get_auto_id_names(new_class)
+            id_name, id_db_name = cls.get_auto_id_names(new_class)
             new_class._auto_id_field = True
             new_class._meta['id_field'] = id_name
             new_class._fields[id_name] = ObjectIdField(db_field=id_db_name)
@@ -415,7 +419,7 @@ class TopLevelDocumentMetaclass(DocumentMetaclass):
         return new_class
 
     @classmethod
-    def get_auto_id_names(mcs, new_class):
+    def get_auto_id_names(cls, new_class):
         id_name, id_db_name = ('id', '_id')
         if id_name not in new_class._fields and \
                 id_db_name not in (v.db_field for v in new_class._fields.values()):
@@ -436,7 +440,7 @@ class MetaDict(dict):
     _merge_options = ('indexes',)
 
     def merge(self, new_options):
-        for k, v in iteritems(new_options):
+        for k, v in new_options.iteritems():
             if k in self._merge_options:
                 self[k] = self.get(k, []) + v
             else:

mongoengine/base/utils.py

@@ -1,22 +0,0 @@
-import re
-
-
-class LazyRegexCompiler(object):
-    """Descriptor to allow lazy compilation of regex"""
-
-    def __init__(self, pattern, flags=0):
-        self._pattern = pattern
-        self._flags = flags
-        self._compiled_regex = None
-
-    @property
-    def compiled_regex(self):
-        if self._compiled_regex is None:
-            self._compiled_regex = re.compile(self._pattern, self._flags)
-        return self._compiled_regex
-
-    def __get__(self, instance, owner):
-        return self.compiled_regex
-
-    def __set__(self, instance, value):
-        raise AttributeError("Can not set attribute LazyRegexCompiler")

mongoengine/common.py

@@ -31,6 +31,7 @@ def _import_class(cls_name):
 
     field_classes = _field_list_cache
 
+    queryset_classes = ('OperationError',)
     deref_classes = ('DeReference',)
 
     if cls_name == 'BaseDocument':
@@ -42,11 +43,14 @@ def _import_class(cls_name):
     elif cls_name in field_classes:
         from mongoengine import fields as module
         import_classes = field_classes
+    elif cls_name in queryset_classes:
+        from mongoengine import queryset as module
+        import_classes = queryset_classes
     elif cls_name in deref_classes:
         from mongoengine import dereference as module
         import_classes = deref_classes
     else:
-        raise ValueError('No import set for: %s' % cls_name)
+        raise ValueError('No import set for: ' % cls_name)
 
     for cls in import_classes:
         _class_registry_cache[cls] = getattr(module, cls)

mongoengine/connection.py

@@ -1,30 +1,19 @@
 from pymongo import MongoClient, ReadPreference, uri_parser
-from pymongo.database import _check_name
 import six
 
-__all__ = [
-    'DEFAULT_CONNECTION_NAME',
-    'DEFAULT_DATABASE_NAME',
-    'MongoEngineConnectionError',
-    'connect',
-    'disconnect',
-    'disconnect_all',
-    'get_connection',
-    'get_db',
-    'register_connection',
-]
+from mongoengine.python_support import IS_PYMONGO_3
+
+__all__ = ['MongoEngineConnectionError', 'connect', 'register_connection',
+           'DEFAULT_CONNECTION_NAME']
 
 
 DEFAULT_CONNECTION_NAME = 'default'
-DEFAULT_DATABASE_NAME = 'test'
-DEFAULT_HOST = 'localhost'
-DEFAULT_PORT = 27017
 
-_connection_settings = {}
-_connections = {}
-_dbs = {}
-
-READ_PREFERENCE = ReadPreference.PRIMARY
+if IS_PYMONGO_3:
+    READ_PREFERENCE = ReadPreference.PRIMARY
+else:
+    from pymongo import MongoReplicaSetClient
+    READ_PREFERENCE = False
 
 
 class MongoEngineConnectionError(Exception):
@@ -34,48 +23,44 @@ class MongoEngineConnectionError(Exception):
     pass
 
 
-def _check_db_name(name):
-    """Check if a database name is valid.
-    This functionality is copied from pymongo Database class constructor.
-    """
-    if not isinstance(name, six.string_types):
-        raise TypeError('name must be an instance of %s' % six.string_types)
-    elif name != '$external':
-        _check_name(name)
+_connection_settings = {}
+_connections = {}
+_dbs = {}
 
 
-def _get_connection_settings(
-        db=None, name=None, host=None, port=None,
-        read_preference=READ_PREFERENCE,
-        username=None, password=None,
-        authentication_source=None,
-        authentication_mechanism=None,
-        **kwargs):
-    """Get the connection settings as a dict
+def register_connection(alias, name=None, host=None, port=None,
+                        read_preference=READ_PREFERENCE,
+                        username=None, password=None,
+                        authentication_source=None,
+                        authentication_mechanism=None,
+                        **kwargs):
+    """Add a connection.
 
-    : param db: the name of the database to use, for compatibility with connect
-    : param name: the name of the specific database to use
-    : param host: the host name of the: program: `mongod` instance to connect to
-    : param port: the port that the: program: `mongod` instance is running on
-    : param read_preference: The read preference for the collection
-    : param username: username to authenticate with
-    : param password: password to authenticate with
-    : param authentication_source: database to authenticate against
-    : param authentication_mechanism: database authentication mechanisms.
+    :param alias: the name that will be used to refer to this connection
+        throughout MongoEngine
+    :param name: the name of the specific database to use
+    :param host: the host name of the :program:`mongod` instance to connect to
+    :param port: the port that the :program:`mongod` instance is running on
+    :param read_preference: The read preference for the collection
+       ** Added pymongo 2.1
+    :param username: username to authenticate with
+    :param password: password to authenticate with
+    :param authentication_source: database to authenticate against
+    :param authentication_mechanism: database authentication mechanisms.
         By default, use SCRAM-SHA-1 with MongoDB 3.0 and later,
         MONGODB-CR (MongoDB Challenge Response protocol) for older servers.
-    : param is_mock: explicitly use mongomock for this connection
-        (can also be done by using `mongomock: // ` as db host prefix)
-    : param kwargs: ad-hoc parameters to be passed into the pymongo driver,
+    :param is_mock: explicitly use mongomock for this connection
+        (can also be done by using `mongomock://` as db host prefix)
+    :param kwargs: ad-hoc parameters to be passed into the pymongo driver,
         for example maxpoolsize, tz_aware, etc. See the documentation
         for pymongo's `MongoClient` for a full list.
 
     .. versionchanged:: 0.10.6 - added mongomock support
     """
     conn_settings = {
-        'name': name or db or DEFAULT_DATABASE_NAME,
-        'host': host or DEFAULT_HOST,
-        'port': port or DEFAULT_PORT,
+        'name': name or 'test',
+        'host': host or 'localhost',
+        'port': port or 27017,
         'read_preference': read_preference,
         'username': username,
         'password': password,
@@ -83,7 +68,6 @@ def _get_connection_settings(
         'authentication_mechanism': authentication_mechanism
     }
 
-    _check_db_name(conn_settings['name'])
     conn_host = conn_settings['host']
 
     # Host can be a list or a string, so if string, force to a list.
@@ -119,30 +103,6 @@ def _get_connection_settings(
                 conn_settings['authentication_source'] = uri_options['authsource']
             if 'authmechanism' in uri_options:
                 conn_settings['authentication_mechanism'] = uri_options['authmechanism']
-            if 'readpreference' in uri_options:
-                read_preferences = (
-                    ReadPreference.NEAREST,
-                    ReadPreference.PRIMARY,
-                    ReadPreference.PRIMARY_PREFERRED,
-                    ReadPreference.SECONDARY,
-                    ReadPreference.SECONDARY_PREFERRED,
-                )
-
-                # Starting with PyMongo v3.5, the "readpreference" option is
-                # returned as a string (e.g. "secondaryPreferred") and not an
-                # int (e.g. 3).
-                # TODO simplify the code below once we drop support for
-                # PyMongo v3.4.
-                read_pf_mode = uri_options['readpreference']
-                if isinstance(read_pf_mode, six.string_types):
-                    read_pf_mode = read_pf_mode.lower()
-                for preference in read_preferences:
-                    if (
-                        preference.name.lower() == read_pf_mode or
-                        preference.mode == read_pf_mode
-                    ):
-                        conn_settings['read_preference'] = preference
-                        break
         else:
             resolved_hosts.append(entity)
     conn_settings['host'] = resolved_hosts
@@ -152,74 +112,17 @@ def _get_connection_settings(
     kwargs.pop('is_slave', None)
 
     conn_settings.update(kwargs)
-    return conn_settings
-
-
-def register_connection(alias, db=None, name=None, host=None, port=None,
-                        read_preference=READ_PREFERENCE,
-                        username=None, password=None,
-                        authentication_source=None,
-                        authentication_mechanism=None,
-                        **kwargs):
-    """Register the connection settings.
-
-    : param alias: the name that will be used to refer to this connection
-        throughout MongoEngine
-    : param name: the name of the specific database to use
-    : param db: the name of the database to use, for compatibility with connect
-    : param host: the host name of the: program: `mongod` instance to connect to
-    : param port: the port that the: program: `mongod` instance is running on
-    : param read_preference: The read preference for the collection
-    : param username: username to authenticate with
-    : param password: password to authenticate with
-    : param authentication_source: database to authenticate against
-    : param authentication_mechanism: database authentication mechanisms.
-        By default, use SCRAM-SHA-1 with MongoDB 3.0 and later,
-        MONGODB-CR (MongoDB Challenge Response protocol) for older servers.
-    : param is_mock: explicitly use mongomock for this connection
-        (can also be done by using `mongomock: // ` as db host prefix)
-    : param kwargs: ad-hoc parameters to be passed into the pymongo driver,
-        for example maxpoolsize, tz_aware, etc. See the documentation
-        for pymongo's `MongoClient` for a full list.
-
-    .. versionchanged:: 0.10.6 - added mongomock support
-    """
-    conn_settings = _get_connection_settings(
-        db=db, name=name, host=host, port=port,
-        read_preference=read_preference,
-        username=username, password=password,
-        authentication_source=authentication_source,
-        authentication_mechanism=authentication_mechanism,
-        **kwargs)
     _connection_settings[alias] = conn_settings
 
 
 def disconnect(alias=DEFAULT_CONNECTION_NAME):
     """Close the connection with a given alias."""
-    from mongoengine.base.common import _get_documents_by_db
-    from mongoengine import Document
-
     if alias in _connections:
         get_connection(alias=alias).close()
         del _connections[alias]
-
     if alias in _dbs:
-        # Detach all cached collections in Documents
-        for doc_cls in _get_documents_by_db(alias, DEFAULT_CONNECTION_NAME):
-            if issubclass(doc_cls, Document):     # Skip EmbeddedDocument
-                doc_cls._disconnect()
-
         del _dbs[alias]
 
-    if alias in _connection_settings:
-        del _connection_settings[alias]
-
-
-def disconnect_all():
-    """Close all registered database."""
-    for alias in list(_connections.keys()):
-        disconnect(alias)
-
 
 def get_connection(alias=DEFAULT_CONNECTION_NAME, reconnect=False):
     """Return a connection with a given alias."""
@@ -243,21 +146,19 @@ def get_connection(alias=DEFAULT_CONNECTION_NAME, reconnect=False):
         raise MongoEngineConnectionError(msg)
 
     def _clean_settings(settings_dict):
-        irrelevant_fields_set = {
-            'name', 'username', 'password',
-            'authentication_source', 'authentication_mechanism'
-        }
+        irrelevant_fields = set([
+            'name', 'username', 'password', 'authentication_source',
+            'authentication_mechanism'
+        ])
         return {
             k: v for k, v in settings_dict.items()
-            if k not in irrelevant_fields_set
+            if k not in irrelevant_fields
         }
 
-    raw_conn_settings = _connection_settings[alias].copy()
-
     # Retrieve a copy of the connection settings associated with the requested
     # alias and remove the database name and authentication info (we don't
     # care about them at this point).
-    conn_settings = _clean_settings(raw_conn_settings)
+    conn_settings = _clean_settings(_connection_settings[alias].copy())
 
     # Determine if we should use PyMongo's or mongomock's MongoClient.
     is_mock = conn_settings.pop('is_mock', False)
@@ -271,58 +172,49 @@ def get_connection(alias=DEFAULT_CONNECTION_NAME, reconnect=False):
     else:
         connection_class = MongoClient
 
-    # Re-use existing connection if one is suitable.
-    existing_connection = _find_existing_connection(raw_conn_settings)
-    if existing_connection:
-        connection = existing_connection
-    else:
-        connection = _create_connection(
-            alias=alias,
-            connection_class=connection_class,
-            **conn_settings
-        )
-    _connections[alias] = connection
-    return _connections[alias]
+        # For replica set connections with PyMongo 2.x, use
+        # MongoReplicaSetClient.
+        # TODO remove this once we stop supporting PyMongo 2.x.
+        if 'replicaSet' in conn_settings and not IS_PYMONGO_3:
+            connection_class = MongoReplicaSetClient
+            conn_settings['hosts_or_uri'] = conn_settings.pop('host', None)
 
+            # hosts_or_uri has to be a string, so if 'host' was provided
+            # as a list, join its parts and separate them by ','
+            if isinstance(conn_settings['hosts_or_uri'], list):
+                conn_settings['hosts_or_uri'] = ','.join(
+                    conn_settings['hosts_or_uri'])
 
-def _create_connection(alias, connection_class, **connection_settings):
-    """
-    Create the new connection for this alias. Raise
-    MongoEngineConnectionError if it can't be established.
-    """
-    try:
-        return connection_class(**connection_settings)
-    except Exception as e:
-        raise MongoEngineConnectionError(
-            'Cannot connect to database %s :\n%s' % (alias, e))
+            # Discard port since it can't be used on MongoReplicaSetClient
+            conn_settings.pop('port', None)
 
-
-def _find_existing_connection(connection_settings):
-    """
-    Check if an existing connection could be reused
-
-    Iterate over all of the connection settings and if an existing connection
-    with the same parameters is suitable, return it
-
-    :param connection_settings: the settings of the new connection
-    :return: An existing connection or None
-    """
-    connection_settings_bis = (
+    # Iterate over all of the connection settings and if a connection with
+    # the same parameters is already established, use it instead of creating
+    # a new one.
+    existing_connection = None
+    connection_settings_iterator = (
         (db_alias, settings.copy())
         for db_alias, settings in _connection_settings.items()
     )
+    for db_alias, connection_settings in connection_settings_iterator:
+        connection_settings = _clean_settings(connection_settings)
+        if conn_settings == connection_settings and _connections.get(db_alias):
+            existing_connection = _connections[db_alias]
+            break
 
-    def _clean_settings(settings_dict):
-        # Only remove the name but it's important to
-        # keep the username/password/authentication_source/authentication_mechanism
-        # to identify if the connection could be shared (cfr https://github.com/MongoEngine/mongoengine/issues/2047)
-        return {k: v for k, v in settings_dict.items() if k != 'name'}
+    # If an existing connection was found, assign it to the new alias
+    if existing_connection:
+        _connections[alias] = existing_connection
+    else:
+        # Otherwise, create the new connection for this alias. Raise
+        # MongoEngineConnectionError if it can't be established.
+        try:
+            _connections[alias] = connection_class(**conn_settings)
+        except Exception as e:
+            raise MongoEngineConnectionError(
+                'Cannot connect to database %s :\n%s' % (alias, e))
 
-    cleaned_conn_settings = _clean_settings(connection_settings)
-    for db_alias, connection_settings in connection_settings_bis:
-        db_conn_settings = _clean_settings(connection_settings)
-        if cleaned_conn_settings == db_conn_settings and _connections.get(db_alias):
-            return _connections[db_alias]
+    return _connections[alias]
 
 
 def get_db(alias=DEFAULT_CONNECTION_NAME, reconnect=False):
@@ -352,27 +244,14 @@ def connect(db=None, alias=DEFAULT_CONNECTION_NAME, **kwargs):
     provide username and password arguments as well.
 
     Multiple databases are supported by using aliases. Provide a separate
-    `alias` to connect to a different instance of: program: `mongod`.
-
-    In order to replace a connection identified by a given alias, you'll
-    need to call ``disconnect`` first
+    `alias` to connect to a different instance of :program:`mongod`.
 
     See the docstring for `register_connection` for more details about all
     supported kwargs.
 
     .. versionchanged:: 0.6 - added multiple database support.
     """
-    if alias in _connections:
-        prev_conn_setting = _connection_settings[alias]
-        new_conn_settings = _get_connection_settings(db, **kwargs)
-
-        if new_conn_settings != prev_conn_setting:
-            err_msg = (
-                u'A different connection with alias `{}` was already '
-                u'registered. Use disconnect() first'
-            ).format(alias)
-            raise MongoEngineConnectionError(err_msg)
-    else:
+    if alias not in _connections:
         register_connection(alias, db, **kwargs)
 
     return get_connection(alias)

mongoengine/context_managers.py

@@ -1,14 +1,9 @@
-from contextlib import contextmanager
-
-from pymongo.write_concern import WriteConcern
-from six import iteritems
-
 from mongoengine.common import _import_class
 from mongoengine.connection import DEFAULT_CONNECTION_NAME, get_db
-from mongoengine.pymongo_support import count_documents
+
 
 __all__ = ('switch_db', 'switch_collection', 'no_dereference',
-           'no_sub_classes', 'query_counter', 'set_write_concern')
+           'no_sub_classes', 'query_counter')
 
 
 class switch_db(object):
@@ -115,7 +110,7 @@ class no_dereference(object):
         GenericReferenceField = _import_class('GenericReferenceField')
         ComplexBaseField = _import_class('ComplexBaseField')
 
-        self.deref_fields = [k for k, v in iteritems(self.cls._fields)
+        self.deref_fields = [k for k, v in self.cls._fields.iteritems()
                              if isinstance(v, (ReferenceField,
                                                GenericReferenceField,
                                                ComplexBaseField))]
@@ -148,85 +143,66 @@ class no_sub_classes(object):
         :param cls: the class to turn querying sub classes on
         """
         self.cls = cls
-        self.cls_initial_subclasses = None
 
     def __enter__(self):
         """Change the objects default and _auto_dereference values."""
-        self.cls_initial_subclasses = self.cls._subclasses
-        self.cls._subclasses = (self.cls._class_name,)
+        self.cls._all_subclasses = self.cls._subclasses
+        self.cls._subclasses = (self.cls,)
         return self.cls
 
     def __exit__(self, t, value, traceback):
         """Reset the default and _auto_dereference values."""
-        self.cls._subclasses = self.cls_initial_subclasses
+        self.cls._subclasses = self.cls._all_subclasses
+        delattr(self.cls, '_all_subclasses')
+        return self.cls
 
 
 class query_counter(object):
-    """Query_counter context manager to get the number of queries.
-    This works by updating the `profiling_level` of the database so that all queries get logged,
-    resetting the db.system.profile collection at the beginnig of the context and counting the new entries.
-
-    This was designed for debugging purpose. In fact it is a global counter so queries issued by other threads/processes
-    can interfere with it
-
-    Be aware that:
-    - Iterating over large amount of documents (>101) makes pymongo issue `getmore` queries to fetch the next batch of
-        documents (https://docs.mongodb.com/manual/tutorial/iterate-a-cursor/#cursor-batches)
-    - Some queries are ignored by default by the counter (killcursors, db.system.indexes)
-    """
+    """Query_counter context manager to get the number of queries."""
 
     def __init__(self):
-        """Construct the query_counter
-        """
+        """Construct the query_counter."""
+        self.counter = 0
         self.db = get_db()
-        self.initial_profiling_level = None
-        self._ctx_query_counter = 0             # number of queries issued by the context
 
-        self._ignored_query = {
-            'ns':
-                {'$ne': '%s.system.indexes' % self.db.name},
-            'op':                       # MONGODB < 3.2
-                {'$ne': 'killcursors'},
-            'command.killCursors':      # MONGODB >= 3.2
-                {'$exists': False}
-        }
-
-    def _turn_on_profiling(self):
-        self.initial_profiling_level = self.db.profiling_level()
+    def __enter__(self):
+        """On every with block we need to drop the profile collection."""
         self.db.set_profiling_level(0)
         self.db.system.profile.drop()
         self.db.set_profiling_level(2)
-
-    def _resets_profiling(self):
-        self.db.set_profiling_level(self.initial_profiling_level)
-
-    def __enter__(self):
-        self._turn_on_profiling()
         return self
 
     def __exit__(self, t, value, traceback):
-        self._resets_profiling()
+        """Reset the profiling level."""
+        self.db.set_profiling_level(0)
 
     def __eq__(self, value):
+        """== Compare querycounter."""
         counter = self._get_count()
         return value == counter
 
     def __ne__(self, value):
+        """!= Compare querycounter."""
         return not self.__eq__(value)
 
     def __lt__(self, value):
+        """< Compare querycounter."""
         return self._get_count() < value
 
     def __le__(self, value):
+        """<= Compare querycounter."""
         return self._get_count() <= value
 
     def __gt__(self, value):
+        """> Compare querycounter."""
         return self._get_count() > value
 
     def __ge__(self, value):
+        """>= Compare querycounter."""
         return self._get_count() >= value
 
     def __int__(self):
+        """int representation."""
         return self._get_count()
 
     def __repr__(self):
@@ -234,17 +210,8 @@ class query_counter(object):
         return u"%s" % self._get_count()
 
     def _get_count(self):
-        """Get the number of queries by counting the current number of entries in db.system.profile
-        and substracting the queries issued by this context. In fact everytime this is called, 1 query is
-        issued so we need to balance that
-        """
-        count = count_documents(self.db.system.profile, self._ignored_query) - self._ctx_query_counter
-        self._ctx_query_counter += 1    # Account for the query we just issued to gather the information
+        """Get the number of queries."""
+        ignore_query = {'ns': {'$ne': '%s.system.indexes' % self.db.name}}
+        count = self.db.system.profile.find(ignore_query).count() - self.counter
+        self.counter += 1
         return count
-
-
-@contextmanager
-def set_write_concern(collection, write_concerns):
-    combined_concerns = dict(collection.write_concern.document.items())
-    combined_concerns.update(write_concerns)
-    yield collection.with_options(write_concern=WriteConcern(**combined_concerns))

mongoengine/dereference.py

@@ -1,10 +1,8 @@
 from bson import DBRef, SON
 import six
-from six import iteritems
 
 from mongoengine.base import (BaseDict, BaseList, EmbeddedDocumentList,
                               TopLevelDocumentMetaclass, get_document)
-from mongoengine.base.datastructures import LazyReference
 from mongoengine.connection import get_db
 from mongoengine.document import Document, EmbeddedDocument
 from mongoengine.fields import DictField, ListField, MapField, ReferenceField
@@ -53,40 +51,26 @@ class DeReference(object):
                         [i.__class__ == doc_type for i in items.values()]):
                     return items
                 elif not field.dbref:
-                    # We must turn the ObjectIds into DBRefs
-
-                    # Recursively dig into the sub items of a list/dict
-                    # to turn the ObjectIds into DBRefs
-                    def _get_items_from_list(items):
-                        new_items = []
-                        for v in items:
-                            value = v
-                            if isinstance(v, dict):
-                                value = _get_items_from_dict(v)
-                            elif isinstance(v, list):
-                                value = _get_items_from_list(v)
-                            elif not isinstance(v, (DBRef, Document)):
-                                value = field.to_python(v)
-                            new_items.append(value)
-                        return new_items
-
-                    def _get_items_from_dict(items):
-                        new_items = {}
-                        for k, v in iteritems(items):
-                            value = v
-                            if isinstance(v, list):
-                                value = _get_items_from_list(v)
-                            elif isinstance(v, dict):
-                                value = _get_items_from_dict(v)
-                            elif not isinstance(v, (DBRef, Document)):
-                                value = field.to_python(v)
-                            new_items[k] = value
-                        return new_items
-
                     if not hasattr(items, 'items'):
-                        items = _get_items_from_list(items)
+
+                        def _get_items(items):
+                            new_items = []
+                            for v in items:
+                                if isinstance(v, list):
+                                    new_items.append(_get_items(v))
+                                elif not isinstance(v, (DBRef, Document)):
+                                    new_items.append(field.to_python(v))
+                                else:
+                                    new_items.append(v)
+                            return new_items
+
+                        items = _get_items(items)
                     else:
-                        items = _get_items_from_dict(items)
+                        items = {
+                            k: (v if isinstance(v, (DBRef, Document))
+                                else field.to_python(v))
+                            for k, v in items.iteritems()
+                        }
 
         self.reference_map = self._find_references(items)
         self.object_map = self._fetch_objects(doc_type=doc_type)
@@ -113,32 +97,26 @@ class DeReference(object):
         depth += 1
         for item in iterator:
             if isinstance(item, (Document, EmbeddedDocument)):
-                for field_name, field in iteritems(item._fields):
+                for field_name, field in item._fields.iteritems():
                     v = item._data.get(field_name, None)
-                    if isinstance(v, LazyReference):
-                        # LazyReference inherits DBRef but should not be dereferenced here !
-                        continue
-                    elif isinstance(v, DBRef):
+                    if isinstance(v, DBRef):
                         reference_map.setdefault(field.document_type, set()).add(v.id)
                     elif isinstance(v, (dict, SON)) and '_ref' in v:
                         reference_map.setdefault(get_document(v['_cls']), set()).add(v['_ref'].id)
                     elif isinstance(v, (dict, list, tuple)) and depth <= self.max_depth:
                         field_cls = getattr(getattr(field, 'field', None), 'document_type', None)
                         references = self._find_references(v, depth)
-                        for key, refs in iteritems(references):
+                        for key, refs in references.iteritems():
                             if isinstance(field_cls, (Document, TopLevelDocumentMetaclass)):
                                 key = field_cls
                             reference_map.setdefault(key, set()).update(refs)
-            elif isinstance(item, LazyReference):
-                # LazyReference inherits DBRef but should not be dereferenced here !
-                continue
             elif isinstance(item, DBRef):
                 reference_map.setdefault(item.collection, set()).add(item.id)
             elif isinstance(item, (dict, SON)) and '_ref' in item:
                 reference_map.setdefault(get_document(item['_cls']), set()).add(item['_ref'].id)
             elif isinstance(item, (dict, list, tuple)) and depth - 1 <= self.max_depth:
                 references = self._find_references(item, depth - 1)
-                for key, refs in iteritems(references):
+                for key, refs in references.iteritems():
                     reference_map.setdefault(key, set()).update(refs)
 
         return reference_map
@@ -147,21 +125,16 @@ class DeReference(object):
         """Fetch all references and convert to their document objects
         """
         object_map = {}
-        for collection, dbrefs in iteritems(self.reference_map):
-
-            # we use getattr instead of hasattr because hasattr swallows any exception under python2
-            # so it could hide nasty things without raising exceptions (cfr bug #1688))
-            ref_document_cls_exists = (getattr(collection, 'objects', None) is not None)
-
-            if ref_document_cls_exists:
+        for collection, dbrefs in self.reference_map.iteritems():
+            if hasattr(collection, 'objects'):  # We have a document class for the refs
                 col_name = collection._get_collection_name()
                 refs = [dbref for dbref in dbrefs
                         if (col_name, dbref) not in object_map]
                 references = collection.objects.in_bulk(refs)
-                for key, doc in iteritems(references):
+                for key, doc in references.iteritems():
                     object_map[(col_name, key)] = doc
             else:  # Generic reference: use the refs data to convert to document
-                if isinstance(doc_type, (ListField, DictField, MapField)):
+                if isinstance(doc_type, (ListField, DictField, MapField,)):
                     continue
 
                 refs = [dbref for dbref in dbrefs
@@ -230,7 +203,7 @@ class DeReference(object):
             data = []
         else:
             is_list = False
-            iterator = iteritems(items)
+            iterator = items.iteritems()
             data = {}
 
         depth += 1
@@ -257,7 +230,7 @@ class DeReference(object):
             elif isinstance(v, (dict, list, tuple)) and depth <= self.max_depth:
                 item_name = '%s.%s' % (name, k) if name else name
                 data[k] = self._attach_objects(v, depth - 1, instance=instance, name=item_name)
-            elif isinstance(v, DBRef) and hasattr(v, 'id'):
+            elif hasattr(v, 'id'):
                 data[k] = self.object_map.get((v.collection, v.id), v)
 
         if instance and name:

mongoengine/document.py

@@ -5,7 +5,6 @@ from bson.dbref import DBRef
 import pymongo
 from pymongo.read_preferences import ReadPreference
 import six
-from six import iteritems
 
 from mongoengine import signals
 from mongoengine.base import (BaseDict, BaseDocument, BaseList,
@@ -13,12 +12,10 @@ from mongoengine.base import (BaseDict, BaseDocument, BaseList,
                               TopLevelDocumentMetaclass, get_document)
 from mongoengine.common import _import_class
 from mongoengine.connection import DEFAULT_CONNECTION_NAME, get_db
-from mongoengine.context_managers import (set_write_concern,
-                                          switch_collection,
-                                          switch_db)
+from mongoengine.context_managers import switch_collection, switch_db
 from mongoengine.errors import (InvalidDocumentError, InvalidQueryError,
                                 SaveConditionError)
-from mongoengine.pymongo_support import list_collection_names
+from mongoengine.python_support import IS_PYMONGO_3
 from mongoengine.queryset import (NotUniqueError, OperationError,
                                   QuerySet, transform)
 
@@ -42,7 +39,7 @@ class InvalidCollectionError(Exception):
     pass
 
 
-class EmbeddedDocument(six.with_metaclass(DocumentMetaclass, BaseDocument)):
+class EmbeddedDocument(BaseDocument):
     """A :class:`~mongoengine.Document` that isn't stored in its own
     collection.  :class:`~mongoengine.EmbeddedDocument`\ s should be used as
     fields on :class:`~mongoengine.Document`\ s through the
@@ -61,6 +58,7 @@ class EmbeddedDocument(six.with_metaclass(DocumentMetaclass, BaseDocument)):
     # The __metaclass__ attribute is removed by 2to3 when running with Python3
     # my_metaclass is defined so that metaclass can be queried in Python 2 & 3
     my_metaclass = DocumentMetaclass
+    __metaclass__ = DocumentMetaclass
 
     # A generic embedded document doesn't have any immutable properties
     # that describe it uniquely, hence it shouldn't be hashable. You can
@@ -90,8 +88,14 @@ class EmbeddedDocument(six.with_metaclass(DocumentMetaclass, BaseDocument)):
 
         return data
 
+    def save(self, *args, **kwargs):
+        self._instance.save(*args, **kwargs)
 
-class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
+    def reload(self, *args, **kwargs):
+        self._instance.reload(*args, **kwargs)
+
+
+class Document(BaseDocument):
     """The base class used for defining the structure and properties of
     collections of documents stored in MongoDB. Inherit from this class, and
     add fields as class attributes to define a document's structure.
@@ -146,6 +150,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
     # The __metaclass__ attribute is removed by 2to3 when running with Python3
     # my_metaclass is defined so that metaclass can be queried in Python 2 & 3
     my_metaclass = TopLevelDocumentMetaclass
+    __metaclass__ = TopLevelDocumentMetaclass
 
     __slots__ = ('__objects',)
 
@@ -167,30 +172,19 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         """
         if self.pk is None:
             return super(BaseDocument, self).__hash__()
-
-        return hash(self.pk)
+        else:
+            return hash(self.pk)
 
     @classmethod
     def _get_db(cls):
         """Some Model using other db_alias"""
         return get_db(cls._meta.get('db_alias', DEFAULT_CONNECTION_NAME))
 
-    @classmethod
-    def _disconnect(cls):
-        """Detach the Document class from the (cached) database collection"""
-        cls._collection = None
-
     @classmethod
     def _get_collection(cls):
-        """Return the PyMongo collection corresponding to this document.
-
-        Upon first call, this method:
-        1. Initializes a :class:`~pymongo.collection.Collection` corresponding
-           to this document.
-        2. Creates indexes defined in this document's :attr:`meta` dictionary.
-           This happens only if `auto_create_index` is True.
-        """
+        """Return a PyMongo collection for the document."""
         if not hasattr(cls, '_collection') or cls._collection is None:
+
             # Get the collection, either capped or regular.
             if cls._meta.get('max_size') or cls._meta.get('max_documents'):
                 cls._collection = cls._get_capped_collection()
@@ -201,10 +195,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
 
             # Ensure indexes on the collection unless auto_create_index was
             # set to False.
-            # Also there is no need to ensure indexes on slave.
-            db = cls._get_db()
-            if cls._meta.get('auto_create_index', True) and\
-                    db.client.is_primary:
+            if cls._meta.get('auto_create_index', True):
                 cls.ensure_indexes()
 
         return cls._collection
@@ -227,7 +218,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
 
         # If the collection already exists and has different options
         # (i.e. isn't capped or has different max/size), raise an error.
-        if collection_name in list_collection_names(db, include_system_collections=True):
+        if collection_name in db.collection_names():
             collection = db[collection_name]
             options = collection.options()
             if (
@@ -252,7 +243,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         data = super(Document, self).to_mongo(*args, **kwargs)
 
         # If '_id' is None, try and set it from self._data. If that
-        # doesn't exist either, remove '_id' from the SON completely.
+        # doesn't exist either, remote '_id' from the SON completely.
         if data['_id'] is None:
             if self._data.get('id') is None:
                 del data['_id']
@@ -289,9 +280,6 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         elif query[id_field] != self.pk:
             raise InvalidQueryError('Invalid document modify query: it must modify only this document.')
 
-        # Need to add shard key to query, or you get an error
-        query.update(self._object_key)
-
         updated = self._qs(**query).modify(new=True, **update)
         if updated is None:
             return False
@@ -332,7 +320,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         :param save_condition: only perform save if matching record in db
             satisfies condition(s) (e.g. version number).
             Raises :class:`OperationError` if the conditions are not satisfied
-        :param signal_kwargs: (optional) kwargs dictionary to be passed to
+        :parm signal_kwargs: (optional) kwargs dictionary to be passed to
             the signal calls.
 
         .. versionchanged:: 0.5
@@ -358,26 +346,24 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         .. versionchanged:: 0.10.7
             Add signal_kwargs argument
         """
-        signal_kwargs = signal_kwargs or {}
-
         if self._meta.get('abstract'):
             raise InvalidDocumentError('Cannot save an abstract document.')
 
+        signal_kwargs = signal_kwargs or {}
         signals.pre_save.send(self.__class__, document=self, **signal_kwargs)
 
         if validate:
             self.validate(clean=clean)
 
         if write_concern is None:
-            write_concern = {}
+            write_concern = {'w': 1}
 
-        doc_id = self.to_mongo(fields=[self._meta['id_field']])
-        created = ('_id' not in doc_id or self._created or force_insert)
+        doc = self.to_mongo()
+
+        created = ('_id' not in doc or self._created or force_insert)
 
         signals.pre_save_post_validation.send(self.__class__, document=self,
                                               created=created, **signal_kwargs)
-        # it might be refreshed by the pre_save_post_validation hook, e.g., for etag generation
-        doc = self.to_mongo()
 
         if self._meta.get('auto_create_index', True):
             self.ensure_indexes()
@@ -437,18 +423,21 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         Helper method, should only be used inside save().
         """
         collection = self._get_collection()
-        with set_write_concern(collection, write_concern) as wc_collection:
-            if force_insert:
-                return wc_collection.insert_one(doc).inserted_id
-            # insert_one will provoke UniqueError alongside save does not
-            # therefore, it need to catch and call replace_one.
-            if '_id' in doc:
-                raw_object = wc_collection.find_one_and_replace(
-                    {'_id': doc['_id']}, doc)
-                if raw_object:
-                    return doc['_id']
 
-            object_id = wc_collection.insert_one(doc).inserted_id
+        if force_insert:
+            return collection.insert(doc, **write_concern)
+
+        object_id = collection.save(doc, **write_concern)
+
+        # In PyMongo 3.0, the save() call calls internally the _update() call
+        # but they forget to return the _id value passed back, therefore getting it back here
+        # Correct behaviour in 2.X and in 3.0.1+ versions
+        if not object_id and pymongo.version_tuple == (3, 0):
+            pk_as_mongo_obj = self._fields.get(self._meta['id_field']).to_mongo(self.pk)
+            object_id = (
+                self._qs.filter(pk=pk_as_mongo_obj).first() and
+                self._qs.filter(pk=pk_as_mongo_obj).first().pk
+            )  # TODO doesn't this make 2 queries?
 
         return object_id
 
@@ -495,12 +484,8 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         update_doc = self._get_update_doc()
         if update_doc:
             upsert = save_condition is None
-            with set_write_concern(collection, write_concern) as wc_collection:
-                last_error = wc_collection.update_one(
-                    select_dict,
-                    update_doc,
-                    upsert=upsert
-                ).raw_result
+            last_error = collection.update(select_dict, update_doc,
+                                           upsert=upsert, **write_concern)
             if not upsert and last_error['n'] == 0:
                 raise SaveConditionError('Race condition preventing'
                                          ' document update detected')
@@ -544,7 +529,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
 
     @property
     def _qs(self):
-        """Return the default queryset corresponding to this document."""
+        """Return the queryset to use for updating / reloading / deletions."""
         if not hasattr(self, '__objects'):
             self.__objects = QuerySet(self, self._get_collection())
         return self.__objects
@@ -552,11 +537,9 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
     @property
     def _object_key(self):
         """Get the query dict that can be used to fetch this object from
-        the database.
-
-        Most of the time the dict is a simple PK lookup, but in case of
-        a sharded collection with a compound shard key, it can contain a more
-        complex query.
+        the database. Most of the time it's a simple PK lookup, but in
+        case of a sharded collection with a compound shard key, it can
+        contain a more complex query.
         """
         select_dict = {'pk': self.pk}
         shard_key = self.__class__._meta.get('shard_key', tuple())
@@ -593,11 +576,12 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         """Delete the :class:`~mongoengine.Document` from the database. This
         will only take effect if the document has been previously saved.
 
-        :param signal_kwargs: (optional) kwargs dictionary to be passed to
+        :parm signal_kwargs: (optional) kwargs dictionary to be passed to
             the signal calls.
         :param write_concern: Extra keyword arguments are passed down which
-            will be used as options for the resultant ``getLastError`` command.
-            For example, ``save(..., w: 2, fsync: True)`` will
+            will be used as options for the resultant
+            ``getLastError`` command.  For example,
+            ``save(..., write_concern={w: 2, fsync: True}, ...)`` will
             wait until at least two servers have recorded the write and
             will force an fsync on the primary server.
 
@@ -609,7 +593,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
 
         # Delete FileFields separately
         FileField = _import_class('FileField')
-        for name, field in iteritems(self._fields):
+        for name, field in self._fields.iteritems():
             if isinstance(field, FileField):
                 getattr(self, name).delete()
 
@@ -718,6 +702,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
             obj = obj[0]
         else:
             raise self.DoesNotExist('Document does not exist')
+
         for field in obj._data:
             if not fields or field in fields:
                 try:
@@ -725,7 +710,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
                 except (KeyError, AttributeError):
                     try:
                         # If field is a special field, e.g. items is stored as _reserved_items,
-                        # a KeyError is thrown. So try to retrieve the field from _data
+                        # an KeyError is thrown. So try to retrieve the field from _data
                         setattr(self, field, self._reload(field, obj._data.get(field)))
                     except KeyError:
                         # If field is removed from the database while the object
@@ -733,9 +718,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
                         # i.e. obj.update(unset__field=1) followed by obj.reload()
                         delattr(self, field)
 
-        self._changed_fields = list(
-            set(self._changed_fields) - set(fields)
-        ) if fields else obj._changed_fields
+        self._changed_fields = obj._changed_fields
         self._created = False
         return self
 
@@ -794,13 +777,13 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         .. versionchanged:: 0.10.7
             :class:`OperationError` exception raised if no collection available
         """
-        coll_name = cls._get_collection_name()
-        if not coll_name:
+        col_name = cls._get_collection_name()
+        if not col_name:
             raise OperationError('Document %s has no collection defined '
                                  '(is it abstract ?)' % cls)
         cls._collection = None
         db = cls._get_db()
-        db.drop_collection(coll_name)
+        db.drop_collection(col_name)
 
     @classmethod
     def create_index(cls, keys, background=False, **kwargs):
@@ -815,13 +798,18 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         index_spec = index_spec.copy()
         fields = index_spec.pop('fields')
         drop_dups = kwargs.get('drop_dups', False)
-        if drop_dups:
+        if IS_PYMONGO_3 and drop_dups:
             msg = 'drop_dups is deprecated and is removed when using PyMongo 3+.'
             warnings.warn(msg, DeprecationWarning)
+        elif not IS_PYMONGO_3:
+            index_spec['drop_dups'] = drop_dups
         index_spec['background'] = background
         index_spec.update(kwargs)
 
-        return cls._get_collection().create_index(fields, **index_spec)
+        if IS_PYMONGO_3:
+            return cls._get_collection().create_index(fields, **index_spec)
+        else:
+            return cls._get_collection().ensure_index(fields, **index_spec)
 
     @classmethod
     def ensure_index(cls, key_or_list, drop_dups=False, background=False,
@@ -836,9 +824,11 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         :param drop_dups: Was removed/ignored with MongoDB >2.7.5. The value
             will be removed if PyMongo3+ is used
         """
-        if drop_dups:
+        if IS_PYMONGO_3 and drop_dups:
             msg = 'drop_dups is deprecated and is removed when using PyMongo 3+.'
             warnings.warn(msg, DeprecationWarning)
+        elif not IS_PYMONGO_3:
+            kwargs.update({'drop_dups': drop_dups})
         return cls.create_index(key_or_list, background=background, **kwargs)
 
     @classmethod
@@ -854,7 +844,7 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         drop_dups = cls._meta.get('index_drop_dups', False)
         index_opts = cls._meta.get('index_opts') or {}
         index_cls = cls._meta.get('index_cls', True)
-        if drop_dups:
+        if IS_PYMONGO_3 and drop_dups:
             msg = 'drop_dups is deprecated and is removed when using PyMongo 3+.'
             warnings.warn(msg, DeprecationWarning)
 
@@ -885,7 +875,11 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
                 if 'cls' in opts:
                     del opts['cls']
 
-                collection.create_index(fields, background=background, **opts)
+                if IS_PYMONGO_3:
+                    collection.create_index(fields, background=background, **opts)
+                else:
+                    collection.ensure_index(fields, background=background,
+                                            drop_dups=drop_dups, **opts)
 
         # If _cls is being used (for polymorphism), it needs an index,
         # only if another index doesn't begin with _cls
@@ -896,8 +890,12 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
             if 'cls' in index_opts:
                 del index_opts['cls']
 
-            collection.create_index('_cls', background=background,
-                                    **index_opts)
+            if IS_PYMONGO_3:
+                collection.create_index('_cls', background=background,
+                                        **index_opts)
+            else:
+                collection.ensure_index('_cls', background=background,
+                                        **index_opts)
 
     @classmethod
     def list_indexes(cls):
@@ -966,16 +964,8 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         """
 
         required = cls.list_indexes()
-
-        existing = []
-        for info in cls._get_collection().index_information().values():
-            if '_fts' in info['key'][0]:
-                index_type = info['key'][0][1]
-                text_index_fields = info.get('weights').keys()
-                existing.append(
-                    [(key, index_type) for key in text_index_fields])
-            else:
-                existing.append(info['key'])
+        existing = [info['key']
+                    for info in cls._get_collection().index_information().values()]
         missing = [index for index in required if index not in existing]
         extra = [index for index in existing if index not in required]
 
@@ -992,10 +982,10 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
         return {'missing': missing, 'extra': extra}
 
 
-class DynamicDocument(six.with_metaclass(TopLevelDocumentMetaclass, Document)):
+class DynamicDocument(Document):
     """A Dynamic Document class allowing flexible, expandable and uncontrolled
     schemas.  As a :class:`~mongoengine.Document` subclass, acts in the same
-    way as an ordinary document but has expanded style properties.  Any data
+    way as an ordinary document but has expando style properties.  Any data
     passed or set against the :class:`~mongoengine.DynamicDocument` that is
     not a field is automatically converted into a
     :class:`~mongoengine.fields.DynamicField` and data can be attributed to that
@@ -1003,12 +993,13 @@ class DynamicDocument(six.with_metaclass(TopLevelDocumentMetaclass, Document)):
 
     .. note::
 
-        There is one caveat on Dynamic Documents: undeclared fields cannot start with `_`
+        There is one caveat on Dynamic Documents: fields cannot start with `_`
     """
 
     # The __metaclass__ attribute is removed by 2to3 when running with Python3
     # my_metaclass is defined so that metaclass can be queried in Python 2 & 3
     my_metaclass = TopLevelDocumentMetaclass
+    __metaclass__ = TopLevelDocumentMetaclass
 
     _dynamic = True
 
@@ -1019,12 +1010,11 @@ class DynamicDocument(six.with_metaclass(TopLevelDocumentMetaclass, Document)):
         field_name = args[0]
         if field_name in self._dynamic_fields:
             setattr(self, field_name, None)
-            self._dynamic_fields[field_name].null = False
         else:
             super(DynamicDocument, self).__delattr__(*args, **kwargs)
 
 
-class DynamicEmbeddedDocument(six.with_metaclass(DocumentMetaclass, EmbeddedDocument)):
+class DynamicEmbeddedDocument(EmbeddedDocument):
     """A Dynamic Embedded Document class allowing flexible, expandable and
     uncontrolled schemas. See :class:`~mongoengine.DynamicDocument` for more
     information about dynamic documents.
@@ -1033,6 +1023,7 @@ class DynamicEmbeddedDocument(six.with_metaclass(DocumentMetaclass, EmbeddedDocu
     # The __metaclass__ attribute is removed by 2to3 when running with Python3
     # my_metaclass is defined so that metaclass can be queried in Python 2 & 3
     my_metaclass = DocumentMetaclass
+    __metaclass__ = DocumentMetaclass
 
     _dynamic = True
 

mongoengine/errors.py

@@ -1,12 +1,11 @@
 from collections import defaultdict
 
 import six
-from six import iteritems
 
 __all__ = ('NotRegistered', 'InvalidDocumentError', 'LookUpError',
            'DoesNotExist', 'MultipleObjectsReturned', 'InvalidQueryError',
            'OperationError', 'NotUniqueError', 'FieldDoesNotExist',
-           'ValidationError', 'SaveConditionError', 'DeprecatedError')
+           'ValidationError', 'SaveConditionError')
 
 
 class NotRegistered(Exception):
@@ -72,7 +71,6 @@ class ValidationError(AssertionError):
     _message = None
 
     def __init__(self, message='', **kwargs):
-        super(ValidationError, self).__init__(message)
         self.errors = kwargs.get('errors', {})
         self.field_name = kwargs.get('field_name')
         self.message = message
@@ -110,8 +108,11 @@ class ValidationError(AssertionError):
 
         def build_dict(source):
             errors_dict = {}
+            if not source:
+                return errors_dict
+
             if isinstance(source, dict):
-                for field_name, error in iteritems(source):
+                for field_name, error in source.iteritems():
                     errors_dict[field_name] = build_dict(error)
             elif isinstance(source, ValidationError) and source.errors:
                 return build_dict(source.errors)
@@ -133,17 +134,12 @@ class ValidationError(AssertionError):
                 value = ' '.join([generate_key(k) for k in value])
             elif isinstance(value, dict):
                 value = ' '.join(
-                    [generate_key(v, k) for k, v in iteritems(value)])
+                    [generate_key(v, k) for k, v in value.iteritems()])
 
             results = '%s.%s' % (prefix, value) if prefix else value
             return results
 
         error_dict = defaultdict(list)
-        for k, v in iteritems(self.to_dict()):
+        for k, v in self.to_dict().iteritems():
             error_dict[generate_key(v)].append(k)
-        return ' '.join(['%s: %s' % (k, v) for k, v in iteritems(error_dict)])
-
-
-class DeprecatedError(Exception):
-    """Raise when a user uses a feature that has been Deprecated"""
-    pass
+        return ' '.join(['%s: %s' % (k, v) for k, v in error_dict.iteritems()])

mongoengine/fields.py

@@ -5,13 +5,13 @@ import re
 import socket
 import time
 import uuid
+import warnings
 from operator import itemgetter
 
 from bson import Binary, DBRef, ObjectId, SON
 import gridfs
 import pymongo
 import six
-from six import iteritems
 
 try:
     import dateutil
@@ -25,19 +25,13 @@ try:
 except ImportError:
     Int64 = long
 
-
 from mongoengine.base import (BaseDocument, BaseField, ComplexBaseField,
-                              GeoJsonBaseField, LazyReference, ObjectIdField,
-                              get_document)
-from mongoengine.base.utils import LazyRegexCompiler
-from mongoengine.common import _import_class
+                              GeoJsonBaseField, ObjectIdField, get_document)
 from mongoengine.connection import DEFAULT_CONNECTION_NAME, get_db
 from mongoengine.document import Document, EmbeddedDocument
 from mongoengine.errors import DoesNotExist, InvalidQueryError, ValidationError
 from mongoengine.python_support import StringIO
-from mongoengine.queryset import DO_NOTHING
-from mongoengine.queryset.base import BaseQuerySet
-from mongoengine.queryset.transform import STRING_OPERATORS
+from mongoengine.queryset import DO_NOTHING, QuerySet
 
 try:
     from PIL import Image, ImageOps
@@ -45,20 +39,13 @@ except ImportError:
     Image = None
     ImageOps = None
 
-if six.PY3:
-    # Useless as long as 2to3 gets executed
-    # as it turns `long` into `int` blindly
-    long = int
-
-
 __all__ = (
     'StringField', 'URLField', 'EmailField', 'IntField', 'LongField',
-    'FloatField', 'DecimalField', 'BooleanField', 'DateTimeField', 'DateField',
+    'FloatField', 'DecimalField', 'BooleanField', 'DateTimeField',
     'ComplexDateTimeField', 'EmbeddedDocumentField', 'ObjectIdField',
     'GenericEmbeddedDocumentField', 'DynamicField', 'ListField',
     'SortedListField', 'EmbeddedDocumentListField', 'DictField',
     'MapField', 'ReferenceField', 'CachedReferenceField',
-    'LazyReferenceField', 'GenericLazyReferenceField',
     'GenericReferenceField', 'BinaryField', 'GridFSError', 'GridFSProxy',
     'FileField', 'ImageGridFsProxy', 'ImproperlyConfigured', 'ImageField',
     'GeoPointField', 'PointField', 'LineStringField', 'PolygonField',
@@ -107,11 +94,11 @@ class StringField(BaseField):
         if not isinstance(op, six.string_types):
             return value
 
-        if op in STRING_OPERATORS:
-            case_insensitive = op.startswith('i')
-            op = op.lstrip('i')
-
-            flags = re.IGNORECASE if case_insensitive else 0
+        if op.lstrip('i') in ('startswith', 'endswith', 'contains', 'exact'):
+            flags = 0
+            if op.startswith('i'):
+                flags = re.IGNORECASE
+                op = op.lstrip('i')
 
             regex = r'%s'
             if op == 'startswith':
@@ -133,9 +120,9 @@ class URLField(StringField):
     .. versionadded:: 0.3
     """
 
-    _URL_REGEX = LazyRegexCompiler(
+    _URL_REGEX = re.compile(
         r'^(?:[a-z0-9\.\-]*)://'  # scheme is validated separately
-        r'(?:(?:[A-Z0-9](?:[A-Z0-9-_]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}(?<!-)\.?)|'  # domain...
+        r'(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}(?<!-)\.?)|'  # domain...
         r'localhost|'  # localhost...
         r'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|'  # ...or ipv4
         r'\[?[A-F0-9]*:[A-F0-9:]+\]?)'  # ...or ipv6
@@ -143,7 +130,8 @@ class URLField(StringField):
         r'(?:/?|[/?]\S+)$', re.IGNORECASE)
     _URL_SCHEMES = ['http', 'https', 'ftp', 'ftps']
 
-    def __init__(self, url_regex=None, schemes=None, **kwargs):
+    def __init__(self, verify_exists=False, url_regex=None, schemes=None, **kwargs):
+        self.verify_exists = verify_exists
         self.url_regex = url_regex or self._URL_REGEX
         self.schemes = schemes or self._URL_SCHEMES
         super(URLField, self).__init__(**kwargs)
@@ -153,10 +141,12 @@ class URLField(StringField):
         scheme = value.split('://')[0].lower()
         if scheme not in self.schemes:
             self.error(u'Invalid scheme {} in URL: {}'.format(scheme, value))
+            return
 
         # Then check full URL
         if not self.url_regex.match(value):
             self.error(u'Invalid URL: {}'.format(value))
+            return
 
 
 class EmailField(StringField):
@@ -164,7 +154,7 @@ class EmailField(StringField):
 
     .. versionadded:: 0.4
     """
-    USER_REGEX = LazyRegexCompiler(
+    USER_REGEX = re.compile(
         # `dot-atom` defined in RFC 5322 Section 3.2.3.
         r"(^[-!#$%&'*+/=?^_`{}|~0-9A-Z]+(\.[-!#$%&'*+/=?^_`{}|~0-9A-Z]+)*\Z"
         # `quoted-string` defined in RFC 5322 Section 3.2.4.
@@ -172,7 +162,7 @@ class EmailField(StringField):
         re.IGNORECASE
     )
 
-    UTF8_USER_REGEX = LazyRegexCompiler(
+    UTF8_USER_REGEX = re.compile(
         six.u(
             # RFC 6531 Section 3.3 extends `atext` (used by dot-atom) to
             # include `UTF8-non-ascii`.
@@ -182,7 +172,7 @@ class EmailField(StringField):
         ), re.IGNORECASE | re.UNICODE
     )
 
-    DOMAIN_REGEX = LazyRegexCompiler(
+    DOMAIN_REGEX = re.compile(
         r'((?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+)(?:[A-Z0-9-]{2,63}(?<!-))\Z',
         re.IGNORECASE
     )
@@ -258,10 +248,10 @@ class EmailField(StringField):
             try:
                 domain_part = domain_part.encode('idna').decode('ascii')
             except UnicodeError:
-                self.error("%s %s" % (self.error_msg % value, "(domain failed IDN encoding)"))
+                self.error(self.error_msg % value)
             else:
                 if not self.validate_domain_part(domain_part):
-                    self.error("%s %s" % (self.error_msg % value, "(domain validation failed)"))
+                    self.error(self.error_msg % value)
 
 
 class IntField(BaseField):
@@ -274,14 +264,14 @@ class IntField(BaseField):
     def to_python(self, value):
         try:
             value = int(value)
-        except (TypeError, ValueError):
+        except ValueError:
             pass
         return value
 
     def validate(self, value):
         try:
             value = int(value)
-        except (TypeError, ValueError):
+        except Exception:
             self.error('%s could not be converted to int' % value)
 
         if self.min_value is not None and value < self.min_value:
@@ -307,7 +297,7 @@ class LongField(BaseField):
     def to_python(self, value):
         try:
             value = long(value)
-        except (TypeError, ValueError):
+        except ValueError:
             pass
         return value
 
@@ -317,7 +307,7 @@ class LongField(BaseField):
     def validate(self, value):
         try:
             value = long(value)
-        except (TypeError, ValueError):
+        except Exception:
             self.error('%s could not be converted to long' % value)
 
         if self.min_value is not None and value < self.min_value:
@@ -371,8 +361,7 @@ class FloatField(BaseField):
 
 
 class DecimalField(BaseField):
-    """Fixed-point decimal number field. Stores the value as a float by default unless `force_string` is used.
-    If using floats, beware of Decimal to float conversion (potential precision loss)
+    """Fixed-point decimal number field.
 
     .. versionchanged:: 0.8
     .. versionadded:: 0.3
@@ -383,9 +372,7 @@ class DecimalField(BaseField):
         """
         :param min_value: Validation rule for the minimum acceptable value.
         :param max_value: Validation rule for the maximum acceptable value.
-        :param force_string: Store the value as a string (instead of a float).
-         Be aware that this affects query sorting and operation like lte, gte (as string comparison is applied)
-         and some query operator won't work (e.g: inc, dec)
+        :param force_string: Store as a string.
         :param precision: Number of decimal places to store.
         :param rounding: The rounding rule from the python decimal library:
 
@@ -416,7 +403,7 @@ class DecimalField(BaseField):
         # Convert to string for python 2.6 before casting to Decimal
         try:
             value = decimal.Decimal('%s' % value)
-        except (TypeError, ValueError, decimal.InvalidOperation):
+        except decimal.InvalidOperation:
             return value
         return value.quantize(decimal.Decimal('.%s' % ('0' * self.precision)), rounding=self.rounding)
 
@@ -433,7 +420,7 @@ class DecimalField(BaseField):
                 value = six.text_type(value)
             try:
                 value = decimal.Decimal(value)
-            except (TypeError, ValueError, decimal.InvalidOperation) as exc:
+            except Exception as exc:
                 self.error('Could not convert value to decimal: %s' % exc)
 
         if self.min_value is not None and value < self.min_value:
@@ -472,8 +459,6 @@ class DateTimeField(BaseField):
     installed you can utilise it to convert varying types of date formats into valid
     python datetime objects.
 
-    Note: To default the field to the current datetime, use: DateTimeField(default=datetime.utcnow)
-
     Note: Microseconds are rounded to the nearest millisecond.
       Pre UTC microsecond support is effectively broken.
       Use :class:`~mongoengine.fields.ComplexDateTimeField` if you
@@ -498,18 +483,11 @@ class DateTimeField(BaseField):
         if not isinstance(value, six.string_types):
             return None
 
-        return self._parse_datetime(value)
-
-    def _parse_datetime(self, value):
-        # Attempt to parse a datetime from a string
-        value = value.strip()
-        if not value:
-            return None
-
+        # Attempt to parse a datetime:
         if dateutil:
             try:
                 return dateutil.parser.parse(value)
-            except (TypeError, ValueError, OverflowError):
+            except (TypeError, ValueError):
                 return None
 
         # split usecs, because they are not recognized by strptime.
@@ -540,22 +518,6 @@ class DateTimeField(BaseField):
         return super(DateTimeField, self).prepare_query_value(op, self.to_mongo(value))
 
 
-class DateField(DateTimeField):
-    def to_mongo(self, value):
-        value = super(DateField, self).to_mongo(value)
-        # drop hours, minutes, seconds
-        if isinstance(value, datetime.datetime):
-            value = datetime.datetime(value.year, value.month, value.day)
-        return value
-
-    def to_python(self, value):
-        value = super(DateField, self).to_python(value)
-        # convert datetime to date
-        if isinstance(value, datetime.datetime):
-            value = datetime.date(value.year, value.month, value.day)
-        return value
-
-
 class ComplexDateTimeField(StringField):
     """
     ComplexDateTimeField handles microseconds exactly instead of rounding
@@ -572,15 +534,11 @@ class ComplexDateTimeField(StringField):
     The `,` as the separator can be easily modified by passing the `separator`
     keyword when initializing the field.
 
-    Note: To default the field to the current datetime, use: DateTimeField(default=datetime.utcnow)
-
     .. versionadded:: 0.5
     """
 
     def __init__(self, separator=',', **kwargs):
-        """
-        :param separator: Allows to customize the separator used for storage (default ``,``)
-        """
+        self.names = ['year', 'month', 'day', 'hour', 'minute', 'second', 'microsecond']
         self.separator = separator
         self.format = separator.join(['%Y', '%m', '%d', '%H', '%M', '%S', '%f'])
         super(ComplexDateTimeField, self).__init__(**kwargs)
@@ -607,24 +565,20 @@ class ComplexDateTimeField(StringField):
         >>> ComplexDateTimeField()._convert_from_string(a)
         datetime.datetime(2011, 6, 8, 20, 26, 24, 92284)
         """
-        values = [int(d) for d in data.split(self.separator)]
+        values = map(int, data.split(self.separator))
         return datetime.datetime(*values)
 
     def __get__(self, instance, owner):
-        if instance is None:
-            return self
-
         data = super(ComplexDateTimeField, self).__get__(instance, owner)
-
-        if isinstance(data, datetime.datetime) or data is None:
+        if data is None:
+            return None if self.null else datetime.datetime.now()
+        if isinstance(data, datetime.datetime):
             return data
         return self._convert_from_string(data)
 
     def __set__(self, instance, value):
-        super(ComplexDateTimeField, self).__set__(instance, value)
-        value = instance._data[self.name]
-        if value is not None:
-            instance._data[self.name] = self._convert_from_datetime(value)
+        value = self._convert_from_datetime(value) if value else value
+        return super(ComplexDateTimeField, self).__set__(instance, value)
 
     def validate(self, value):
         value = self.to_python(value)
@@ -653,7 +607,6 @@ class EmbeddedDocumentField(BaseField):
     """
 
     def __init__(self, document_type, **kwargs):
-        # XXX ValidationError raised outside of the "validate" method.
         if not (
             isinstance(document_type, six.string_types) or
             issubclass(document_type, EmbeddedDocument)
@@ -668,17 +621,9 @@ class EmbeddedDocumentField(BaseField):
     def document_type(self):
         if isinstance(self.document_type_obj, six.string_types):
             if self.document_type_obj == RECURSIVE_REFERENCE_CONSTANT:
-                resolved_document_type = self.owner_document
+                self.document_type_obj = self.owner_document
             else:
-                resolved_document_type = get_document(self.document_type_obj)
-
-            if not issubclass(resolved_document_type, EmbeddedDocument):
-                # Due to the late resolution of the document_type
-                # There is a chance that it won't be an EmbeddedDocument (#1661)
-                self.error('Invalid embedded document class provided to an '
-                           'EmbeddedDocumentField')
-            self.document_type_obj = resolved_document_type
-
+                self.document_type_obj = get_document(self.document_type_obj)
         return self.document_type_obj
 
     def to_python(self, value):
@@ -702,11 +647,7 @@ class EmbeddedDocumentField(BaseField):
         self.document_type.validate(value, clean)
 
     def lookup_member(self, member_name):
-        doc_and_subclasses = [self.document_type] + self.document_type.__subclasses__()
-        for doc_type in doc_and_subclasses:
-            field = doc_type._fields.get(member_name)
-            if field:
-                return field
+        return self.document_type._fields.get(member_name)
 
     def prepare_query_value(self, op, value):
         if value is not None and not isinstance(value, self.document_type):
@@ -741,29 +682,16 @@ class GenericEmbeddedDocumentField(BaseField):
         return value
 
     def validate(self, value, clean=True):
-        if self.choices and isinstance(value, SON):
-            for choice in self.choices:
-                if value['_cls'] == choice._class_name:
-                    return True
-
         if not isinstance(value, EmbeddedDocument):
             self.error('Invalid embedded document instance provided to an '
                        'GenericEmbeddedDocumentField')
 
         value.validate(clean=clean)
 
-    def lookup_member(self, member_name):
-        document_choices = self.choices or []
-        for document_choice in document_choices:
-            doc_and_subclasses = [document_choice] + document_choice.__subclasses__()
-            for doc_type in doc_and_subclasses:
-                field = doc_type._fields.get(member_name)
-                if field:
-                    return field
-
     def to_mongo(self, document, use_db_field=True, fields=None):
         if document is None:
             return None
+
         data = document.to_mongo(use_db_field, fields)
         if '_cls' not in data:
             data['_cls'] = document._class_name
@@ -802,12 +730,12 @@ class DynamicField(BaseField):
             value = {k: v for k, v in enumerate(value)}
 
         data = {}
-        for k, v in iteritems(value):
+        for k, v in value.iteritems():
             data[k] = self.to_mongo(v, use_db_field, fields)
 
         value = data
         if is_list:  # Convert back to a list
-            value = [v for k, v in sorted(iteritems(data), key=itemgetter(0))]
+            value = [v for k, v in sorted(data.iteritems(), key=itemgetter(0))]
         return value
 
     def to_python(self, value):
@@ -847,20 +775,10 @@ class ListField(ComplexBaseField):
         kwargs.setdefault('default', lambda: [])
         super(ListField, self).__init__(**kwargs)
 
-    def __get__(self, instance, owner):
-        if instance is None:
-            # Document class being used rather than a document object
-            return self
-        value = instance._data.get(self.name)
-        LazyReferenceField = _import_class('LazyReferenceField')
-        GenericLazyReferenceField = _import_class('GenericLazyReferenceField')
-        if isinstance(self.field, (LazyReferenceField, GenericLazyReferenceField)) and value:
-            instance._data[self.name] = [self.field.build_lazyref(x) for x in value]
-        return super(ListField, self).__get__(instance, owner)
-
     def validate(self, value):
         """Make sure that a list of valid fields is being used."""
-        if not isinstance(value, (list, tuple, BaseQuerySet)):
+        if (not isinstance(value, (list, tuple, QuerySet)) or
+                isinstance(value, six.string_types)):
             self.error('Only lists and tuples may be used in a list field')
         super(ListField, self).validate(value)
 
@@ -952,7 +870,7 @@ def key_has_dot_or_dollar(d):
     dictionary contains a dot or a dollar sign.
     """
     for k, v in d.items():
-        if ('.' in k or k.startswith('$')) or (isinstance(v, dict) and key_has_dot_or_dollar(v)):
+        if ('.' in k or '$' in k) or (isinstance(v, dict) and key_has_dot_or_dollar(v)):
             return True
 
 
@@ -967,10 +885,12 @@ class DictField(ComplexBaseField):
     .. versionchanged:: 0.5 - Can now handle complex / varying types of data
     """
 
-    def __init__(self, field=None, *args, **kwargs):
+    def __init__(self, basecls=None, field=None, *args, **kwargs):
         self.field = field
         self._auto_dereference = False
-
+        self.basecls = basecls or BaseField
+        if not issubclass(self.basecls, BaseField):
+            self.error('DictField only accepts dict values')
         kwargs.setdefault('default', lambda: {})
         super(DictField, self).__init__(*args, **kwargs)
 
@@ -985,11 +905,11 @@ class DictField(ComplexBaseField):
             self.error(msg)
         if key_has_dot_or_dollar(value):
             self.error('Invalid dictionary key name - keys may not contain "."'
-                       ' or startswith "$" characters')
+                       ' or "$" characters')
         super(DictField, self).validate(value)
 
     def lookup_member(self, member_name):
-        return DictField(db_field=member_name)
+        return DictField(basecls=self.basecls, db_field=member_name)
 
     def prepare_query_value(self, op, value):
         match_operators = ['contains', 'icontains', 'startswith',
@@ -999,7 +919,7 @@ class DictField(ComplexBaseField):
         if op in match_operators and isinstance(value, six.string_types):
             return StringField().prepare_query_value(op, value)
 
-        if hasattr(self.field, 'field'):    # Used for instance when using DictField(ListField(IntField()))
+        if hasattr(self.field, 'field'):
             if op in ('set', 'unset') and isinstance(value, dict):
                 return {
                     k: self.field.prepare_query_value(op, v)
@@ -1019,7 +939,6 @@ class MapField(DictField):
     """
 
     def __init__(self, field=None, *args, **kwargs):
-        # XXX ValidationError raised outside of the "validate" method.
         if not isinstance(field, BaseField):
             self.error('Argument to MapField constructor must be a valid '
                        'field')
@@ -1030,15 +949,6 @@ class ReferenceField(BaseField):
     """A reference to a document that will be automatically dereferenced on
     access (lazily).
 
-    Note this means you will get a database I/O access everytime you access
-    this field. This is necessary because the field returns a :class:`~mongoengine.Document`
-    which precise type can depend of the value of the `_cls` field present in the
-    document in database.
-    In short, using this type of field can lead to poor performances (especially
-    if you access this field only to retrieve it `pk` field which is already
-    known before dereference). To solve this you should consider using the
-    :class:`~mongoengine.fields.LazyReferenceField`.
-
     Use the `reverse_delete_rule` to handle what should happen if the document
     the field is referencing is deleted.  EmbeddedDocuments, DictFields and
     MapFields does not support reverse_delete_rule and an `InvalidDocumentError`
@@ -1057,13 +967,11 @@ class ReferenceField(BaseField):
 
     .. code-block:: python
 
-        class Org(Document):
-            owner = ReferenceField('User')
+        class Bar(Document):
+            content = StringField()
+            foo = ReferenceField('Foo')
 
-        class User(Document):
-            org = ReferenceField('Org', reverse_delete_rule=CASCADE)
-
-        User.register_delete_rule(Org, 'owner', DENY)
+        Foo.register_delete_rule(Bar, 'foo', NULLIFY)
 
     .. versionchanged:: 0.5 added `reverse_delete_rule`
     """
@@ -1081,7 +989,6 @@ class ReferenceField(BaseField):
             A reference to an abstract document type is always stored as a
             :class:`~pymongo.dbref.DBRef`, regardless of the value of `dbref`.
         """
-        # XXX ValidationError raised outside of the "validate" method.
         if (
             not isinstance(document_type, six.string_types) and
             not issubclass(document_type, Document)
@@ -1111,9 +1018,9 @@ class ReferenceField(BaseField):
 
         # Get value from document instance if available
         value = instance._data.get(self.name)
-        auto_dereference = instance._fields[self.name]._auto_dereference
+        self._auto_dereference = instance._fields[self.name]._auto_dereference
         # Dereference DBRefs
-        if auto_dereference and isinstance(value, DBRef):
+        if self._auto_dereference and isinstance(value, DBRef):
             if hasattr(value, 'cls'):
                 # Dereference using the class type specified in the reference
                 cls = get_document(value.cls)
@@ -1136,8 +1043,6 @@ class ReferenceField(BaseField):
         if isinstance(document, Document):
             # We need the id from the saved object to create the DBRef
             id_ = document.pk
-
-            # XXX ValidationError raised outside of the "validate" method.
             if id_ is None:
                 self.error('You can only reference documents once they have'
                            ' been saved to the database')
@@ -1177,13 +1082,21 @@ class ReferenceField(BaseField):
         return self.to_mongo(value)
 
     def validate(self, value):
-        if not isinstance(value, (self.document_type, LazyReference, DBRef, ObjectId)):
-            self.error('A ReferenceField only accepts DBRef, LazyReference, ObjectId or documents')
+
+        if not isinstance(value, (self.document_type, DBRef, ObjectId)):
+            self.error('A ReferenceField only accepts DBRef, ObjectId or documents')
 
         if isinstance(value, Document) and value.id is None:
             self.error('You can only reference documents once they have been '
                        'saved to the database')
 
+        if self.document_type._meta.get('abstract') and \
+                not isinstance(value, self.document_type):
+            self.error(
+                '%s is not an instance of abstract reference type %s' % (
+                    self.document_type._class_name)
+            )
+
     def lookup_member(self, member_name):
         return self.document_type._fields.get(member_name)
 
@@ -1204,7 +1117,6 @@ class CachedReferenceField(BaseField):
         if fields is None:
             fields = []
 
-        # XXX ValidationError raised outside of the "validate" method.
         if (
             not isinstance(document_type, six.string_types) and
             not issubclass(document_type, Document)
@@ -1264,10 +1176,9 @@ class CachedReferenceField(BaseField):
 
         # Get value from document instance if available
         value = instance._data.get(self.name)
-        auto_dereference = instance._fields[self.name]._auto_dereference
-
+        self._auto_dereference = instance._fields[self.name]._auto_dereference
         # Dereference DBRefs
-        if auto_dereference and isinstance(value, DBRef):
+        if self._auto_dereference and isinstance(value, DBRef):
             dereferenced = self.document_type._get_db().dereference(value)
             if dereferenced is None:
                 raise DoesNotExist('Trying to dereference unknown document %s' % value)
@@ -1280,7 +1191,6 @@ class CachedReferenceField(BaseField):
         id_field_name = self.document_type._meta['id_field']
         id_field = self.document_type._fields[id_field_name]
 
-        # XXX ValidationError raised outside of the "validate" method.
         if isinstance(document, Document):
             # We need the id from the saved object to create the DBRef
             id_ = document.pk
@@ -1289,6 +1199,7 @@ class CachedReferenceField(BaseField):
                            ' been saved to the database')
         else:
             self.error('Only accept a document object')
+            # TODO: should raise here or will fail next statement
 
         value = SON((
             ('_id', id_field.to_mongo(id_)),
@@ -1306,20 +1217,16 @@ class CachedReferenceField(BaseField):
         if value is None:
             return None
 
-        # XXX ValidationError raised outside of the "validate" method.
         if isinstance(value, Document):
             if value.pk is None:
                 self.error('You can only reference documents once they have'
                            ' been saved to the database')
-            value_dict = {'_id': value.pk}
-            for field in self.fields:
-                value_dict.update({field: value[field]})
-
-            return value_dict
+            return {'_id': value.pk}
 
         raise NotImplementedError
 
     def validate(self, value):
+
         if not isinstance(value, self.document_type):
             self.error('A CachedReferenceField only accepts documents')
 
@@ -1352,12 +1259,6 @@ class GenericReferenceField(BaseField):
     """A reference to *any* :class:`~mongoengine.document.Document` subclass
     that will be automatically dereferenced on access (lazily).
 
-    Note this field works the same way as :class:`~mongoengine.document.ReferenceField`,
-    doing database I/O access the first time it is accessed (even if it's to access
-    it ``pk`` or ``id`` field).
-    To solve this you should consider using the
-    :class:`~mongoengine.fields.GenericLazyReferenceField`.
-
     .. note ::
         * Any documents used as a generic reference must be registered in the
           document registry.  Importing the model will automatically register
@@ -1380,8 +1281,6 @@ class GenericReferenceField(BaseField):
                 elif isinstance(choice, type) and issubclass(choice, Document):
                     self.choices.append(choice._class_name)
                 else:
-                    # XXX ValidationError raised outside of the "validate"
-                    # method.
                     self.error('Invalid choices provided: must be a list of'
                                'Document subclasses and/or six.string_typess')
 
@@ -1400,8 +1299,8 @@ class GenericReferenceField(BaseField):
 
         value = instance._data.get(self.name)
 
-        auto_dereference = instance._fields[self.name]._auto_dereference
-        if auto_dereference and isinstance(value, (dict, SON)):
+        self._auto_dereference = instance._fields[self.name]._auto_dereference
+        if self._auto_dereference and isinstance(value, (dict, SON)):
             dereferenced = self.dereference(value)
             if dereferenced is None:
                 raise DoesNotExist('Trying to dereference unknown document %s' % value)
@@ -1445,7 +1344,6 @@ class GenericReferenceField(BaseField):
             # We need the id from the saved object to create the DBRef
             id_ = document.id
             if id_ is None:
-                # XXX ValidationError raised outside of the "validate" method.
                 self.error('You can only reference documents once they have'
                            ' been saved to the database')
         else:
@@ -1483,20 +1381,14 @@ class BinaryField(BaseField):
         return Binary(value)
 
     def validate(self, value):
-        if not isinstance(value, (six.binary_type, Binary)):
+        if not isinstance(value, (six.binary_type, six.text_type, Binary)):
             self.error('BinaryField only accepts instances of '
                        '(%s, %s, Binary)' % (
-                           six.binary_type.__name__, Binary.__name__))
+                           six.binary_type.__name__, six.text_type.__name__))
 
         if self.max_bytes is not None and len(value) > self.max_bytes:
             self.error('Binary value is too long')
 
-    def prepare_query_value(self, op, value):
-        if value is None:
-            return value
-        return super(BinaryField, self).prepare_query_value(
-            op, self.to_mongo(value))
-
 
 class GridFSError(Exception):
     pass
@@ -1537,11 +1429,9 @@ class GridFSProxy(object):
     def __get__(self, instance, value):
         return self
 
-    def __bool__(self):
+    def __nonzero__(self):
         return bool(self.grid_id)
 
-    __nonzero__ = __bool__  # For Py2 support
-
     def __getstate__(self):
         self_dict = self.__dict__
         self_dict['_fs'] = None
@@ -1559,9 +1449,9 @@ class GridFSProxy(object):
         return '<%s: %s>' % (self.__class__.__name__, self.grid_id)
 
     def __str__(self):
-        gridout = self.get()
-        filename = getattr(gridout, 'filename') if gridout else '<no file>'
-        return '<%s: %s (%s)>' % (self.__class__.__name__, filename, self.grid_id)
+        name = getattr(
+            self.get(), 'filename', self.grid_id) if self.get() else '(no file)'
+        return '<%s: %s>' % (self.__class__.__name__, name)
 
     def __eq__(self, other):
         if isinstance(other, GridFSProxy):
@@ -1571,9 +1461,6 @@ class GridFSProxy(object):
         else:
             return False
 
-    def __ne__(self, other):
-        return not self == other
-
     @property
     def fs(self):
         if not self._fs:
@@ -1881,9 +1768,12 @@ class ImageField(FileField):
     """
     A Image File storage field.
 
-    :param size: max size to store images, provided as (width, height, force)
-        if larger, it will be automatically resized (ex: size=(800, 600, True))
-    :param thumbnail_size: size to generate a thumbnail, provided as (width, height, force)
+    @size (width, height, force):
+        max size to store images, if larger will be automatically resized
+        ex: size=(800, 600, True)
+
+    @thumbnail (width, height, force):
+        size to generate a thumbnail
 
     .. versionadded:: 0.6
     """
@@ -1954,7 +1844,8 @@ class SequenceField(BaseField):
         self.collection_name = collection_name or self.COLLECTION_NAME
         self.db_alias = db_alias or DEFAULT_CONNECTION_NAME
         self.sequence_name = sequence_name
-        self.value_decorator = value_decorator if callable(value_decorator) else self.VALUE_DECORATOR
+        self.value_decorator = (callable(value_decorator) and
+                                value_decorator or self.VALUE_DECORATOR)
         super(SequenceField, self).__init__(*args, **kwargs)
 
     def generate(self):
@@ -2063,7 +1954,7 @@ class UUIDField(BaseField):
                 if not isinstance(value, six.string_types):
                     value = six.text_type(value)
                 return uuid.UUID(value)
-            except (ValueError, TypeError, AttributeError):
+            except Exception:
                 return original_value
         return value
 
@@ -2085,7 +1976,7 @@ class UUIDField(BaseField):
                 value = str(value)
             try:
                 uuid.UUID(value)
-            except (ValueError, TypeError, AttributeError) as exc:
+            except Exception as exc:
                 self.error('Could not convert to UUID: %s' % exc)
 
 
@@ -2243,201 +2134,3 @@ class MultiPolygonField(GeoJsonBaseField):
     .. versionadded:: 0.9
     """
     _type = 'MultiPolygon'
-
-
-class LazyReferenceField(BaseField):
-    """A really lazy reference to a document.
-    Unlike the :class:`~mongoengine.fields.ReferenceField` it will
-    **not** be automatically (lazily) dereferenced on access.
-    Instead, access will return a :class:`~mongoengine.base.LazyReference` class
-    instance, allowing access to `pk` or manual dereference by using
-    ``fetch()`` method.
-
-    .. versionadded:: 0.15
-    """
-
-    def __init__(self, document_type, passthrough=False, dbref=False,
-                 reverse_delete_rule=DO_NOTHING, **kwargs):
-        """Initialises the Reference Field.
-
-        :param dbref:  Store the reference as :class:`~pymongo.dbref.DBRef`
-          or as the :class:`~pymongo.objectid.ObjectId`.id .
-        :param reverse_delete_rule: Determines what to do when the referring
-          object is deleted
-        :param passthrough: When trying to access unknown fields, the
-          :class:`~mongoengine.base.datastructure.LazyReference` instance will
-          automatically call `fetch()` and try to retrive the field on the fetched
-          document. Note this only work getting field (not setting or deleting).
-        """
-        # XXX ValidationError raised outside of the "validate" method.
-        if (
-            not isinstance(document_type, six.string_types) and
-            not issubclass(document_type, Document)
-        ):
-            self.error('Argument to LazyReferenceField constructor must be a '
-                       'document class or a string')
-
-        self.dbref = dbref
-        self.passthrough = passthrough
-        self.document_type_obj = document_type
-        self.reverse_delete_rule = reverse_delete_rule
-        super(LazyReferenceField, self).__init__(**kwargs)
-
-    @property
-    def document_type(self):
-        if isinstance(self.document_type_obj, six.string_types):
-            if self.document_type_obj == RECURSIVE_REFERENCE_CONSTANT:
-                self.document_type_obj = self.owner_document
-            else:
-                self.document_type_obj = get_document(self.document_type_obj)
-        return self.document_type_obj
-
-    def build_lazyref(self, value):
-        if isinstance(value, LazyReference):
-            if value.passthrough != self.passthrough:
-                value = LazyReference(value.document_type, value.pk, passthrough=self.passthrough)
-        elif value is not None:
-            if isinstance(value, self.document_type):
-                value = LazyReference(self.document_type, value.pk, passthrough=self.passthrough)
-            elif isinstance(value, DBRef):
-                value = LazyReference(self.document_type, value.id, passthrough=self.passthrough)
-            else:
-                # value is the primary key of the referenced document
-                value = LazyReference(self.document_type, value, passthrough=self.passthrough)
-        return value
-
-    def __get__(self, instance, owner):
-        """Descriptor to allow lazy dereferencing."""
-        if instance is None:
-            # Document class being used rather than a document object
-            return self
-
-        value = self.build_lazyref(instance._data.get(self.name))
-        if value:
-            instance._data[self.name] = value
-
-        return super(LazyReferenceField, self).__get__(instance, owner)
-
-    def to_mongo(self, value):
-        if isinstance(value, LazyReference):
-            pk = value.pk
-        elif isinstance(value, self.document_type):
-            pk = value.pk
-        elif isinstance(value, DBRef):
-            pk = value.id
-        else:
-            # value is the primary key of the referenced document
-            pk = value
-        id_field_name = self.document_type._meta['id_field']
-        id_field = self.document_type._fields[id_field_name]
-        pk = id_field.to_mongo(pk)
-        if self.dbref:
-            return DBRef(self.document_type._get_collection_name(), pk)
-        else:
-            return pk
-
-    def validate(self, value):
-        if isinstance(value, LazyReference):
-            if value.collection != self.document_type._get_collection_name():
-                self.error('Reference must be on a `%s` document.' % self.document_type)
-            pk = value.pk
-        elif isinstance(value, self.document_type):
-            pk = value.pk
-        elif isinstance(value, DBRef):
-            # TODO: check collection ?
-            collection = self.document_type._get_collection_name()
-            if value.collection != collection:
-                self.error("DBRef on bad collection (must be on `%s`)" % collection)
-            pk = value.id
-        else:
-            # value is the primary key of the referenced document
-            id_field_name = self.document_type._meta['id_field']
-            id_field = getattr(self.document_type, id_field_name)
-            pk = value
-            try:
-                id_field.validate(pk)
-            except ValidationError:
-                self.error(
-                    "value should be `{0}` document, LazyReference or DBRef on `{0}` "
-                    "or `{0}`'s primary key (i.e. `{1}`)".format(
-                        self.document_type.__name__, type(id_field).__name__))
-
-        if pk is None:
-            self.error('You can only reference documents once they have been '
-                       'saved to the database')
-
-    def prepare_query_value(self, op, value):
-        if value is None:
-            return None
-        super(LazyReferenceField, self).prepare_query_value(op, value)
-        return self.to_mongo(value)
-
-    def lookup_member(self, member_name):
-        return self.document_type._fields.get(member_name)
-
-
-class GenericLazyReferenceField(GenericReferenceField):
-    """A reference to *any* :class:`~mongoengine.document.Document` subclass.
-    Unlike the :class:`~mongoengine.fields.GenericReferenceField` it will
-    **not** be automatically (lazily) dereferenced on access.
-    Instead, access will return a :class:`~mongoengine.base.LazyReference` class
-    instance, allowing access to `pk` or manual dereference by using
-    ``fetch()`` method.
-
-    .. note ::
-        * Any documents used as a generic reference must be registered in the
-          document registry.  Importing the model will automatically register
-          it.
-
-        * You can use the choices param to limit the acceptable Document types
-
-    .. versionadded:: 0.15
-    """
-
-    def __init__(self, *args, **kwargs):
-        self.passthrough = kwargs.pop('passthrough', False)
-        super(GenericLazyReferenceField, self).__init__(*args, **kwargs)
-
-    def _validate_choices(self, value):
-        if isinstance(value, LazyReference):
-            value = value.document_type._class_name
-        super(GenericLazyReferenceField, self)._validate_choices(value)
-
-    def build_lazyref(self, value):
-        if isinstance(value, LazyReference):
-            if value.passthrough != self.passthrough:
-                value = LazyReference(value.document_type, value.pk, passthrough=self.passthrough)
-        elif value is not None:
-            if isinstance(value, (dict, SON)):
-                value = LazyReference(get_document(value['_cls']), value['_ref'].id, passthrough=self.passthrough)
-            elif isinstance(value, Document):
-                value = LazyReference(type(value), value.pk, passthrough=self.passthrough)
-        return value
-
-    def __get__(self, instance, owner):
-        if instance is None:
-            return self
-
-        value = self.build_lazyref(instance._data.get(self.name))
-        if value:
-            instance._data[self.name] = value
-
-        return super(GenericLazyReferenceField, self).__get__(instance, owner)
-
-    def validate(self, value):
-        if isinstance(value, LazyReference) and value.pk is None:
-            self.error('You can only reference documents once they have been'
-                       ' saved to the database')
-        return super(GenericLazyReferenceField, self).validate(value)
-
-    def to_mongo(self, document):
-        if document is None:
-            return None
-
-        if isinstance(document, LazyReference):
-            return SON((
-                ('_cls', document.document_type._class_name),
-                ('_ref', DBRef(document.document_type._get_collection_name(), document.pk))
-            ))
-        else:
-            return super(GenericLazyReferenceField, self).to_mongo(document)

mongoengine/mongodb_support.py

@@ -1,19 +0,0 @@
-"""
-Helper functions, constants, and types to aid with MongoDB version support
-"""
-from mongoengine.connection import get_connection
-
-
-# Constant that can be used to compare the version retrieved with
-# get_mongodb_version()
-MONGODB_34 = (3, 4)
-MONGODB_36 = (3, 6)
-
-
-def get_mongodb_version():
-    """Return the version of the connected mongoDB (first 2 digits)
-
-    :return: tuple(int, int)
-    """
-    version_list = get_connection().server_info()['versionArray'][:2]     # e.g: (3, 2)
-    return tuple(version_list)

mongoengine/pymongo_support.py

@@ -1,32 +0,0 @@
-"""
-Helper functions, constants, and types to aid with PyMongo v2.7 - v3.x support.
-"""
-import pymongo
-
-_PYMONGO_37 = (3, 7)
-
-PYMONGO_VERSION = tuple(pymongo.version_tuple[:2])
-
-IS_PYMONGO_GTE_37 = PYMONGO_VERSION >= _PYMONGO_37
-
-
-def count_documents(collection, filter):
-    """Pymongo>3.7 deprecates count in favour of count_documents"""
-    if IS_PYMONGO_GTE_37:
-        return collection.count_documents(filter)
-    else:
-        count = collection.find(filter).count()
-    return count
-
-
-def list_collection_names(db, include_system_collections=False):
-    """Pymongo>3.7 deprecates collection_names in favour of list_collection_names"""
-    if IS_PYMONGO_GTE_37:
-        collections = db.list_collection_names()
-    else:
-        collections = db.collection_names()
-
-    if not include_system_collections:
-        collections = [c for c in collections if not c.startswith('system.')]
-
-    return collections

mongoengine/python_support.py

@@ -1,8 +1,17 @@
 """
-Helper functions, constants, and types to aid with Python v2.7 - v3.x support
+Helper functions, constants, and types to aid with Python v2.7 - v3.x and
+PyMongo v2.7 - v3.x support.
 """
+import pymongo
 import six
 
+
+if pymongo.version_tuple[0] < 3:
+    IS_PYMONGO_3 = False
+else:
+    IS_PYMONGO_3 = True
+
+
 # six.BytesIO resolves to StringIO.StringIO in Py2 and io.BytesIO in Py3.
 StringIO = six.BytesIO
 
@@ -14,10 +23,3 @@ if not six.PY3:
         pass
     else:
         StringIO = cStringIO.StringIO
-
-
-if six.PY3:
-    from collections.abc import Hashable
-else:
-    # raises DeprecationWarnings in Python >=3.7
-    from collections import Hashable

mongoengine/queryset/base.py

@@ -2,6 +2,7 @@ from __future__ import absolute_import
 
 import copy
 import itertools
+import operator
 import pprint
 import re
 import warnings
@@ -10,22 +11,24 @@ from bson import SON, json_util
 from bson.code import Code
 import pymongo
 import pymongo.errors
-from pymongo.collection import ReturnDocument
 from pymongo.common import validate_read_preference
 import six
-from six import iteritems
 
 from mongoengine import signals
 from mongoengine.base import get_document
 from mongoengine.common import _import_class
 from mongoengine.connection import get_db
-from mongoengine.context_managers import set_write_concern, switch_db
+from mongoengine.context_managers import switch_db
 from mongoengine.errors import (InvalidQueryError, LookUpError,
                                 NotUniqueError, OperationError)
+from mongoengine.python_support import IS_PYMONGO_3
 from mongoengine.queryset import transform
 from mongoengine.queryset.field_list import QueryFieldList
 from mongoengine.queryset.visitor import Q, QNode
 
+if IS_PYMONGO_3:
+    from pymongo.collection import ReturnDocument
+
 
 __all__ = ('BaseQuerySet', 'DO_NOTHING', 'NULLIFY', 'CASCADE', 'DENY', 'PULL')
 
@@ -36,6 +39,8 @@ CASCADE = 2
 DENY = 3
 PULL = 4
 
+RE_TYPE = type(re.compile(''))
+
 
 class BaseQuerySet(object):
     """A set of results returned from a query. Wraps a MongoDB cursor,
@@ -73,7 +78,6 @@ class BaseQuerySet(object):
                 self._initial_query = {
                     '_cls': {'$in': self._document._subclasses}}
             self._loaded_fields = QueryFieldList(always_include=['_cls'])
-
         self._cursor_obj = None
         self._limit = None
         self._skip = None
@@ -187,7 +191,7 @@ class BaseQuerySet(object):
                 )
 
             if queryset._as_pymongo:
-                return queryset._cursor[key]
+                return queryset._get_as_pymongo(queryset._cursor[key])
 
             return queryset._document._from_son(
                 queryset._cursor[key],
@@ -195,7 +199,7 @@ class BaseQuerySet(object):
                 only_fields=self.only_fields
             )
 
-        raise TypeError('Provide a slice or an integer index')
+        raise AttributeError('Provide a slice or an integer index')
 
     def __iter__(self):
         raise NotImplementedError
@@ -205,16 +209,18 @@ class BaseQuerySet(object):
         queryset = self.order_by()
         return False if queryset.first() is None else True
 
+    def __nonzero__(self):
+        """Avoid to open all records in an if stmt in Py2."""
+        return self._has_data()
+
     def __bool__(self):
         """Avoid to open all records in an if stmt in Py3."""
         return self._has_data()
 
-    __nonzero__ = __bool__  # For Py2 support
-
     # Core functions
 
     def all(self):
-        """Returns a copy of the current QuerySet."""
+        """Returns all documents."""
         return self.__call__()
 
     def filter(self, *q_objs, **query):
@@ -263,13 +269,13 @@ class BaseQuerySet(object):
         queryset = queryset.filter(*q_objs, **query)
 
         try:
-            result = six.next(queryset)
+            result = queryset.next()
         except StopIteration:
             msg = ('%s matching query does not exist.'
                    % queryset._document._class_name)
             raise queryset._document.DoesNotExist(msg)
         try:
-            six.next(queryset)
+            queryset.next()
         except StopIteration:
             return result
 
@@ -336,7 +342,7 @@ class BaseQuerySet(object):
                        % str(self._document))
                 raise OperationError(msg)
             if doc.pk and not doc._created:
-                msg = 'Some documents have ObjectIds, use doc.update() instead'
+                msg = 'Some documents have ObjectIds use doc.update() instead'
                 raise OperationError(msg)
 
         signal_kwargs = signal_kwargs or {}
@@ -344,24 +350,11 @@ class BaseQuerySet(object):
                                      documents=docs, **signal_kwargs)
 
         raw = [doc.to_mongo() for doc in docs]
-
-        with set_write_concern(self._collection, write_concern) as collection:
-            insert_func = collection.insert_many
-            if return_one:
-                raw = raw[0]
-                insert_func = collection.insert_one
-
         try:
-            inserted_result = insert_func(raw)
-            ids = [inserted_result.inserted_id] if return_one else inserted_result.inserted_ids
+            ids = self._collection.insert(raw, **write_concern)
         except pymongo.errors.DuplicateKeyError as err:
             message = 'Could not save document (%s)'
             raise NotUniqueError(message % six.text_type(err))
-        except pymongo.errors.BulkWriteError as err:
-            # inserting documents that already have an _id field will
-            # give huge performance debt or raise
-            message = u'Document must not have _id value before bulk write (%s)'
-            raise NotUniqueError(message % six.text_type(err))
         except pymongo.errors.OperationFailure as err:
             message = 'Could not save document (%s)'
             if re.match('^E1100[01] duplicate key', six.text_type(err)):
@@ -371,20 +364,18 @@ class BaseQuerySet(object):
                 raise NotUniqueError(message % six.text_type(err))
             raise OperationError(message % six.text_type(err))
 
-        # Apply inserted_ids to documents
-        for doc, doc_id in zip(docs, ids):
-            doc.pk = doc_id
-
         if not load_bulk:
             signals.post_bulk_insert.send(
                 self._document, documents=docs, loaded=False, **signal_kwargs)
-            return ids[0] if return_one else ids
+            return return_one and ids[0] or ids
 
         documents = self.in_bulk(ids)
-        results = [documents.get(obj_id) for obj_id in ids]
+        results = []
+        for obj_id in ids:
+            results.append(documents.get(obj_id))
         signals.post_bulk_insert.send(
             self._document, documents=results, loaded=True, **signal_kwargs)
-        return results[0] if return_one else results
+        return return_one and results[0] or results
 
     def count(self, with_limit_and_skip=False):
         """Count the selected elements in the query.
@@ -393,11 +384,9 @@ class BaseQuerySet(object):
             :meth:`skip` that has been applied to this cursor into account when
             getting the count
         """
-        if self._limit == 0 and with_limit_and_skip is False or self._none:
+        if self._limit == 0 and with_limit_and_skip or self._none:
             return 0
-        count = self._cursor.count(with_limit_and_skip=with_limit_and_skip)
-        self._cursor_obj = None
-        return count
+        return self._cursor.count(with_limit_and_skip=with_limit_and_skip)
 
     def delete(self, write_concern=None, _from_doc_delete=False,
                cascade_refs=None):
@@ -497,12 +486,10 @@ class BaseQuerySet(object):
             ``save(..., write_concern={w: 2, fsync: True}, ...)`` will
             wait until at least two servers have recorded the write and
             will force an fsync on the primary server.
-        :param full_result: Return the associated ``pymongo.UpdateResult`` rather than just the number
-            updated items
+        :param full_result: Return the full result rather than just the number
+            updated.
         :param update: Django-style update keyword arguments
 
-        :returns the number of updated documents (unless ``full_result`` is True)
-
         .. versionadded:: 0.2
         """
         if not update and not upsert:
@@ -523,15 +510,12 @@ class BaseQuerySet(object):
             else:
                 update['$set'] = {'_cls': queryset._document._class_name}
         try:
-            with set_write_concern(queryset._collection, write_concern) as collection:
-                update_func = collection.update_one
-                if multi:
-                    update_func = collection.update_many
-                result = update_func(query, update, upsert=upsert)
+            result = queryset._collection.update(query, update, multi=multi,
+                                                 upsert=upsert, **write_concern)
             if full_result:
                 return result
-            elif result.raw_result:
-                return result.raw_result['n']
+            elif result:
+                return result['n']
         except pymongo.errors.DuplicateKeyError as err:
             raise NotUniqueError(u'Update failed (%s)' % six.text_type(err))
         except pymongo.errors.OperationFailure as err:
@@ -560,13 +544,13 @@ class BaseQuerySet(object):
                                     write_concern=write_concern,
                                     full_result=True, **update)
 
-        if atomic_update.raw_result['updatedExisting']:
+        if atomic_update['updatedExisting']:
             document = self.get()
         else:
-            document = self._document.objects.with_id(atomic_update.upserted_id)
+            document = self._document.objects.with_id(atomic_update['upserted'])
         return document
 
-    def update_one(self, upsert=False, write_concern=None, full_result=False, **update):
+    def update_one(self, upsert=False, write_concern=None, **update):
         """Perform an atomic update on the fields of the first document
         matched by the query.
 
@@ -577,19 +561,12 @@ class BaseQuerySet(object):
             ``save(..., write_concern={w: 2, fsync: True}, ...)`` will
             wait until at least two servers have recorded the write and
             will force an fsync on the primary server.
-        :param full_result: Return the associated ``pymongo.UpdateResult`` rather than just the number
-            updated items
         :param update: Django-style update keyword arguments
-            full_result
-        :returns the number of updated documents (unless ``full_result`` is True)
+
         .. versionadded:: 0.2
         """
         return self.update(
-            upsert=upsert,
-            multi=False,
-            write_concern=write_concern,
-            full_result=full_result,
-            **update)
+            upsert=upsert, multi=False, write_concern=write_concern, **update)
 
     def modify(self, upsert=False, full_response=False, remove=False, new=False, **update):
         """Update and return the updated document.
@@ -624,25 +601,31 @@ class BaseQuerySet(object):
 
         queryset = self.clone()
         query = queryset._query
-        if not remove:
+        if not IS_PYMONGO_3 or not remove:
             update = transform.update(queryset._document, **update)
         sort = queryset._ordering
 
         try:
-            if full_response:
-                msg = 'With PyMongo 3+, it is not possible anymore to get the full response.'
-                warnings.warn(msg, DeprecationWarning)
-            if remove:
-                result = queryset._collection.find_one_and_delete(
-                    query, sort=sort, **self._cursor_args)
-            else:
-                if new:
-                    return_doc = ReturnDocument.AFTER
+            if IS_PYMONGO_3:
+                if full_response:
+                    msg = 'With PyMongo 3+, it is not possible anymore to get the full response.'
+                    warnings.warn(msg, DeprecationWarning)
+                if remove:
+                    result = queryset._collection.find_one_and_delete(
+                        query, sort=sort, **self._cursor_args)
                 else:
-                    return_doc = ReturnDocument.BEFORE
-                result = queryset._collection.find_one_and_update(
-                    query, update, upsert=upsert, sort=sort, return_document=return_doc,
-                    **self._cursor_args)
+                    if new:
+                        return_doc = ReturnDocument.AFTER
+                    else:
+                        return_doc = ReturnDocument.BEFORE
+                    result = queryset._collection.find_one_and_update(
+                        query, update, upsert=upsert, sort=sort, return_document=return_doc,
+                        **self._cursor_args)
+
+            else:
+                result = queryset._collection.find_and_modify(
+                    query, update, upsert=upsert, sort=sort, remove=remove, new=new,
+                    full_response=full_response, **self._cursor_args)
         except pymongo.errors.DuplicateKeyError as err:
             raise NotUniqueError(u'Update failed (%s)' % err)
         except pymongo.errors.OperationFailure as err:
@@ -691,7 +674,7 @@ class BaseQuerySet(object):
                     self._document._from_son(doc, only_fields=self.only_fields))
         elif self._as_pymongo:
             for doc in docs:
-                doc_map[doc['_id']] = doc
+                doc_map[doc['_id']] = self._get_as_pymongo(doc)
         else:
             for doc in docs:
                 doc_map[doc['_id']] = self._document._from_son(
@@ -708,9 +691,8 @@ class BaseQuerySet(object):
         return queryset
 
     def no_sub_classes(self):
-        """Filter for only the instances of this specific document.
-
-        Do NOT return any inherited documents.
+        """
+        Only return instances of this document and not any inherited documents
         """
         if self._document._meta.get('allow_inheritance') is True:
             self._initial_query = {'_cls': self._document._class_name}
@@ -750,7 +732,7 @@ class BaseQuerySet(object):
                       '_read_preference', '_iter', '_scalar', '_as_pymongo',
                       '_limit', '_skip', '_hint', '_auto_dereference',
                       '_search_text', 'only_fields', '_max_time_ms',
-                      '_comment', '_batch_size')
+                      '_comment')
 
         for prop in copy_props:
             val = getattr(self, prop)
@@ -777,11 +759,10 @@ class BaseQuerySet(object):
         """Limit the number of returned documents to `n`. This may also be
         achieved using array-slicing syntax (e.g. ``User.objects[:5]``).
 
-        :param n: the maximum number of objects to return if n is greater than 0.
-        When 0 is passed, returns all the documents in the cursor
+        :param n: the maximum number of objects to return
         """
         queryset = self.clone()
-        queryset._limit = n
+        queryset._limit = n if n != 0 else 1
 
         # If a cursor object has already been created, apply the limit to it.
         if queryset._cursor_obj:
@@ -979,10 +960,11 @@ class BaseQuerySet(object):
         # explicitly included, and then more complicated operators such as
         # $slice.
         def _sort_key(field_tuple):
-            _, value = field_tuple
-            if isinstance(value, int):
+            key, value = field_tuple
+            if isinstance(value, (int)):
                 return value  # 0 for exclusion, 1 for inclusion
-            return 2  # so that complex values appear last
+            else:
+                return 2  # so that complex values appear last
 
         fields = sorted(cleaned_fields, key=_sort_key)
 
@@ -1011,15 +993,13 @@ class BaseQuerySet(object):
         return queryset
 
     def order_by(self, *keys):
-        """Order the :class:`~mongoengine.queryset.QuerySet` by the given keys.
-
-        The order may be specified by prepending each of the keys by a "+" or
-        a "-". Ascending order is assumed if there's no prefix.
-
-        If no keys are passed, existing ordering is cleared instead.
+        """Order the :class:`~mongoengine.queryset.QuerySet` by the keys. The
+        order may be specified by prepending each of the keys by a + or a -.
+        Ascending order is assumed. If no keys are passed, existing ordering
+        is cleared instead.
 
         :param keys: fields to order the query results by; keys may be
-            prefixed with "+" or a "-" to determine the ordering direction.
+            prefixed with **+** or **-** to determine the ordering direction
         """
         queryset = self.clone()
 
@@ -1077,14 +1057,15 @@ class BaseQuerySet(object):
         ..versionchanged:: 0.5 - made chainable
         .. deprecated:: Ignored with PyMongo 3+
         """
-        msg = 'snapshot is deprecated as it has no impact when using PyMongo 3+.'
-        warnings.warn(msg, DeprecationWarning)
+        if IS_PYMONGO_3:
+            msg = 'snapshot is deprecated as it has no impact when using PyMongo 3+.'
+            warnings.warn(msg, DeprecationWarning)
         queryset = self.clone()
         queryset._snapshot = enabled
         return queryset
 
     def timeout(self, enabled):
-        """Enable or disable the default mongod timeout when querying. (no_cursor_timeout option)
+        """Enable or disable the default mongod timeout when querying.
 
         :param enabled: whether or not the timeout is used
 
@@ -1102,8 +1083,9 @@ class BaseQuerySet(object):
 
         .. deprecated:: Ignored with PyMongo 3+
         """
-        msg = 'slave_okay is deprecated as it has no impact when using PyMongo 3+.'
-        warnings.warn(msg, DeprecationWarning)
+        if IS_PYMONGO_3:
+            msg = 'slave_okay is deprecated as it has no impact when using PyMongo 3+.'
+            warnings.warn(msg, DeprecationWarning)
         queryset = self.clone()
         queryset._slave_okay = enabled
         return queryset
@@ -1193,21 +1175,13 @@ class BaseQuerySet(object):
             initial_pipeline.append({'$sort': dict(self._ordering)})
 
         if self._limit is not None:
-            # As per MongoDB Documentation (https://docs.mongodb.com/manual/reference/operator/aggregation/limit/),
-            # keeping limit stage right after sort stage is more efficient. But this leads to wrong set of documents
-            # for a skip stage that might succeed these. So we need to maintain more documents in memory in such a
-            # case (https://stackoverflow.com/a/24161461).
-            initial_pipeline.append({'$limit': self._limit + (self._skip or 0)})
+            initial_pipeline.append({'$limit': self._limit})
 
         if self._skip is not None:
             initial_pipeline.append({'$skip': self._skip})
 
         pipeline = initial_pipeline + list(pipeline)
 
-        if self._read_preference is not None:
-            return self._collection.with_options(read_preference=self._read_preference) \
-                       .aggregate(pipeline, cursor={}, **kwargs)
-
         return self._collection.aggregate(pipeline, cursor={}, **kwargs)
 
     # JS functionality
@@ -1414,7 +1388,11 @@ class BaseQuerySet(object):
         if isinstance(field_instances[-1], ListField):
             pipeline.insert(1, {'$unwind': '$' + field})
 
-        result = tuple(self._document._get_collection().aggregate(pipeline))
+        result = self._document._get_collection().aggregate(pipeline)
+        if IS_PYMONGO_3:
+            result = tuple(result)
+        else:
+            result = result.get('result')
 
         if result:
             return result[0]['total']
@@ -1441,7 +1419,11 @@ class BaseQuerySet(object):
         if isinstance(field_instances[-1], ListField):
             pipeline.insert(1, {'$unwind': '$' + field})
 
-        result = tuple(self._document._get_collection().aggregate(pipeline))
+        result = self._document._get_collection().aggregate(pipeline)
+        if IS_PYMONGO_3:
+            result = tuple(result)
+        else:
+            result = result.get('result')
         if result:
             return result[0]['total']
         return 0
@@ -1475,16 +1457,16 @@ class BaseQuerySet(object):
 
     # Iterator helpers
 
-    def __next__(self):
+    def next(self):
         """Wrap the result in a :class:`~mongoengine.Document` object.
         """
         if self._limit == 0 or self._none:
             raise StopIteration
 
-        raw_doc = six.next(self._cursor)
+        raw_doc = self._cursor.next()
 
         if self._as_pymongo:
-            return raw_doc
+            return self._get_as_pymongo(raw_doc)
 
         doc = self._document._from_son(
             raw_doc, _auto_dereference=self._auto_dereference,
@@ -1495,8 +1477,6 @@ class BaseQuerySet(object):
 
         return doc
 
-    next = __next__     # For Python2 support
-
     def rewind(self):
         """Rewind the cursor to its unevaluated state.
 
@@ -1516,16 +1496,26 @@ class BaseQuerySet(object):
 
     @property
     def _cursor_args(self):
-        fields_name = 'projection'
-        # snapshot is not handled at all by PyMongo 3+
-        # TODO: evaluate similar possibilities using modifiers
-        if self._snapshot:
-            msg = 'The snapshot option is not anymore available with PyMongo 3+'
-            warnings.warn(msg, DeprecationWarning)
-        cursor_args = {
-            'no_cursor_timeout': not self._timeout
-        }
-
+        if not IS_PYMONGO_3:
+            fields_name = 'fields'
+            cursor_args = {
+                'timeout': self._timeout,
+                'snapshot': self._snapshot
+            }
+            if self._read_preference is not None:
+                cursor_args['read_preference'] = self._read_preference
+            else:
+                cursor_args['slave_okay'] = self._slave_okay
+        else:
+            fields_name = 'projection'
+            # snapshot is not handled at all by PyMongo 3+
+            # TODO: evaluate similar possibilities using modifiers
+            if self._snapshot:
+                msg = 'The snapshot option is not anymore available with PyMongo 3+'
+                warnings.warn(msg, DeprecationWarning)
+            cursor_args = {
+                'no_cursor_timeout': not self._timeout
+            }
         if self._loaded_fields:
             cursor_args[fields_name] = self._loaded_fields.as_dict()
 
@@ -1549,7 +1539,7 @@ class BaseQuerySet(object):
         # XXX In PyMongo 3+, we define the read preference on a collection
         # level, not a cursor level. Thus, we need to get a cloned collection
         # object using `with_options` first.
-        if self._read_preference is not None:
+        if IS_PYMONGO_3 and self._read_preference is not None:
             self._cursor_obj = self._collection\
                 .with_options(read_preference=self._read_preference)\
                 .find(self._query, **self._cursor_args)
@@ -1588,9 +1578,6 @@ class BaseQuerySet(object):
         if self._batch_size is not None:
             self._cursor_obj.batch_size(self._batch_size)
 
-        if self._comment is not None:
-            self._cursor_obj.comment(self._comment)
-
         return self._cursor_obj
 
     def __deepcopy__(self, memo):
@@ -1719,13 +1706,13 @@ class BaseQuerySet(object):
             }
         """
         total, data, types = self.exec_js(freq_func, field)
-        values = {types.get(k): int(v) for k, v in iteritems(data)}
+        values = {types.get(k): int(v) for k, v in data.iteritems()}
 
         if normalize:
             values = {k: float(v) / total for k, v in values.items()}
 
         frequencies = {}
-        for k, v in iteritems(values):
+        for k, v in values.iteritems():
             if isinstance(k, float):
                 if int(k) == k:
                     k = int(k)
@@ -1735,33 +1722,25 @@ class BaseQuerySet(object):
         return frequencies
 
     def _fields_to_dbfields(self, fields):
-        """Translate fields' paths to their db equivalents."""
+        """Translate fields paths to its db equivalents"""
+        ret = []
         subclasses = []
-        if self._document._meta['allow_inheritance']:
+        document = self._document
+        if document._meta['allow_inheritance']:
             subclasses = [get_document(x)
-                          for x in self._document._subclasses][1:]
-
-        db_field_paths = []
+                          for x in document._subclasses][1:]
         for field in fields:
-            field_parts = field.split('.')
             try:
-                field = '.'.join(
-                    f if isinstance(f, six.string_types) else f.db_field
-                    for f in self._document._lookup_field(field_parts)
-                )
-                db_field_paths.append(field)
+                field = '.'.join(f.db_field for f in
+                                 document._lookup_field(field.split('.')))
+                ret.append(field)
             except LookUpError as err:
                 found = False
-
-                # If a field path wasn't found on the main document, go
-                # through its subclasses and see if it exists on any of them.
                 for subdoc in subclasses:
                     try:
-                        subfield = '.'.join(
-                            f if isinstance(f, six.string_types) else f.db_field
-                            for f in subdoc._lookup_field(field_parts)
-                        )
-                        db_field_paths.append(subfield)
+                        subfield = '.'.join(f.db_field for f in
+                                            subdoc._lookup_field(field.split('.')))
+                        ret.append(subfield)
                         found = True
                         break
                     except LookUpError:
@@ -1769,8 +1748,7 @@ class BaseQuerySet(object):
 
                 if not found:
                     raise err
-
-        return db_field_paths
+        return ret
 
     def _get_order_by(self, keys):
         """Given a list of MongoEngine-style sort keys, return a list
@@ -1821,6 +1799,26 @@ class BaseQuerySet(object):
 
         return tuple(data)
 
+    def _get_as_pymongo(self, doc):
+        """Clean up a PyMongo doc, removing fields that were only fetched
+        for the sake of MongoEngine's implementation, and return it.
+        """
+        # Always remove _cls as a MongoEngine's implementation detail.
+        if '_cls' in doc:
+            del doc['_cls']
+
+        # If the _id was not included in a .only or was excluded in a .exclude,
+        # remove it from the doc (we always fetch it so that we can properly
+        # construct documents).
+        fields = self._loaded_fields
+        if fields and '_id' in doc and (
+            (fields.value == QueryFieldList.ONLY and '_id' not in fields.fields) or
+            (fields.value == QueryFieldList.EXCLUDE and '_id' in fields.fields)
+        ):
+            del doc['_id']
+
+        return doc
+
     def _sub_js_fields(self, code):
         """When fields are specified with [~fieldname] syntax, where
         *fieldname* is the Python name of a field, *fieldname* will be
@@ -1842,8 +1840,8 @@ class BaseQuerySet(object):
             # Substitute the correct name for the field into the javascript
             return '.'.join([f.db_field for f in fields])
 
-        code = re.sub(r'\[\s*~([A-z_][A-z_0-9.]+?)\s*\]', field_sub, code)
-        code = re.sub(r'\{\{\s*~([A-z_][A-z_0-9.]+?)\s*\}\}', field_path_sub,
+        code = re.sub(u'\[\s*~([A-z_][A-z_0-9.]+?)\s*\]', field_sub, code)
+        code = re.sub(u'\{\{\s*~([A-z_][A-z_0-9.]+?)\s*\}\}', field_path_sub,
                       code)
         return code
 

mongoengine/queryset/field_list.py

@@ -63,11 +63,9 @@ class QueryFieldList(object):
             self._only_called = True
         return self
 
-    def __bool__(self):
+    def __nonzero__(self):
         return bool(self.fields)
 
-    __nonzero__ = __bool__  # For Py2 support
-
     def as_dict(self):
         field_list = {field: self.value for field in self.fields}
         if self.slice:

mongoengine/queryset/manager.py

@@ -36,7 +36,7 @@ class QuerySetManager(object):
         queryset_class = owner._meta.get('queryset_class', self.default)
         queryset = queryset_class(owner, owner._get_collection())
         if self.get_queryset:
-            arg_count = self.get_queryset.__code__.co_argcount
+            arg_count = self.get_queryset.func_code.co_argcount
             if arg_count == 1:
                 queryset = self.get_queryset(queryset)
             elif arg_count == 2:

mongoengine/queryset/queryset.py

@@ -1,5 +1,3 @@
-import six
-
 from mongoengine.errors import OperationError
 from mongoengine.queryset.base import (BaseQuerySet, CASCADE, DENY, DO_NOTHING,
                                        NULLIFY, PULL)
@@ -89,10 +87,10 @@ class QuerySet(BaseQuerySet):
                 yield self._result_cache[pos]
                 pos += 1
 
-            # return if we already established there were no more
+            # Raise StopIteration if we already established there were no more
             # docs in the db cursor.
             if not self._has_more:
-                return
+                raise StopIteration
 
             # Otherwise, populate more of the cache and repeat.
             if len(self._result_cache) <= pos:
@@ -114,8 +112,8 @@ class QuerySet(BaseQuerySet):
         # Pull in ITER_CHUNK_SIZE docs from the database and store them in
         # the result cache.
         try:
-            for _ in six.moves.range(ITER_CHUNK_SIZE):
-                self._result_cache.append(six.next(self))
+            for _ in xrange(ITER_CHUNK_SIZE):
+                self._result_cache.append(self.next())
         except StopIteration:
             # Getting this exception means there are no more docs in the
             # db cursor. Set _has_more to False so that we can use that
@@ -168,9 +166,9 @@ class QuerySetNoCache(BaseQuerySet):
             return '.. queryset mid-iteration ..'
 
         data = []
-        for _ in six.moves.range(REPR_OUTPUT_SIZE + 1):
+        for _ in xrange(REPR_OUTPUT_SIZE + 1):
             try:
-                data.append(six.next(self))
+                data.append(self.next())
             except StopIteration:
                 break
 
@@ -186,3 +184,10 @@ class QuerySetNoCache(BaseQuerySet):
             queryset = self.clone()
         queryset.rewind()
         return queryset
+
+
+class QuerySetNoDeRef(QuerySet):
+    """Special no_dereference QuerySet"""
+
+    def __dereference(items, max_depth=1, instance=None, name=None):
+        return items

mongoengine/queryset/transform.py

@@ -4,11 +4,12 @@ from bson import ObjectId, SON
 from bson.dbref import DBRef
 import pymongo
 import six
-from six import iteritems
 
 from mongoengine.base import UPDATE_OPERATORS
 from mongoengine.common import _import_class
+from mongoengine.connection import get_connection
 from mongoengine.errors import InvalidQueryError
+from mongoengine.python_support import IS_PYMONGO_3
 
 __all__ = ('query', 'update')
 
@@ -86,14 +87,35 @@ def query(_doc_cls=None, **kwargs):
             singular_ops = [None, 'ne', 'gt', 'gte', 'lt', 'lte', 'not']
             singular_ops += STRING_OPERATORS
             if op in singular_ops:
-                value = field.prepare_query_value(op, value)
+                if isinstance(field, six.string_types):
+                    if (op in STRING_OPERATORS and
+                            isinstance(value, six.string_types)):
+                        StringField = _import_class('StringField')
+                        value = StringField.prepare_query_value(op, value)
+                    else:
+                        value = field
+                else:
+                    value = field.prepare_query_value(op, value)
 
-                if isinstance(field, CachedReferenceField) and value:
-                    value = value['_id']
+                    if isinstance(field, CachedReferenceField) and value:
+                        value = value['_id']
 
             elif op in ('in', 'nin', 'all', 'near') and not isinstance(value, dict):
-                # Raise an error if the in/nin/all/near param is not iterable.
-                value = _prepare_query_for_iterable(field, op, value)
+                # Raise an error if the in/nin/all/near param is not iterable. We need a
+                # special check for BaseDocument, because - although it's iterable - using
+                # it as such in the context of this method is most definitely a mistake.
+                BaseDocument = _import_class('BaseDocument')
+                if isinstance(value, BaseDocument):
+                    raise TypeError("When using the `in`, `nin`, `all`, or "
+                                    "`near`-operators you can\'t use a "
+                                    "`Document`, you must wrap your object "
+                                    "in a list (object -> [object]).")
+                elif not hasattr(value, '__iter__'):
+                    raise TypeError("The `in`, `nin`, `all`, or "
+                                    "`near`-operators must be applied to an "
+                                    "iterable (e.g. a list).")
+                else:
+                    value = [field.prepare_query_value(op, v) for v in value]
 
             # If we're querying a GenericReferenceField, we need to alter the
             # key depending on the value:
@@ -138,14 +160,14 @@ def query(_doc_cls=None, **kwargs):
         if op is None or key not in mongo_query:
             mongo_query[key] = value
         elif key in mongo_query:
-            if isinstance(mongo_query[key], dict) and isinstance(value, dict):
+            if isinstance(mongo_query[key], dict):
                 mongo_query[key].update(value)
                 # $max/minDistance needs to come last - convert to SON
                 value_dict = mongo_query[key]
                 if ('$maxDistance' in value_dict or '$minDistance' in value_dict) and \
                         ('$near' in value_dict or '$nearSphere' in value_dict):
                     value_son = SON()
-                    for k, v in iteritems(value_dict):
+                    for k, v in value_dict.iteritems():
                         if k == '$maxDistance' or k == '$minDistance':
                             continue
                         value_son[k] = v
@@ -153,14 +175,16 @@ def query(_doc_cls=None, **kwargs):
                     # PyMongo 3+ and MongoDB < 2.6
                     near_embedded = False
                     for near_op in ('$near', '$nearSphere'):
-                        if isinstance(value_dict.get(near_op), dict):
+                        if isinstance(value_dict.get(near_op), dict) and (
+                                IS_PYMONGO_3 or get_connection().max_wire_version > 1):
                             value_son[near_op] = SON(value_son[near_op])
                             if '$maxDistance' in value_dict:
-                                value_son[near_op]['$maxDistance'] = value_dict['$maxDistance']
+                                value_son[near_op][
+                                    '$maxDistance'] = value_dict['$maxDistance']
                             if '$minDistance' in value_dict:
-                                value_son[near_op]['$minDistance'] = value_dict['$minDistance']
+                                value_son[near_op][
+                                    '$minDistance'] = value_dict['$minDistance']
                             near_embedded = True
-
                     if not near_embedded:
                         if '$maxDistance' in value_dict:
                             value_son['$maxDistance'] = value_dict['$maxDistance']
@@ -190,37 +214,30 @@ def update(_doc_cls=None, **update):
     format.
     """
     mongo_update = {}
-
     for key, value in update.items():
         if key == '__raw__':
             mongo_update.update(value)
             continue
-
         parts = key.split('__')
-
         # if there is no operator, default to 'set'
         if len(parts) < 3 and parts[0] not in UPDATE_OPERATORS:
             parts.insert(0, 'set')
-
         # Check for an operator and transform to mongo-style if there is
         op = None
         if parts[0] in UPDATE_OPERATORS:
             op = parts.pop(0)
             # Convert Pythonic names to Mongo equivalents
-            operator_map = {
-                'push_all': 'pushAll',
-                'pull_all': 'pullAll',
-                'dec': 'inc',
-                'add_to_set': 'addToSet',
-                'set_on_insert': 'setOnInsert'
-            }
-            if op == 'dec':
+            if op in ('push_all', 'pull_all'):
+                op = op.replace('_all', 'All')
+            elif op == 'dec':
                 # Support decrement by flipping a positive value's sign
                 # and using 'inc'
+                op = 'inc'
                 value = -value
-            # If the operator doesn't found from operator map, the op value
-            # will stay unchanged
-            op = operator_map.get(op, op)
+            elif op == 'add_to_set':
+                op = 'addToSet'
+            elif op == 'set_on_insert':
+                op = 'setOnInsert'
 
         match = None
         if parts[-1] in COMPARISON_OPERATORS:
@@ -267,15 +284,7 @@ def update(_doc_cls=None, **update):
             if isinstance(field, GeoJsonBaseField):
                 value = field.to_mongo(value)
 
-            if op == 'pull':
-                if field.required or value is not None:
-                    if match in ('in', 'nin') and not isinstance(value, dict):
-                        value = _prepare_query_for_iterable(field, op, value)
-                    else:
-                        value = field.prepare_query_value(op, value)
-            elif op == 'push' and isinstance(value, (list, tuple, set)):
-                value = [field.prepare_query_value(op, v) for v in value]
-            elif op in (None, 'set', 'push'):
+            if op in (None, 'set', 'push', 'pull'):
                 if field.required or value is not None:
                     value = field.prepare_query_value(op, value)
             elif op in ('pushAll', 'pullAll'):
@@ -287,8 +296,6 @@ def update(_doc_cls=None, **update):
                     value = field.prepare_query_value(op, value)
             elif op == 'unset':
                 value = 1
-            elif op == 'inc':
-                value = field.prepare_query_value(op, value)
 
         if match:
             match = '$' + match
@@ -296,6 +303,10 @@ def update(_doc_cls=None, **update):
 
         key = '.'.join(parts)
 
+        if not op:
+            raise InvalidQueryError('Updates must supply an operation '
+                                    'eg: set__FIELD=value')
+
         if 'pull' in op and '.' in key:
             # Dot operators don't work on pull operations
             # unless they point to a list field
@@ -308,17 +319,11 @@ def update(_doc_cls=None, **update):
             field_classes = [c.__class__ for c in cleaned_fields]
             field_classes.reverse()
             ListField = _import_class('ListField')
-            EmbeddedDocumentListField = _import_class('EmbeddedDocumentListField')
-            if ListField in field_classes or EmbeddedDocumentListField in field_classes:
-                # Join all fields via dot notation to the last ListField or EmbeddedDocumentListField
+            if ListField in field_classes:
+                # Join all fields via dot notation to the last ListField
                 # Then process as normal
-                if ListField in field_classes:
-                    _check_field = ListField
-                else:
-                    _check_field = EmbeddedDocumentListField
-
                 last_listField = len(
-                    cleaned_fields) - field_classes.index(_check_field)
+                    cleaned_fields) - field_classes.index(ListField)
                 key = '.'.join(parts[:last_listField])
                 parts = parts[last_listField:]
                 parts.insert(0, key)
@@ -328,26 +333,10 @@ def update(_doc_cls=None, **update):
                 value = {key: value}
         elif op == 'addToSet' and isinstance(value, list):
             value = {key: {'$each': value}}
-        elif op in ('push', 'pushAll'):
-            if parts[-1].isdigit():
-                key = '.'.join(parts[0:-1])
-                position = int(parts[-1])
-                # $position expects an iterable. If pushing a single value,
-                # wrap it in a list.
-                if not isinstance(value, (set, tuple, list)):
-                    value = [value]
-                value = {key: {'$each': value, '$position': position}}
-            else:
-                if op == 'pushAll':
-                    op = 'push'  # convert to non-deprecated keyword
-                    if not isinstance(value, (set, tuple, list)):
-                        value = [value]
-                    value = {key: {'$each': value}}
-                else:
-                    value = {key: value}
         else:
             value = {key: value}
         key = '$' + op
+
         if key not in mongo_update:
             mongo_update[key] = value
         elif key in mongo_update and isinstance(mongo_update[key], dict):
@@ -414,6 +403,7 @@ def _infer_geometry(value):
                                 'type and coordinates keys')
     elif isinstance(value, (list, set)):
         # TODO: shouldn't we test value[0][0][0][0] to see if it is MultiPolygon?
+        # TODO: should both TypeError and IndexError be alike interpreted?
 
         try:
             value[0][0][0]
@@ -435,22 +425,3 @@ def _infer_geometry(value):
 
     raise InvalidQueryError('Invalid $geometry data. Can be either a '
                             'dictionary or (nested) lists of coordinate(s)')
-
-
-def _prepare_query_for_iterable(field, op, value):
-    # We need a special check for BaseDocument, because - although it's iterable - using
-    # it as such in the context of this method is most definitely a mistake.
-    BaseDocument = _import_class('BaseDocument')
-
-    if isinstance(value, BaseDocument):
-        raise TypeError("When using the `in`, `nin`, `all`, or "
-                        "`near`-operators you can\'t use a "
-                        "`Document`, you must wrap your object "
-                        "in a list (object -> [object]).")
-
-    if not hasattr(value, '__iter__'):
-        raise TypeError("The `in`, `nin`, `all`, or "
-                        "`near`-operators must be applied to an "
-                        "iterable (e.g. a list).")
-
-    return [field.prepare_query_value(op, v) for v in value]

mongoengine/queryset/visitor.py

@@ -3,7 +3,7 @@ import copy
 from mongoengine.errors import InvalidQueryError
 from mongoengine.queryset import transform
 
-__all__ = ('Q', 'QNode')
+__all__ = ('Q',)
 
 
 class QNodeVisitor(object):
@@ -131,10 +131,6 @@ class QCombination(QNode):
             else:
                 self.children.append(node)
 
-    def __repr__(self):
-        op = ' & ' if self.operation is self.AND else ' | '
-        return '(%s)' % op.join([repr(node) for node in self.children])
-
     def accept(self, visitor):
         for i in range(len(self.children)):
             if isinstance(self.children[i], QNode):
@@ -155,9 +151,6 @@ class Q(QNode):
     def __init__(self, **query):
         self.query = query
 
-    def __repr__(self):
-        return 'Q(**%s)' % repr(self.query)
-
     def accept(self, visitor):
         return visitor.visit_query(self)
 

requirements.txt

@@ -1,5 +1,5 @@
 nose
-pymongo>=3.4
+pymongo>=2.7.1
 six==1.10.0
 flake8
 flake8-import-order

setup.cfg

@@ -1,11 +1,11 @@
 [nosetests]
 verbosity=2
 detailed-errors=1
-#tests=tests
+tests=tests
 cover-package=mongoengine
 
 [flake8]
-ignore=E501,F401,F403,F405,I201,I202,W504, W605
+ignore=E501,F401,F403,F405,I201
 exclude=build,dist,docs,venv,venv3,.tox,.eggs,tests
 max-complexity=47
 application-import-names=mongoengine,tests

setup.py

@@ -44,8 +44,9 @@ CLASSIFIERS = [
     "Programming Language :: Python :: 2",
     "Programming Language :: Python :: 2.7",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.3",
+    "Programming Language :: Python :: 3.4",
     "Programming Language :: Python :: 3.5",
-    "Programming Language :: Python :: 3.6",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
     'Topic :: Database',
@@ -69,9 +70,9 @@ setup(
     name='mongoengine',
     version=VERSION,
     author='Harry Marr',
-    author_email='harry.marr@gmail.com',
-    maintainer="Stefan Wojcik",
-    maintainer_email="wojcikstefan@gmail.com",
+    author_email='harry.marr@{nospam}gmail.com',
+    maintainer="Ross Lawley",
+    maintainer_email="ross.lawley@{nospam}gmail.com",
     url='http://mongoengine.org/',
     download_url='https://github.com/MongoEngine/mongoengine/tarball/master',
     license='MIT',
@@ -80,7 +81,7 @@ setup(
     long_description=LONG_DESCRIPTION,
     platforms=['any'],
     classifiers=CLASSIFIERS,
-    install_requires=['pymongo>=3.4', 'six'],
+    install_requires=['pymongo>=2.7.1', 'six'],
     test_suite='nose.collector',
     **extra_opts
 )

tests/__init__.py

@@ -1,4 +1,4 @@
-from .all_warnings import AllWarnings
-from .document import *
-from .queryset import *
-from .fields import *
+from all_warnings import AllWarnings
+from document import *
+from queryset import *
+from fields import *

tests/document/__init__.py

@@ -1,13 +1,13 @@
 import unittest
 
-from .class_methods import *
-from .delta import *
-from .dynamic import *
-from .indexes import *
-from .inheritance import *
-from .instance import *
-from .json_serialisation import *
-from .validation import *
+from class_methods import *
+from delta import *
+from dynamic import *
+from indexes import *
+from inheritance import *
+from instance import *
+from json_serialisation import *
+from validation import *
 
 if __name__ == '__main__':
     unittest.main()

tests/document/class_methods.py

@@ -2,7 +2,6 @@
 import unittest
 
 from mongoengine import *
-from mongoengine.pymongo_support import list_collection_names
 
 from mongoengine.queryset import NULLIFY, PULL
 from mongoengine.connection import get_db
@@ -27,7 +26,9 @@ class ClassMethodsTest(unittest.TestCase):
         self.Person = Person
 
     def tearDown(self):
-        for collection in list_collection_names(self.db):
+        for collection in self.db.collection_names():
+            if 'system.' in collection:
+                continue
             self.db.drop_collection(collection)
 
     def test_definition(self):
@@ -64,10 +65,10 @@ class ClassMethodsTest(unittest.TestCase):
         """
         collection_name = 'person'
         self.Person(name='Test').save()
-        self.assertIn(collection_name, list_collection_names(self.db))
+        self.assertTrue(collection_name in self.db.collection_names())
 
         self.Person.drop_collection()
-        self.assertNotIn(collection_name, list_collection_names(self.db))
+        self.assertFalse(collection_name in self.db.collection_names())
 
     def test_register_delete_rule(self):
         """Ensure that register delete rule adds a delete rule to the document
@@ -100,16 +101,16 @@ class ClassMethodsTest(unittest.TestCase):
         BlogPost.drop_collection()
 
         BlogPost.ensure_indexes()
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [], 'extra': []})
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [], 'extra': [] })
 
         BlogPost.ensure_index(['author', 'description'])
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [], 'extra': [[('author', 1), ('description', 1)]]})
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [], 'extra': [[('author', 1), ('description', 1)]] })
 
         BlogPost._get_collection().drop_index('author_1_description_1')
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [], 'extra': []})
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [], 'extra': [] })
 
         BlogPost._get_collection().drop_index('author_1_title_1')
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [[('author', 1), ('title', 1)]], 'extra': []})
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [[('author', 1), ('title', 1)]], 'extra': [] })
 
     def test_compare_indexes_inheritance(self):
         """ Ensure that the indexes are properly created and that
@@ -138,16 +139,16 @@ class ClassMethodsTest(unittest.TestCase):
 
         BlogPost.ensure_indexes()
         BlogPostWithTags.ensure_indexes()
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [], 'extra': []})
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [], 'extra': [] })
 
         BlogPostWithTags.ensure_index(['author', 'tag_list'])
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [], 'extra': [[('_cls', 1), ('author', 1), ('tag_list', 1)]]})
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [], 'extra': [[('_cls', 1), ('author', 1), ('tag_list', 1)]] })
 
         BlogPostWithTags._get_collection().drop_index('_cls_1_author_1_tag_list_1')
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [], 'extra': []})
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [], 'extra': [] })
 
         BlogPostWithTags._get_collection().drop_index('_cls_1_author_1_tags_1')
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [[('_cls', 1), ('author', 1), ('tags', 1)]], 'extra': []})
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [[('_cls', 1), ('author', 1), ('tags', 1)]], 'extra': [] })
 
     def test_compare_indexes_multiple_subclasses(self):
         """ Ensure that compare_indexes behaves correctly if called from a
@@ -182,28 +183,9 @@ class ClassMethodsTest(unittest.TestCase):
         BlogPostWithTags.ensure_indexes()
         BlogPostWithCustomField.ensure_indexes()
 
-        self.assertEqual(BlogPost.compare_indexes(), {'missing': [], 'extra': []})
-        self.assertEqual(BlogPostWithTags.compare_indexes(), {'missing': [], 'extra': []})
-        self.assertEqual(BlogPostWithCustomField.compare_indexes(), {'missing': [], 'extra': []})
-
-    def test_compare_indexes_for_text_indexes(self):
-        """ Ensure that compare_indexes behaves correctly for text indexes """
-
-        class Doc(Document):
-            a = StringField()
-            b = StringField()
-            meta = {'indexes': [
-                {'fields': ['$a', "$b"],
-                 'default_language': 'english',
-                 'weights': {'a': 10, 'b': 2}
-                }
-            ]}
-
-        Doc.drop_collection()
-        Doc.ensure_indexes()
-        actual = Doc.compare_indexes()
-        expected = {'missing': [], 'extra': []}
-        self.assertEqual(actual, expected)
+        self.assertEqual(BlogPost.compare_indexes(), { 'missing': [], 'extra': [] })
+        self.assertEqual(BlogPostWithTags.compare_indexes(), { 'missing': [], 'extra': [] })
+        self.assertEqual(BlogPostWithCustomField.compare_indexes(), { 'missing': [], 'extra': [] })
 
     def test_list_indexes_inheritance(self):
         """ ensure that all of the indexes are listed regardless of the super-
@@ -337,7 +319,7 @@ class ClassMethodsTest(unittest.TestCase):
             meta = {'collection': collection_name}
 
         Person(name="Test User").save()
-        self.assertIn(collection_name, list_collection_names(self.db))
+        self.assertTrue(collection_name in self.db.collection_names())
 
         user_obj = self.db[collection_name].find_one()
         self.assertEqual(user_obj['name'], "Test User")
@@ -346,7 +328,7 @@ class ClassMethodsTest(unittest.TestCase):
         self.assertEqual(user_obj.name, "Test User")
 
         Person.drop_collection()
-        self.assertNotIn(collection_name, list_collection_names(self.db))
+        self.assertFalse(collection_name in self.db.collection_names())
 
     def test_collection_name_and_primary(self):
         """Ensure that a collection with a specified name may be used.

tests/document/delta.py

@@ -3,14 +3,16 @@ import unittest
 
 from bson import SON
 from mongoengine import *
-from mongoengine.pymongo_support import list_collection_names
-from tests.utils import MongoDBTestCase
+from mongoengine.connection import get_db
+
+__all__ = ("DeltaTest",)
 
 
-class DeltaTest(MongoDBTestCase):
+class DeltaTest(unittest.TestCase):
 
     def setUp(self):
-        super(DeltaTest, self).setUp()
+        connect(db='mongoenginetest')
+        self.db = get_db()
 
         class Person(Document):
             name = StringField()
@@ -23,7 +25,9 @@ class DeltaTest(MongoDBTestCase):
         self.Person = Person
 
     def tearDown(self):
-        for collection in list_collection_names(self.db):
+        for collection in self.db.collection_names():
+            if 'system.' in collection:
+                continue
             self.db.drop_collection(collection)
 
     def test_delta(self):
@@ -690,7 +694,7 @@ class DeltaTest(MongoDBTestCase):
         organization.employees.append(person)
         updates, removals = organization._delta()
         self.assertEqual({}, removals)
-        self.assertIn('employees', updates)
+        self.assertTrue('employees' in updates)
 
     def test_delta_with_dbref_false(self):
         person, organization, employee = self.circular_reference_deltas_2(Document, Document, False)
@@ -705,7 +709,7 @@ class DeltaTest(MongoDBTestCase):
         organization.employees.append(person)
         updates, removals = organization._delta()
         self.assertEqual({}, removals)
-        self.assertIn('employees', updates)
+        self.assertTrue('employees' in updates)
 
     def test_nested_nested_fields_mark_as_changed(self):
         class EmbeddedDoc(EmbeddedDocument):
@@ -859,6 +863,5 @@ class DeltaTest(MongoDBTestCase):
         self.assertEqual('oops', delta[0]["users.007.rolist"][0]["type"])
         self.assertEqual(uinfo.id, delta[0]["users.007.info"])
 
-
 if __name__ == '__main__':
     unittest.main()

tests/document/dynamic.py

@@ -1,15 +1,16 @@
 import unittest
 
 from mongoengine import *
-from tests.utils import MongoDBTestCase
+from mongoengine.connection import get_db
 
-__all__ = ("TestDynamicDocument", )
+__all__ = ("DynamicTest", )
 
 
-class TestDynamicDocument(MongoDBTestCase):
+class DynamicTest(unittest.TestCase):
 
     def setUp(self):
-        super(TestDynamicDocument, self).setUp()
+        connect(db='mongoenginetest')
+        self.db = get_db()
 
         class Person(DynamicDocument):
             name = StringField()
@@ -97,72 +98,6 @@ class TestDynamicDocument(MongoDBTestCase):
         self.assertEqual(len(p._data), 4)
         self.assertEqual(sorted(p._data.keys()), ['_cls', 'age', 'id', 'name'])
 
-    def test_fields_without_underscore(self):
-        """Ensure we can query dynamic fields"""
-        Person = self.Person
-
-        p = self.Person(name='Dean')
-        p.save()
-
-        raw_p = Person.objects.as_pymongo().get(id=p.id)
-        self.assertEqual(
-            raw_p,
-            {
-                '_cls': u'Person',
-                '_id': p.id,
-                'name': u'Dean'
-             }
-        )
-
-        p.name = 'OldDean'
-        p.newattr = 'garbage'
-        p.save()
-        raw_p = Person.objects.as_pymongo().get(id=p.id)
-        self.assertEqual(
-            raw_p,
-            {
-                '_cls': u'Person',
-                '_id': p.id,
-                'name': 'OldDean',
-                'newattr': u'garbage'
-            }
-        )
-
-    def test_fields_containing_underscore(self):
-        """Ensure we can query dynamic fields"""
-        class WeirdPerson(DynamicDocument):
-            name = StringField()
-            _name = StringField()
-
-        WeirdPerson.drop_collection()
-
-        p = WeirdPerson(name='Dean', _name='Dean')
-        p.save()
-
-        raw_p = WeirdPerson.objects.as_pymongo().get(id=p.id)
-        self.assertEqual(
-            raw_p,
-            {
-                '_id': p.id,
-                '_name': u'Dean',
-                'name': u'Dean'
-            }
-        )
-
-        p.name = 'OldDean'
-        p._name = 'NewDean'
-        p._newattr1 = 'garbage'    # Unknown fields won't be added
-        p.save()
-        raw_p = WeirdPerson.objects.as_pymongo().get(id=p.id)
-        self.assertEqual(
-            raw_p,
-            {
-                '_id': p.id,
-                '_name': u'NewDean',
-                'name': u'OldDean',
-            }
-        )
-
     def test_dynamic_document_queries(self):
         """Ensure we can query dynamic fields"""
         p = self.Person()
@@ -239,8 +174,8 @@ class TestDynamicDocument(MongoDBTestCase):
 
         Employee.drop_collection()
 
-        self.assertIn('name', Employee._fields)
-        self.assertIn('salary', Employee._fields)
+        self.assertTrue('name' in Employee._fields)
+        self.assertTrue('salary' in Employee._fields)
         self.assertEqual(Employee._get_collection_name(),
                          self.Person._get_collection_name())
 
@@ -254,7 +189,7 @@ class TestDynamicDocument(MongoDBTestCase):
         self.assertEqual(1, Employee.objects(age=20).count())
 
         joe_bloggs = self.Person.objects.first()
-        self.assertIsInstance(joe_bloggs, Employee)
+        self.assertTrue(isinstance(joe_bloggs, Employee))
 
     def test_embedded_dynamic_document(self):
         """Test dynamic embedded documents"""
@@ -434,6 +369,5 @@ class TestDynamicDocument(MongoDBTestCase):
         person.save()
         self.assertEqual(Person.objects.first().age, 35)
 
-
 if __name__ == '__main__':
     unittest.main()

tests/document/indexes.py

@@ -1,15 +1,16 @@
 # -*- coding: utf-8 -*-
 import unittest
-from datetime import datetime
+import sys
 
 from nose.plugins.skip import SkipTest
-from pymongo.errors import OperationFailure
+from datetime import datetime
 import pymongo
-from six import iteritems
 
 from mongoengine import *
 from mongoengine.connection import get_db
 
+from tests.utils import get_mongodb_version, needs_mongodb_v26
+
 __all__ = ("IndexesTest", )
 
 
@@ -67,9 +68,9 @@ class IndexesTest(unittest.TestCase):
         info = BlogPost.objects._collection.index_information()
         # _id, '-date', 'tags', ('cat', 'date')
         self.assertEqual(len(info), 4)
-        info = [value['key'] for key, value in iteritems(info)]
+        info = [value['key'] for key, value in info.iteritems()]
         for expected in expected_specs:
-            self.assertIn(expected['fields'], info)
+            self.assertTrue(expected['fields'] in info)
 
     def _index_test_inheritance(self, InheritFrom):
 
@@ -99,9 +100,9 @@ class IndexesTest(unittest.TestCase):
         # the indices on -date and tags will both contain
         # _cls as first element in the key
         self.assertEqual(len(info), 4)
-        info = [value['key'] for key, value in iteritems(info)]
+        info = [value['key'] for key, value in info.iteritems()]
         for expected in expected_specs:
-            self.assertIn(expected['fields'], info)
+            self.assertTrue(expected['fields'] in info)
 
         class ExtendedBlogPost(BlogPost):
             title = StringField()
@@ -114,9 +115,9 @@ class IndexesTest(unittest.TestCase):
 
         ExtendedBlogPost.ensure_indexes()
         info = ExtendedBlogPost.objects._collection.index_information()
-        info = [value['key'] for key, value in iteritems(info)]
+        info = [value['key'] for key, value in info.iteritems()]
         for expected in expected_specs:
-            self.assertIn(expected['fields'], info)
+            self.assertTrue(expected['fields'] in info)
 
     def test_indexes_document_inheritance(self):
         """Ensure that indexes are used when meta[indexes] is specified for
@@ -224,8 +225,8 @@ class IndexesTest(unittest.TestCase):
         # Indexes are lazy so use list() to perform query
         list(Person.objects)
         info = Person.objects._collection.index_information()
-        info = [value['key'] for key, value in iteritems(info)]
-        self.assertIn([('rank.title', 1)], info)
+        info = [value['key'] for key, value in info.iteritems()]
+        self.assertTrue([('rank.title', 1)] in info)
 
     def test_explicit_geo2d_index(self):
         """Ensure that geo2d indexes work when created via meta[indexes]
@@ -244,8 +245,8 @@ class IndexesTest(unittest.TestCase):
 
         Place.ensure_indexes()
         info = Place._get_collection().index_information()
-        info = [value['key'] for key, value in iteritems(info)]
-        self.assertIn([('location.point', '2d')], info)
+        info = [value['key'] for key, value in info.iteritems()]
+        self.assertTrue([('location.point', '2d')] in info)
 
     def test_explicit_geo2d_index_embedded(self):
         """Ensure that geo2d indexes work when created via meta[indexes]
@@ -267,8 +268,8 @@ class IndexesTest(unittest.TestCase):
 
         Place.ensure_indexes()
         info = Place._get_collection().index_information()
-        info = [value['key'] for key, value in iteritems(info)]
-        self.assertIn([('current.location.point', '2d')], info)
+        info = [value['key'] for key, value in info.iteritems()]
+        self.assertTrue([('current.location.point', '2d')] in info)
 
     def test_explicit_geosphere_index(self):
         """Ensure that geosphere indexes work when created via meta[indexes]
@@ -287,8 +288,8 @@ class IndexesTest(unittest.TestCase):
 
         Place.ensure_indexes()
         info = Place._get_collection().index_information()
-        info = [value['key'] for key, value in iteritems(info)]
-        self.assertIn([('location.point', '2dsphere')], info)
+        info = [value['key'] for key, value in info.iteritems()]
+        self.assertTrue([('location.point', '2dsphere')] in info)
 
     def test_explicit_geohaystack_index(self):
         """Ensure that geohaystack indexes work when created via meta[indexes]
@@ -309,8 +310,8 @@ class IndexesTest(unittest.TestCase):
 
         Place.ensure_indexes()
         info = Place._get_collection().index_information()
-        info = [value['key'] for key, value in iteritems(info)]
-        self.assertIn([('location.point', 'geoHaystack')], info)
+        info = [value['key'] for key, value in info.iteritems()]
+        self.assertTrue([('location.point', 'geoHaystack')] in info)
 
     def test_create_geohaystack_index(self):
         """Ensure that geohaystack indexes can be created
@@ -321,8 +322,8 @@ class IndexesTest(unittest.TestCase):
 
         Place.create_index({'fields': (')location.point', 'name')}, bucketSize=10)
         info = Place._get_collection().index_information()
-        info = [value['key'] for key, value in iteritems(info)]
-        self.assertIn([('location.point', 'geoHaystack'), ('name', 1)], info)
+        info = [value['key'] for key, value in info.iteritems()]
+        self.assertTrue([('location.point', 'geoHaystack'), ('name', 1)] in info)
 
     def test_dictionary_indexes(self):
         """Ensure that indexes are used when meta[indexes] contains
@@ -354,8 +355,8 @@ class IndexesTest(unittest.TestCase):
         info = [(value['key'],
                  value.get('unique', False),
                  value.get('sparse', False))
-                for key, value in iteritems(info)]
-        self.assertIn(([('addDate', -1)], True, True), info)
+                for key, value in info.iteritems()]
+        self.assertTrue(([('addDate', -1)], True, True) in info)
 
         BlogPost.drop_collection()
 
@@ -406,7 +407,7 @@ class IndexesTest(unittest.TestCase):
 
         self.assertEqual(2, User.objects.count())
         info = User.objects._collection.index_information()
-        self.assertEqual(list(info.keys()), ['_id_'])
+        self.assertEqual(info.keys(), ['_id_'])
 
         User.ensure_indexes()
         info = User.objects._collection.index_information()
@@ -475,6 +476,7 @@ class IndexesTest(unittest.TestCase):
     def test_covered_index(self):
         """Ensure that covered indexes can be used
         """
+
         class Test(Document):
             a = IntField()
             b = IntField()
@@ -489,41 +491,38 @@ class IndexesTest(unittest.TestCase):
         obj = Test(a=1)
         obj.save()
 
+        IS_MONGODB_3 = get_mongodb_version()[0] >= 3
+
         # Need to be explicit about covered indexes as mongoDB doesn't know if
         # the documents returned might have more keys in that here.
         query_plan = Test.objects(id=obj.id).exclude('a').explain()
-        self.assertEqual(
-            query_plan.get('queryPlanner').get('winningPlan').get('inputStage').get('stage'),
-            'IDHACK'
-        )
+        if not IS_MONGODB_3:
+            self.assertFalse(query_plan['indexOnly'])
+        else:
+            self.assertEqual(query_plan.get('queryPlanner').get('winningPlan').get('inputStage').get('stage'), 'IDHACK')
 
         query_plan = Test.objects(id=obj.id).only('id').explain()
-        self.assertEqual(
-            query_plan.get('queryPlanner').get('winningPlan').get('inputStage').get('stage'),
-            'IDHACK'
-        )
+        if not IS_MONGODB_3:
+            self.assertTrue(query_plan['indexOnly'])
+        else:
+            self.assertEqual(query_plan.get('queryPlanner').get('winningPlan').get('inputStage').get('stage'), 'IDHACK')
 
         query_plan = Test.objects(a=1).only('a').exclude('id').explain()
-        self.assertEqual(
-            query_plan.get('queryPlanner').get('winningPlan').get('inputStage').get('stage'),
-            'IXSCAN'
-        )
-        self.assertEqual(
-            query_plan.get('queryPlanner').get('winningPlan').get('stage'),
-            'PROJECTION'
-        )
+        if not IS_MONGODB_3:
+            self.assertTrue(query_plan['indexOnly'])
+        else:
+            self.assertEqual(query_plan.get('queryPlanner').get('winningPlan').get('inputStage').get('stage'), 'IXSCAN')
+            self.assertEqual(query_plan.get('queryPlanner').get('winningPlan').get('stage'), 'PROJECTION')
 
         query_plan = Test.objects(a=1).explain()
-        self.assertEqual(
-            query_plan.get('queryPlanner').get('winningPlan').get('inputStage').get('stage'),
-            'IXSCAN'
-        )
-        self.assertEqual(
-            query_plan.get('queryPlanner').get('winningPlan').get('stage'),
-            'FETCH'
-        )
+        if not IS_MONGODB_3:
+            self.assertFalse(query_plan['indexOnly'])
+        else:
+            self.assertEqual(query_plan.get('queryPlanner').get('winningPlan').get('inputStage').get('stage'), 'IXSCAN')
+            self.assertEqual(query_plan.get('queryPlanner').get('winningPlan').get('stage'), 'FETCH')
 
     def test_index_on_id(self):
+
         class BlogPost(Document):
             meta = {
                 'indexes': [
@@ -542,46 +541,40 @@ class IndexesTest(unittest.TestCase):
                                  [('categories', 1), ('_id', 1)])
 
     def test_hint(self):
-        TAGS_INDEX_NAME = 'tags_1'
 
         class BlogPost(Document):
             tags = ListField(StringField())
             meta = {
                 'indexes': [
-                    {
-                        'fields': ['tags'],
-                        'name': TAGS_INDEX_NAME
-                    }
+                    'tags',
                 ],
             }
 
         BlogPost.drop_collection()
 
-        for i in range(10):
-            tags = [("tag %i" % n) for n in range(i % 2)]
+        for i in range(0, 10):
+            tags = [("tag %i" % n) for n in range(0, i % 2)]
             BlogPost(tags=tags).save()
 
-        # Hinting by shape should work.
-        self.assertEqual(BlogPost.objects.hint([('tags', 1)]).count(), 10)
-
-        # Hinting by index name should work.
-        self.assertEqual(BlogPost.objects.hint(TAGS_INDEX_NAME).count(), 10)
-
-        # Clearing the hint should work fine.
+        self.assertEqual(BlogPost.objects.count(), 10)
         self.assertEqual(BlogPost.objects.hint().count(), 10)
-        self.assertEqual(BlogPost.objects.hint([('ZZ', 1)]).hint().count(), 10)
 
-        # Hinting on a non-existent index shape should fail.
-        with self.assertRaises(OperationFailure):
-            BlogPost.objects.hint([('ZZ', 1)]).count()
+        # PyMongo 3.0 bug only, works correctly with 2.X and 3.0.1+ versions
+        if pymongo.version != '3.0':
+            self.assertEqual(BlogPost.objects.hint([('tags', 1)]).count(), 10)
 
-        # Hinting on a non-existent index name should fail.
-        with self.assertRaises(OperationFailure):
-            BlogPost.objects.hint('Bad Name').count()
+            self.assertEqual(BlogPost.objects.hint([('ZZ', 1)]).count(), 10)
 
-        # Invalid shape argument (missing list brackets) should fail.
-        with self.assertRaises(ValueError):
-            BlogPost.objects.hint(('tags', 1)).count()
+        if pymongo.version >= '2.8':
+            self.assertEqual(BlogPost.objects.hint('tags').count(), 10)
+        else:
+            def invalid_index():
+                BlogPost.objects.hint('tags').next()
+            self.assertRaises(TypeError, invalid_index)
+
+        def invalid_index_2():
+            return BlogPost.objects.hint(('tags', 1)).next()
+        self.assertRaises(Exception, invalid_index_2)
 
     def test_unique(self):
         """Ensure that uniqueness constraints are applied to fields.
@@ -598,32 +591,10 @@ class IndexesTest(unittest.TestCase):
         # Two posts with the same slug is not allowed
         post2 = BlogPost(title='test2', slug='test')
         self.assertRaises(NotUniqueError, post2.save)
-        self.assertRaises(NotUniqueError, BlogPost.objects.insert, post2)
 
-        # Ensure backwards compatibility for errors
+        # Ensure backwards compatibilty for errors
         self.assertRaises(OperationError, post2.save)
 
-    def test_primary_key_unique_not_working(self):
-        """Relates to #1445"""
-        class Blog(Document):
-            id = StringField(primary_key=True, unique=True)
-
-        Blog.drop_collection()
-
-        with self.assertRaises(OperationFailure) as ctx_err:
-            Blog(id='garbage').save()
-
-        # One of the errors below should happen. Which one depends on the
-        # PyMongo version and dict order.
-        err_msg = str(ctx_err.exception)
-        self.assertTrue(
-            any([
-                "The field 'unique' is not valid for an _id index specification" in err_msg,
-                "The field 'background' is not valid for an _id index specification" in err_msg,
-                "The field 'sparse' is not valid for an _id index specification" in err_msg,
-            ])
-        )
-
     def test_unique_with(self):
         """Ensure that unique_with constraints are applied to fields.
         """
@@ -705,77 +676,6 @@ class IndexesTest(unittest.TestCase):
 
         self.assertRaises(NotUniqueError, post2.save)
 
-    def test_unique_embedded_document_in_sorted_list(self):
-        """
-        Ensure that the uniqueness constraints are applied to fields in
-        embedded documents, even when the embedded documents in a sorted list
-        field.
-        """
-        class SubDocument(EmbeddedDocument):
-            year = IntField()
-            slug = StringField(unique=True)
-
-        class BlogPost(Document):
-            title = StringField()
-            subs = SortedListField(EmbeddedDocumentField(SubDocument),
-                                   ordering='year')
-
-        BlogPost.drop_collection()
-
-        post1 = BlogPost(
-            title='test1', subs=[
-                SubDocument(year=2009, slug='conflict'),
-                SubDocument(year=2009, slug='conflict')
-            ]
-        )
-        post1.save()
-
-        # confirm that the unique index is created
-        indexes = BlogPost._get_collection().index_information()
-        self.assertIn('subs.slug_1', indexes)
-        self.assertTrue(indexes['subs.slug_1']['unique'])
-
-        post2 = BlogPost(
-            title='test2', subs=[SubDocument(year=2014, slug='conflict')]
-        )
-
-        self.assertRaises(NotUniqueError, post2.save)
-
-    def test_unique_embedded_document_in_embedded_document_list(self):
-        """
-        Ensure that the uniqueness constraints are applied to fields in
-        embedded documents, even when the embedded documents in an embedded
-        list field.
-        """
-        class SubDocument(EmbeddedDocument):
-            year = IntField()
-            slug = StringField(unique=True)
-
-        class BlogPost(Document):
-            title = StringField()
-            subs = EmbeddedDocumentListField(SubDocument)
-
-        BlogPost.drop_collection()
-
-        post1 = BlogPost(
-            title='test1', subs=[
-                SubDocument(year=2009, slug='conflict'),
-                SubDocument(year=2009, slug='conflict')
-            ]
-        )
-        post1.save()
-
-        # confirm that the unique index is created
-        indexes = BlogPost._get_collection().index_information()
-        self.assertIn('subs.slug_1', indexes)
-        self.assertTrue(indexes['subs.slug_1']['unique'])
-
-        post2 = BlogPost(
-            title='test2', subs=[SubDocument(year=2014, slug='conflict')]
-        )
-
-        self.assertRaises(NotUniqueError, post2.save)
-
     def test_unique_with_embedded_document_and_embedded_unique(self):
         """Ensure that uniqueness constraints are applied to fields on
         embedded documents.  And work with unique_with as well.
@@ -827,18 +727,6 @@ class IndexesTest(unittest.TestCase):
         self.assertEqual(3600,
                          info['created_1']['expireAfterSeconds'])
 
-    def test_index_drop_dups_silently_ignored(self):
-        class Customer(Document):
-            cust_id = IntField(unique=True, required=True)
-            meta = {
-                'indexes': ['cust_id'],
-                'index_drop_dups': True,
-                'allow_inheritance': False,
-            }
-
-        Customer.drop_collection()
-        Customer.objects.first()
-
     def test_unique_and_indexes(self):
         """Ensure that 'unique' constraints aren't overridden by
         meta.indexes.
@@ -855,23 +743,18 @@ class IndexesTest(unittest.TestCase):
         cust.save()
 
         cust_dupe = Customer(cust_id=1)
-        with self.assertRaises(NotUniqueError):
+        try:
             cust_dupe.save()
+            raise AssertionError("We saved a dupe!")
+        except NotUniqueError:
+            pass
 
-        cust = Customer(cust_id=2)
-        cust.save()
-
-        # duplicate key on update
-        with self.assertRaises(NotUniqueError):
-            cust.cust_id = 1
-            cust.save()
-
-    def test_primary_save_duplicate_update_existing_object(self):
+    def test_unique_and_primary(self):
         """If you set a field as primary, then unexpected behaviour can occur.
         You won't create a duplicate but you will update an existing document.
         """
         class User(Document):
-            name = StringField(primary_key=True)
+            name = StringField(primary_key=True, unique=True)
             password = StringField()
 
         User.drop_collection()
@@ -918,9 +801,9 @@ class IndexesTest(unittest.TestCase):
             self.fail('Unbound local error at index + pk definition')
 
         info = BlogPost.objects._collection.index_information()
-        info = [value['key'] for key, value in iteritems(info)]
+        info = [value['key'] for key, value in info.iteritems()]
         index_item = [('_id', 1), ('comments.comment_id', 1)]
-        self.assertIn(index_item, info)
+        self.assertTrue(index_item in info)
 
     def test_compound_key_embedded(self):
 
@@ -966,9 +849,9 @@ class IndexesTest(unittest.TestCase):
             }
 
         info = MyDoc.objects._collection.index_information()
-        info = [value['key'] for key, value in iteritems(info)]
-        self.assertIn([('provider_ids.foo', 1)], info)
-        self.assertIn([('provider_ids.bar', 1)], info)
+        info = [value['key'] for key, value in info.iteritems()]
+        self.assertTrue([('provider_ids.foo', 1)] in info)
+        self.assertTrue([('provider_ids.bar', 1)] in info)
 
     def test_sparse_compound_indexes(self):
 
@@ -984,6 +867,7 @@ class IndexesTest(unittest.TestCase):
                          info['provider_ids.foo_1_provider_ids.bar_1']['key'])
         self.assertTrue(info['provider_ids.foo_1_provider_ids.bar_1']['sparse'])
 
+    @needs_mongodb_v26
     def test_text_indexes(self):
         class Book(Document):
             title = DictField()
@@ -992,9 +876,9 @@ class IndexesTest(unittest.TestCase):
             }
 
         indexes = Book.objects._collection.index_information()
-        self.assertIn("title_text", indexes)
+        self.assertTrue("title_text" in indexes)
         key = indexes["title_text"]["key"]
-        self.assertIn(('_fts', 'text'), key)
+        self.assertTrue(('_fts', 'text') in key)
 
     def test_hashed_indexes(self):
 
@@ -1005,8 +889,8 @@ class IndexesTest(unittest.TestCase):
             }
 
         indexes = Book.objects._collection.index_information()
-        self.assertIn("ref_id_hashed", indexes)
-        self.assertIn(('ref_id', 'hashed'), indexes["ref_id_hashed"]["key"])
+        self.assertTrue("ref_id_hashed" in indexes)
+        self.assertTrue(('ref_id', 'hashed') in indexes["ref_id_hashed"]["key"])
 
     def test_indexes_after_database_drop(self):
         """
@@ -1047,6 +931,7 @@ class IndexesTest(unittest.TestCase):
             # Drop the temporary database at the end
             connection.drop_database('tempdatabase')
 
+
     def test_index_dont_send_cls_option(self):
         """
         Ensure that 'cls' option is not sent through ensureIndex. We shouldn't
@@ -1128,7 +1013,7 @@ class IndexesTest(unittest.TestCase):
         TestDoc.ensure_indexes()
 
         index_info = TestDoc._get_collection().index_information()
-        self.assertIn('shard_1_1__cls_1_txt_1_1', index_info)
+        self.assertTrue('shard_1_1__cls_1_txt_1_1' in index_info)
 
 
 if __name__ == '__main__':

tests/document/inheritance.py

@@ -2,45 +2,30 @@
 import unittest
 import warnings
 
-from six import iteritems
+from datetime import datetime
 
-from mongoengine import (BooleanField, Document, EmbeddedDocument,
-                         EmbeddedDocumentField, GenericReferenceField,
-                         IntField, ReferenceField, StringField)
-from mongoengine.pymongo_support import list_collection_names
-from tests.utils import MongoDBTestCase
 from tests.fixtures import Base
 
+from mongoengine import Document, EmbeddedDocument, connect
+from mongoengine.connection import get_db
+from mongoengine.fields import (BooleanField, GenericReferenceField,
+                                IntField, StringField)
+
 __all__ = ('InheritanceTest', )
 
 
-class InheritanceTest(MongoDBTestCase):
+class InheritanceTest(unittest.TestCase):
+
+    def setUp(self):
+        connect(db='mongoenginetest')
+        self.db = get_db()
 
     def tearDown(self):
-        for collection in list_collection_names(self.db):
+        for collection in self.db.collection_names():
+            if 'system.' in collection:
+                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'))
-        self.assertEqual(test_doc._cls, 'DataDoc')
-        self.assertEqual(test_doc.embed._cls, 'EmbedData')
-        test_doc.save()
-        saved_doc = DataDoc.objects.with_id(test_doc.id)
-        self.assertEqual(test_doc._cls, saved_doc._cls)
-        self.assertEqual(test_doc.embed._cls, saved_doc.embed._cls)
-        test_doc.delete()
-
     def test_superclasses(self):
         """Ensure that the correct list of superclasses is assembled.
         """
@@ -273,10 +258,9 @@ class InheritanceTest(MongoDBTestCase):
             name = StringField()
 
         # can't inherit because Animal didn't explicitly allow inheritance
-        with self.assertRaises(ValueError) as cm:
+        with self.assertRaises(ValueError):
             class Dog(Animal):
                 pass
-        self.assertIn("Document Animal may not be subclassed", str(cm.exception))
 
         # Check that _cls etc aren't present on simple documents
         dog = Animal(name='dog').save()
@@ -284,7 +268,7 @@ class InheritanceTest(MongoDBTestCase):
 
         collection = self.db[Animal._get_collection_name()]
         obj = collection.find_one()
-        self.assertNotIn('_cls', obj)
+        self.assertFalse('_cls' in obj)
 
     def test_cant_turn_off_inheritance_on_subclass(self):
         """Ensure if inheritance is on in a subclass you cant turn it off.
@@ -293,10 +277,9 @@ class InheritanceTest(MongoDBTestCase):
             name = StringField()
             meta = {'allow_inheritance': True}
 
-        with self.assertRaises(ValueError) as cm:
+        with self.assertRaises(ValueError):
             class Mammal(Animal):
                 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):
         """Ensure that abstract documents can set inheritance rules and that
@@ -309,48 +292,13 @@ class InheritanceTest(MongoDBTestCase):
         class Animal(FinalDocument):
             name = StringField()
 
-        with self.assertRaises(ValueError) as cm:
+        with self.assertRaises(ValueError):
             class Mammal(Animal):
                 pass
 
         # Check that _cls isn't present in simple documents
         doc = Animal(name='dog')
-        self.assertNotIn('_cls', doc.to_mongo())
-
-    def test_using_abstract_class_in_reference_field(self):
-        # Ensures no regression of #1920
-        class AbstractHuman(Document):
-            meta = {'abstract': True}
-
-        class Dad(AbstractHuman):
-            name = StringField()
-
-        class Home(Document):
-            dad = ReferenceField(AbstractHuman)  # Referencing the abstract class
-            address = StringField()
-
-        dad = Dad(name='5').save()
-        Home(dad=dad, address='street').save()
-
-        home = Home.objects.first()
-        home.address = 'garbage'
-        home.save()     # Was failing with ValidationError
-
-    def test_abstract_class_referencing_self(self):
-        # Ensures no regression of #1920
-        class Human(Document):
-            meta = {'abstract': True}
-            creator = ReferenceField('self', dbref=True)
-
-        class User(Human):
-            name = StringField()
-
-        user = User(name='John').save()
-        user2 = User(name='Foo', creator=user).save()
-
-        user2 = User.objects.with_id(user2.id)
-        user2.name = 'Bar'
-        user2.save()    # Was failing with ValidationError
+        self.assertFalse('_cls' in doc.to_mongo())
 
     def test_abstract_handle_ids_in_metaclass_properly(self):
 
@@ -410,11 +358,11 @@ class InheritanceTest(MongoDBTestCase):
             meta = {'abstract': True,
                     'allow_inheritance': False}
 
-        city = City(continent='asia')
-        self.assertEqual(None, city.pk)
+        bkk = City(continent='asia')
+        self.assertEqual(None, bkk.pk)
         # TODO: expected error? Shouldn't we create a new error type?
         with self.assertRaises(KeyError):
-            setattr(city, 'pk', 1)
+            setattr(bkk, 'pk', 1)
 
     def test_allow_inheritance_embedded_document(self):
         """Ensure embedded documents respect inheritance."""
@@ -426,14 +374,14 @@ class InheritanceTest(MongoDBTestCase):
                 pass
 
         doc = Comment(content='test')
-        self.assertNotIn('_cls', doc.to_mongo())
+        self.assertFalse('_cls' in doc.to_mongo())
 
         class Comment(EmbeddedDocument):
             content = StringField()
             meta = {'allow_inheritance': True}
 
         doc = Comment(content='test')
-        self.assertIn('_cls', doc.to_mongo())
+        self.assertTrue('_cls' in doc.to_mongo())
 
     def test_document_inheritance(self):
         """Ensure mutliple inheritance of abstract documents
@@ -482,12 +430,12 @@ class InheritanceTest(MongoDBTestCase):
             meta = {'abstract': True}
         class Human(Mammal): pass
 
-        for k, v in iteritems(defaults):
+        for k, v in defaults.iteritems():
             for cls in [Animal, Fish, Guppy]:
                 self.assertEqual(cls._meta[k], v)
 
-        self.assertNotIn('collection', Animal._meta)
-        self.assertNotIn('collection', Mammal._meta)
+        self.assertFalse('collection' in Animal._meta)
+        self.assertFalse('collection' in Mammal._meta)
 
         self.assertEqual(Animal._get_collection_name(), None)
         self.assertEqual(Mammal._get_collection_name(), None)

tests/document/json_serialisation.py

@@ -32,12 +32,12 @@ class TestJson(unittest.TestCase):
             string = StringField(db_field='s')
             embedded = EmbeddedDocumentField(Embedded, db_field='e')
 
-        doc = Doc(string="Hello", embedded=Embedded(string="Inner Hello"))
-        doc_json = doc.to_json(sort_keys=True, use_db_field=False, separators=(',', ':'))
+        doc = Doc( string="Hello", embedded=Embedded(string="Inner Hello"))
+        doc_json = doc.to_json(sort_keys=True, use_db_field=False,separators=(',', ':'))
 
         expected_json = """{"embedded":{"string":"Inner Hello"},"string":"Hello"}"""
 
-        self.assertEqual(doc_json, expected_json)
+        self.assertEqual( doc_json, expected_json)
 
     def test_json_simple(self):
 
@@ -61,6 +61,10 @@ class TestJson(unittest.TestCase):
         self.assertEqual(doc, Doc.from_json(doc.to_json()))
 
     def test_json_complex(self):
+
+        if pymongo.version_tuple[0] <= 2 and pymongo.version_tuple[1] <= 3:
+            raise SkipTest("Need pymongo 2.4 as has a fix for DBRefs")
+
         class EmbeddedDoc(EmbeddedDocument):
             pass
 

tests/document/validation.py

@@ -20,16 +20,16 @@ class ValidatorErrorTest(unittest.TestCase):
 
         # 1st level error schema
         error.errors = {'1st': ValidationError('bad 1st'), }
-        self.assertIn('1st', error.to_dict())
+        self.assertTrue('1st' in error.to_dict())
         self.assertEqual(error.to_dict()['1st'], 'bad 1st')
 
         # 2nd level error schema
         error.errors = {'1st': ValidationError('bad 1st', errors={
             '2nd': ValidationError('bad 2nd'),
         })}
-        self.assertIn('1st', error.to_dict())
-        self.assertIsInstance(error.to_dict()['1st'], dict)
-        self.assertIn('2nd', error.to_dict()['1st'])
+        self.assertTrue('1st' in error.to_dict())
+        self.assertTrue(isinstance(error.to_dict()['1st'], dict))
+        self.assertTrue('2nd' in error.to_dict()['1st'])
         self.assertEqual(error.to_dict()['1st']['2nd'], 'bad 2nd')
 
         # moar levels
@@ -40,10 +40,10 @@ class ValidatorErrorTest(unittest.TestCase):
                 }),
             }),
         })}
-        self.assertIn('1st', error.to_dict())
-        self.assertIn('2nd', error.to_dict()['1st'])
-        self.assertIn('3rd', error.to_dict()['1st']['2nd'])
-        self.assertIn('4th', error.to_dict()['1st']['2nd']['3rd'])
+        self.assertTrue('1st' in error.to_dict())
+        self.assertTrue('2nd' in error.to_dict()['1st'])
+        self.assertTrue('3rd' in error.to_dict()['1st']['2nd'])
+        self.assertTrue('4th' in error.to_dict()['1st']['2nd']['3rd'])
         self.assertEqual(error.to_dict()['1st']['2nd']['3rd']['4th'],
                          'Inception')
 
@@ -58,7 +58,7 @@ class ValidatorErrorTest(unittest.TestCase):
         try:
             User().validate()
         except ValidationError as e:
-            self.assertIn("User:None", e.message)
+            self.assertTrue("User:None" in e.message)
             self.assertEqual(e.to_dict(), {
                 'username': 'Field is required',
                 'name': 'Field is required'})
@@ -68,7 +68,7 @@ class ValidatorErrorTest(unittest.TestCase):
         try:
             user.save()
         except ValidationError as e:
-            self.assertIn("User:RossC0", e.message)
+            self.assertTrue("User:RossC0" in e.message)
             self.assertEqual(e.to_dict(), {
                 'name': 'Field is required'})
 
@@ -116,7 +116,7 @@ class ValidatorErrorTest(unittest.TestCase):
         try:
             Doc(id="bad").validate()
         except ValidationError as e:
-            self.assertIn("SubDoc:None", e.message)
+            self.assertTrue("SubDoc:None" in e.message)
             self.assertEqual(e.to_dict(), {
                 "e": {'val': 'OK could not be converted to int'}})
 
@@ -127,14 +127,14 @@ class ValidatorErrorTest(unittest.TestCase):
         doc = Doc.objects.first()
         keys = doc._data.keys()
         self.assertEqual(2, len(keys))
-        self.assertIn('e', keys)
-        self.assertIn('id', keys)
+        self.assertTrue('e' in keys)
+        self.assertTrue('id' in keys)
 
         doc.e.val = "OK"
         try:
             doc.save()
         except ValidationError as e:
-            self.assertIn("Doc:test", e.message)
+            self.assertTrue("Doc:test" in e.message)
             self.assertEqual(e.to_dict(), {
                 "e": {'val': 'OK could not be converted to int'}})
 

tests/fields/__init__.py

@@ -1,3 +1,3 @@
-from .fields import *
-from .file_tests import *
-from .geo import *
+from fields import *
+from file_tests import *
+from geo import *

tests/fields/file_tests.py

@@ -24,16 +24,6 @@ TEST_IMAGE_PATH = os.path.join(os.path.dirname(__file__), 'mongoengine.png')
 TEST_IMAGE2_PATH = os.path.join(os.path.dirname(__file__), 'mongodb_leaf.png')
 
 
-def get_file(path):
-    """Use a BytesIO instead of a file to allow
-    to have a one-liner and avoid that the file remains opened"""
-    bytes_io = StringIO()
-    with open(path, 'rb') as f:
-        bytes_io.write(f.read())
-    bytes_io.seek(0)
-    return bytes_io
-
-
 class FileTest(MongoDBTestCase):
 
     def tearDown(self):
@@ -63,8 +53,8 @@ class FileTest(MongoDBTestCase):
         putfile.save()
 
         result = PutFile.objects.first()
-        self.assertEqual(putfile, result)
-        self.assertEqual("%s" % result.the_file, "<GridFSProxy: hello (%s)>" % result.the_file.grid_id)
+        self.assertTrue(putfile == result)
+        self.assertEqual("%s" % result.the_file, "<GridFSProxy: hello>")
         self.assertEqual(result.the_file.read(), text)
         self.assertEqual(result.the_file.content_type, content_type)
         result.the_file.delete()  # Remove file from GridFS
@@ -81,7 +71,7 @@ class FileTest(MongoDBTestCase):
         putfile.save()
 
         result = PutFile.objects.first()
-        self.assertEqual(putfile, result)
+        self.assertTrue(putfile == result)
         self.assertEqual(result.the_file.read(), text)
         self.assertEqual(result.the_file.content_type, content_type)
         result.the_file.delete()
@@ -106,7 +96,7 @@ class FileTest(MongoDBTestCase):
         streamfile.save()
 
         result = StreamFile.objects.first()
-        self.assertEqual(streamfile, result)
+        self.assertTrue(streamfile == result)
         self.assertEqual(result.the_file.read(), text + more_text)
         self.assertEqual(result.the_file.content_type, content_type)
         result.the_file.seek(0)
@@ -142,7 +132,7 @@ class FileTest(MongoDBTestCase):
         streamfile.save()
 
         result = StreamFile.objects.first()
-        self.assertEqual(streamfile, result)
+        self.assertTrue(streamfile == result)
         self.assertEqual(result.the_file.read(), text + more_text)
         # self.assertEqual(result.the_file.content_type, content_type)
         result.the_file.seek(0)
@@ -171,7 +161,7 @@ class FileTest(MongoDBTestCase):
         setfile.save()
 
         result = SetFile.objects.first()
-        self.assertEqual(setfile, result)
+        self.assertTrue(setfile == result)
         self.assertEqual(result.the_file.read(), text)
 
         # Try replacing file with new one
@@ -179,7 +169,7 @@ class FileTest(MongoDBTestCase):
         result.save()
 
         result = SetFile.objects.first()
-        self.assertEqual(setfile, result)
+        self.assertTrue(setfile == result)
         self.assertEqual(result.the_file.read(), more_text)
         result.the_file.delete()
 
@@ -241,8 +231,8 @@ class FileTest(MongoDBTestCase):
         test_file_dupe = TestFile()
         data = test_file_dupe.the_file.read()  # Should be None
 
-        self.assertNotEqual(test_file.name, test_file_dupe.name)
-        self.assertNotEqual(test_file.the_file.read(), data)
+        self.assertTrue(test_file.name != test_file_dupe.name)
+        self.assertTrue(test_file.the_file.read() != data)
 
         TestFile.drop_collection()
 
@@ -257,8 +247,8 @@ class FileTest(MongoDBTestCase):
         Animal.drop_collection()
         marmot = Animal(genus='Marmota', family='Sciuridae')
 
-        marmot_photo_content = get_file(TEST_IMAGE_PATH)  # Retrieve a photo from disk
-        marmot.photo.put(marmot_photo_content, content_type='image/jpeg', foo='bar')
+        marmot_photo = open(TEST_IMAGE_PATH, 'rb')  # Retrieve a photo from disk
+        marmot.photo.put(marmot_photo, content_type='image/jpeg', foo='bar')
         marmot.photo.close()
         marmot.save()
 
@@ -271,11 +261,11 @@ class FileTest(MongoDBTestCase):
             the_file = FileField()
         TestFile.drop_collection()
 
-        test_file = TestFile(the_file=get_file(TEST_IMAGE_PATH)).save()
+        test_file = TestFile(the_file=open(TEST_IMAGE_PATH, 'rb')).save()
         self.assertEqual(test_file.the_file.get().length, 8313)
 
         test_file = TestFile.objects.first()
-        test_file.the_file = get_file(TEST_IMAGE2_PATH)
+        test_file.the_file = open(TEST_IMAGE2_PATH, 'rb')
         test_file.save()
         self.assertEqual(test_file.the_file.get().length, 4971)
 
@@ -301,7 +291,7 @@ class FileTest(MongoDBTestCase):
             the_file = FileField()
 
         test_file = TestFile()
-        self.assertNotIn(test_file.the_file, [{"test": 1}])
+        self.assertFalse(test_file.the_file in [{"test": 1}])
 
     def test_file_disk_space(self):
         """ Test disk space usage when we delete/replace a file """
@@ -320,16 +310,16 @@ class FileTest(MongoDBTestCase):
 
         files = db.fs.files.find()
         chunks = db.fs.chunks.find()
-        self.assertEqual(len(list(files)), 1)
-        self.assertEqual(len(list(chunks)), 1)
+        self.assertEquals(len(list(files)), 1)
+        self.assertEquals(len(list(chunks)), 1)
 
         # Deleting the docoument should delete the files
         testfile.delete()
 
         files = db.fs.files.find()
         chunks = db.fs.chunks.find()
-        self.assertEqual(len(list(files)), 0)
-        self.assertEqual(len(list(chunks)), 0)
+        self.assertEquals(len(list(files)), 0)
+        self.assertEquals(len(list(chunks)), 0)
 
         # Test case where we don't store a file in the first place
         testfile = TestFile()
@@ -337,15 +327,15 @@ class FileTest(MongoDBTestCase):
 
         files = db.fs.files.find()
         chunks = db.fs.chunks.find()
-        self.assertEqual(len(list(files)), 0)
-        self.assertEqual(len(list(chunks)), 0)
+        self.assertEquals(len(list(files)), 0)
+        self.assertEquals(len(list(chunks)), 0)
 
         testfile.delete()
 
         files = db.fs.files.find()
         chunks = db.fs.chunks.find()
-        self.assertEqual(len(list(files)), 0)
-        self.assertEqual(len(list(chunks)), 0)
+        self.assertEquals(len(list(files)), 0)
+        self.assertEquals(len(list(chunks)), 0)
 
         # Test case where we overwrite the file
         testfile = TestFile()
@@ -358,15 +348,15 @@ class FileTest(MongoDBTestCase):
 
         files = db.fs.files.find()
         chunks = db.fs.chunks.find()
-        self.assertEqual(len(list(files)), 1)
-        self.assertEqual(len(list(chunks)), 1)
+        self.assertEquals(len(list(files)), 1)
+        self.assertEquals(len(list(chunks)), 1)
 
         testfile.delete()
 
         files = db.fs.files.find()
         chunks = db.fs.chunks.find()
-        self.assertEqual(len(list(files)), 0)
-        self.assertEqual(len(list(chunks)), 0)
+        self.assertEquals(len(list(files)), 0)
+        self.assertEquals(len(list(chunks)), 0)
 
     def test_image_field(self):
         if not HAS_PIL:
@@ -389,7 +379,7 @@ class FileTest(MongoDBTestCase):
                 self.assertEqual("%s" % e, "Invalid image: cannot identify image file %s" % f)
 
         t = TestImage()
-        t.image.put(get_file(TEST_IMAGE_PATH))
+        t.image.put(open(TEST_IMAGE_PATH, 'rb'))
         t.save()
 
         t = TestImage.objects.first()
@@ -410,11 +400,11 @@ class FileTest(MongoDBTestCase):
             the_file = ImageField()
         TestFile.drop_collection()
 
-        test_file = TestFile(the_file=get_file(TEST_IMAGE_PATH)).save()
+        test_file = TestFile(the_file=open(TEST_IMAGE_PATH, 'rb')).save()
         self.assertEqual(test_file.the_file.size, (371, 76))
 
         test_file = TestFile.objects.first()
-        test_file.the_file = get_file(TEST_IMAGE2_PATH)
+        test_file.the_file = open(TEST_IMAGE2_PATH, 'rb')
         test_file.save()
         self.assertEqual(test_file.the_file.size, (45, 101))
 
@@ -428,7 +418,7 @@ class FileTest(MongoDBTestCase):
         TestImage.drop_collection()
 
         t = TestImage()
-        t.image.put(get_file(TEST_IMAGE_PATH))
+        t.image.put(open(TEST_IMAGE_PATH, 'rb'))
         t.save()
 
         t = TestImage.objects.first()
@@ -451,7 +441,7 @@ class FileTest(MongoDBTestCase):
         TestImage.drop_collection()
 
         t = TestImage()
-        t.image.put(get_file(TEST_IMAGE_PATH))
+        t.image.put(open(TEST_IMAGE_PATH, 'rb'))
         t.save()
 
         t = TestImage.objects.first()
@@ -474,7 +464,7 @@ class FileTest(MongoDBTestCase):
         TestImage.drop_collection()
 
         t = TestImage()
-        t.image.put(get_file(TEST_IMAGE_PATH))
+        t.image.put(open(TEST_IMAGE_PATH, 'rb'))
         t.save()
 
         t = TestImage.objects.first()
@@ -552,8 +542,8 @@ class FileTest(MongoDBTestCase):
         TestImage.drop_collection()
 
         t = TestImage()
-        t.image1.put(get_file(TEST_IMAGE_PATH))
-        t.image2.put(get_file(TEST_IMAGE2_PATH))
+        t.image1.put(open(TEST_IMAGE_PATH, 'rb'))
+        t.image2.put(open(TEST_IMAGE2_PATH, 'rb'))
         t.save()
 
         test = TestImage.objects.first()
@@ -573,10 +563,12 @@ class FileTest(MongoDBTestCase):
         Animal.drop_collection()
         marmot = Animal(genus='Marmota', family='Sciuridae')
 
-        with open(TEST_IMAGE_PATH, 'rb') as marmot_photo:   # Retrieve a photo from disk
-            photos_field = marmot._fields['photos'].field
-            new_proxy = photos_field.get_proxy_obj('photos', marmot)
-            new_proxy.put(marmot_photo, content_type='image/jpeg', foo='bar')
+        marmot_photo = open(TEST_IMAGE_PATH, 'rb')  # Retrieve a photo from disk
+
+        photos_field = marmot._fields['photos'].field
+        new_proxy = photos_field.get_proxy_obj('photos', marmot)
+        new_proxy.put(marmot_photo, content_type='image/jpeg', foo='bar')
+        marmot_photo.close()
 
         marmot.photos.append(new_proxy)
         marmot.save()
@@ -586,6 +578,5 @@ class FileTest(MongoDBTestCase):
         self.assertEqual(marmot.photos[0].foo, 'bar')
         self.assertEqual(marmot.photos[0].get().length, 8313)
 
-
 if __name__ == '__main__':
     unittest.main()

tests/fields/geo.py

@@ -40,11 +40,6 @@ class GeoFieldTest(unittest.TestCase):
             expected = "Both values (%s) in point must be float or int" % repr(coord)
             self._test_for_expected_error(Location, coord, expected)
 
-        invalid_coords = [21, 4, 'a']
-        for coord in invalid_coords:
-            expected = "GeoPointField can only accept tuples or lists of (x, y)"
-            self._test_for_expected_error(Location, coord, expected)
-
     def test_point_validation(self):
         class Location(Document):
             loc = PointField()
@@ -303,9 +298,9 @@ class GeoFieldTest(unittest.TestCase):
             polygon = PolygonField()
 
         geo_indicies = Event._geo_indices()
-        self.assertIn({'fields': [('line', '2dsphere')]}, geo_indicies)
-        self.assertIn({'fields': [('polygon', '2dsphere')]}, geo_indicies)
-        self.assertIn({'fields': [('point', '2dsphere')]}, geo_indicies)
+        self.assertTrue({'fields': [('line', '2dsphere')]} in geo_indicies)
+        self.assertTrue({'fields': [('polygon', '2dsphere')]} in geo_indicies)
+        self.assertTrue({'fields': [('point', '2dsphere')]} in geo_indicies)
 
     def test_indexes_2dsphere_embedded(self):
         """Ensure that indexes are created automatically for GeoPointFields.
@@ -321,9 +316,9 @@ class GeoFieldTest(unittest.TestCase):
             venue = EmbeddedDocumentField(Venue)
 
         geo_indicies = Event._geo_indices()
-        self.assertIn({'fields': [('venue.line', '2dsphere')]}, geo_indicies)
-        self.assertIn({'fields': [('venue.polygon', '2dsphere')]}, geo_indicies)
-        self.assertIn({'fields': [('venue.point', '2dsphere')]}, geo_indicies)
+        self.assertTrue({'fields': [('venue.line', '2dsphere')]} in geo_indicies)
+        self.assertTrue({'fields': [('venue.polygon', '2dsphere')]} in geo_indicies)
+        self.assertTrue({'fields': [('venue.point', '2dsphere')]} in geo_indicies)
 
     def test_geo_indexes_recursion(self):
 
@@ -340,9 +335,9 @@ class GeoFieldTest(unittest.TestCase):
 
         Parent(name='Berlin').save()
         info = Parent._get_collection().index_information()
-        self.assertNotIn('location_2d', info)
+        self.assertFalse('location_2d' in info)
         info = Location._get_collection().index_information()
-        self.assertIn('location_2d', info)
+        self.assertTrue('location_2d' in info)
 
         self.assertEqual(len(Parent._geo_indices()), 0)
         self.assertEqual(len(Location._geo_indices()), 1)

tests/fields/test_binary_field.py

@@ -1,143 +0,0 @@
-# -*- coding: utf-8 -*-
-import uuid
-
-from nose.plugins.skip import SkipTest
-import six
-
-from bson import Binary
-
-from mongoengine import *
-from tests.utils import MongoDBTestCase
-
-BIN_VALUE = six.b('\xa9\xf3\x8d(\xd7\x03\x84\xb4k[\x0f\xe3\xa2\x19\x85p[J\xa3\xd2>\xde\xe6\x87\xb1\x7f\xc6\xe6\xd9r\x18\xf5')
-
-
-class TestBinaryField(MongoDBTestCase):
-    def test_binary_fields(self):
-        """Ensure that binary fields can be stored and retrieved.
-        """
-        class Attachment(Document):
-            content_type = StringField()
-            blob = BinaryField()
-
-        BLOB = six.b('\xe6\x00\xc4\xff\x07')
-        MIME_TYPE = 'application/octet-stream'
-
-        Attachment.drop_collection()
-
-        attachment = Attachment(content_type=MIME_TYPE, blob=BLOB)
-        attachment.save()
-
-        attachment_1 = Attachment.objects().first()
-        self.assertEqual(MIME_TYPE, attachment_1.content_type)
-        self.assertEqual(BLOB, six.binary_type(attachment_1.blob))
-
-    def test_validation_succeeds(self):
-        """Ensure that valid values can be assigned to binary fields.
-        """
-        class AttachmentRequired(Document):
-            blob = BinaryField(required=True)
-
-        class AttachmentSizeLimit(Document):
-            blob = BinaryField(max_bytes=4)
-
-        attachment_required = AttachmentRequired()
-        self.assertRaises(ValidationError, attachment_required.validate)
-        attachment_required.blob = Binary(six.b('\xe6\x00\xc4\xff\x07'))
-        attachment_required.validate()
-
-        _5_BYTES = six.b('\xe6\x00\xc4\xff\x07')
-        _4_BYTES = six.b('\xe6\x00\xc4\xff')
-        self.assertRaises(ValidationError, AttachmentSizeLimit(blob=_5_BYTES).validate)
-        AttachmentSizeLimit(blob=_4_BYTES).validate()
-
-    def test_validation_fails(self):
-        """Ensure that invalid values cannot be assigned to binary fields."""
-
-        class Attachment(Document):
-            blob = BinaryField()
-
-        for invalid_data in (2, u'Im_a_unicode', ['some_str']):
-            self.assertRaises(ValidationError, Attachment(blob=invalid_data).validate)
-
-    def test__primary(self):
-        class Attachment(Document):
-            id = BinaryField(primary_key=True)
-
-        Attachment.drop_collection()
-        binary_id = uuid.uuid4().bytes
-        att = Attachment(id=binary_id).save()
-        self.assertEqual(1, Attachment.objects.count())
-        self.assertEqual(1, Attachment.objects.filter(id=att.id).count())
-        att.delete()
-        self.assertEqual(0, Attachment.objects.count())
-
-    def test_primary_filter_by_binary_pk_as_str(self):
-        raise SkipTest("Querying by id as string is not currently supported")
-
-        class Attachment(Document):
-            id = BinaryField(primary_key=True)
-
-        Attachment.drop_collection()
-        binary_id = uuid.uuid4().bytes
-        att = Attachment(id=binary_id).save()
-        self.assertEqual(1, Attachment.objects.filter(id=binary_id).count())
-        att.delete()
-        self.assertEqual(0, Attachment.objects.count())
-
-    def test_match_querying_with_bytes(self):
-        class MyDocument(Document):
-            bin_field = BinaryField()
-
-        MyDocument.drop_collection()
-
-        doc = MyDocument(bin_field=BIN_VALUE).save()
-        matched_doc = MyDocument.objects(bin_field=BIN_VALUE).first()
-        self.assertEqual(matched_doc.id, doc.id)
-
-    def test_match_querying_with_binary(self):
-        class MyDocument(Document):
-            bin_field = BinaryField()
-
-        MyDocument.drop_collection()
-
-        doc = MyDocument(bin_field=BIN_VALUE).save()
-
-        matched_doc = MyDocument.objects(bin_field=Binary(BIN_VALUE)).first()
-        self.assertEqual(matched_doc.id, doc.id)
-
-    def test_modify_operation__set(self):
-        """Ensures no regression of bug #1127"""
-        class MyDocument(Document):
-            some_field = StringField()
-            bin_field = BinaryField()
-
-        MyDocument.drop_collection()
-
-        doc = MyDocument.objects(some_field='test').modify(
-            upsert=True, new=True,
-            set__bin_field=BIN_VALUE
-        )
-        self.assertEqual(doc.some_field, 'test')
-        if six.PY3:
-            self.assertEqual(doc.bin_field, BIN_VALUE)
-        else:
-            self.assertEqual(doc.bin_field, Binary(BIN_VALUE))
-
-    def test_update_one(self):
-        """Ensures no regression of bug #1127"""
-        class MyDocument(Document):
-            bin_field = BinaryField()
-
-        MyDocument.drop_collection()
-
-        bin_data = six.b('\xe6\x00\xc4\xff\x07')
-        doc = MyDocument(bin_field=bin_data).save()
-
-        n_updated = MyDocument.objects(bin_field=bin_data).update_one(bin_field=BIN_VALUE)
-        self.assertEqual(n_updated, 1)
-        fetched = MyDocument.objects.with_id(doc.id)
-        if six.PY3:
-            self.assertEqual(fetched.bin_field, BIN_VALUE)
-        else:
-            self.assertEqual(fetched.bin_field, Binary(BIN_VALUE))

tests/fields/test_boolean_field.py

@@ -1,49 +0,0 @@
-# -*- coding: utf-8 -*-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase, get_as_pymongo
-
-
-class TestBooleanField(MongoDBTestCase):
-    def test_storage(self):
-        class Person(Document):
-            admin = BooleanField()
-
-        person = Person(admin=True)
-        person.save()
-        self.assertEqual(
-            get_as_pymongo(person),
-            {'_id': person.id,
-             'admin': True})
-
-    def test_validation(self):
-        """Ensure that invalid values cannot be assigned to boolean
-        fields.
-        """
-        class Person(Document):
-            admin = BooleanField()
-
-        person = Person()
-        person.admin = True
-        person.validate()
-
-        person.admin = 2
-        self.assertRaises(ValidationError, person.validate)
-        person.admin = 'Yes'
-        self.assertRaises(ValidationError, person.validate)
-        person.admin = 'False'
-        self.assertRaises(ValidationError, person.validate)
-
-    def test_weirdness_constructor(self):
-        """When attribute is set in contructor, it gets cast into a bool
-        which causes some weird behavior. We dont necessarily want to maintain this behavior
-        but its a known issue
-        """
-        class Person(Document):
-            admin = BooleanField()
-
-        new_person = Person(admin='False')
-        self.assertTrue(new_person.admin)
-
-        new_person = Person(admin='0')
-        self.assertTrue(new_person.admin)

tests/fields/test_cached_reference_field.py

@@ -1,446 +0,0 @@
-# -*- coding: utf-8 -*-
-from decimal import Decimal
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestCachedReferenceField(MongoDBTestCase):
-
-    def test_get_and_save(self):
-        """
-        Tests #1047: CachedReferenceField creates DBRefs on to_python,
-        but can't save them on to_mongo.
-        """
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocorrence(Document):
-            person = StringField()
-            animal = CachedReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocorrence.drop_collection()
-
-        Ocorrence(person="testte",
-                  animal=Animal(name="Leopard", tag="heavy").save()).save()
-        p = Ocorrence.objects.get()
-        p.person = 'new_testte'
-        p.save()
-
-    def test_general_things(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocorrence(Document):
-            person = StringField()
-            animal = CachedReferenceField(
-                Animal, fields=['tag'])
-
-        Animal.drop_collection()
-        Ocorrence.drop_collection()
-
-        a = Animal(name="Leopard", tag="heavy")
-        a.save()
-
-        self.assertEqual(Animal._cached_reference_fields, [Ocorrence.animal])
-        o = Ocorrence(person="teste", animal=a)
-        o.save()
-
-        p = Ocorrence(person="Wilson")
-        p.save()
-
-        self.assertEqual(Ocorrence.objects(animal=None).count(), 1)
-
-        self.assertEqual(
-            a.to_mongo(fields=['tag']), {'tag': 'heavy', "_id": a.pk})
-
-        self.assertEqual(o.to_mongo()['animal']['tag'], 'heavy')
-
-        # counts
-        Ocorrence(person="teste 2").save()
-        Ocorrence(person="teste 3").save()
-
-        count = Ocorrence.objects(animal__tag='heavy').count()
-        self.assertEqual(count, 1)
-
-        ocorrence = Ocorrence.objects(animal__tag='heavy').first()
-        self.assertEqual(ocorrence.person, "teste")
-        self.assertIsInstance(ocorrence.animal, Animal)
-
-    def test_with_decimal(self):
-        class PersonAuto(Document):
-            name = StringField()
-            salary = DecimalField()
-
-        class SocialTest(Document):
-            group = StringField()
-            person = CachedReferenceField(
-                PersonAuto,
-                fields=('salary',))
-
-        PersonAuto.drop_collection()
-        SocialTest.drop_collection()
-
-        p = PersonAuto(name="Alberto", salary=Decimal('7000.00'))
-        p.save()
-
-        s = SocialTest(group="dev", person=p)
-        s.save()
-
-        self.assertEqual(
-            SocialTest.objects._collection.find_one({'person.salary': 7000.00}), {
-                '_id': s.pk,
-                'group': s.group,
-                'person': {
-                    '_id': p.pk,
-                    'salary': 7000.00
-                }
-            })
-
-    def test_cached_reference_field_reference(self):
-        class Group(Document):
-            name = StringField()
-
-        class Person(Document):
-            name = StringField()
-            group = ReferenceField(Group)
-
-        class SocialData(Document):
-            obs = StringField()
-            tags = ListField(
-                StringField())
-            person = CachedReferenceField(
-                Person,
-                fields=('group',))
-
-        Group.drop_collection()
-        Person.drop_collection()
-        SocialData.drop_collection()
-
-        g1 = Group(name='dev')
-        g1.save()
-
-        g2 = Group(name="designers")
-        g2.save()
-
-        p1 = Person(name="Alberto", group=g1)
-        p1.save()
-
-        p2 = Person(name="Andre", group=g1)
-        p2.save()
-
-        p3 = Person(name="Afro design", group=g2)
-        p3.save()
-
-        s1 = SocialData(obs="testing 123", person=p1, tags=['tag1', 'tag2'])
-        s1.save()
-
-        s2 = SocialData(obs="testing 321", person=p3, tags=['tag3', 'tag4'])
-        s2.save()
-
-        self.assertEqual(SocialData.objects._collection.find_one(
-            {'tags': 'tag2'}), {
-                '_id': s1.pk,
-                'obs': 'testing 123',
-                'tags': ['tag1', 'tag2'],
-                'person': {
-                    '_id': p1.pk,
-                    'group': g1.pk
-                }
-        })
-
-        self.assertEqual(SocialData.objects(person__group=g2).count(), 1)
-        self.assertEqual(SocialData.objects(person__group=g2).first(), s2)
-
-    def test_cached_reference_field_push_with_fields(self):
-        class Product(Document):
-            name = StringField()
-
-        Product.drop_collection()
-
-        class Basket(Document):
-            products = ListField(CachedReferenceField(Product, fields=['name']))
-
-        Basket.drop_collection()
-        product1 = Product(name='abc').save()
-        product2 = Product(name='def').save()
-        basket = Basket(products=[product1]).save()
-        self.assertEqual(
-            Basket.objects._collection.find_one(),
-            {
-                '_id': basket.pk,
-                'products': [
-                    {
-                        '_id': product1.pk,
-                        'name': product1.name
-                    }
-                ]
-            }
-        )
-        # push to list
-        basket.update(push__products=product2)
-        basket.reload()
-        self.assertEqual(
-            Basket.objects._collection.find_one(),
-            {
-                '_id': basket.pk,
-                'products': [
-                    {
-                        '_id': product1.pk,
-                        'name': product1.name
-                    },
-                    {
-                        '_id': product2.pk,
-                        'name': product2.name
-                    }
-                ]
-            }
-        )
-
-    def test_cached_reference_field_update_all(self):
-        class Person(Document):
-            TYPES = (
-                ('pf', "PF"),
-                ('pj', "PJ")
-            )
-            name = StringField()
-            tp = StringField(choices=TYPES)
-            father = CachedReferenceField('self', fields=('tp',))
-
-        Person.drop_collection()
-
-        a1 = Person(name="Wilson Father", tp="pj")
-        a1.save()
-
-        a2 = Person(name='Wilson Junior', tp='pf', father=a1)
-        a2.save()
-
-        a2 = Person.objects.with_id(a2.id)
-        self.assertEqual(a2.father.tp, a1.tp)
-
-        self.assertEqual(dict(a2.to_mongo()), {
-            "_id": a2.pk,
-            "name": u"Wilson Junior",
-            "tp": u"pf",
-            "father": {
-                "_id": a1.pk,
-                "tp": u"pj"
-            }
-        })
-
-        self.assertEqual(Person.objects(father=a1)._query, {
-            'father._id': a1.pk
-        })
-        self.assertEqual(Person.objects(father=a1).count(), 1)
-
-        Person.objects.update(set__tp="pf")
-        Person.father.sync_all()
-
-        a2.reload()
-        self.assertEqual(dict(a2.to_mongo()), {
-            "_id": a2.pk,
-            "name": u"Wilson Junior",
-            "tp": u"pf",
-            "father": {
-                "_id": a1.pk,
-                "tp": u"pf"
-            }
-        })
-
-    def test_cached_reference_fields_on_embedded_documents(self):
-        with self.assertRaises(InvalidDocumentError):
-            class Test(Document):
-                name = StringField()
-
-            type('WrongEmbeddedDocument', (
-                EmbeddedDocument,), {
-                    'test': CachedReferenceField(Test)
-            })
-
-    def test_cached_reference_auto_sync(self):
-        class Person(Document):
-            TYPES = (
-                ('pf', "PF"),
-                ('pj', "PJ")
-            )
-            name = StringField()
-            tp = StringField(
-                choices=TYPES
-            )
-
-            father = CachedReferenceField('self', fields=('tp',))
-
-        Person.drop_collection()
-
-        a1 = Person(name="Wilson Father", tp="pj")
-        a1.save()
-
-        a2 = Person(name='Wilson Junior', tp='pf', father=a1)
-        a2.save()
-
-        a1.tp = 'pf'
-        a1.save()
-
-        a2.reload()
-        self.assertEqual(dict(a2.to_mongo()), {
-            '_id': a2.pk,
-            'name': 'Wilson Junior',
-            'tp': 'pf',
-            'father': {
-                '_id': a1.pk,
-                'tp': 'pf'
-            }
-        })
-
-    def test_cached_reference_auto_sync_disabled(self):
-        class Persone(Document):
-            TYPES = (
-                ('pf', "PF"),
-                ('pj', "PJ")
-            )
-            name = StringField()
-            tp = StringField(
-                choices=TYPES
-            )
-
-            father = CachedReferenceField(
-                'self', fields=('tp',), auto_sync=False)
-
-        Persone.drop_collection()
-
-        a1 = Persone(name="Wilson Father", tp="pj")
-        a1.save()
-
-        a2 = Persone(name='Wilson Junior', tp='pf', father=a1)
-        a2.save()
-
-        a1.tp = 'pf'
-        a1.save()
-
-        self.assertEqual(Persone.objects._collection.find_one({'_id': a2.pk}), {
-            '_id': a2.pk,
-            'name': 'Wilson Junior',
-            'tp': 'pf',
-            'father': {
-                '_id': a1.pk,
-                'tp': 'pj'
-            }
-        })
-
-    def test_cached_reference_embedded_fields(self):
-        class Owner(EmbeddedDocument):
-            TPS = (
-                ('n', "Normal"),
-                ('u', "Urgent")
-            )
-            name = StringField()
-            tp = StringField(
-                verbose_name="Type",
-                db_field="t",
-                choices=TPS)
-
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-            owner = EmbeddedDocumentField(Owner)
-
-        class Ocorrence(Document):
-            person = StringField()
-            animal = CachedReferenceField(
-                Animal, fields=['tag', 'owner.tp'])
-
-        Animal.drop_collection()
-        Ocorrence.drop_collection()
-
-        a = Animal(name="Leopard", tag="heavy",
-                   owner=Owner(tp='u', name="Wilson Júnior")
-                   )
-        a.save()
-
-        o = Ocorrence(person="teste", animal=a)
-        o.save()
-        self.assertEqual(dict(a.to_mongo(fields=['tag', 'owner.tp'])), {
-            '_id': a.pk,
-            'tag': 'heavy',
-            'owner': {
-                't': 'u'
-            }
-        })
-        self.assertEqual(o.to_mongo()['animal']['tag'], 'heavy')
-        self.assertEqual(o.to_mongo()['animal']['owner']['t'], 'u')
-
-        # Check to_mongo with fields
-        self.assertNotIn('animal', o.to_mongo(fields=['person']))
-
-        # counts
-        Ocorrence(person="teste 2").save()
-        Ocorrence(person="teste 3").save()
-
-        count = Ocorrence.objects(
-            animal__tag='heavy', animal__owner__tp='u').count()
-        self.assertEqual(count, 1)
-
-        ocorrence = Ocorrence.objects(
-            animal__tag='heavy',
-            animal__owner__tp='u').first()
-        self.assertEqual(ocorrence.person, "teste")
-        self.assertIsInstance(ocorrence.animal, Animal)
-
-    def test_cached_reference_embedded_list_fields(self):
-        class Owner(EmbeddedDocument):
-            name = StringField()
-            tags = ListField(StringField())
-
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-            owner = EmbeddedDocumentField(Owner)
-
-        class Ocorrence(Document):
-            person = StringField()
-            animal = CachedReferenceField(
-                Animal, fields=['tag', 'owner.tags'])
-
-        Animal.drop_collection()
-        Ocorrence.drop_collection()
-
-        a = Animal(name="Leopard", tag="heavy",
-                   owner=Owner(tags=['cool', 'funny'],
-                               name="Wilson Júnior")
-                   )
-        a.save()
-
-        o = Ocorrence(person="teste 2", animal=a)
-        o.save()
-        self.assertEqual(dict(a.to_mongo(fields=['tag', 'owner.tags'])), {
-            '_id': a.pk,
-            'tag': 'heavy',
-            'owner': {
-                'tags': ['cool', 'funny']
-            }
-        })
-
-        self.assertEqual(o.to_mongo()['animal']['tag'], 'heavy')
-        self.assertEqual(o.to_mongo()['animal']['owner']['tags'],
-                         ['cool', 'funny'])
-
-        # counts
-        Ocorrence(person="teste 2").save()
-        Ocorrence(person="teste 3").save()
-
-        query = Ocorrence.objects(
-            animal__tag='heavy', animal__owner__tags='cool')._query
-        self.assertEqual(
-            query, {'animal.owner.tags': 'cool', 'animal.tag': 'heavy'})
-
-        ocorrence = Ocorrence.objects(
-            animal__tag='heavy',
-            animal__owner__tags='cool').first()
-        self.assertEqual(ocorrence.person, "teste 2")
-        self.assertIsInstance(ocorrence.animal, Animal)

tests/fields/test_complex_datetime_field.py

@@ -1,184 +0,0 @@
-# -*- coding: utf-8 -*-
-import datetime
-import math
-import itertools
-import re
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class ComplexDateTimeFieldTest(MongoDBTestCase):
-    def test_complexdatetime_storage(self):
-        """Tests for complex datetime fields - which can handle
-        microseconds without rounding.
-        """
-        class LogEntry(Document):
-            date = ComplexDateTimeField()
-            date_with_dots = ComplexDateTimeField(separator='.')
-
-        LogEntry.drop_collection()
-
-        # Post UTC - microseconds are rounded (down) nearest millisecond and
-        # dropped - with default datetimefields
-        d1 = datetime.datetime(1970, 1, 1, 0, 0, 1, 999)
-        log = LogEntry()
-        log.date = d1
-        log.save()
-        log.reload()
-        self.assertEqual(log.date, d1)
-
-        # Post UTC - microseconds are rounded (down) nearest millisecond - with
-        # default datetimefields
-        d1 = datetime.datetime(1970, 1, 1, 0, 0, 1, 9999)
-        log.date = d1
-        log.save()
-        log.reload()
-        self.assertEqual(log.date, d1)
-
-        # Pre UTC dates microseconds below 1000 are dropped - with default
-        # datetimefields
-        d1 = datetime.datetime(1969, 12, 31, 23, 59, 59, 999)
-        log.date = d1
-        log.save()
-        log.reload()
-        self.assertEqual(log.date, d1)
-
-        # Pre UTC microseconds above 1000 is wonky - with default datetimefields
-        # log.date has an invalid microsecond value so I can't construct
-        # a date to compare.
-        for i in range(1001, 3113, 33):
-            d1 = datetime.datetime(1969, 12, 31, 23, 59, 59, i)
-            log.date = d1
-            log.save()
-            log.reload()
-            self.assertEqual(log.date, d1)
-            log1 = LogEntry.objects.get(date=d1)
-            self.assertEqual(log, log1)
-
-        # Test string padding
-        microsecond = map(int, [math.pow(10, x) for x in range(6)])
-        mm = dd = hh = ii = ss = [1, 10]
-
-        for values in itertools.product([2014], mm, dd, hh, ii, ss, microsecond):
-            stored = LogEntry(date=datetime.datetime(*values)).to_mongo()['date']
-            self.assertTrue(re.match('^\d{4},\d{2},\d{2},\d{2},\d{2},\d{2},\d{6}$', stored) is not None)
-
-        # Test separator
-        stored = LogEntry(date_with_dots=datetime.datetime(2014, 1, 1)).to_mongo()['date_with_dots']
-        self.assertTrue(re.match('^\d{4}.\d{2}.\d{2}.\d{2}.\d{2}.\d{2}.\d{6}$', stored) is not None)
-
-    def test_complexdatetime_usage(self):
-        """Tests for complex datetime fields - which can handle
-        microseconds without rounding.
-        """
-        class LogEntry(Document):
-            date = ComplexDateTimeField()
-
-        LogEntry.drop_collection()
-
-        d1 = datetime.datetime(1950, 1, 1, 0, 0, 1, 999)
-        log = LogEntry()
-        log.date = d1
-        log.save()
-
-        log1 = LogEntry.objects.get(date=d1)
-        self.assertEqual(log, log1)
-
-        # create extra 59 log entries for a total of 60
-        for i in range(1951, 2010):
-            d = datetime.datetime(i, 1, 1, 0, 0, 1, 999)
-            LogEntry(date=d).save()
-
-        self.assertEqual(LogEntry.objects.count(), 60)
-
-        # Test ordering
-        logs = LogEntry.objects.order_by("date")
-        i = 0
-        while i < 59:
-            self.assertTrue(logs[i].date <= logs[i + 1].date)
-            i += 1
-
-        logs = LogEntry.objects.order_by("-date")
-        i = 0
-        while i < 59:
-            self.assertTrue(logs[i].date >= logs[i + 1].date)
-            i += 1
-
-        # Test searching
-        logs = LogEntry.objects.filter(date__gte=datetime.datetime(1980, 1, 1))
-        self.assertEqual(logs.count(), 30)
-
-        logs = LogEntry.objects.filter(date__lte=datetime.datetime(1980, 1, 1))
-        self.assertEqual(logs.count(), 30)
-
-        logs = LogEntry.objects.filter(
-            date__lte=datetime.datetime(2011, 1, 1),
-            date__gte=datetime.datetime(2000, 1, 1),
-        )
-        self.assertEqual(logs.count(), 10)
-
-        LogEntry.drop_collection()
-
-        # Test microsecond-level ordering/filtering
-        for microsecond in (99, 999, 9999, 10000):
-            LogEntry(
-                date=datetime.datetime(2015, 1, 1, 0, 0, 0, microsecond)
-            ).save()
-
-        logs = list(LogEntry.objects.order_by('date'))
-        for next_idx, log in enumerate(logs[:-1], start=1):
-            next_log = logs[next_idx]
-            self.assertTrue(log.date < next_log.date)
-
-        logs = list(LogEntry.objects.order_by('-date'))
-        for next_idx, log in enumerate(logs[:-1], start=1):
-            next_log = logs[next_idx]
-            self.assertTrue(log.date > next_log.date)
-
-        logs = LogEntry.objects.filter(
-            date__lte=datetime.datetime(2015, 1, 1, 0, 0, 0, 10000))
-        self.assertEqual(logs.count(), 4)
-
-    def test_no_default_value(self):
-        class Log(Document):
-            timestamp = ComplexDateTimeField()
-
-        Log.drop_collection()
-
-        log = Log()
-        self.assertIsNone(log.timestamp)
-        log.save()
-
-        fetched_log = Log.objects.with_id(log.id)
-        self.assertIsNone(fetched_log.timestamp)
-
-    def test_default_static_value(self):
-        NOW = datetime.datetime.utcnow()
-        class Log(Document):
-            timestamp = ComplexDateTimeField(default=NOW)
-
-        Log.drop_collection()
-
-        log = Log()
-        self.assertEqual(log.timestamp, NOW)
-        log.save()
-
-        fetched_log = Log.objects.with_id(log.id)
-        self.assertEqual(fetched_log.timestamp, NOW)
-
-    def test_default_callable(self):
-        NOW = datetime.datetime.utcnow()
-
-        class Log(Document):
-            timestamp = ComplexDateTimeField(default=datetime.datetime.utcnow)
-
-        Log.drop_collection()
-
-        log = Log()
-        self.assertGreaterEqual(log.timestamp, NOW)
-        log.save()
-
-        fetched_log = Log.objects.with_id(log.id)
-        self.assertGreaterEqual(fetched_log.timestamp, NOW)

tests/fields/test_date_field.py

@@ -1,165 +0,0 @@
-# -*- coding: utf-8 -*-
-import datetime
-import six
-
-try:
-    import dateutil
-except ImportError:
-    dateutil = None
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestDateField(MongoDBTestCase):
-    def test_date_from_empty_string(self):
-        """
-        Ensure an exception is raised when trying to
-        cast an empty string to datetime.
-        """
-        class MyDoc(Document):
-            dt = DateField()
-
-        md = MyDoc(dt='')
-        self.assertRaises(ValidationError, md.save)
-
-    def test_date_from_whitespace_string(self):
-        """
-        Ensure an exception is raised when trying to
-        cast a whitespace-only string to datetime.
-        """
-        class MyDoc(Document):
-            dt = DateField()
-
-        md = MyDoc(dt='   ')
-        self.assertRaises(ValidationError, md.save)
-
-    def test_default_values_today(self):
-        """Ensure that default field values are used when creating
-        a document.
-        """
-        class Person(Document):
-            day = DateField(default=datetime.date.today)
-
-        person = Person()
-        person.validate()
-        self.assertEqual(person.day, person.day)
-        self.assertEqual(person.day, datetime.date.today())
-        self.assertEqual(person._data['day'], person.day)
-
-    def test_date(self):
-        """Tests showing pymongo date fields
-
-        See: http://api.mongodb.org/python/current/api/bson/son.html#dt
-        """
-        class LogEntry(Document):
-            date = DateField()
-
-        LogEntry.drop_collection()
-
-        # Test can save dates
-        log = LogEntry()
-        log.date = datetime.date.today()
-        log.save()
-        log.reload()
-        self.assertEqual(log.date, datetime.date.today())
-
-        d1 = datetime.datetime(1970, 1, 1, 0, 0, 1, 999)
-        d2 = datetime.datetime(1970, 1, 1, 0, 0, 1)
-        log = LogEntry()
-        log.date = d1
-        log.save()
-        log.reload()
-        self.assertEqual(log.date, d1.date())
-        self.assertEqual(log.date, d2.date())
-
-        d1 = datetime.datetime(1970, 1, 1, 0, 0, 1, 9999)
-        d2 = datetime.datetime(1970, 1, 1, 0, 0, 1, 9000)
-        log.date = d1
-        log.save()
-        log.reload()
-        self.assertEqual(log.date, d1.date())
-        self.assertEqual(log.date, d2.date())
-
-        if not six.PY3:
-            # Pre UTC dates microseconds below 1000 are dropped
-            # This does not seem to be true in PY3
-            d1 = datetime.datetime(1969, 12, 31, 23, 59, 59, 999)
-            d2 = datetime.datetime(1969, 12, 31, 23, 59, 59)
-            log.date = d1
-            log.save()
-            log.reload()
-            self.assertEqual(log.date, d1.date())
-            self.assertEqual(log.date, d2.date())
-
-    def test_regular_usage(self):
-        """Tests for regular datetime fields"""
-        class LogEntry(Document):
-            date = DateField()
-
-        LogEntry.drop_collection()
-
-        d1 = datetime.datetime(1970, 1, 1, 0, 0, 1)
-        log = LogEntry()
-        log.date = d1
-        log.validate()
-        log.save()
-
-        for query in (d1, d1.isoformat(' ')):
-            log1 = LogEntry.objects.get(date=query)
-            self.assertEqual(log, log1)
-
-        if dateutil:
-            log1 = LogEntry.objects.get(date=d1.isoformat('T'))
-            self.assertEqual(log, log1)
-
-        # create additional 19 log entries for a total of 20
-        for i in range(1971, 1990):
-            d = datetime.datetime(i, 1, 1, 0, 0, 1)
-            LogEntry(date=d).save()
-
-        self.assertEqual(LogEntry.objects.count(), 20)
-
-        # Test ordering
-        logs = LogEntry.objects.order_by("date")
-        i = 0
-        while i < 19:
-            self.assertTrue(logs[i].date <= logs[i + 1].date)
-            i += 1
-
-        logs = LogEntry.objects.order_by("-date")
-        i = 0
-        while i < 19:
-            self.assertTrue(logs[i].date >= logs[i + 1].date)
-            i += 1
-
-        # Test searching
-        logs = LogEntry.objects.filter(date__gte=datetime.datetime(1980, 1, 1))
-        self.assertEqual(logs.count(), 10)
-
-    def test_validation(self):
-        """Ensure that invalid values cannot be assigned to datetime
-        fields.
-        """
-        class LogEntry(Document):
-            time = DateField()
-
-        log = LogEntry()
-        log.time = datetime.datetime.now()
-        log.validate()
-
-        log.time = datetime.date.today()
-        log.validate()
-
-        log.time = datetime.datetime.now().isoformat(' ')
-        log.validate()
-
-        if dateutil:
-            log.time = datetime.datetime.now().isoformat('T')
-            log.validate()
-
-        log.time = -1
-        self.assertRaises(ValidationError, log.validate)
-        log.time = 'ABC'
-        self.assertRaises(ValidationError, log.validate)

tests/fields/test_datetime_field.py

@@ -1,231 +0,0 @@
-# -*- coding: utf-8 -*-
-import datetime as dt
-import six
-
-try:
-    import dateutil
-except ImportError:
-    dateutil = None
-
-from mongoengine import *
-from mongoengine import connection
-
-from tests.utils import MongoDBTestCase
-
-
-class TestDateTimeField(MongoDBTestCase):
-    def test_datetime_from_empty_string(self):
-        """
-        Ensure an exception is raised when trying to
-        cast an empty string to datetime.
-        """
-        class MyDoc(Document):
-            dt = DateTimeField()
-
-        md = MyDoc(dt='')
-        self.assertRaises(ValidationError, md.save)
-
-    def test_datetime_from_whitespace_string(self):
-        """
-        Ensure an exception is raised when trying to
-        cast a whitespace-only string to datetime.
-        """
-        class MyDoc(Document):
-            dt = DateTimeField()
-
-        md = MyDoc(dt='   ')
-        self.assertRaises(ValidationError, md.save)
-
-    def test_default_value_utcnow(self):
-        """Ensure that default field values are used when creating
-        a document.
-        """
-        class Person(Document):
-            created = DateTimeField(default=dt.datetime.utcnow)
-
-        utcnow = dt.datetime.utcnow()
-        person = Person()
-        person.validate()
-        person_created_t0 = person.created
-        self.assertLess(person.created - utcnow, dt.timedelta(seconds=1))
-        self.assertEqual(person_created_t0, person.created)  # make sure it does not change
-        self.assertEqual(person._data['created'], person.created)
-
-    def test_handling_microseconds(self):
-        """Tests showing pymongo datetime fields handling of microseconds.
-        Microseconds are rounded to the nearest millisecond and pre UTC
-        handling is wonky.
-
-        See: http://api.mongodb.org/python/current/api/bson/son.html#dt
-        """
-        class LogEntry(Document):
-            date = DateTimeField()
-
-        LogEntry.drop_collection()
-
-        # Test can save dates
-        log = LogEntry()
-        log.date = dt.date.today()
-        log.save()
-        log.reload()
-        self.assertEqual(log.date.date(), dt.date.today())
-
-        # Post UTC - microseconds are rounded (down) nearest millisecond and
-        # dropped
-        d1 = dt.datetime(1970, 1, 1, 0, 0, 1, 999)
-        d2 = dt.datetime(1970, 1, 1, 0, 0, 1)
-        log = LogEntry()
-        log.date = d1
-        log.save()
-        log.reload()
-        self.assertNotEqual(log.date, d1)
-        self.assertEqual(log.date, d2)
-
-        # Post UTC - microseconds are rounded (down) nearest millisecond
-        d1 = dt.datetime(1970, 1, 1, 0, 0, 1, 9999)
-        d2 = dt.datetime(1970, 1, 1, 0, 0, 1, 9000)
-        log.date = d1
-        log.save()
-        log.reload()
-        self.assertNotEqual(log.date, d1)
-        self.assertEqual(log.date, d2)
-
-        if not six.PY3:
-            # Pre UTC dates microseconds below 1000 are dropped
-            # This does not seem to be true in PY3
-            d1 = dt.datetime(1969, 12, 31, 23, 59, 59, 999)
-            d2 = dt.datetime(1969, 12, 31, 23, 59, 59)
-            log.date = d1
-            log.save()
-            log.reload()
-            self.assertNotEqual(log.date, d1)
-            self.assertEqual(log.date, d2)
-
-    def test_regular_usage(self):
-        """Tests for regular datetime fields"""
-        class LogEntry(Document):
-            date = DateTimeField()
-
-        LogEntry.drop_collection()
-
-        d1 = dt.datetime(1970, 1, 1, 0, 0, 1)
-        log = LogEntry()
-        log.date = d1
-        log.validate()
-        log.save()
-
-        for query in (d1, d1.isoformat(' ')):
-            log1 = LogEntry.objects.get(date=query)
-            self.assertEqual(log, log1)
-
-        if dateutil:
-            log1 = LogEntry.objects.get(date=d1.isoformat('T'))
-            self.assertEqual(log, log1)
-
-        # create additional 19 log entries for a total of 20
-        for i in range(1971, 1990):
-            d = dt.datetime(i, 1, 1, 0, 0, 1)
-            LogEntry(date=d).save()
-
-        self.assertEqual(LogEntry.objects.count(), 20)
-
-        # Test ordering
-        logs = LogEntry.objects.order_by("date")
-        i = 0
-        while i < 19:
-            self.assertTrue(logs[i].date <= logs[i + 1].date)
-            i += 1
-
-        logs = LogEntry.objects.order_by("-date")
-        i = 0
-        while i < 19:
-            self.assertTrue(logs[i].date >= logs[i + 1].date)
-            i += 1
-
-        # Test searching
-        logs = LogEntry.objects.filter(date__gte=dt.datetime(1980, 1, 1))
-        self.assertEqual(logs.count(), 10)
-
-        logs = LogEntry.objects.filter(date__lte=dt.datetime(1980, 1, 1))
-        self.assertEqual(logs.count(), 10)
-
-        logs = LogEntry.objects.filter(
-            date__lte=dt.datetime(1980, 1, 1),
-            date__gte=dt.datetime(1975, 1, 1),
-        )
-        self.assertEqual(logs.count(), 5)
-
-    def test_datetime_validation(self):
-        """Ensure that invalid values cannot be assigned to datetime
-        fields.
-        """
-        class LogEntry(Document):
-            time = DateTimeField()
-
-        log = LogEntry()
-        log.time = dt.datetime.now()
-        log.validate()
-
-        log.time = dt.date.today()
-        log.validate()
-
-        log.time = dt.datetime.now().isoformat(' ')
-        log.validate()
-
-        log.time = '2019-05-16 21:42:57.897847'
-        log.validate()
-
-        if dateutil:
-            log.time = dt.datetime.now().isoformat('T')
-            log.validate()
-
-        log.time = -1
-        self.assertRaises(ValidationError, log.validate)
-        log.time = 'ABC'
-        self.assertRaises(ValidationError, log.validate)
-        log.time = '2019-05-16 21:GARBAGE:12'
-        self.assertRaises(ValidationError, log.validate)
-        log.time = '2019-05-16 21:42:57.GARBAGE'
-        self.assertRaises(ValidationError, log.validate)
-        log.time = '2019-05-16 21:42:57.123.456'
-        self.assertRaises(ValidationError, log.validate)
-
-    def test_parse_datetime_as_str(self):
-        class DTDoc(Document):
-            date = DateTimeField()
-
-        date_str = '2019-03-02 22:26:01'
-
-        # make sure that passing a parsable datetime works
-        dtd = DTDoc()
-        dtd.date = date_str
-        self.assertIsInstance(dtd.date, six.string_types)
-        dtd.save()
-        dtd.reload()
-
-        self.assertIsInstance(dtd.date, dt.datetime)
-        self.assertEqual(str(dtd.date), date_str)
-
-        dtd.date = 'January 1st, 9999999999'
-        self.assertRaises(ValidationError, dtd.validate)
-
-
-class TestDateTimeTzAware(MongoDBTestCase):
-    def test_datetime_tz_aware_mark_as_changed(self):
-        # Reset the connections
-        connection._connection_settings = {}
-        connection._connections = {}
-        connection._dbs = {}
-
-        connect(db='mongoenginetest', tz_aware=True)
-
-        class LogEntry(Document):
-            time = DateTimeField()
-
-        LogEntry.drop_collection()
-
-        LogEntry(time=dt.datetime(2013, 1, 1, 0, 0, 0)).save()
-
-        log = LogEntry.objects.first()
-        log.time = dt.datetime(2013, 1, 1, 0, 0, 0)
-        self.assertEqual(['time'], log._changed_fields)

tests/fields/test_decimal_field.py

@@ -1,91 +0,0 @@
-# -*- coding: utf-8 -*-
-from decimal import Decimal
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestDecimalField(MongoDBTestCase):
-
-    def test_validation(self):
-        """Ensure that invalid values cannot be assigned to decimal fields.
-        """
-        class Person(Document):
-            height = DecimalField(min_value=Decimal('0.1'),
-                                  max_value=Decimal('3.5'))
-
-        Person.drop_collection()
-
-        Person(height=Decimal('1.89')).save()
-        person = Person.objects.first()
-        self.assertEqual(person.height, Decimal('1.89'))
-
-        person.height = '2.0'
-        person.save()
-        person.height = 0.01
-        self.assertRaises(ValidationError, person.validate)
-        person.height = Decimal('0.01')
-        self.assertRaises(ValidationError, person.validate)
-        person.height = Decimal('4.0')
-        self.assertRaises(ValidationError, person.validate)
-        person.height = 'something invalid'
-        self.assertRaises(ValidationError, person.validate)
-
-        person_2 = Person(height='something invalid')
-        self.assertRaises(ValidationError, person_2.validate)
-
-    def test_comparison(self):
-        class Person(Document):
-            money = DecimalField()
-
-        Person.drop_collection()
-
-        Person(money=6).save()
-        Person(money=7).save()
-        Person(money=8).save()
-        Person(money=10).save()
-
-        self.assertEqual(2, Person.objects(money__gt=Decimal("7")).count())
-        self.assertEqual(2, Person.objects(money__gt=7).count())
-        self.assertEqual(2, Person.objects(money__gt="7").count())
-
-        self.assertEqual(3, Person.objects(money__gte="7").count())
-
-    def test_storage(self):
-        class Person(Document):
-            float_value = DecimalField(precision=4)
-            string_value = DecimalField(precision=4, force_string=True)
-
-        Person.drop_collection()
-        values_to_store = [10, 10.1, 10.11, "10.111", Decimal("10.1111"), Decimal("10.11111")]
-        for store_at_creation in [True, False]:
-            for value in values_to_store:
-                # to_python is called explicitly if values were sent in the kwargs of __init__
-                if store_at_creation:
-                    Person(float_value=value, string_value=value).save()
-                else:
-                    person = Person.objects.create()
-                    person.float_value = value
-                    person.string_value = value
-                    person.save()
-
-        # How its stored
-        expected = [
-            {'float_value': 10.0, 'string_value': '10.0000'},
-            {'float_value': 10.1, 'string_value': '10.1000'},
-            {'float_value': 10.11, 'string_value': '10.1100'},
-            {'float_value': 10.111, 'string_value': '10.1110'},
-            {'float_value': 10.1111, 'string_value': '10.1111'},
-            {'float_value': 10.1111, 'string_value': '10.1111'}]
-        expected.extend(expected)
-        actual = list(Person.objects.exclude('id').as_pymongo())
-        self.assertEqual(expected, actual)
-
-        # How it comes out locally
-        expected = [Decimal('10.0000'), Decimal('10.1000'), Decimal('10.1100'),
-                    Decimal('10.1110'), Decimal('10.1111'), Decimal('10.1111')]
-        expected.extend(expected)
-        for field_name in ['float_value', 'string_value']:
-            actual = list(Person.objects().scalar(field_name))
-            self.assertEqual(expected, actual)

tests/fields/test_dict_field.py

@@ -1,324 +0,0 @@
-# -*- coding: utf-8 -*-
-from mongoengine import *
-from mongoengine.base import BaseDict
-
-from tests.utils import MongoDBTestCase, get_as_pymongo
-
-
-class TestDictField(MongoDBTestCase):
-
-    def test_storage(self):
-        class BlogPost(Document):
-            info = DictField()
-
-        BlogPost.drop_collection()
-
-        info = {'testkey': 'testvalue'}
-        post = BlogPost(info=info).save()
-        self.assertEqual(
-            get_as_pymongo(post),
-            {
-                '_id': post.id,
-                'info': info
-            }
-        )
-
-    def test_general_things(self):
-        """Ensure that dict types work as expected."""
-        class BlogPost(Document):
-            info = DictField()
-
-        BlogPost.drop_collection()
-
-        post = BlogPost()
-        post.info = 'my post'
-        self.assertRaises(ValidationError, post.validate)
-
-        post.info = ['test', 'test']
-        self.assertRaises(ValidationError, post.validate)
-
-        post.info = {'$title': 'test'}
-        self.assertRaises(ValidationError, post.validate)
-
-        post.info = {'nested': {'$title': 'test'}}
-        self.assertRaises(ValidationError, post.validate)
-
-        post.info = {'the.title': 'test'}
-        self.assertRaises(ValidationError, post.validate)
-
-        post.info = {'nested': {'the.title': 'test'}}
-        self.assertRaises(ValidationError, post.validate)
-
-        post.info = {1: 'test'}
-        self.assertRaises(ValidationError, post.validate)
-
-        post.info = {'title': 'test'}
-        post.save()
-
-        post = BlogPost()
-        post.info = {'title': 'dollar_sign', 'details': {'te$t': 'test'}}
-        post.save()
-
-        post = BlogPost()
-        post.info = {'details': {'test': 'test'}}
-        post.save()
-
-        post = BlogPost()
-        post.info = {'details': {'test': 3}}
-        post.save()
-
-        self.assertEqual(BlogPost.objects.count(), 4)
-        self.assertEqual(
-            BlogPost.objects.filter(info__title__exact='test').count(), 1)
-        self.assertEqual(
-            BlogPost.objects.filter(info__details__test__exact='test').count(), 1)
-
-        post = BlogPost.objects.filter(info__title__exact='dollar_sign').first()
-        self.assertIn('te$t', post['info']['details'])
-
-        # Confirm handles non strings or non existing keys
-        self.assertEqual(
-            BlogPost.objects.filter(info__details__test__exact=5).count(), 0)
-        self.assertEqual(
-            BlogPost.objects.filter(info__made_up__test__exact='test').count(), 0)
-
-        post = BlogPost.objects.create(info={'title': 'original'})
-        post.info.update({'title': 'updated'})
-        post.save()
-        post.reload()
-        self.assertEqual('updated', post.info['title'])
-
-        post.info.setdefault('authors', [])
-        post.save()
-        post.reload()
-        self.assertEqual([], post.info['authors'])
-
-    def test_dictfield_dump_document(self):
-        """Ensure a DictField can handle another document's dump."""
-        class Doc(Document):
-            field = DictField()
-
-        class ToEmbed(Document):
-            id = IntField(primary_key=True, default=1)
-            recursive = DictField()
-
-        class ToEmbedParent(Document):
-            id = IntField(primary_key=True, default=1)
-            recursive = DictField()
-
-            meta = {'allow_inheritance': True}
-
-        class ToEmbedChild(ToEmbedParent):
-            pass
-
-        to_embed_recursive = ToEmbed(id=1).save()
-        to_embed = ToEmbed(
-            id=2, recursive=to_embed_recursive.to_mongo().to_dict()).save()
-        doc = Doc(field=to_embed.to_mongo().to_dict())
-        doc.save()
-        self.assertIsInstance(doc.field, dict)
-        self.assertEqual(doc.field, {'_id': 2, 'recursive': {'_id': 1, 'recursive': {}}})
-        # Same thing with a Document with a _cls field
-        to_embed_recursive = ToEmbedChild(id=1).save()
-        to_embed_child = ToEmbedChild(
-            id=2, recursive=to_embed_recursive.to_mongo().to_dict()).save()
-        doc = Doc(field=to_embed_child.to_mongo().to_dict())
-        doc.save()
-        self.assertIsInstance(doc.field, dict)
-        expected = {
-            '_id': 2, '_cls': 'ToEmbedParent.ToEmbedChild',
-            'recursive': {'_id': 1, '_cls': 'ToEmbedParent.ToEmbedChild', 'recursive': {}}
-        }
-        self.assertEqual(doc.field, expected)
-
-    def test_dictfield_strict(self):
-        """Ensure that dict field handles validation if provided a strict field type."""
-        class Simple(Document):
-            mapping = DictField(field=IntField())
-
-        Simple.drop_collection()
-
-        e = Simple()
-        e.mapping['someint'] = 1
-        e.save()
-
-        # try creating an invalid mapping
-        with self.assertRaises(ValidationError):
-            e.mapping['somestring'] = "abc"
-            e.save()
-
-    def test_dictfield_complex(self):
-        """Ensure that the dict field can handle the complex types."""
-        class SettingBase(EmbeddedDocument):
-            meta = {'allow_inheritance': True}
-
-        class StringSetting(SettingBase):
-            value = StringField()
-
-        class IntegerSetting(SettingBase):
-            value = IntField()
-
-        class Simple(Document):
-            mapping = DictField()
-
-        Simple.drop_collection()
-
-        e = Simple()
-        e.mapping['somestring'] = StringSetting(value='foo')
-        e.mapping['someint'] = IntegerSetting(value=42)
-        e.mapping['nested_dict'] = {'number': 1, 'string': 'Hi!',
-                                    'float': 1.001,
-                                    'complex': IntegerSetting(value=42),
-                                    'list': [IntegerSetting(value=42),
-                                             StringSetting(value='foo')]}
-        e.save()
-
-        e2 = Simple.objects.get(id=e.id)
-        self.assertIsInstance(e2.mapping['somestring'], StringSetting)
-        self.assertIsInstance(e2.mapping['someint'], IntegerSetting)
-
-        # Test querying
-        self.assertEqual(
-            Simple.objects.filter(mapping__someint__value=42).count(), 1)
-        self.assertEqual(
-            Simple.objects.filter(mapping__nested_dict__number=1).count(), 1)
-        self.assertEqual(
-            Simple.objects.filter(mapping__nested_dict__complex__value=42).count(), 1)
-        self.assertEqual(
-            Simple.objects.filter(mapping__nested_dict__list__0__value=42).count(), 1)
-        self.assertEqual(
-            Simple.objects.filter(mapping__nested_dict__list__1__value='foo').count(), 1)
-
-        # Confirm can update
-        Simple.objects().update(
-            set__mapping={"someint": IntegerSetting(value=10)})
-        Simple.objects().update(
-            set__mapping__nested_dict__list__1=StringSetting(value='Boo'))
-        self.assertEqual(
-            Simple.objects.filter(mapping__nested_dict__list__1__value='foo').count(), 0)
-        self.assertEqual(
-            Simple.objects.filter(mapping__nested_dict__list__1__value='Boo').count(), 1)
-
-    def test_push_dict(self):
-        class MyModel(Document):
-            events = ListField(DictField())
-
-        doc = MyModel(events=[{'a': 1}]).save()
-        raw_doc = get_as_pymongo(doc)
-        expected_raw_doc = {
-            '_id': doc.id,
-            'events': [{'a': 1}]
-        }
-        self.assertEqual(raw_doc, expected_raw_doc)
-
-        MyModel.objects(id=doc.id).update(push__events={})
-        raw_doc = get_as_pymongo(doc)
-        expected_raw_doc = {
-            '_id': doc.id,
-            'events': [{'a': 1}, {}]
-        }
-        self.assertEqual(raw_doc, expected_raw_doc)
-
-    def test_ensure_unique_default_instances(self):
-        """Ensure that every field has it's own unique default instance."""
-        class D(Document):
-            data = DictField()
-            data2 = DictField(default=lambda: {})
-
-        d1 = D()
-        d1.data['foo'] = 'bar'
-        d1.data2['foo'] = 'bar'
-        d2 = D()
-        self.assertEqual(d2.data, {})
-        self.assertEqual(d2.data2, {})
-
-    def test_dict_field_invalid_dict_value(self):
-        class DictFieldTest(Document):
-            dictionary = DictField(required=True)
-
-        DictFieldTest.drop_collection()
-
-        test = DictFieldTest(dictionary=None)
-        test.dictionary  # Just access to test getter
-        self.assertRaises(ValidationError, test.validate)
-
-        test = DictFieldTest(dictionary=False)
-        test.dictionary  # Just access to test getter
-        self.assertRaises(ValidationError, test.validate)
-
-    def test_dict_field_raises_validation_error_if_wrongly_assign_embedded_doc(self):
-        class DictFieldTest(Document):
-            dictionary = DictField(required=True)
-
-        DictFieldTest.drop_collection()
-
-        class Embedded(EmbeddedDocument):
-            name = StringField()
-
-        embed = Embedded(name='garbage')
-        doc = DictFieldTest(dictionary=embed)
-        with self.assertRaises(ValidationError) as ctx_err:
-            doc.validate()
-        self.assertIn("'dictionary'", str(ctx_err.exception))
-        self.assertIn('Only dictionaries may be used in a DictField', str(ctx_err.exception))
-
-    def test_atomic_update_dict_field(self):
-        """Ensure that the entire DictField can be atomically updated."""
-        class Simple(Document):
-            mapping = DictField(field=ListField(IntField(required=True)))
-
-        Simple.drop_collection()
-
-        e = Simple()
-        e.mapping['someints'] = [1, 2]
-        e.save()
-        e.update(set__mapping={"ints": [3, 4]})
-        e.reload()
-        self.assertEqual(BaseDict, type(e.mapping))
-        self.assertEqual({"ints": [3, 4]}, e.mapping)
-
-        # try creating an invalid mapping
-        with self.assertRaises(ValueError):
-            e.update(set__mapping={"somestrings": ["foo", "bar", ]})
-
-    def test_dictfield_with_referencefield_complex_nesting_cases(self):
-        """Ensure complex nesting inside DictField handles dereferencing of ReferenceField(dbref=True | False)"""
-        # Relates to Issue #1453
-        class Doc(Document):
-            s = StringField()
-
-        class Simple(Document):
-            mapping0 = DictField(ReferenceField(Doc, dbref=True))
-            mapping1 = DictField(ReferenceField(Doc, dbref=False))
-            mapping2 = DictField(ListField(ReferenceField(Doc, dbref=True)))
-            mapping3 = DictField(ListField(ReferenceField(Doc, dbref=False)))
-            mapping4 = DictField(DictField(field=ReferenceField(Doc, dbref=True)))
-            mapping5 = DictField(DictField(field=ReferenceField(Doc, dbref=False)))
-            mapping6 = DictField(ListField(DictField(ReferenceField(Doc, dbref=True))))
-            mapping7 = DictField(ListField(DictField(ReferenceField(Doc, dbref=False))))
-            mapping8 = DictField(ListField(DictField(ListField(ReferenceField(Doc, dbref=True)))))
-            mapping9 = DictField(ListField(DictField(ListField(ReferenceField(Doc, dbref=False)))))
-
-        Doc.drop_collection()
-        Simple.drop_collection()
-
-        d = Doc(s='aa').save()
-        e = Simple()
-        e.mapping0['someint'] = e.mapping1['someint'] = d
-        e.mapping2['someint'] = e.mapping3['someint'] = [d]
-        e.mapping4['someint'] = e.mapping5['someint'] = {'d': d}
-        e.mapping6['someint'] = e.mapping7['someint'] = [{'d': d}]
-        e.mapping8['someint'] = e.mapping9['someint'] = [{'d': [d]}]
-        e.save()
-
-        s = Simple.objects.first()
-        self.assertIsInstance(s.mapping0['someint'], Doc)
-        self.assertIsInstance(s.mapping1['someint'], Doc)
-        self.assertIsInstance(s.mapping2['someint'][0], Doc)
-        self.assertIsInstance(s.mapping3['someint'][0], Doc)
-        self.assertIsInstance(s.mapping4['someint']['d'], Doc)
-        self.assertIsInstance(s.mapping5['someint']['d'], Doc)
-        self.assertIsInstance(s.mapping6['someint'][0]['d'], Doc)
-        self.assertIsInstance(s.mapping7['someint'][0]['d'], Doc)
-        self.assertIsInstance(s.mapping8['someint'][0]['d'][0], Doc)
-        self.assertIsInstance(s.mapping9['someint'][0]['d'][0], Doc)

tests/fields/test_email_field.py

@@ -1,130 +0,0 @@
-# -*- coding: utf-8 -*-
-import sys
-from unittest import SkipTest
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestEmailField(MongoDBTestCase):
-    def test_generic_behavior(self):
-        class User(Document):
-            email = EmailField()
-
-        user = User(email='ross@example.com')
-        user.validate()
-
-        user = User(email='ross@example.co.uk')
-        user.validate()
-
-        user = User(email=('Kofq@rhom0e4klgauOhpbpNdogawnyIKvQS0wk2mjqrgGQ5S'
-                           'aJIazqqWkm7.net'))
-        user.validate()
-
-        user = User(email='new-tld@example.technology')
-        user.validate()
-
-        user = User(email='ross@example.com.')
-        self.assertRaises(ValidationError, user.validate)
-
-        # unicode domain
-        user = User(email=u'user@пример.рф')
-        user.validate()
-
-        # invalid unicode domain
-        user = User(email=u'user@пример')
-        self.assertRaises(ValidationError, user.validate)
-
-        # invalid data type
-        user = User(email=123)
-        self.assertRaises(ValidationError, user.validate)
-
-    def test_email_field_unicode_user(self):
-        # Don't run this test on pypy3, which doesn't support unicode regex:
-        # https://bitbucket.org/pypy/pypy/issues/1821/regular-expression-doesnt-find-unicode
-        if sys.version_info[:2] == (3, 2):
-            raise SkipTest('unicode email addresses are not supported on PyPy 3')
-
-        class User(Document):
-            email = EmailField()
-
-        # unicode user shouldn't validate by default...
-        user = User(email=u'Dörte@Sörensen.example.com')
-        self.assertRaises(ValidationError, user.validate)
-
-        # ...but it should be fine with allow_utf8_user set to True
-        class User(Document):
-            email = EmailField(allow_utf8_user=True)
-
-        user = User(email=u'Dörte@Sörensen.example.com')
-        user.validate()
-
-    def test_email_field_domain_whitelist(self):
-        class User(Document):
-            email = EmailField()
-
-        # localhost domain shouldn't validate by default...
-        user = User(email='me@localhost')
-        self.assertRaises(ValidationError, user.validate)
-
-        # ...but it should be fine if it's whitelisted
-        class User(Document):
-            email = EmailField(domain_whitelist=['localhost'])
-
-        user = User(email='me@localhost')
-        user.validate()
-
-    def test_email_domain_validation_fails_if_invalid_idn(self):
-        class User(Document):
-            email = EmailField()
-
-        invalid_idn = '.google.com'
-        user = User(email='me@%s' % invalid_idn)
-        with self.assertRaises(ValidationError) as ctx_err:
-            user.validate()
-        self.assertIn("domain failed IDN encoding", str(ctx_err.exception))
-
-    def test_email_field_ip_domain(self):
-        class User(Document):
-            email = EmailField()
-
-        valid_ipv4 = 'email@[127.0.0.1]'
-        valid_ipv6 = 'email@[2001:dB8::1]'
-        invalid_ip = 'email@[324.0.0.1]'
-
-        # IP address as a domain shouldn't validate by default...
-        user = User(email=valid_ipv4)
-        self.assertRaises(ValidationError, user.validate)
-
-        user = User(email=valid_ipv6)
-        self.assertRaises(ValidationError, user.validate)
-
-        user = User(email=invalid_ip)
-        self.assertRaises(ValidationError, user.validate)
-
-        # ...but it should be fine with allow_ip_domain set to True
-        class User(Document):
-            email = EmailField(allow_ip_domain=True)
-
-        user = User(email=valid_ipv4)
-        user.validate()
-
-        user = User(email=valid_ipv6)
-        user.validate()
-
-        # invalid IP should still fail validation
-        user = User(email=invalid_ip)
-        self.assertRaises(ValidationError, user.validate)
-
-    def test_email_field_honors_regex(self):
-        class User(Document):
-            email = EmailField(regex=r'\w+@example.com')
-
-        # Fails regex validation
-        user = User(email='me@foo.com')
-        self.assertRaises(ValidationError, user.validate)
-
-        # Passes regex validation
-        user = User(email='me@example.com')
-        self.assertIsNone(user.validate())

tests/fields/test_embedded_document_field.py

@@ -1,344 +0,0 @@
-# -*- coding: utf-8 -*-
-from mongoengine import Document, StringField, ValidationError, EmbeddedDocument, EmbeddedDocumentField, \
-    InvalidQueryError, LookUpError, IntField, GenericEmbeddedDocumentField, ListField, EmbeddedDocumentListField, \
-    ReferenceField
-
-from tests.utils import MongoDBTestCase
-
-
-class TestEmbeddedDocumentField(MongoDBTestCase):
-    def test___init___(self):
-        class MyDoc(EmbeddedDocument):
-            name = StringField()
-
-        field = EmbeddedDocumentField(MyDoc)
-        self.assertEqual(field.document_type_obj, MyDoc)
-
-        field2 = EmbeddedDocumentField('MyDoc')
-        self.assertEqual(field2.document_type_obj, 'MyDoc')
-
-    def test___init___throw_error_if_document_type_is_not_EmbeddedDocument(self):
-        with self.assertRaises(ValidationError):
-            EmbeddedDocumentField(dict)
-
-    def test_document_type_throw_error_if_not_EmbeddedDocument_subclass(self):
-
-        class MyDoc(Document):
-            name = StringField()
-
-        emb = EmbeddedDocumentField('MyDoc')
-        with self.assertRaises(ValidationError) as ctx:
-            emb.document_type
-        self.assertIn('Invalid embedded document class provided to an EmbeddedDocumentField', str(ctx.exception))
-
-    def test_embedded_document_field_only_allow_subclasses_of_embedded_document(self):
-        # Relates to #1661
-        class MyDoc(Document):
-            name = StringField()
-
-        with self.assertRaises(ValidationError):
-            class MyFailingDoc(Document):
-                emb = EmbeddedDocumentField(MyDoc)
-
-        with self.assertRaises(ValidationError):
-            class MyFailingdoc2(Document):
-                emb = EmbeddedDocumentField('MyDoc')
-
-    def test_query_embedded_document_attribute(self):
-        class AdminSettings(EmbeddedDocument):
-            foo1 = StringField()
-            foo2 = StringField()
-
-        class Person(Document):
-            settings = EmbeddedDocumentField(AdminSettings)
-            name = StringField()
-
-        Person.drop_collection()
-
-        p = Person(
-            settings=AdminSettings(foo1='bar1', foo2='bar2'),
-            name='John',
-        ).save()
-
-        # Test non exiting attribute
-        with self.assertRaises(InvalidQueryError) as ctx_err:
-            Person.objects(settings__notexist='bar').first()
-        self.assertEqual(unicode(ctx_err.exception), u'Cannot resolve field "notexist"')
-
-        with self.assertRaises(LookUpError):
-            Person.objects.only('settings.notexist')
-
-        # Test existing attribute
-        self.assertEqual(Person.objects(settings__foo1='bar1').first().id, p.id)
-        only_p = Person.objects.only('settings.foo1').first()
-        self.assertEqual(only_p.settings.foo1, p.settings.foo1)
-        self.assertIsNone(only_p.settings.foo2)
-        self.assertIsNone(only_p.name)
-
-        exclude_p = Person.objects.exclude('settings.foo1').first()
-        self.assertIsNone(exclude_p.settings.foo1)
-        self.assertEqual(exclude_p.settings.foo2, p.settings.foo2)
-        self.assertEqual(exclude_p.name, p.name)
-
-    def test_query_embedded_document_attribute_with_inheritance(self):
-        class BaseSettings(EmbeddedDocument):
-            meta = {'allow_inheritance': True}
-            base_foo = StringField()
-
-        class AdminSettings(BaseSettings):
-            sub_foo = StringField()
-
-        class Person(Document):
-            settings = EmbeddedDocumentField(BaseSettings)
-
-        Person.drop_collection()
-
-        p = Person(settings=AdminSettings(base_foo='basefoo', sub_foo='subfoo'))
-        p.save()
-
-        # Test non exiting attribute
-        with self.assertRaises(InvalidQueryError) as ctx_err:
-            self.assertEqual(Person.objects(settings__notexist='bar').first().id, p.id)
-        self.assertEqual(unicode(ctx_err.exception), u'Cannot resolve field "notexist"')
-
-        # Test existing attribute
-        self.assertEqual(Person.objects(settings__base_foo='basefoo').first().id, p.id)
-        self.assertEqual(Person.objects(settings__sub_foo='subfoo').first().id, p.id)
-
-        only_p = Person.objects.only('settings.base_foo', 'settings._cls').first()
-        self.assertEqual(only_p.settings.base_foo, 'basefoo')
-        self.assertIsNone(only_p.settings.sub_foo)
-
-    def test_query_list_embedded_document_with_inheritance(self):
-        class Post(EmbeddedDocument):
-            title = StringField(max_length=120, required=True)
-            meta = {'allow_inheritance': True}
-
-        class TextPost(Post):
-            content = StringField()
-
-        class MoviePost(Post):
-            author = StringField()
-
-        class Record(Document):
-            posts = ListField(EmbeddedDocumentField(Post))
-
-        record_movie = Record(posts=[MoviePost(author='John', title='foo')]).save()
-        record_text = Record(posts=[TextPost(content='a', title='foo')]).save()
-
-        records = list(Record.objects(posts__author=record_movie.posts[0].author))
-        self.assertEqual(len(records), 1)
-        self.assertEqual(records[0].id, record_movie.id)
-
-        records = list(Record.objects(posts__content=record_text.posts[0].content))
-        self.assertEqual(len(records), 1)
-        self.assertEqual(records[0].id, record_text.id)
-
-        self.assertEqual(Record.objects(posts__title='foo').count(), 2)
-
-
-class TestGenericEmbeddedDocumentField(MongoDBTestCase):
-
-    def test_generic_embedded_document(self):
-        class Car(EmbeddedDocument):
-            name = StringField()
-
-        class Dish(EmbeddedDocument):
-            food = StringField(required=True)
-            number = IntField()
-
-        class Person(Document):
-            name = StringField()
-            like = GenericEmbeddedDocumentField()
-
-        Person.drop_collection()
-
-        person = Person(name='Test User')
-        person.like = Car(name='Fiat')
-        person.save()
-
-        person = Person.objects.first()
-        self.assertIsInstance(person.like, Car)
-
-        person.like = Dish(food="arroz", number=15)
-        person.save()
-
-        person = Person.objects.first()
-        self.assertIsInstance(person.like, Dish)
-
-    def test_generic_embedded_document_choices(self):
-        """Ensure you can limit GenericEmbeddedDocument choices."""
-        class Car(EmbeddedDocument):
-            name = StringField()
-
-        class Dish(EmbeddedDocument):
-            food = StringField(required=True)
-            number = IntField()
-
-        class Person(Document):
-            name = StringField()
-            like = GenericEmbeddedDocumentField(choices=(Dish,))
-
-        Person.drop_collection()
-
-        person = Person(name='Test User')
-        person.like = Car(name='Fiat')
-        self.assertRaises(ValidationError, person.validate)
-
-        person.like = Dish(food="arroz", number=15)
-        person.save()
-
-        person = Person.objects.first()
-        self.assertIsInstance(person.like, Dish)
-
-    def test_generic_list_embedded_document_choices(self):
-        """Ensure you can limit GenericEmbeddedDocument choices inside
-        a list field.
-        """
-        class Car(EmbeddedDocument):
-            name = StringField()
-
-        class Dish(EmbeddedDocument):
-            food = StringField(required=True)
-            number = IntField()
-
-        class Person(Document):
-            name = StringField()
-            likes = ListField(GenericEmbeddedDocumentField(choices=(Dish,)))
-
-        Person.drop_collection()
-
-        person = Person(name='Test User')
-        person.likes = [Car(name='Fiat')]
-        self.assertRaises(ValidationError, person.validate)
-
-        person.likes = [Dish(food="arroz", number=15)]
-        person.save()
-
-        person = Person.objects.first()
-        self.assertIsInstance(person.likes[0], Dish)
-
-    def test_choices_validation_documents(self):
-        """
-        Ensure fields with document choices validate given a valid choice.
-        """
-        class UserComments(EmbeddedDocument):
-            author = StringField()
-            message = StringField()
-
-        class BlogPost(Document):
-            comments = ListField(
-                GenericEmbeddedDocumentField(choices=(UserComments,))
-            )
-
-        # Ensure Validation Passes
-        BlogPost(comments=[
-            UserComments(author='user2', message='message2'),
-        ]).save()
-
-    def test_choices_validation_documents_invalid(self):
-        """
-        Ensure fields with document choices validate given an invalid choice.
-        This should throw a ValidationError exception.
-        """
-        class UserComments(EmbeddedDocument):
-            author = StringField()
-            message = StringField()
-
-        class ModeratorComments(EmbeddedDocument):
-            author = StringField()
-            message = StringField()
-
-        class BlogPost(Document):
-            comments = ListField(
-                GenericEmbeddedDocumentField(choices=(UserComments,))
-            )
-
-        # Single Entry Failure
-        post = BlogPost(comments=[
-            ModeratorComments(author='mod1', message='message1'),
-        ])
-        self.assertRaises(ValidationError, post.save)
-
-        # Mixed Entry Failure
-        post = BlogPost(comments=[
-            ModeratorComments(author='mod1', message='message1'),
-            UserComments(author='user2', message='message2'),
-        ])
-        self.assertRaises(ValidationError, post.save)
-
-    def test_choices_validation_documents_inheritance(self):
-        """
-        Ensure fields with document choices validate given subclass of choice.
-        """
-        class Comments(EmbeddedDocument):
-            meta = {
-                'abstract': True
-            }
-            author = StringField()
-            message = StringField()
-
-        class UserComments(Comments):
-            pass
-
-        class BlogPost(Document):
-            comments = ListField(
-                GenericEmbeddedDocumentField(choices=(Comments,))
-            )
-
-        # Save Valid EmbeddedDocument Type
-        BlogPost(comments=[
-            UserComments(author='user2', message='message2'),
-        ]).save()
-
-    def test_query_generic_embedded_document_attribute(self):
-        class AdminSettings(EmbeddedDocument):
-            foo1 = StringField()
-
-        class NonAdminSettings(EmbeddedDocument):
-            foo2 = StringField()
-
-        class Person(Document):
-            settings = GenericEmbeddedDocumentField(choices=(AdminSettings, NonAdminSettings))
-
-        Person.drop_collection()
-
-        p1 = Person(settings=AdminSettings(foo1='bar1')).save()
-        p2 = Person(settings=NonAdminSettings(foo2='bar2')).save()
-
-        # Test non exiting attribute
-        with self.assertRaises(InvalidQueryError) as ctx_err:
-            Person.objects(settings__notexist='bar').first()
-        self.assertEqual(unicode(ctx_err.exception), u'Cannot resolve field "notexist"')
-
-        with self.assertRaises(LookUpError):
-            Person.objects.only('settings.notexist')
-
-        # Test existing attribute
-        self.assertEqual(Person.objects(settings__foo1='bar1').first().id, p1.id)
-        self.assertEqual(Person.objects(settings__foo2='bar2').first().id, p2.id)
-
-    def test_query_generic_embedded_document_attribute_with_inheritance(self):
-        class BaseSettings(EmbeddedDocument):
-            meta = {'allow_inheritance': True}
-            base_foo = StringField()
-
-        class AdminSettings(BaseSettings):
-            sub_foo = StringField()
-
-        class Person(Document):
-            settings = GenericEmbeddedDocumentField(choices=[BaseSettings])
-
-        Person.drop_collection()
-
-        p = Person(settings=AdminSettings(base_foo='basefoo', sub_foo='subfoo'))
-        p.save()
-
-        # Test non exiting attribute
-        with self.assertRaises(InvalidQueryError) as ctx_err:
-            self.assertEqual(Person.objects(settings__notexist='bar').first().id, p.id)
-        self.assertEqual(unicode(ctx_err.exception), u'Cannot resolve field "notexist"')
-
-        # Test existing attribute
-        self.assertEqual(Person.objects(settings__base_foo='basefoo').first().id, p.id)
-        self.assertEqual(Person.objects(settings__sub_foo='subfoo').first().id, p.id)

tests/fields/test_float_field.py

@@ -1,58 +0,0 @@
-# -*- coding: utf-8 -*-
-import six
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestFloatField(MongoDBTestCase):
-
-    def test_float_ne_operator(self):
-        class TestDocument(Document):
-            float_fld = FloatField()
-
-        TestDocument.drop_collection()
-
-        TestDocument(float_fld=None).save()
-        TestDocument(float_fld=1).save()
-
-        self.assertEqual(1, TestDocument.objects(float_fld__ne=None).count())
-        self.assertEqual(1, TestDocument.objects(float_fld__ne=1).count())
-
-    def test_validation(self):
-        """Ensure that invalid values cannot be assigned to float fields.
-        """
-        class Person(Document):
-            height = FloatField(min_value=0.1, max_value=3.5)
-
-        class BigPerson(Document):
-            height = FloatField()
-
-        person = Person()
-        person.height = 1.89
-        person.validate()
-
-        person.height = '2.0'
-        self.assertRaises(ValidationError, person.validate)
-
-        person.height = 0.01
-        self.assertRaises(ValidationError, person.validate)
-
-        person.height = 4.0
-        self.assertRaises(ValidationError, person.validate)
-
-        person_2 = Person(height='something invalid')
-        self.assertRaises(ValidationError, person_2.validate)
-
-        big_person = BigPerson()
-
-        for value, value_type in enumerate(six.integer_types):
-            big_person.height = value_type(value)
-            big_person.validate()
-
-        big_person.height = 2 ** 500
-        big_person.validate()
-
-        big_person.height = 2 ** 100000  # Too big for a float value
-        self.assertRaises(ValidationError, big_person.validate)

tests/fields/test_int_field.py

@@ -1,42 +0,0 @@
-# -*- coding: utf-8 -*-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestIntField(MongoDBTestCase):
-
-    def test_int_validation(self):
-        """Ensure that invalid values cannot be assigned to int fields.
-        """
-        class Person(Document):
-            age = IntField(min_value=0, max_value=110)
-
-        person = Person()
-        person.age = 0
-        person.validate()
-
-        person.age = 50
-        person.validate()
-
-        person.age = 110
-        person.validate()
-
-        person.age = -1
-        self.assertRaises(ValidationError, person.validate)
-        person.age = 120
-        self.assertRaises(ValidationError, person.validate)
-        person.age = 'ten'
-        self.assertRaises(ValidationError, person.validate)
-
-    def test_ne_operator(self):
-        class TestDocument(Document):
-            int_fld = IntField()
-
-        TestDocument.drop_collection()
-
-        TestDocument(int_fld=None).save()
-        TestDocument(int_fld=1).save()
-
-        self.assertEqual(1, TestDocument.objects(int_fld__ne=None).count())
-        self.assertEqual(1, TestDocument.objects(int_fld__ne=1).count())

tests/fields/test_lazy_reference_field.py

@@ -1,570 +0,0 @@
-# -*- coding: utf-8 -*-
-from bson import DBRef, ObjectId
-
-from mongoengine import *
-from mongoengine.base import LazyReference
-
-from tests.utils import MongoDBTestCase
-
-
-class TestLazyReferenceField(MongoDBTestCase):
-    def test_lazy_reference_config(self):
-        # Make sure ReferenceField only accepts a document class or a string
-        # with a document class name.
-        self.assertRaises(ValidationError, LazyReferenceField, EmbeddedDocument)
-
-    def test___repr__(self):
-        class Animal(Document):
-            pass
-
-        class Ocurrence(Document):
-            animal = LazyReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal = Animal()
-        oc = Ocurrence(animal=animal)
-        self.assertIn('LazyReference', repr(oc.animal))
-
-    def test___getattr___unknown_attr_raises_attribute_error(self):
-        class Animal(Document):
-            pass
-
-        class Ocurrence(Document):
-            animal = LazyReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal = Animal().save()
-        oc = Ocurrence(animal=animal)
-        with self.assertRaises(AttributeError):
-            oc.animal.not_exist
-
-    def test_lazy_reference_simple(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = LazyReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        Ocurrence(person="test", animal=animal).save()
-        p = Ocurrence.objects.get()
-        self.assertIsInstance(p.animal, LazyReference)
-        fetched_animal = p.animal.fetch()
-        self.assertEqual(fetched_animal, animal)
-        # `fetch` keep cache on referenced document by default...
-        animal.tag = "not so heavy"
-        animal.save()
-        double_fetch = p.animal.fetch()
-        self.assertIs(fetched_animal, double_fetch)
-        self.assertEqual(double_fetch.tag, "heavy")
-        # ...unless specified otherwise
-        fetch_force = p.animal.fetch(force=True)
-        self.assertIsNot(fetch_force, fetched_animal)
-        self.assertEqual(fetch_force.tag, "not so heavy")
-
-    def test_lazy_reference_fetch_invalid_ref(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = LazyReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        Ocurrence(person="test", animal=animal).save()
-        animal.delete()
-        p = Ocurrence.objects.get()
-        self.assertIsInstance(p.animal, LazyReference)
-        with self.assertRaises(DoesNotExist):
-            p.animal.fetch()
-
-    def test_lazy_reference_set(self):
-        class Animal(Document):
-            meta = {'allow_inheritance': True}
-
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = LazyReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        class SubAnimal(Animal):
-            nick = StringField()
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        sub_animal = SubAnimal(nick='doggo', name='dog').save()
-        for ref in (
-                animal,
-                animal.pk,
-                DBRef(animal._get_collection_name(), animal.pk),
-                LazyReference(Animal, animal.pk),
-
-                sub_animal,
-                sub_animal.pk,
-                DBRef(sub_animal._get_collection_name(), sub_animal.pk),
-                LazyReference(SubAnimal, sub_animal.pk),
-                ):
-            p = Ocurrence(person="test", animal=ref).save()
-            p.reload()
-            self.assertIsInstance(p.animal, LazyReference)
-            p.animal.fetch()
-
-    def test_lazy_reference_bad_set(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = LazyReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        class BadDoc(Document):
-            pass
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        baddoc = BadDoc().save()
-        for bad in (
-                42,
-                'foo',
-                baddoc,
-                DBRef(baddoc._get_collection_name(), animal.pk),
-                LazyReference(BadDoc, animal.pk)
-                ):
-            with self.assertRaises(ValidationError):
-                p = Ocurrence(person="test", animal=bad).save()
-
-    def test_lazy_reference_query_conversion(self):
-        """Ensure that LazyReferenceFields can be queried using objects and values
-        of the type of the primary key of the referenced object.
-        """
-        class Member(Document):
-            user_num = IntField(primary_key=True)
-
-        class BlogPost(Document):
-            title = StringField()
-            author = LazyReferenceField(Member, dbref=False)
-
-        Member.drop_collection()
-        BlogPost.drop_collection()
-
-        m1 = Member(user_num=1)
-        m1.save()
-        m2 = Member(user_num=2)
-        m2.save()
-
-        post1 = BlogPost(title='post 1', author=m1)
-        post1.save()
-
-        post2 = BlogPost(title='post 2', author=m2)
-        post2.save()
-
-        post = BlogPost.objects(author=m1).first()
-        self.assertEqual(post.id, post1.id)
-
-        post = BlogPost.objects(author=m2).first()
-        self.assertEqual(post.id, post2.id)
-
-        # Same thing by passing a LazyReference instance
-        post = BlogPost.objects(author=LazyReference(Member, m2.pk)).first()
-        self.assertEqual(post.id, post2.id)
-
-    def test_lazy_reference_query_conversion_dbref(self):
-        """Ensure that LazyReferenceFields can be queried using objects and values
-        of the type of the primary key of the referenced object.
-        """
-        class Member(Document):
-            user_num = IntField(primary_key=True)
-
-        class BlogPost(Document):
-            title = StringField()
-            author = LazyReferenceField(Member, dbref=True)
-
-        Member.drop_collection()
-        BlogPost.drop_collection()
-
-        m1 = Member(user_num=1)
-        m1.save()
-        m2 = Member(user_num=2)
-        m2.save()
-
-        post1 = BlogPost(title='post 1', author=m1)
-        post1.save()
-
-        post2 = BlogPost(title='post 2', author=m2)
-        post2.save()
-
-        post = BlogPost.objects(author=m1).first()
-        self.assertEqual(post.id, post1.id)
-
-        post = BlogPost.objects(author=m2).first()
-        self.assertEqual(post.id, post2.id)
-
-        # Same thing by passing a LazyReference instance
-        post = BlogPost.objects(author=LazyReference(Member, m2.pk)).first()
-        self.assertEqual(post.id, post2.id)
-
-    def test_lazy_reference_passthrough(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            animal = LazyReferenceField(Animal, passthrough=False)
-            animal_passthrough = LazyReferenceField(Animal, passthrough=True)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        Ocurrence(animal=animal, animal_passthrough=animal).save()
-        p = Ocurrence.objects.get()
-        self.assertIsInstance(p.animal, LazyReference)
-        with self.assertRaises(KeyError):
-            p.animal['name']
-        with self.assertRaises(AttributeError):
-            p.animal.name
-        self.assertEqual(p.animal.pk, animal.pk)
-
-        self.assertEqual(p.animal_passthrough.name, "Leopard")
-        self.assertEqual(p.animal_passthrough['name'], "Leopard")
-
-        # Should not be able to access referenced document's methods
-        with self.assertRaises(AttributeError):
-            p.animal.save
-        with self.assertRaises(KeyError):
-            p.animal['save']
-
-    def test_lazy_reference_not_set(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = LazyReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        Ocurrence(person='foo').save()
-        p = Ocurrence.objects.get()
-        self.assertIs(p.animal, None)
-
-    def test_lazy_reference_equality(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        Animal.drop_collection()
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        animalref = LazyReference(Animal, animal.pk)
-        self.assertEqual(animal, animalref)
-        self.assertEqual(animalref, animal)
-
-        other_animalref = LazyReference(Animal, ObjectId("54495ad94c934721ede76f90"))
-        self.assertNotEqual(animal, other_animalref)
-        self.assertNotEqual(other_animalref, animal)
-
-    def test_lazy_reference_embedded(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class EmbeddedOcurrence(EmbeddedDocument):
-            in_list = ListField(LazyReferenceField(Animal))
-            direct = LazyReferenceField(Animal)
-
-        class Ocurrence(Document):
-            in_list = ListField(LazyReferenceField(Animal))
-            in_embedded = EmbeddedDocumentField(EmbeddedOcurrence)
-            direct = LazyReferenceField(Animal)
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal1 = Animal('doggo').save()
-        animal2 = Animal('cheeta').save()
-
-        def check_fields_type(occ):
-            self.assertIsInstance(occ.direct, LazyReference)
-            for elem in occ.in_list:
-                self.assertIsInstance(elem, LazyReference)
-            self.assertIsInstance(occ.in_embedded.direct, LazyReference)
-            for elem in occ.in_embedded.in_list:
-                self.assertIsInstance(elem, LazyReference)
-
-        occ = Ocurrence(
-            in_list=[animal1, animal2],
-            in_embedded={'in_list': [animal1, animal2], 'direct': animal1},
-            direct=animal1
-        ).save()
-        check_fields_type(occ)
-        occ.reload()
-        check_fields_type(occ)
-        occ.direct = animal1.id
-        occ.in_list = [animal1.id, animal2.id]
-        occ.in_embedded.direct = animal1.id
-        occ.in_embedded.in_list = [animal1.id, animal2.id]
-        check_fields_type(occ)
-
-
-class TestGenericLazyReferenceField(MongoDBTestCase):
-    def test_generic_lazy_reference_simple(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = GenericLazyReferenceField()
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        Ocurrence(person="test", animal=animal).save()
-        p = Ocurrence.objects.get()
-        self.assertIsInstance(p.animal, LazyReference)
-        fetched_animal = p.animal.fetch()
-        self.assertEqual(fetched_animal, animal)
-        # `fetch` keep cache on referenced document by default...
-        animal.tag = "not so heavy"
-        animal.save()
-        double_fetch = p.animal.fetch()
-        self.assertIs(fetched_animal, double_fetch)
-        self.assertEqual(double_fetch.tag, "heavy")
-        # ...unless specified otherwise
-        fetch_force = p.animal.fetch(force=True)
-        self.assertIsNot(fetch_force, fetched_animal)
-        self.assertEqual(fetch_force.tag, "not so heavy")
-
-    def test_generic_lazy_reference_choices(self):
-        class Animal(Document):
-            name = StringField()
-
-        class Vegetal(Document):
-            name = StringField()
-
-        class Mineral(Document):
-            name = StringField()
-
-        class Ocurrence(Document):
-            living_thing = GenericLazyReferenceField(choices=[Animal, Vegetal])
-            thing = GenericLazyReferenceField()
-
-        Animal.drop_collection()
-        Vegetal.drop_collection()
-        Mineral.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal = Animal(name="Leopard").save()
-        vegetal = Vegetal(name="Oak").save()
-        mineral = Mineral(name="Granite").save()
-
-        occ_animal = Ocurrence(living_thing=animal, thing=animal).save()
-        occ_vegetal = Ocurrence(living_thing=vegetal, thing=vegetal).save()
-        with self.assertRaises(ValidationError):
-            Ocurrence(living_thing=mineral).save()
-
-        occ = Ocurrence.objects.get(living_thing=animal)
-        self.assertEqual(occ, occ_animal)
-        self.assertIsInstance(occ.thing, LazyReference)
-        self.assertIsInstance(occ.living_thing, LazyReference)
-
-        occ.thing = vegetal
-        occ.living_thing = vegetal
-        occ.save()
-
-        occ.thing = mineral
-        occ.living_thing = mineral
-        with self.assertRaises(ValidationError):
-            occ.save()
-
-    def test_generic_lazy_reference_set(self):
-        class Animal(Document):
-            meta = {'allow_inheritance': True}
-
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = GenericLazyReferenceField()
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        class SubAnimal(Animal):
-            nick = StringField()
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        sub_animal = SubAnimal(nick='doggo', name='dog').save()
-        for ref in (
-                animal,
-                LazyReference(Animal, animal.pk),
-                {'_cls': 'Animal', '_ref': DBRef(animal._get_collection_name(), animal.pk)},
-
-                sub_animal,
-                LazyReference(SubAnimal, sub_animal.pk),
-                {'_cls': 'SubAnimal', '_ref': DBRef(sub_animal._get_collection_name(), sub_animal.pk)},
-                ):
-            p = Ocurrence(person="test", animal=ref).save()
-            p.reload()
-            self.assertIsInstance(p.animal, (LazyReference, Document))
-            p.animal.fetch()
-
-    def test_generic_lazy_reference_bad_set(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = GenericLazyReferenceField(choices=['Animal'])
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        class BadDoc(Document):
-            pass
-
-        animal = Animal(name="Leopard", tag="heavy").save()
-        baddoc = BadDoc().save()
-        for bad in (
-                42,
-                'foo',
-                baddoc,
-                LazyReference(BadDoc, animal.pk)
-                ):
-            with self.assertRaises(ValidationError):
-                p = Ocurrence(person="test", animal=bad).save()
-
-    def test_generic_lazy_reference_query_conversion(self):
-        class Member(Document):
-            user_num = IntField(primary_key=True)
-
-        class BlogPost(Document):
-            title = StringField()
-            author = GenericLazyReferenceField()
-
-        Member.drop_collection()
-        BlogPost.drop_collection()
-
-        m1 = Member(user_num=1)
-        m1.save()
-        m2 = Member(user_num=2)
-        m2.save()
-
-        post1 = BlogPost(title='post 1', author=m1)
-        post1.save()
-
-        post2 = BlogPost(title='post 2', author=m2)
-        post2.save()
-
-        post = BlogPost.objects(author=m1).first()
-        self.assertEqual(post.id, post1.id)
-
-        post = BlogPost.objects(author=m2).first()
-        self.assertEqual(post.id, post2.id)
-
-        # Same thing by passing a LazyReference instance
-        post = BlogPost.objects(author=LazyReference(Member, m2.pk)).first()
-        self.assertEqual(post.id, post2.id)
-
-    def test_generic_lazy_reference_not_set(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = GenericLazyReferenceField()
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        Ocurrence(person='foo').save()
-        p = Ocurrence.objects.get()
-        self.assertIs(p.animal, None)
-
-    def test_generic_lazy_reference_accepts_string_instead_of_class(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class Ocurrence(Document):
-            person = StringField()
-            animal = GenericLazyReferenceField('Animal')
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal = Animal().save()
-        Ocurrence(animal=animal).save()
-        p = Ocurrence.objects.get()
-        self.assertEqual(p.animal, animal)
-
-    def test_generic_lazy_reference_embedded(self):
-        class Animal(Document):
-            name = StringField()
-            tag = StringField()
-
-        class EmbeddedOcurrence(EmbeddedDocument):
-            in_list = ListField(GenericLazyReferenceField())
-            direct = GenericLazyReferenceField()
-
-        class Ocurrence(Document):
-            in_list = ListField(GenericLazyReferenceField())
-            in_embedded = EmbeddedDocumentField(EmbeddedOcurrence)
-            direct = GenericLazyReferenceField()
-
-        Animal.drop_collection()
-        Ocurrence.drop_collection()
-
-        animal1 = Animal('doggo').save()
-        animal2 = Animal('cheeta').save()
-
-        def check_fields_type(occ):
-            self.assertIsInstance(occ.direct, LazyReference)
-            for elem in occ.in_list:
-                self.assertIsInstance(elem, LazyReference)
-            self.assertIsInstance(occ.in_embedded.direct, LazyReference)
-            for elem in occ.in_embedded.in_list:
-                self.assertIsInstance(elem, LazyReference)
-
-        occ = Ocurrence(
-            in_list=[animal1, animal2],
-            in_embedded={'in_list': [animal1, animal2], 'direct': animal1},
-            direct=animal1
-        ).save()
-        check_fields_type(occ)
-        occ.reload()
-        check_fields_type(occ)
-        animal1_ref = {'_cls': 'Animal', '_ref': DBRef(animal1._get_collection_name(), animal1.pk)}
-        animal2_ref = {'_cls': 'Animal', '_ref': DBRef(animal2._get_collection_name(), animal2.pk)}
-        occ.direct = animal1_ref
-        occ.in_list = [animal1_ref, animal2_ref]
-        occ.in_embedded.direct = animal1_ref
-        occ.in_embedded.in_list = [animal1_ref, animal2_ref]
-        check_fields_type(occ)

tests/fields/test_long_field.py

@@ -1,56 +0,0 @@
-# -*- coding: utf-8 -*-
-import six
-
-try:
-    from bson.int64 import Int64
-except ImportError:
-    Int64 = long
-
-from mongoengine import *
-from mongoengine.connection import get_db
-
-from tests.utils import MongoDBTestCase
-
-
-class TestLongField(MongoDBTestCase):
-
-    def test_long_field_is_considered_as_int64(self):
-        """
-        Tests that long fields are stored as long in mongo, even if long
-        value is small enough to be an int.
-        """
-        class TestLongFieldConsideredAsInt64(Document):
-            some_long = LongField()
-
-        doc = TestLongFieldConsideredAsInt64(some_long=42).save()
-        db = get_db()
-        self.assertIsInstance(db.test_long_field_considered_as_int64.find()[0]['some_long'], Int64)
-        self.assertIsInstance(doc.some_long, six.integer_types)
-
-    def test_long_validation(self):
-        """Ensure that invalid values cannot be assigned to long fields.
-        """
-        class TestDocument(Document):
-            value = LongField(min_value=0, max_value=110)
-
-        doc = TestDocument()
-        doc.value = 50
-        doc.validate()
-
-        doc.value = -1
-        self.assertRaises(ValidationError, doc.validate)
-        doc.value = 120
-        self.assertRaises(ValidationError, doc.validate)
-        doc.value = 'ten'
-        self.assertRaises(ValidationError, doc.validate)
-
-    def test_long_ne_operator(self):
-        class TestDocument(Document):
-            long_fld = LongField()
-
-        TestDocument.drop_collection()
-
-        TestDocument(long_fld=None).save()
-        TestDocument(long_fld=1).save()
-
-        self.assertEqual(1, TestDocument.objects(long_fld__ne=None).count())

tests/fields/test_map_field.py

@@ -1,144 +0,0 @@
-# -*- coding: utf-8 -*-
-import datetime
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestMapField(MongoDBTestCase):
-
-    def test_mapfield(self):
-        """Ensure that the MapField handles the declared type."""
-        class Simple(Document):
-            mapping = MapField(IntField())
-
-        Simple.drop_collection()
-
-        e = Simple()
-        e.mapping['someint'] = 1
-        e.save()
-
-        with self.assertRaises(ValidationError):
-            e.mapping['somestring'] = "abc"
-            e.save()
-
-        with self.assertRaises(ValidationError):
-            class NoDeclaredType(Document):
-                mapping = MapField()
-
-    def test_complex_mapfield(self):
-        """Ensure that the MapField can handle complex declared types."""
-
-        class SettingBase(EmbeddedDocument):
-            meta = {"allow_inheritance": True}
-
-        class StringSetting(SettingBase):
-            value = StringField()
-
-        class IntegerSetting(SettingBase):
-            value = IntField()
-
-        class Extensible(Document):
-            mapping = MapField(EmbeddedDocumentField(SettingBase))
-
-        Extensible.drop_collection()
-
-        e = Extensible()
-        e.mapping['somestring'] = StringSetting(value='foo')
-        e.mapping['someint'] = IntegerSetting(value=42)
-        e.save()
-
-        e2 = Extensible.objects.get(id=e.id)
-        self.assertIsInstance(e2.mapping['somestring'], StringSetting)
-        self.assertIsInstance(e2.mapping['someint'], IntegerSetting)
-
-        with self.assertRaises(ValidationError):
-            e.mapping['someint'] = 123
-            e.save()
-
-    def test_embedded_mapfield_db_field(self):
-        class Embedded(EmbeddedDocument):
-            number = IntField(default=0, db_field='i')
-
-        class Test(Document):
-            my_map = MapField(field=EmbeddedDocumentField(Embedded),
-                              db_field='x')
-
-        Test.drop_collection()
-
-        test = Test()
-        test.my_map['DICTIONARY_KEY'] = Embedded(number=1)
-        test.save()
-
-        Test.objects.update_one(inc__my_map__DICTIONARY_KEY__number=1)
-
-        test = Test.objects.get()
-        self.assertEqual(test.my_map['DICTIONARY_KEY'].number, 2)
-        doc = self.db.test.find_one()
-        self.assertEqual(doc['x']['DICTIONARY_KEY']['i'], 2)
-
-    def test_mapfield_numerical_index(self):
-        """Ensure that MapField accept numeric strings as indexes."""
-
-        class Embedded(EmbeddedDocument):
-            name = StringField()
-
-        class Test(Document):
-            my_map = MapField(EmbeddedDocumentField(Embedded))
-
-        Test.drop_collection()
-
-        test = Test()
-        test.my_map['1'] = Embedded(name='test')
-        test.save()
-        test.my_map['1'].name = 'test updated'
-        test.save()
-
-    def test_map_field_lookup(self):
-        """Ensure MapField lookups succeed on Fields without a lookup
-        method.
-        """
-
-        class Action(EmbeddedDocument):
-            operation = StringField()
-            object = StringField()
-
-        class Log(Document):
-            name = StringField()
-            visited = MapField(DateTimeField())
-            actions = MapField(EmbeddedDocumentField(Action))
-
-        Log.drop_collection()
-        Log(name="wilson", visited={'friends': datetime.datetime.now()},
-            actions={'friends': Action(operation='drink', object='beer')}).save()
-
-        self.assertEqual(1, Log.objects(
-            visited__friends__exists=True).count())
-
-        self.assertEqual(1, Log.objects(
-            actions__friends__operation='drink',
-            actions__friends__object='beer').count())
-
-    def test_map_field_unicode(self):
-        class Info(EmbeddedDocument):
-            description = StringField()
-            value_list = ListField(field=StringField())
-
-        class BlogPost(Document):
-            info_dict = MapField(field=EmbeddedDocumentField(Info))
-
-        BlogPost.drop_collection()
-
-        tree = BlogPost(info_dict={
-            u"éééé": {
-                'description': u"VALUE: éééé"
-            }
-        })
-
-        tree.save()
-
-        self.assertEqual(
-            BlogPost.objects.get(id=tree.id).info_dict[u"éééé"].description,
-            u"VALUE: éééé"
-        )

tests/fields/test_reference_field.py

@@ -1,219 +0,0 @@
-# -*- coding: utf-8 -*-
-from bson import SON, DBRef
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestReferenceField(MongoDBTestCase):
-    def test_reference_validation(self):
-        """Ensure that invalid document objects cannot be assigned to
-        reference fields.
-        """
-
-        class User(Document):
-            name = StringField()
-
-        class BlogPost(Document):
-            content = StringField()
-            author = ReferenceField(User)
-
-        User.drop_collection()
-        BlogPost.drop_collection()
-
-        # Make sure ReferenceField only accepts a document class or a string
-        # with a document class name.
-        self.assertRaises(ValidationError, ReferenceField, EmbeddedDocument)
-
-        user = User(name='Test User')
-
-        # Ensure that the referenced object must have been saved
-        post1 = BlogPost(content='Chips and gravy taste good.')
-        post1.author = user
-        self.assertRaises(ValidationError, post1.save)
-
-        # Check that an invalid object type cannot be used
-        post2 = BlogPost(content='Chips and chilli taste good.')
-        post1.author = post2
-        self.assertRaises(ValidationError, post1.validate)
-
-        # Ensure ObjectID's are accepted as references
-        user_object_id = user.pk
-        post3 = BlogPost(content="Chips and curry sauce taste good.")
-        post3.author = user_object_id
-        post3.save()
-
-        # Make sure referencing a saved document of the right type works
-        user.save()
-        post1.author = user
-        post1.save()
-
-        # Make sure referencing a saved document of the *wrong* type fails
-        post2.save()
-        post1.author = post2
-        self.assertRaises(ValidationError, post1.validate)
-
-    def test_objectid_reference_fields(self):
-        """Make sure storing Object ID references works."""
-
-        class Person(Document):
-            name = StringField()
-            parent = ReferenceField('self')
-
-        Person.drop_collection()
-
-        p1 = Person(name="John").save()
-        Person(name="Ross", parent=p1.pk).save()
-
-        p = Person.objects.get(name="Ross")
-        self.assertEqual(p.parent, p1)
-
-    def test_dbref_reference_fields(self):
-        """Make sure storing references as bson.dbref.DBRef works."""
-
-        class Person(Document):
-            name = StringField()
-            parent = ReferenceField('self', dbref=True)
-
-        Person.drop_collection()
-
-        p1 = Person(name="John").save()
-        Person(name="Ross", parent=p1).save()
-
-        self.assertEqual(
-            Person._get_collection().find_one({'name': 'Ross'})['parent'],
-            DBRef('person', p1.pk)
-        )
-
-        p = Person.objects.get(name="Ross")
-        self.assertEqual(p.parent, p1)
-
-    def test_dbref_to_mongo(self):
-        """Make sure that calling to_mongo on a ReferenceField which
-        has dbref=False, but actually actually contains a DBRef returns
-        an ID of that DBRef.
-        """
-
-        class Person(Document):
-            name = StringField()
-            parent = ReferenceField('self', dbref=False)
-
-        p = Person(
-            name='Steve',
-            parent=DBRef('person', 'abcdefghijklmnop')
-        )
-        self.assertEqual(p.to_mongo(), SON([
-            ('name', u'Steve'),
-            ('parent', 'abcdefghijklmnop')
-        ]))
-
-    def test_objectid_reference_fields(self):
-        class Person(Document):
-            name = StringField()
-            parent = ReferenceField('self', dbref=False)
-
-        Person.drop_collection()
-
-        p1 = Person(name="John").save()
-        Person(name="Ross", parent=p1).save()
-
-        col = Person._get_collection()
-        data = col.find_one({'name': 'Ross'})
-        self.assertEqual(data['parent'], p1.pk)
-
-        p = Person.objects.get(name="Ross")
-        self.assertEqual(p.parent, p1)
-
-    def test_undefined_reference(self):
-        """Ensure that ReferenceFields may reference undefined Documents.
-        """
-        class Product(Document):
-            name = StringField()
-            company = ReferenceField('Company')
-
-        class Company(Document):
-            name = StringField()
-
-        Product.drop_collection()
-        Company.drop_collection()
-
-        ten_gen = Company(name='10gen')
-        ten_gen.save()
-        mongodb = Product(name='MongoDB', company=ten_gen)
-        mongodb.save()
-
-        me = Product(name='MongoEngine')
-        me.save()
-
-        obj = Product.objects(company=ten_gen).first()
-        self.assertEqual(obj, mongodb)
-        self.assertEqual(obj.company, ten_gen)
-
-        obj = Product.objects(company=None).first()
-        self.assertEqual(obj, me)
-
-        obj = Product.objects.get(company=None)
-        self.assertEqual(obj, me)
-
-    def test_reference_query_conversion(self):
-        """Ensure that ReferenceFields can be queried using objects and values
-        of the type of the primary key of the referenced object.
-        """
-        class Member(Document):
-            user_num = IntField(primary_key=True)
-
-        class BlogPost(Document):
-            title = StringField()
-            author = ReferenceField(Member, dbref=False)
-
-        Member.drop_collection()
-        BlogPost.drop_collection()
-
-        m1 = Member(user_num=1)
-        m1.save()
-        m2 = Member(user_num=2)
-        m2.save()
-
-        post1 = BlogPost(title='post 1', author=m1)
-        post1.save()
-
-        post2 = BlogPost(title='post 2', author=m2)
-        post2.save()
-
-        post = BlogPost.objects(author=m1).first()
-        self.assertEqual(post.id, post1.id)
-
-        post = BlogPost.objects(author=m2).first()
-        self.assertEqual(post.id, post2.id)
-
-    def test_reference_query_conversion_dbref(self):
-        """Ensure that ReferenceFields can be queried using objects and values
-        of the type of the primary key of the referenced object.
-        """
-        class Member(Document):
-            user_num = IntField(primary_key=True)
-
-        class BlogPost(Document):
-            title = StringField()
-            author = ReferenceField(Member, dbref=True)
-
-        Member.drop_collection()
-        BlogPost.drop_collection()
-
-        m1 = Member(user_num=1)
-        m1.save()
-        m2 = Member(user_num=2)
-        m2.save()
-
-        post1 = BlogPost(title='post 1', author=m1)
-        post1.save()
-
-        post2 = BlogPost(title='post 2', author=m2)
-        post2.save()
-
-        post = BlogPost.objects(author=m1).first()
-        self.assertEqual(post.id, post1.id)
-
-        post = BlogPost.objects(author=m2).first()
-        self.assertEqual(post.id, post2.id)

tests/fields/test_sequence_field.py

@@ -1,271 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestSequenceField(MongoDBTestCase):
-    def test_sequence_field(self):
-        class Person(Document):
-            id = SequenceField(primary_key=True)
-            name = StringField()
-
-        self.db['mongoengine.counters'].drop()
-        Person.drop_collection()
-
-        for x in range(10):
-            Person(name="Person %s" % x).save()
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 10)
-
-        ids = [i.id for i in Person.objects]
-        self.assertEqual(ids, range(1, 11))
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 10)
-
-        Person.id.set_next_value(1000)
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 1000)
-
-    def test_sequence_field_get_next_value(self):
-        class Person(Document):
-            id = SequenceField(primary_key=True)
-            name = StringField()
-
-        self.db['mongoengine.counters'].drop()
-        Person.drop_collection()
-
-        for x in range(10):
-            Person(name="Person %s" % x).save()
-
-        self.assertEqual(Person.id.get_next_value(), 11)
-        self.db['mongoengine.counters'].drop()
-
-        self.assertEqual(Person.id.get_next_value(), 1)
-
-        class Person(Document):
-            id = SequenceField(primary_key=True, value_decorator=str)
-            name = StringField()
-
-        self.db['mongoengine.counters'].drop()
-        Person.drop_collection()
-
-        for x in range(10):
-            Person(name="Person %s" % x).save()
-
-        self.assertEqual(Person.id.get_next_value(), '11')
-        self.db['mongoengine.counters'].drop()
-
-        self.assertEqual(Person.id.get_next_value(), '1')
-
-    def test_sequence_field_sequence_name(self):
-        class Person(Document):
-            id = SequenceField(primary_key=True, sequence_name='jelly')
-            name = StringField()
-
-        self.db['mongoengine.counters'].drop()
-        Person.drop_collection()
-
-        for x in range(10):
-            Person(name="Person %s" % x).save()
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'jelly.id'})
-        self.assertEqual(c['next'], 10)
-
-        ids = [i.id for i in Person.objects]
-        self.assertEqual(ids, range(1, 11))
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'jelly.id'})
-        self.assertEqual(c['next'], 10)
-
-        Person.id.set_next_value(1000)
-        c = self.db['mongoengine.counters'].find_one({'_id': 'jelly.id'})
-        self.assertEqual(c['next'], 1000)
-
-    def test_multiple_sequence_fields(self):
-        class Person(Document):
-            id = SequenceField(primary_key=True)
-            counter = SequenceField()
-            name = StringField()
-
-        self.db['mongoengine.counters'].drop()
-        Person.drop_collection()
-
-        for x in range(10):
-            Person(name="Person %s" % x).save()
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 10)
-
-        ids = [i.id for i in Person.objects]
-        self.assertEqual(ids, range(1, 11))
-
-        counters = [i.counter for i in Person.objects]
-        self.assertEqual(counters, range(1, 11))
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 10)
-
-        Person.id.set_next_value(1000)
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 1000)
-
-        Person.counter.set_next_value(999)
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.counter'})
-        self.assertEqual(c['next'], 999)
-
-    def test_sequence_fields_reload(self):
-        class Animal(Document):
-            counter = SequenceField()
-            name = StringField()
-
-        self.db['mongoengine.counters'].drop()
-        Animal.drop_collection()
-
-        a = Animal(name="Boi").save()
-
-        self.assertEqual(a.counter, 1)
-        a.reload()
-        self.assertEqual(a.counter, 1)
-
-        a.counter = None
-        self.assertEqual(a.counter, 2)
-        a.save()
-
-        self.assertEqual(a.counter, 2)
-
-        a = Animal.objects.first()
-        self.assertEqual(a.counter, 2)
-        a.reload()
-        self.assertEqual(a.counter, 2)
-
-    def test_multiple_sequence_fields_on_docs(self):
-        class Animal(Document):
-            id = SequenceField(primary_key=True)
-            name = StringField()
-
-        class Person(Document):
-            id = SequenceField(primary_key=True)
-            name = StringField()
-
-        self.db['mongoengine.counters'].drop()
-        Animal.drop_collection()
-        Person.drop_collection()
-
-        for x in range(10):
-            Animal(name="Animal %s" % x).save()
-            Person(name="Person %s" % x).save()
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 10)
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'animal.id'})
-        self.assertEqual(c['next'], 10)
-
-        ids = [i.id for i in Person.objects]
-        self.assertEqual(ids, range(1, 11))
-
-        id = [i.id for i in Animal.objects]
-        self.assertEqual(id, range(1, 11))
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 10)
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'animal.id'})
-        self.assertEqual(c['next'], 10)
-
-    def test_sequence_field_value_decorator(self):
-        class Person(Document):
-            id = SequenceField(primary_key=True, value_decorator=str)
-            name = StringField()
-
-        self.db['mongoengine.counters'].drop()
-        Person.drop_collection()
-
-        for x in range(10):
-            p = Person(name="Person %s" % x)
-            p.save()
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 10)
-
-        ids = [i.id for i in Person.objects]
-        self.assertEqual(ids, map(str, range(1, 11)))
-
-        c = self.db['mongoengine.counters'].find_one({'_id': 'person.id'})
-        self.assertEqual(c['next'], 10)
-
-    def test_embedded_sequence_field(self):
-        class Comment(EmbeddedDocument):
-            id = SequenceField()
-            content = StringField(required=True)
-
-        class Post(Document):
-            title = StringField(required=True)
-            comments = ListField(EmbeddedDocumentField(Comment))
-
-        self.db['mongoengine.counters'].drop()
-        Post.drop_collection()
-
-        Post(title="MongoEngine",
-             comments=[Comment(content="NoSQL Rocks"),
-                       Comment(content="MongoEngine Rocks")]).save()
-        c = self.db['mongoengine.counters'].find_one({'_id': 'comment.id'})
-        self.assertEqual(c['next'], 2)
-        post = Post.objects.first()
-        self.assertEqual(1, post.comments[0].id)
-        self.assertEqual(2, post.comments[1].id)
-
-    def test_inherited_sequencefield(self):
-        class Base(Document):
-            name = StringField()
-            counter = SequenceField()
-            meta = {'abstract': True}
-
-        class Foo(Base):
-            pass
-
-        class Bar(Base):
-            pass
-
-        bar = Bar(name='Bar')
-        bar.save()
-
-        foo = Foo(name='Foo')
-        foo.save()
-
-        self.assertTrue('base.counter' in
-                        self.db['mongoengine.counters'].find().distinct('_id'))
-        self.assertFalse(('foo.counter' or 'bar.counter') in
-                         self.db['mongoengine.counters'].find().distinct('_id'))
-        self.assertNotEqual(foo.counter, bar.counter)
-        self.assertEqual(foo._fields['counter'].owner_document, Base)
-        self.assertEqual(bar._fields['counter'].owner_document, Base)
-
-    def test_no_inherited_sequencefield(self):
-        class Base(Document):
-            name = StringField()
-            meta = {'abstract': True}
-
-        class Foo(Base):
-            counter = SequenceField()
-
-        class Bar(Base):
-            counter = SequenceField()
-
-        bar = Bar(name='Bar')
-        bar.save()
-
-        foo = Foo(name='Foo')
-        foo.save()
-
-        self.assertFalse('base.counter' in
-                         self.db['mongoengine.counters'].find().distinct('_id'))
-        self.assertTrue(('foo.counter' and 'bar.counter') in
-                         self.db['mongoengine.counters'].find().distinct('_id'))
-        self.assertEqual(foo.counter, bar.counter)
-        self.assertEqual(foo._fields['counter'].owner_document, Foo)
-        self.assertEqual(bar._fields['counter'].owner_document, Bar)

tests/fields/test_url_field.py

@@ -1,59 +0,0 @@
-# -*- coding: utf-8 -*-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase
-
-
-class TestURLField(MongoDBTestCase):
-
-    def test_validation(self):
-        """Ensure that URLFields validate urls properly."""
-        class Link(Document):
-            url = URLField()
-
-        link = Link()
-        link.url = 'google'
-        self.assertRaises(ValidationError, link.validate)
-
-        link.url = 'http://www.google.com:8080'
-        link.validate()
-
-    def test_unicode_url_validation(self):
-        """Ensure unicode URLs are validated properly."""
-        class Link(Document):
-            url = URLField()
-
-        link = Link()
-        link.url = u'http://привет.com'
-
-        # TODO fix URL validation - this *IS* a valid URL
-        # For now we just want to make sure that the error message is correct
-        with self.assertRaises(ValidationError) as ctx_err:
-            link.validate()
-        self.assertEqual(unicode(ctx_err.exception),
-                         u"ValidationError (Link:None) (Invalid URL: http://\u043f\u0440\u0438\u0432\u0435\u0442.com: ['url'])")
-
-    def test_url_scheme_validation(self):
-        """Ensure that URLFields validate urls with specific schemes properly.
-        """
-        class Link(Document):
-            url = URLField()
-
-        class SchemeLink(Document):
-            url = URLField(schemes=['ws', 'irc'])
-
-        link = Link()
-        link.url = 'ws://google.com'
-        self.assertRaises(ValidationError, link.validate)
-
-        scheme_link = SchemeLink()
-        scheme_link.url = 'ws://google.com'
-        scheme_link.validate()
-
-    def test_underscore_allowed_in_domains_names(self):
-        class Link(Document):
-            url = URLField()
-
-        link = Link()
-        link.url = 'https://san_leandro-ca.geebo.com'
-        link.validate()

tests/fields/test_uuid_field.py

@@ -1,65 +0,0 @@
-# -*- coding: utf-8 -*-
-import uuid
-
-from mongoengine import *
-
-from tests.utils import MongoDBTestCase, get_as_pymongo
-
-
-class Person(Document):
-    api_key = UUIDField(binary=False)
-
-
-class TestUUIDField(MongoDBTestCase):
-    def test_storage(self):
-        uid = uuid.uuid4()
-        person = Person(api_key=uid).save()
-        self.assertEqual(
-            get_as_pymongo(person),
-            {'_id': person.id,
-             'api_key': str(uid)
-             }
-            )
-
-    def test_field_string(self):
-        """Test UUID fields storing as String
-        """
-        Person.drop_collection()
-
-        uu = uuid.uuid4()
-        Person(api_key=uu).save()
-        self.assertEqual(1, Person.objects(api_key=uu).count())
-        self.assertEqual(uu, Person.objects.first().api_key)
-
-        person = Person()
-        valid = (uuid.uuid4(), uuid.uuid1())
-        for api_key in valid:
-            person.api_key = api_key
-            person.validate()
-
-        invalid = ('9d159858-549b-4975-9f98-dd2f987c113g',
-                   '9d159858-549b-4975-9f98-dd2f987c113')
-        for api_key in invalid:
-            person.api_key = api_key
-            self.assertRaises(ValidationError, person.validate)
-
-    def test_field_binary(self):
-        """Test UUID fields storing as Binary object."""
-        Person.drop_collection()
-
-        uu = uuid.uuid4()
-        Person(api_key=uu).save()
-        self.assertEqual(1, Person.objects(api_key=uu).count())
-        self.assertEqual(uu, Person.objects.first().api_key)
-
-        person = Person()
-        valid = (uuid.uuid4(), uuid.uuid1())
-        for api_key in valid:
-            person.api_key = api_key
-            person.validate()
-
-        invalid = ('9d159858-549b-4975-9f98-dd2f987c113g',
-                   '9d159858-549b-4975-9f98-dd2f987c113')
-        for api_key in invalid:
-            person.api_key = api_key
-            self.assertRaises(ValidationError, person.validate)

tests/fixtures.py

@@ -48,7 +48,6 @@ class PickleSignalsTest(Document):
     def post_delete(self, sender, document, **kwargs):
         pickled = pickle.dumps(document)
 
-
 signals.post_save.connect(PickleSignalsTest.post_save, sender=PickleSignalsTest)
 signals.post_delete.connect(PickleSignalsTest.post_delete, sender=PickleSignalsTest)
 

tests/queryset/__init__.py

@@ -1,6 +1,6 @@
-from .transform import *
-from .field_list import *
-from .queryset import *
-from .visitor import *
-from .geo import *
-from .modify import *
+from transform import *
+from field_list import *
+from queryset import *
+from visitor import *
+from geo import *
+from modify import *

tests/queryset/field_list.py

@@ -181,7 +181,7 @@ class OnlyExcludeAllTest(unittest.TestCase):
         employee.save()
 
         obj = self.Person.objects(id=employee.id).only('age').get()
-        self.assertIsInstance(obj, Employee)
+        self.assertTrue(isinstance(obj, Employee))
 
         # Check field names are looked up properly
         obj = Employee.objects(id=employee.id).only('salary').get()
@@ -197,18 +197,14 @@ class OnlyExcludeAllTest(unittest.TestCase):
             title = StringField()
             text = StringField()
 
-        class VariousData(EmbeddedDocument):
-            some = BooleanField()
-
         class BlogPost(Document):
             content = StringField()
             author = EmbeddedDocumentField(User)
             comments = ListField(EmbeddedDocumentField(Comment))
-            various = MapField(field=EmbeddedDocumentField(VariousData))
 
         BlogPost.drop_collection()
 
-        post = BlogPost(content='Had a good coffee today...', various={'test_dynamic': {'some': True}})
+        post = BlogPost(content='Had a good coffee today...')
         post.author = User(name='Test User')
         post.comments = [Comment(title='I aggree', text='Great post!'), Comment(title='Coffee', text='I hate coffee')]
         post.save()
@@ -219,9 +215,6 @@ class OnlyExcludeAllTest(unittest.TestCase):
         self.assertEqual(obj.author.name, 'Test User')
         self.assertEqual(obj.comments, [])
 
-        obj = BlogPost.objects.only('various.test_dynamic.some').get()
-        self.assertEqual(obj.various["test_dynamic"].some, True)
-
         obj = BlogPost.objects.only('content', 'comments.title',).get()
         self.assertEqual(obj.content, 'Had a good coffee today...')
         self.assertEqual(obj.author, None)
@@ -413,6 +406,7 @@ class OnlyExcludeAllTest(unittest.TestCase):
         numbers = Numbers.objects.fields(embedded__n={"$slice": [-5, 10]}).get()
         self.assertEqual(numbers.embedded.n, [-5, -4, -3, -2, -1])
 
+
     def test_exclude_from_subclasses_docs(self):
 
         class Base(Document):
@@ -435,6 +429,5 @@ class OnlyExcludeAllTest(unittest.TestCase):
 
         self.assertRaises(LookUpError, Base.objects.exclude, "made_up")
 
-
 if __name__ == '__main__':
     unittest.main()

tests/queryset/geo.py

@@ -3,7 +3,7 @@ import unittest
 
 from mongoengine import *
 
-from tests.utils import MongoDBTestCase
+from tests.utils import MongoDBTestCase, needs_mongodb_v3
 
 
 __all__ = ("GeoQueriesTest",)
@@ -70,6 +70,9 @@ class GeoQueriesTest(MongoDBTestCase):
         self.assertEqual(events.count(), 1)
         self.assertEqual(events[0], event2)
 
+    # $minDistance was added in MongoDB v2.6, but continued being buggy
+    # until v3.0; skip for older versions
+    @needs_mongodb_v3
     def test_near_and_min_distance(self):
         """Ensure the "min_distance" operator works alongside the "near"
         operator.
@@ -92,9 +95,9 @@ class GeoQueriesTest(MongoDBTestCase):
             location__within_distance=point_and_distance)
         self.assertEqual(events.count(), 2)
         events = list(events)
-        self.assertNotIn(event2, events)
-        self.assertIn(event1, events)
-        self.assertIn(event3, events)
+        self.assertTrue(event2 not in events)
+        self.assertTrue(event1 in events)
+        self.assertTrue(event3 in events)
 
         # find events within 10 degrees of san francisco
         point_and_distance = [[-122.415579, 37.7566023], 10]
@@ -240,6 +243,9 @@ class GeoQueriesTest(MongoDBTestCase):
         events = self.Event.objects(location__geo_within_polygon=polygon2)
         self.assertEqual(events.count(), 0)
 
+    # $minDistance was added in MongoDB v2.6, but continued being buggy
+    # until v3.0; skip for older versions
+    @needs_mongodb_v3
     def test_2dsphere_near_and_min_max_distance(self):
         """Ensure "min_distace" and "max_distance" operators work well
         together with the "near" operator in a 2dsphere index.
@@ -279,9 +285,9 @@ class GeoQueriesTest(MongoDBTestCase):
             location__geo_within_center=point_and_distance)
         self.assertEqual(events.count(), 2)
         events = list(events)
-        self.assertNotIn(event2, events)
-        self.assertIn(event1, events)
-        self.assertIn(event3, events)
+        self.assertTrue(event2 not in events)
+        self.assertTrue(event1 in events)
+        self.assertTrue(event3 in events)
 
     def _test_embedded(self, point_field_class):
         """Helper test method ensuring given point field class works
@@ -322,6 +328,8 @@ class GeoQueriesTest(MongoDBTestCase):
         """Make sure PointField works properly in an embedded document."""
         self._test_embedded(point_field_class=PointField)
 
+    # Needs MongoDB > 2.6.4 https://jira.mongodb.org/browse/SERVER-14039
+    @needs_mongodb_v3
     def test_spherical_geospatial_operators(self):
         """Ensure that spherical geospatial queries are working."""
         class Point(Document):
@@ -502,35 +510,17 @@ class GeoQueriesTest(MongoDBTestCase):
         roads = Road.objects.filter(poly__geo_intersects={"$geometry": polygon}).count()
         self.assertEqual(1, roads)
 
-    def test_aspymongo_with_only(self):
-        """Ensure as_pymongo works with only"""
-        class Place(Document):
-            location = PointField()
-
-        Place.drop_collection()
-        p = Place(location=[24.946861267089844, 60.16311983618494])
-        p.save()
-        qs = Place.objects().only('location')
-        self.assertDictEqual(
-            qs.as_pymongo()[0]['location'],
-            {u'type': u'Point',
-             u'coordinates': [
-                24.946861267089844,
-                60.16311983618494]
-            }
-        )
-
     def test_2dsphere_point_sets_correctly(self):
         class Location(Document):
             loc = PointField()
 
         Location.drop_collection()
 
-        Location(loc=[1, 2]).save()
+        Location(loc=[1,2]).save()
         loc = Location.objects.as_pymongo()[0]
         self.assertEqual(loc["loc"], {"type": "Point", "coordinates": [1, 2]})
 
-        Location.objects.update(set__loc=[2, 1])
+        Location.objects.update(set__loc=[2,1])
         loc = Location.objects.as_pymongo()[0]
         self.assertEqual(loc["loc"], {"type": "Point", "coordinates": [2, 1]})
 

tests/queryset/modify.py

@@ -1,6 +1,6 @@
 import unittest
 
-from mongoengine import connect, Document, IntField, StringField, ListField
+from mongoengine import connect, Document, IntField
 
 __all__ = ("FindAndModifyTest",)
 
@@ -94,36 +94,6 @@ class FindAndModifyTest(unittest.TestCase):
         self.assertEqual(old_doc.to_mongo(), {"_id": 1})
         self.assertDbEqual([{"_id": 0, "value": 0}, {"_id": 1, "value": -1}])
 
-    def test_modify_with_push(self):
-        class BlogPost(Document):
-            tags = ListField(StringField())
-
-        BlogPost.drop_collection()
-
-        blog = BlogPost.objects.create()
-
-        # Push a new tag via modify with new=False (default).
-        BlogPost(id=blog.id).modify(push__tags='code')
-        self.assertEqual(blog.tags, [])
-        blog.reload()
-        self.assertEqual(blog.tags, ['code'])
-
-        # Push a new tag via modify with new=True.
-        blog = BlogPost.objects(id=blog.id).modify(push__tags='java', new=True)
-        self.assertEqual(blog.tags, ['code', 'java'])
-
-        # Push a new tag with a positional argument.
-        blog = BlogPost.objects(id=blog.id).modify(
-            push__tags__0='python',
-            new=True)
-        self.assertEqual(blog.tags, ['python', 'code', 'java'])
-
-        # Push multiple new tags with a positional argument.
-        blog = BlogPost.objects(id=blog.id).modify(
-            push__tags__1=['go', 'rust'],
-            new=True)
-        self.assertEqual(blog.tags, ['python', 'go', 'rust', 'code', 'java'])
-
 
 if __name__ == '__main__':
     unittest.main()

tests/queryset/pickable.py

@@ -6,12 +6,10 @@ from mongoengine.connection import connect
 
 __author__ = 'stas'
 
-
 class Person(Document):
     name = StringField()
     age = IntField()
 
-
 class TestQuerysetPickable(unittest.TestCase):
     """
     Test for adding pickling support for QuerySet instances
@@ -20,7 +18,7 @@ class TestQuerysetPickable(unittest.TestCase):
     def setUp(self):
         super(TestQuerysetPickable, self).setUp()
 
-        connection = connect(db="test")  # type: pymongo.mongo_client.MongoClient
+        connection = connect(db="test") #type: pymongo.mongo_client.MongoClient
 
         connection.drop_database("test")
 
@@ -29,6 +27,7 @@ class TestQuerysetPickable(unittest.TestCase):
             age=21
         )
 
+
     def test_picke_simple_qs(self):
 
         qs = Person.objects.all()
@@ -47,10 +46,10 @@ class TestQuerysetPickable(unittest.TestCase):
 
         self.assertEqual(qs.count(), loadedQs.count())
 
-        # can update loadedQs
+        #can update loadedQs
         loadedQs.update(age=23)
 
-        # check
+        #check
         self.assertEqual(Person.objects.first().age, 23)
 
     def test_pickle_support_filtration(self):
@@ -71,7 +70,7 @@ class TestQuerysetPickable(unittest.TestCase):
 
         self.assertEqual(loaded.count(), 2)
         self.assertEqual(loaded.filter(name="Bob").first().age, 23)
-
+    
 
 
 

tests/queryset/transform.py

@@ -1,7 +1,5 @@
 import unittest
 
-from bson.son import SON
-
 from mongoengine import *
 from mongoengine.queryset import Q, transform
 
@@ -30,16 +28,12 @@ class TransformTest(unittest.TestCase):
                          {'name': {'$exists': True}})
 
     def test_transform_update(self):
-        class LisDoc(Document):
-            foo = ListField(StringField())
-
         class DicDoc(Document):
             dictField = DictField()
 
         class Doc(Document):
             pass
 
-        LisDoc.drop_collection()
         DicDoc.drop_collection()
         Doc.drop_collection()
 
@@ -48,36 +42,14 @@ class TransformTest(unittest.TestCase):
 
         for k, v in (("set", "$set"), ("set_on_insert", "$setOnInsert"), ("push", "$push")):
             update = transform.update(DicDoc, **{"%s__dictField__test" % k: doc})
-            self.assertIsInstance(update[v]["dictField.test"], dict)
+            self.assertTrue(isinstance(update[v]["dictField.test"], dict))
 
         # Update special cases
         update = transform.update(DicDoc, unset__dictField__test=doc)
         self.assertEqual(update["$unset"]["dictField.test"], 1)
 
         update = transform.update(DicDoc, pull__dictField__test=doc)
-        self.assertIsInstance(update["$pull"]["dictField"]["test"], dict)
-
-        update = transform.update(LisDoc, pull__foo__in=['a'])
-        self.assertEqual(update, {'$pull': {'foo': {'$in': ['a']}}})
-
-    def test_transform_update_push(self):
-        """Ensure the differences in behvaior between 'push' and 'push_all'"""
-        class BlogPost(Document):
-            tags = ListField(StringField())
-
-        update = transform.update(BlogPost, push__tags=['mongo', 'db'])
-        self.assertEqual(update, {'$push': {'tags': ['mongo', 'db']}})
-
-        update = transform.update(BlogPost, push_all__tags=['mongo', 'db'])
-        self.assertEqual(update, {'$push': {'tags': {'$each': ['mongo', 'db']}}})
-
-    def test_transform_update_no_operator_default_to_set(self):
-        """Ensure the differences in behvaior between 'push' and 'push_all'"""
-        class BlogPost(Document):
-            tags = ListField(StringField())
-
-        update = transform.update(BlogPost, tags=['mongo', 'db'])
-        self.assertEqual(update, {'$set': {'tags': ['mongo', 'db']}})
+        self.assertTrue(isinstance(update["$pull"]["dictField"]["test"], dict))
 
     def test_query_field_name(self):
         """Ensure that the correct field name is used when querying.
@@ -96,15 +68,17 @@ class TransformTest(unittest.TestCase):
         post = BlogPost(**data)
         post.save()
 
-        self.assertIn('postTitle', BlogPost.objects(title=data['title'])._query)
+        self.assertTrue('postTitle' in
+                        BlogPost.objects(title=data['title'])._query)
         self.assertFalse('title' in
                          BlogPost.objects(title=data['title'])._query)
         self.assertEqual(BlogPost.objects(title=data['title']).count(), 1)
 
-        self.assertIn('_id', BlogPost.objects(pk=post.id)._query)
+        self.assertTrue('_id' in BlogPost.objects(pk=post.id)._query)
         self.assertEqual(BlogPost.objects(pk=post.id).count(), 1)
 
-        self.assertIn('postComments.commentContent', BlogPost.objects(comments__content='test')._query)
+        self.assertTrue('postComments.commentContent' in
+                        BlogPost.objects(comments__content='test')._query)
         self.assertEqual(BlogPost.objects(comments__content='test').count(), 1)
 
         BlogPost.drop_collection()
@@ -122,8 +96,8 @@ class TransformTest(unittest.TestCase):
         post = BlogPost(**data)
         post.save()
 
-        self.assertIn('_id', BlogPost.objects(pk=data['title'])._query)
-        self.assertIn('_id', BlogPost.objects(title=data['title'])._query)
+        self.assertTrue('_id' in BlogPost.objects(pk=data['title'])._query)
+        self.assertTrue('_id' in BlogPost.objects(title=data['title'])._query)
         self.assertEqual(BlogPost.objects(pk=data['title']).count(), 1)
 
         BlogPost.drop_collection()
@@ -267,35 +241,6 @@ class TransformTest(unittest.TestCase):
         with self.assertRaises(InvalidQueryError):
             events.count()
 
-    def test_update_pull_for_list_fields(self):
-        """
-        Test added to check pull operation in update for
-        EmbeddedDocumentListField which is inside a EmbeddedDocumentField
-        """
-        class Word(EmbeddedDocument):
-            word = StringField()
-            index = IntField()
-
-        class SubDoc(EmbeddedDocument):
-            heading = ListField(StringField())
-            text = EmbeddedDocumentListField(Word)
-
-        class MainDoc(Document):
-            title = StringField()
-            content = EmbeddedDocumentField(SubDoc)
-
-        word = Word(word='abc', index=1)
-        update = transform.update(MainDoc, pull__content__text=word)
-        self.assertEqual(update, {'$pull': {'content.text': SON([('word', u'abc'), ('index', 1)])}})
-
-        update = transform.update(MainDoc, pull__content__heading='xyz')
-        self.assertEqual(update, {'$pull': {'content.heading': 'xyz'}})
-
-        update = transform.update(MainDoc, pull__content__text__word__in=['foo', 'bar'])
-        self.assertEqual(update, {'$pull': {'content.text': {'word': {'$in': ['foo', 'bar']}}}})
-
-        update = transform.update(MainDoc, pull__content__text__word__nin=['foo', 'bar'])
-        self.assertEqual(update, {'$pull': {'content.text': {'word': {'$nin': ['foo', 'bar']}}}})
 
 if __name__ == '__main__':
     unittest.main()

tests/queryset/visitor.py

@@ -196,7 +196,7 @@ class QTest(unittest.TestCase):
 
         test2 = test.clone()
         self.assertEqual(test2.count(), 3)
-        self.assertNotEqual(test2, test)
+        self.assertFalse(test2 == test)
 
         test3 = test2.filter(x=6)
         self.assertEqual(test3.count(), 1)
@@ -275,6 +275,7 @@ class QTest(unittest.TestCase):
         with self.assertRaises(InvalidQueryError):
             self.Person.objects.filter('user1')
 
+
     def test_q_regex(self):
         """Ensure that Q objects can be queried using regexes.
         """
@@ -295,18 +296,6 @@ class QTest(unittest.TestCase):
         obj = self.Person.objects(Q(name__not=re.compile('^Gui'))).first()
         self.assertEqual(obj, None)
 
-    def test_q_repr(self):
-        self.assertEqual(repr(Q()), 'Q(**{})')
-        self.assertEqual(repr(Q(name='test')), "Q(**{'name': 'test'})")
-
-        self.assertEqual(
-            repr(Q(name='test') & Q(age__gte=18)),
-            "(Q(**{'name': 'test'}) & Q(**{'age__gte': 18}))")
-
-        self.assertEqual(
-            repr(Q(name='test') | Q(age__gte=18)),
-            "(Q(**{'name': 'test'}) | Q(**{'age__gte': 18}))")
-
     def test_q_lists(self):
         """Ensure that Q objects query ListFields correctly.
         """

tests/test_common.py

@@ -1,15 +0,0 @@
-import unittest
-
-from mongoengine.common import _import_class
-from mongoengine import Document
-
-
-class TestCommon(unittest.TestCase):
-
-    def test__import_class(self):
-        doc_cls = _import_class("Document")
-        self.assertIs(doc_cls, Document)
-
-    def test__import_class_raise_if_not_known(self):
-        with self.assertRaises(ValueError):
-            _import_class("UnknownClass")

tests/test_connection.py

@@ -1,8 +1,5 @@
 import datetime
-
-from pymongo import MongoClient
-from pymongo.errors import OperationFailure, InvalidName
-from pymongo import ReadPreference
+from pymongo.errors import OperationFailure
 
 try:
     import unittest2 as unittest
@@ -15,27 +12,23 @@ from bson.tz_util import utc
 
 from mongoengine import (
     connect, register_connection,
-    Document, DateTimeField,
-    disconnect_all, StringField)
+    Document, DateTimeField
+)
+from mongoengine.python_support import IS_PYMONGO_3
 import mongoengine.connection
 from mongoengine.connection import (MongoEngineConnectionError, get_db,
-                                    get_connection, disconnect, DEFAULT_DATABASE_NAME)
+                                    get_connection)
 
 
 def get_tz_awareness(connection):
-    return connection.codec_options.tz_aware
+    if not IS_PYMONGO_3:
+        return connection.tz_aware
+    else:
+        return connection.codec_options.tz_aware
 
 
 class ConnectionTest(unittest.TestCase):
 
-    @classmethod
-    def setUpClass(cls):
-        disconnect_all()
-
-    @classmethod
-    def tearDownClass(cls):
-        disconnect_all()
-
     def tearDown(self):
         mongoengine.connection._connection_settings = {}
         mongoengine.connection._connections = {}
@@ -46,156 +39,15 @@ class ConnectionTest(unittest.TestCase):
         connect('mongoenginetest')
 
         conn = get_connection()
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
+        self.assertTrue(isinstance(conn, pymongo.mongo_client.MongoClient))
 
         db = get_db()
-        self.assertIsInstance(db, pymongo.database.Database)
+        self.assertTrue(isinstance(db, pymongo.database.Database))
         self.assertEqual(db.name, 'mongoenginetest')
 
         connect('mongoenginetest2', alias='testdb')
         conn = get_connection('testdb')
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
-
-    def test_connect_disconnect_works_properly(self):
-        class History1(Document):
-            name = StringField()
-            meta = {'db_alias': 'db1'}
-
-        class History2(Document):
-            name = StringField()
-            meta = {'db_alias': 'db2'}
-
-        connect('db1', alias='db1')
-        connect('db2', alias='db2')
-
-        History1.drop_collection()
-        History2.drop_collection()
-
-        h = History1(name='default').save()
-        h1 = History2(name='db1').save()
-
-        self.assertEqual(list(History1.objects().as_pymongo()),
-                         [{'_id': h.id, 'name': 'default'}])
-        self.assertEqual(list(History2.objects().as_pymongo()),
-                         [{'_id': h1.id, 'name': 'db1'}])
-
-        disconnect('db1')
-        disconnect('db2')
-
-        with self.assertRaises(MongoEngineConnectionError):
-            list(History1.objects().as_pymongo())
-
-        with self.assertRaises(MongoEngineConnectionError):
-            list(History2.objects().as_pymongo())
-
-        connect('db1', alias='db1')
-        connect('db2', alias='db2')
-
-        self.assertEqual(list(History1.objects().as_pymongo()),
-                         [{'_id': h.id, 'name': 'default'}])
-        self.assertEqual(list(History2.objects().as_pymongo()),
-                         [{'_id': h1.id, 'name': 'db1'}])
-
-    def test_connect_different_documents_to_different_database(self):
-        class History(Document):
-            name = StringField()
-
-        class History1(Document):
-            name = StringField()
-            meta = {'db_alias': 'db1'}
-
-        class History2(Document):
-            name = StringField()
-            meta = {'db_alias': 'db2'}
-
-        connect()
-        connect('db1', alias='db1')
-        connect('db2', alias='db2')
-
-        History.drop_collection()
-        History1.drop_collection()
-        History2.drop_collection()
-
-        h = History(name='default').save()
-        h1 = History1(name='db1').save()
-        h2 = History2(name='db2').save()
-
-        self.assertEqual(History._collection.database.name, DEFAULT_DATABASE_NAME)
-        self.assertEqual(History1._collection.database.name, 'db1')
-        self.assertEqual(History2._collection.database.name, 'db2')
-
-        self.assertEqual(list(History.objects().as_pymongo()),
-                         [{'_id': h.id, 'name': 'default'}])
-        self.assertEqual(list(History1.objects().as_pymongo()),
-                         [{'_id': h1.id, 'name': 'db1'}])
-        self.assertEqual(list(History2.objects().as_pymongo()),
-                         [{'_id': h2.id, 'name': 'db2'}])
-
-    def test_connect_fails_if_connect_2_times_with_default_alias(self):
-        connect('mongoenginetest')
-
-        with self.assertRaises(MongoEngineConnectionError) as ctx_err:
-            connect('mongoenginetest2')
-        self.assertEqual("A different connection with alias `default` was already registered. Use disconnect() first", str(ctx_err.exception))
-
-    def test_connect_fails_if_connect_2_times_with_custom_alias(self):
-        connect('mongoenginetest', alias='alias1')
-
-        with self.assertRaises(MongoEngineConnectionError) as ctx_err:
-            connect('mongoenginetest2', alias='alias1')
-
-        self.assertEqual("A different connection with alias `alias1` was already registered. Use disconnect() first", str(ctx_err.exception))
-
-    def test_connect_fails_if_similar_connection_settings_arent_defined_the_same_way(self):
-        """Intended to keep the detecton function simple but robust"""
-        db_name = 'mongoenginetest'
-        db_alias = 'alias1'
-        connect(db=db_name, alias=db_alias, host='localhost', port=27017)
-
-        with self.assertRaises(MongoEngineConnectionError):
-            connect(host='mongodb://localhost:27017/%s' % db_name, alias=db_alias)
-
-    def test_connect_passes_silently_connect_multiple_times_with_same_config(self):
-        # test default connection to `test`
-        connect()
-        connect()
-        self.assertEqual(len(mongoengine.connection._connections), 1)
-        connect('test01', alias='test01')
-        connect('test01', alias='test01')
-        self.assertEqual(len(mongoengine.connection._connections), 2)
-        connect(host='mongodb://localhost:27017/mongoenginetest02', alias='test02')
-        connect(host='mongodb://localhost:27017/mongoenginetest02', alias='test02')
-        self.assertEqual(len(mongoengine.connection._connections), 3)
-
-    def test_connect_with_invalid_db_name(self):
-        """Ensure that connect() method fails fast if db name is invalid
-        """
-        with self.assertRaises(InvalidName):
-            connect('mongomock://localhost')
-
-    def test_connect_with_db_name_external(self):
-        """Ensure that connect() works if db name is $external
-        """
-        """Ensure that the connect() method works properly."""
-        connect('$external')
-
-        conn = get_connection()
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
-
-        db = get_db()
-        self.assertIsInstance(db, pymongo.database.Database)
-        self.assertEqual(db.name, '$external')
-
-        connect('$external', alias='testdb')
-        conn = get_connection('testdb')
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
-
-    def test_connect_with_invalid_db_name_type(self):
-        """Ensure that connect() method fails fast if db name has invalid type
-        """
-        with self.assertRaises(TypeError):
-            non_string_db_name = ['e. g. list instead of a string']
-            connect(non_string_db_name)
+        self.assertTrue(isinstance(conn, pymongo.mongo_client.MongoClient))
 
     def test_connect_in_mocking(self):
         """Ensure that the connect() method works properly in mocking.
@@ -207,31 +59,31 @@ class ConnectionTest(unittest.TestCase):
 
         connect('mongoenginetest', host='mongomock://localhost')
         conn = get_connection()
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
         connect('mongoenginetest2', host='mongomock://localhost', alias='testdb2')
         conn = get_connection('testdb2')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
         connect('mongoenginetest3', host='mongodb://localhost', is_mock=True, alias='testdb3')
         conn = get_connection('testdb3')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
         connect('mongoenginetest4', is_mock=True, alias='testdb4')
         conn = get_connection('testdb4')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
         connect(host='mongodb://localhost:27017/mongoenginetest5', is_mock=True, alias='testdb5')
         conn = get_connection('testdb5')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
         connect(host='mongomock://localhost:27017/mongoenginetest6', alias='testdb6')
         conn = get_connection('testdb6')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
         connect(host='mongomock://localhost:27017/mongoenginetest7', is_mock=True, alias='testdb7')
         conn = get_connection('testdb7')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
     def test_connect_with_host_list(self):
         """Ensure that the connect() method works when host is a list
@@ -245,155 +97,35 @@ class ConnectionTest(unittest.TestCase):
 
         connect(host=['mongomock://localhost'])
         conn = get_connection()
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
-        connect(host=['mongodb://localhost'], is_mock=True, alias='testdb2')
+        connect(host=['mongodb://localhost'], is_mock=True,  alias='testdb2')
         conn = get_connection('testdb2')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
-        connect(host=['localhost'], is_mock=True, alias='testdb3')
+        connect(host=['localhost'], is_mock=True,  alias='testdb3')
         conn = get_connection('testdb3')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
         connect(host=['mongomock://localhost:27017', 'mongomock://localhost:27018'], alias='testdb4')
         conn = get_connection('testdb4')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
-        connect(host=['mongodb://localhost:27017', 'mongodb://localhost:27018'], is_mock=True, alias='testdb5')
+        connect(host=['mongodb://localhost:27017', 'mongodb://localhost:27018'], is_mock=True,  alias='testdb5')
         conn = get_connection('testdb5')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
-        connect(host=['localhost:27017', 'localhost:27018'], is_mock=True, alias='testdb6')
+        connect(host=['localhost:27017', 'localhost:27018'], is_mock=True,  alias='testdb6')
         conn = get_connection('testdb6')
-        self.assertIsInstance(conn, mongomock.MongoClient)
+        self.assertTrue(isinstance(conn, mongomock.MongoClient))
 
-    def test_disconnect_cleans_globals(self):
-        """Ensure that the disconnect() method cleans the globals objects"""
-        connections = mongoengine.connection._connections
-        dbs = mongoengine.connection._dbs
-        connection_settings = mongoengine.connection._connection_settings
-
-        connect('mongoenginetest')
-
-        self.assertEqual(len(connections), 1)
-        self.assertEqual(len(dbs), 0)
-        self.assertEqual(len(connection_settings), 1)
-
-        class TestDoc(Document):
-            pass
-
-        TestDoc.drop_collection()  # triggers the db
-        self.assertEqual(len(dbs), 1)
-
-        disconnect()
-        self.assertEqual(len(connections), 0)
-        self.assertEqual(len(dbs), 0)
-        self.assertEqual(len(connection_settings), 0)
-
-    def test_disconnect_cleans_cached_collection_attribute_in_document(self):
-        """Ensure that the disconnect() method works properly"""
+    def test_disconnect(self):
+        """Ensure that the disconnect() method works properly
+        """
         conn1 = connect('mongoenginetest')
-
-        class History(Document):
-            pass
-
-        self.assertIsNone(History._collection)
-
-        History.drop_collection()
-
-        History.objects.first()     # will trigger the caching of _collection attribute
-        self.assertIsNotNone(History._collection)
-
-        disconnect()
-
-        self.assertIsNone(History._collection)
-
-        with self.assertRaises(MongoEngineConnectionError) as ctx_err:
-            History.objects.first()
-        self.assertEqual("You have not defined a default connection", str(ctx_err.exception))
-
-    def test_connect_disconnect_works_on_same_document(self):
-        """Ensure that the connect/disconnect works properly with a single Document"""
-        db1 = 'db1'
-        db2 = 'db2'
-
-        # Ensure freshness of the 2 databases through pymongo
-        client = MongoClient('localhost', 27017)
-        client.drop_database(db1)
-        client.drop_database(db2)
-
-        # Save in db1
-        connect(db1)
-
-        class User(Document):
-            name = StringField(required=True)
-
-        user1 = User(name='John is in db1').save()
-        disconnect()
-
-        # Make sure save doesnt work at this stage
-        with self.assertRaises(MongoEngineConnectionError):
-            User(name='Wont work').save()
-
-        # Save in db2
-        connect(db2)
-        user2 = User(name='Bob is in db2').save()
-        disconnect()
-
-        db1_users = list(client[db1].user.find())
-        self.assertEqual(db1_users, [{'_id': user1.id, 'name': 'John is in db1'}])
-        db2_users = list(client[db2].user.find())
-        self.assertEqual(db2_users, [{'_id': user2.id, 'name': 'Bob is in db2'}])
-
-    def test_disconnect_silently_pass_if_alias_does_not_exist(self):
-        connections = mongoengine.connection._connections
-        self.assertEqual(len(connections), 0)
-        disconnect(alias='not_exist')
-
-    def test_disconnect_all(self):
-        connections = mongoengine.connection._connections
-        dbs = mongoengine.connection._dbs
-        connection_settings = mongoengine.connection._connection_settings
-
-        connect('mongoenginetest')
-        connect('mongoenginetest2', alias='db1')
-
-        class History(Document):
-            pass
-
-        class History1(Document):
-            name = StringField()
-            meta = {'db_alias': 'db1'}
-
-        History.drop_collection()   # will trigger the caching of _collection attribute
-        History.objects.first()
-        History1.drop_collection()
-        History1.objects.first()
-
-        self.assertIsNotNone(History._collection)
-        self.assertIsNotNone(History1._collection)
-
-        self.assertEqual(len(connections), 2)
-        self.assertEqual(len(dbs), 2)
-        self.assertEqual(len(connection_settings), 2)
-
-        disconnect_all()
-
-        self.assertIsNone(History._collection)
-        self.assertIsNone(History1._collection)
-
-        self.assertEqual(len(connections), 0)
-        self.assertEqual(len(dbs), 0)
-        self.assertEqual(len(connection_settings), 0)
-
-        with self.assertRaises(MongoEngineConnectionError):
-            History.objects.first()
-
-        with self.assertRaises(MongoEngineConnectionError):
-            History1.objects.first()
-
-    def test_disconnect_all_silently_pass_if_no_connection_exist(self):
-        disconnect_all()
+        mongoengine.connection.disconnect()
+        conn2 = connect('mongoenginetest')
+        self.assertTrue(conn1 is not conn2)
 
     def test_sharing_connections(self):
         """Ensure that connections are shared when the connection settings are exactly the same
@@ -404,31 +136,41 @@ class ConnectionTest(unittest.TestCase):
         connect('mongoenginetests', alias='testdb2')
         actual_connection = get_connection('testdb2')
 
-        expected_connection.server_info()
+        # Handle PyMongo 3+ Async Connection
+        if IS_PYMONGO_3:
+            # Ensure we are connected, throws ServerSelectionTimeoutError otherwise.
+            # Purposely not catching exception to fail test if thrown.
+            expected_connection.server_info()
 
         self.assertEqual(expected_connection, actual_connection)
 
     def test_connect_uri(self):
         """Ensure that the connect() method works properly with URIs."""
         c = connect(db='mongoenginetest', alias='admin')
-        c.admin.system.users.delete_many({})
-        c.mongoenginetest.system.users.delete_many({})
+        c.admin.system.users.remove({})
+        c.mongoenginetest.system.users.remove({})
 
-        c.admin.command("createUser", "admin", pwd="password", roles=["root"])
+        c.admin.add_user("admin", "password")
         c.admin.authenticate("admin", "password")
-        c.admin.command("createUser", "username", pwd="password", roles=["dbOwner"])
+        c.mongoenginetest.add_user("username", "password")
+
+        if not IS_PYMONGO_3:
+            self.assertRaises(
+                MongoEngineConnectionError, connect, 'testdb_uri_bad',
+                host='mongodb://test:password@localhost'
+            )
 
         connect("testdb_uri", host='mongodb://username:password@localhost/mongoenginetest')
 
         conn = get_connection()
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
+        self.assertTrue(isinstance(conn, pymongo.mongo_client.MongoClient))
 
         db = get_db()
-        self.assertIsInstance(db, pymongo.database.Database)
+        self.assertTrue(isinstance(db, pymongo.database.Database))
         self.assertEqual(db.name, 'mongoenginetest')
 
-        c.admin.system.users.delete_many({})
-        c.mongoenginetest.system.users.delete_many({})
+        c.admin.system.users.remove({})
+        c.mongoenginetest.system.users.remove({})
 
     def test_connect_uri_without_db(self):
         """Ensure connect() method works properly if the URI doesn't
@@ -437,10 +179,10 @@ class ConnectionTest(unittest.TestCase):
         connect("mongoenginetest", host='mongodb://localhost/')
 
         conn = get_connection()
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
+        self.assertTrue(isinstance(conn, pymongo.mongo_client.MongoClient))
 
         db = get_db()
-        self.assertIsInstance(db, pymongo.database.Database)
+        self.assertTrue(isinstance(db, pymongo.database.Database))
         self.assertEqual(db.name, 'mongoenginetest')
 
     def test_connect_uri_default_db(self):
@@ -450,10 +192,10 @@ class ConnectionTest(unittest.TestCase):
         connect(host='mongodb://localhost/')
 
         conn = get_connection()
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
+        self.assertTrue(isinstance(conn, pymongo.mongo_client.MongoClient))
 
         db = get_db()
-        self.assertIsInstance(db, pymongo.database.Database)
+        self.assertTrue(isinstance(db, pymongo.database.Database))
         self.assertEqual(db.name, 'test')
 
     def test_uri_without_credentials_doesnt_override_conn_settings(self):
@@ -475,16 +217,23 @@ class ConnectionTest(unittest.TestCase):
         """
         # Create users
         c = connect('mongoenginetest')
-
-        c.admin.system.users.delete_many({})
-        c.admin.command("createUser", "username2", pwd="password", roles=["dbOwner"])
+        c.admin.system.users.remove({})
+        c.admin.add_user('username2', 'password')
 
         # Authentication fails without "authSource"
-        test_conn = connect(
-            'mongoenginetest', alias='test1',
-            host='mongodb://username2:password@localhost/mongoenginetest'
-        )
-        self.assertRaises(OperationFailure, test_conn.server_info)
+        if IS_PYMONGO_3:
+            test_conn = connect(
+                'mongoenginetest', alias='test1',
+                host='mongodb://username2:password@localhost/mongoenginetest'
+            )
+            self.assertRaises(OperationFailure, test_conn.server_info)
+        else:
+            self.assertRaises(
+                MongoEngineConnectionError,
+                connect, 'mongoenginetest', alias='test1',
+                host='mongodb://username2:password@localhost/mongoenginetest'
+            )
+            self.assertRaises(MongoEngineConnectionError, get_db, 'test1')
 
         # Authentication succeeds with "authSource"
         authd_conn = connect(
@@ -493,11 +242,11 @@ class ConnectionTest(unittest.TestCase):
                   'mongoenginetest?authSource=admin')
         )
         db = get_db('test2')
-        self.assertIsInstance(db, pymongo.database.Database)
+        self.assertTrue(isinstance(db, pymongo.database.Database))
         self.assertEqual(db.name, 'mongoenginetest')
 
         # Clear all users
-        authd_conn.admin.system.users.delete_many({})
+        authd_conn.admin.system.users.remove({})
 
     def test_register_connection(self):
         """Ensure that connections with different aliases may be registered.
@@ -506,10 +255,10 @@ class ConnectionTest(unittest.TestCase):
 
         self.assertRaises(MongoEngineConnectionError, get_connection)
         conn = get_connection('testdb')
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
+        self.assertTrue(isinstance(conn, pymongo.mongo_client.MongoClient))
 
         db = get_db('testdb')
-        self.assertIsInstance(db, pymongo.database.Database)
+        self.assertTrue(isinstance(db, pymongo.database.Database))
         self.assertEqual(db.name, 'mongoenginetest2')
 
     def test_register_connection_defaults(self):
@@ -518,7 +267,7 @@ class ConnectionTest(unittest.TestCase):
         register_connection('testdb', 'mongoenginetest', host=None, port=None)
 
         conn = get_connection('testdb')
-        self.assertIsInstance(conn, pymongo.mongo_client.MongoClient)
+        self.assertTrue(isinstance(conn, pymongo.mongo_client.MongoClient))
 
     def test_connection_kwargs(self):
         """Ensure that connection kwargs get passed to pymongo."""
@@ -535,7 +284,14 @@ class ConnectionTest(unittest.TestCase):
         """Ensure we can specify a max connection pool size using
         a connection kwarg.
         """
-        pool_size_kwargs = {'maxpoolsize': 100}
+        # Use "max_pool_size" or "maxpoolsize" depending on PyMongo version
+        # (former was changed to the latter as described in
+        # https://jira.mongodb.org/browse/PYTHON-854).
+        # TODO remove once PyMongo < 3.0 support is dropped
+        if pymongo.version_tuple[0] >= 3:
+            pool_size_kwargs = {'maxpoolsize': 100}
+        else:
+            pool_size_kwargs = {'max_pool_size': 100}
 
         conn = connect('mongoenginetest', alias='max_pool_size_via_kwarg', **pool_size_kwargs)
         self.assertEqual(conn.max_pool_size, 100)
@@ -544,6 +300,9 @@ class ConnectionTest(unittest.TestCase):
         """Ensure we can specify a max connection pool size using
         an option in a connection URI.
         """
+        if pymongo.version_tuple[0] == 2 and pymongo.version_tuple[1] < 9:
+            raise SkipTest('maxpoolsize as a URI option is only supported in PyMongo v2.9+')
+
         conn = connect(host='mongodb://localhost/test?maxpoolsize=100', alias='max_pool_size_via_uri')
         self.assertEqual(conn.max_pool_size, 100)
 
@@ -553,30 +312,46 @@ class ConnectionTest(unittest.TestCase):
         """
         conn1 = connect(alias='conn1', host='mongodb://localhost/testing?w=1&j=true')
         conn2 = connect('testing', alias='conn2', w=1, j=True)
-        self.assertEqual(conn1.write_concern.document, {'w': 1, 'j': True})
-        self.assertEqual(conn2.write_concern.document, {'w': 1, 'j': True})
+        if IS_PYMONGO_3:
+            self.assertEqual(conn1.write_concern.document, {'w': 1, 'j': True})
+            self.assertEqual(conn2.write_concern.document, {'w': 1, 'j': True})
+        else:
+            self.assertEqual(dict(conn1.write_concern), {'w': 1, 'j': True})
+            self.assertEqual(dict(conn2.write_concern), {'w': 1, 'j': True})
 
     def test_connect_with_replicaset_via_uri(self):
         """Ensure connect() works when specifying a replicaSet via the
         MongoDB URI.
         """
-        c = connect(host='mongodb://localhost/test?replicaSet=local-rs')
-        db = get_db()
-        self.assertIsInstance(db, pymongo.database.Database)
-        self.assertEqual(db.name, 'test')
+        if IS_PYMONGO_3:
+            c = connect(host='mongodb://localhost/test?replicaSet=local-rs')
+            db = get_db()
+            self.assertTrue(isinstance(db, pymongo.database.Database))
+            self.assertEqual(db.name, 'test')
+        else:
+            # PyMongo < v3.x raises an exception:
+            # "localhost:27017 is not a member of replica set local-rs"
+            with self.assertRaises(MongoEngineConnectionError):
+                c = connect(host='mongodb://localhost/test?replicaSet=local-rs')
 
     def test_connect_with_replicaset_via_kwargs(self):
         """Ensure connect() works when specifying a replicaSet via the
         connection kwargs
         """
-        c = connect(replicaset='local-rs')
-        self.assertEqual(c._MongoClient__options.replica_set_name,
-                         'local-rs')
-        db = get_db()
-        self.assertIsInstance(db, pymongo.database.Database)
-        self.assertEqual(db.name, 'test')
+        if IS_PYMONGO_3:
+            c = connect(replicaset='local-rs')
+            self.assertEqual(c._MongoClient__options.replica_set_name,
+                             'local-rs')
+            db = get_db()
+            self.assertTrue(isinstance(db, pymongo.database.Database))
+            self.assertEqual(db.name, 'test')
+        else:
+            # PyMongo < v3.x raises an exception:
+            # "localhost:27017 is not a member of replica set local-rs"
+            with self.assertRaises(MongoEngineConnectionError):
+                c = connect(replicaset='local-rs')
 
-    def test_connect_tz_aware(self):
+    def test_datetime(self):
         connect('mongoenginetest', tz_aware=True)
         d = datetime.datetime(2010, 5, 5, tzinfo=utc)
 
@@ -589,10 +364,6 @@ class ConnectionTest(unittest.TestCase):
         date_doc = DateDoc.objects.first()
         self.assertEqual(d, date_doc.the_date)
 
-    def test_read_preference_from_parse(self):
-        conn = connect(host="mongodb://a1.vpc,a2.vpc,a3.vpc/prod?readPreference=secondaryPreferred")
-        self.assertEqual(conn.read_preference, ReadPreference.SECONDARY_PREFERRED)
-
     def test_multiple_connection_settings(self):
         connect('mongoenginetest', alias='t1', host="localhost")
 
@@ -600,26 +371,19 @@ class ConnectionTest(unittest.TestCase):
 
         mongo_connections = mongoengine.connection._connections
         self.assertEqual(len(mongo_connections.items()), 2)
-        self.assertIn('t1', mongo_connections.keys())
-        self.assertIn('t2', mongo_connections.keys())
-
-        # Handle PyMongo 3+ Async Connection
-        # Ensure we are connected, throws ServerSelectionTimeoutError otherwise.
-        # Purposely not catching exception to fail test if thrown.
-        mongo_connections['t1'].server_info()
-        mongo_connections['t2'].server_info()
-        self.assertEqual(mongo_connections['t1'].address[0], 'localhost')
-        self.assertEqual(mongo_connections['t2'].address[0], '127.0.0.1')
-
-    def test_connect_2_databases_uses_same_client_if_only_dbname_differs(self):
-        c1 = connect(alias='testdb1', db='testdb1')
-        c2 = connect(alias='testdb2', db='testdb2')
-        self.assertIs(c1, c2)
-
-    def test_connect_2_databases_uses_different_client_if_different_parameters(self):
-        c1 = connect(alias='testdb1', db='testdb1', username='u1')
-        c2 = connect(alias='testdb2', db='testdb2', username='u2')
-        self.assertIsNot(c1, c2)
+        self.assertTrue('t1' in mongo_connections.keys())
+        self.assertTrue('t2' in mongo_connections.keys())
+        if not IS_PYMONGO_3:
+            self.assertEqual(mongo_connections['t1'].host, 'localhost')
+            self.assertEqual(mongo_connections['t2'].host, '127.0.0.1')
+        else:
+            # Handle PyMongo 3+ Async Connection
+            # Ensure we are connected, throws ServerSelectionTimeoutError otherwise.
+            # Purposely not catching exception to fail test if thrown.
+            mongo_connections['t1'].server_info()
+            mongo_connections['t2'].server_info()
+            self.assertEqual(mongo_connections['t1'].address[0], 'localhost')
+            self.assertEqual(mongo_connections['t2'].address[0], '127.0.0.1')
 
 
 if __name__ == '__main__':

tests/test_context_managers.py

@@ -5,7 +5,6 @@ from mongoengine.connection import get_db
 from mongoengine.context_managers import (switch_db, switch_collection,
                                           no_sub_classes, no_dereference,
                                           query_counter)
-from mongoengine.pymongo_support import count_documents
 
 
 class ContextManagersTest(unittest.TestCase):
@@ -37,15 +36,14 @@ class ContextManagersTest(unittest.TestCase):
 
     def test_switch_collection_context_manager(self):
         connect('mongoenginetest')
-        register_connection(alias='testdb-1', db='mongoenginetest2')
+        register_connection('testdb-1', 'mongoenginetest2')
 
         class Group(Document):
             name = StringField()
 
-        Group.drop_collection()         # drops in default
-
+        Group.drop_collection()
         with switch_collection(Group, 'group1') as Group:
-            Group.drop_collection()     # drops in group1
+            Group.drop_collection()
 
         Group(name="hello - group").save()
         self.assertEqual(1, Group.objects.count())
@@ -91,15 +89,15 @@ class ContextManagersTest(unittest.TestCase):
 
         with no_dereference(Group) as Group:
             group = Group.objects.first()
-            for m in group.members:
-                self.assertNotIsInstance(m, User)
-            self.assertNotIsInstance(group.ref, User)
-            self.assertNotIsInstance(group.generic, User)
+            self.assertTrue(all([not isinstance(m, User)
+                                for m in group.members]))
+            self.assertFalse(isinstance(group.ref, User))
+            self.assertFalse(isinstance(group.generic, User))
 
-        for m in group.members:
-            self.assertIsInstance(m, User)
-        self.assertIsInstance(group.ref, User)
-        self.assertIsInstance(group.generic, User)
+        self.assertTrue(all([isinstance(m, User)
+                             for m in group.members]))
+        self.assertTrue(isinstance(group.ref, User))
+        self.assertTrue(isinstance(group.generic, User))
 
     def test_no_dereference_context_manager_dbref(self):
         """Ensure that DBRef items in ListFields aren't dereferenced.
@@ -131,17 +129,19 @@ class ContextManagersTest(unittest.TestCase):
             group = Group.objects.first()
             self.assertTrue(all([not isinstance(m, User)
                                 for m in group.members]))
-            self.assertNotIsInstance(group.ref, User)
-            self.assertNotIsInstance(group.generic, User)
+            self.assertFalse(isinstance(group.ref, User))
+            self.assertFalse(isinstance(group.generic, User))
 
         self.assertTrue(all([isinstance(m, User)
                              for m in group.members]))
-        self.assertIsInstance(group.ref, User)
-        self.assertIsInstance(group.generic, User)
+        self.assertTrue(isinstance(group.ref, User))
+        self.assertTrue(isinstance(group.generic, User))
 
     def test_no_sub_classes(self):
         class A(Document):
             x = IntField()
+            y = IntField()
+
             meta = {'allow_inheritance': True}
 
         class B(A):
@@ -152,29 +152,29 @@ class ContextManagersTest(unittest.TestCase):
 
         A.drop_collection()
 
-        A(x=10).save()
-        A(x=15).save()
-        B(x=20).save()
-        B(x=30).save()
-        C(x=40).save()
+        A(x=10, y=20).save()
+        A(x=15, y=30).save()
+        B(x=20, y=40).save()
+        B(x=30, y=50).save()
+        C(x=40, y=60).save()
 
         self.assertEqual(A.objects.count(), 5)
         self.assertEqual(B.objects.count(), 3)
         self.assertEqual(C.objects.count(), 1)
 
-        with no_sub_classes(A):
+        with no_sub_classes(A) as A:
             self.assertEqual(A.objects.count(), 2)
 
             for obj in A.objects:
                 self.assertEqual(obj.__class__, A)
 
-        with no_sub_classes(B):
+        with no_sub_classes(B) as B:
             self.assertEqual(B.objects.count(), 2)
 
             for obj in B.objects:
                 self.assertEqual(obj.__class__, B)
 
-        with no_sub_classes(C):
+        with no_sub_classes(C) as C:
             self.assertEqual(C.objects.count(), 1)
 
             for obj in C.objects:
@@ -185,133 +185,18 @@ class ContextManagersTest(unittest.TestCase):
         self.assertEqual(B.objects.count(), 3)
         self.assertEqual(C.objects.count(), 1)
 
-    def test_no_sub_classes_modification_to_document_class_are_temporary(self):
-        class A(Document):
-            x = IntField()
-            meta = {'allow_inheritance': True}
-
-        class B(A):
-            z = IntField()
-
-        self.assertEqual(A._subclasses, ('A', 'A.B'))
-        with no_sub_classes(A):
-            self.assertEqual(A._subclasses, ('A',))
-        self.assertEqual(A._subclasses, ('A', 'A.B'))
-
-        self.assertEqual(B._subclasses, ('A.B',))
-        with no_sub_classes(B):
-            self.assertEqual(B._subclasses, ('A.B',))
-        self.assertEqual(B._subclasses, ('A.B',))
-
-    def test_no_subclass_context_manager_does_not_swallow_exception(self):
-        class User(Document):
-            name = StringField()
-
-        with self.assertRaises(TypeError):
-            with no_sub_classes(User):
-                raise TypeError()
-
-    def test_query_counter_does_not_swallow_exception(self):
-
-        with self.assertRaises(TypeError):
-            with query_counter() as q:
-                raise TypeError()
-
-    def test_query_counter_temporarily_modifies_profiling_level(self):
-        connect('mongoenginetest')
-        db = get_db()
-
-        initial_profiling_level = db.profiling_level()
-
-        try:
-            NEW_LEVEL = 1
-            db.set_profiling_level(NEW_LEVEL)
-            self.assertEqual(db.profiling_level(), NEW_LEVEL)
-            with query_counter() as q:
-                self.assertEqual(db.profiling_level(), 2)
-            self.assertEqual(db.profiling_level(), NEW_LEVEL)
-        except Exception:
-            db.set_profiling_level(initial_profiling_level)    # Ensures it gets reseted no matter the outcome of the test
-            raise
-
     def test_query_counter(self):
         connect('mongoenginetest')
         db = get_db()
-
-        collection = db.query_counter
-        collection.drop()
-
-        def issue_1_count_query():
-            count_documents(collection, {})
-
-        def issue_1_insert_query():
-            collection.insert_one({'test': 'garbage'})
-
-        def issue_1_find_query():
-            collection.find_one()
-
-        counter = 0
-        with query_counter() as q:
-            self.assertEqual(q, counter)
-            self.assertEqual(q, counter)    # Ensures previous count query did not get counted
-
-            for _ in range(10):
-                issue_1_insert_query()
-                counter += 1
-            self.assertEqual(q, counter)
-
-            for _ in range(4):
-                issue_1_find_query()
-                counter += 1
-            self.assertEqual(q, counter)
-
-            for _ in range(3):
-                issue_1_count_query()
-                counter += 1
-            self.assertEqual(q, counter)
-
-            self.assertEqual(int(q), counter)       # test __int__
-            self.assertEqual(repr(q), str(int(q)))  # test __repr__
-            self.assertGreater(q, -1)               # test __gt__
-            self.assertGreaterEqual(q, int(q))      # test __gte__
-            self.assertNotEqual(q, -1)
-            self.assertLess(q, 1000)
-            self.assertLessEqual(q, int(q))
-
-    def test_query_counter_counts_getmore_queries(self):
-        connect('mongoenginetest')
-        db = get_db()
-
-        collection = db.query_counter
-        collection.drop()
-
-        many_docs = [{'test': 'garbage %s' % i} for i in range(150)]
-        collection.insert_many(many_docs)   # first batch of documents contains 101 documents
+        db.test.find({})
 
         with query_counter() as q:
-            self.assertEqual(q, 0)
-            list(collection.find())
-            self.assertEqual(q, 2)  # 1st select + 1 getmore
+            self.assertEqual(0, q)
 
-    def test_query_counter_ignores_particular_queries(self):
-        connect('mongoenginetest')
-        db = get_db()
-
-        collection = db.query_counter
-        collection.insert_many([{'test': 'garbage %s' % i} for i in range(10)])
-
-        with query_counter() as q:
-            self.assertEqual(q, 0)
-            cursor = collection.find()
-            self.assertEqual(q, 0)      # cursor wasn't opened yet
-            _ = next(cursor)            # opens the cursor and fires the find query
-            self.assertEqual(q, 1)
-
-            cursor.close()              # issues a `killcursors` query that is ignored by the context
-            self.assertEqual(q, 1)
-            _ = db.system.indexes.find_one()    # queries on db.system.indexes are ignored as well
-            self.assertEqual(q, 1)
+            for i in range(1, 51):
+                db.test.find({}).count()
 
+            self.assertEqual(50, q)
 
 if __name__ == '__main__':
     unittest.main()

tests/test_datastructures.py

@@ -1,361 +1,6 @@
 import unittest
-from six import iterkeys
 
-from mongoengine import Document
-from mongoengine.base.datastructures import StrictDict, BaseList, BaseDict
-
-
-class DocumentStub(object):
-    def __init__(self):
-        self._changed_fields = []
-
-    def _mark_as_changed(self, key):
-        self._changed_fields.append(key)
-
-
-class TestBaseDict(unittest.TestCase):
-
-    @staticmethod
-    def _get_basedict(dict_items):
-        """Get a BaseList bound to a fake document instance"""
-        fake_doc = DocumentStub()
-        base_list = BaseDict(dict_items, instance=None, name='my_name')
-        base_list._instance = fake_doc  # hack to inject the mock, it does not work in the constructor
-        return base_list
-
-    def test___init___(self):
-        class MyDoc(Document):
-            pass
-
-        dict_items = {'k': 'v'}
-        doc = MyDoc()
-        base_dict = BaseDict(dict_items, instance=doc, name='my_name')
-        self.assertIsInstance(base_dict._instance, Document)
-        self.assertEqual(base_dict._name, 'my_name')
-        self.assertEqual(base_dict, dict_items)
-
-    def test_setdefault_calls_mark_as_changed(self):
-        base_dict = self._get_basedict({})
-        base_dict.setdefault('k', 'v')
-        self.assertEqual(base_dict._instance._changed_fields, [base_dict._name])
-
-    def test_popitems_calls_mark_as_changed(self):
-        base_dict = self._get_basedict({'k': 'v'})
-        self.assertEqual(base_dict.popitem(), ('k', 'v'))
-        self.assertEqual(base_dict._instance._changed_fields, [base_dict._name])
-        self.assertFalse(base_dict)
-
-    def test_pop_calls_mark_as_changed(self):
-        base_dict = self._get_basedict({'k': 'v'})
-        self.assertEqual(base_dict.pop('k'), 'v')
-        self.assertEqual(base_dict._instance._changed_fields, [base_dict._name])
-        self.assertFalse(base_dict)
-
-    def test_pop_calls_does_not_mark_as_changed_when_it_fails(self):
-        base_dict = self._get_basedict({'k': 'v'})
-        with self.assertRaises(KeyError):
-            base_dict.pop('X')
-        self.assertFalse(base_dict._instance._changed_fields)
-
-    def test_clear_calls_mark_as_changed(self):
-        base_dict = self._get_basedict({'k': 'v'})
-        base_dict.clear()
-        self.assertEqual(base_dict._instance._changed_fields, ['my_name'])
-        self.assertEqual(base_dict, {})
-
-    def test___delitem___calls_mark_as_changed(self):
-        base_dict = self._get_basedict({'k': 'v'})
-        del base_dict['k']
-        self.assertEqual(base_dict._instance._changed_fields, ['my_name.k'])
-        self.assertEqual(base_dict, {})
-
-    def test___getitem____KeyError(self):
-        base_dict = self._get_basedict({})
-        with self.assertRaises(KeyError):
-            base_dict['new']
-
-    def test___getitem____simple_value(self):
-        base_dict = self._get_basedict({'k': 'v'})
-        base_dict['k'] = 'v'
-
-    def test___getitem____sublist_gets_converted_to_BaseList(self):
-        base_dict = self._get_basedict({'k': [0, 1, 2]})
-        sub_list = base_dict['k']
-        self.assertEqual(sub_list, [0, 1, 2])
-        self.assertIsInstance(sub_list, BaseList)
-        self.assertIs(sub_list._instance, base_dict._instance)
-        self.assertEqual(sub_list._name, 'my_name.k')
-        self.assertEqual(base_dict._instance._changed_fields, [])
-
-        # Challenge mark_as_changed from sublist
-        sub_list[1] = None
-        self.assertEqual(base_dict._instance._changed_fields, ['my_name.k.1'])
-
-    def test___getitem____subdict_gets_converted_to_BaseDict(self):
-        base_dict = self._get_basedict({'k': {'subk': 'subv'}})
-        sub_dict = base_dict['k']
-        self.assertEqual(sub_dict, {'subk': 'subv'})
-        self.assertIsInstance(sub_dict, BaseDict)
-        self.assertIs(sub_dict._instance, base_dict._instance)
-        self.assertEqual(sub_dict._name, 'my_name.k')
-        self.assertEqual(base_dict._instance._changed_fields, [])
-
-        # Challenge mark_as_changed from subdict
-        sub_dict['subk'] = None
-        self.assertEqual(base_dict._instance._changed_fields, ['my_name.k.subk'])
-
-    def test_get_sublist_gets_converted_to_BaseList_just_like__getitem__(self):
-        base_dict = self._get_basedict({'k': [0, 1, 2]})
-        sub_list = base_dict.get('k')
-        self.assertEqual(sub_list, [0, 1, 2])
-        self.assertIsInstance(sub_list, BaseList)
-
-    def test_get_returns_the_same_as___getitem__(self):
-        base_dict = self._get_basedict({'k': [0, 1, 2]})
-        get_ = base_dict.get('k')
-        getitem_ = base_dict['k']
-        self.assertEqual(get_, getitem_)
-
-    def test_get_default(self):
-        base_dict = self._get_basedict({})
-        sentinel = object()
-        self.assertEqual(base_dict.get('new'), None)
-        self.assertIs(base_dict.get('new', sentinel), sentinel)
-
-    def test___setitem___calls_mark_as_changed(self):
-        base_dict = self._get_basedict({})
-        base_dict['k'] = 'v'
-        self.assertEqual(base_dict._instance._changed_fields, ['my_name.k'])
-        self.assertEqual(base_dict, {'k': 'v'})
-
-    def test_update_calls_mark_as_changed(self):
-        base_dict = self._get_basedict({})
-        base_dict.update({'k': 'v'})
-        self.assertEqual(base_dict._instance._changed_fields, ['my_name'])
-
-    def test___setattr____not_tracked_by_changes(self):
-        base_dict = self._get_basedict({})
-        base_dict.a_new_attr = 'test'
-        self.assertEqual(base_dict._instance._changed_fields, [])
-
-    def test___delattr____tracked_by_changes(self):
-        # This is probably a bug as __setattr__ is not tracked
-        # This is even bad because it could be that there is an attribute
-        # with the same name as a key
-        base_dict = self._get_basedict({})
-        base_dict.a_new_attr = 'test'
-        del base_dict.a_new_attr
-        self.assertEqual(base_dict._instance._changed_fields, ['my_name.a_new_attr'])
-
-
-class TestBaseList(unittest.TestCase):
-
-    @staticmethod
-    def _get_baselist(list_items):
-        """Get a BaseList bound to a fake document instance"""
-        fake_doc = DocumentStub()
-        base_list = BaseList(list_items, instance=None, name='my_name')
-        base_list._instance = fake_doc  # hack to inject the mock, it does not work in the constructor
-        return base_list
-
-    def test___init___(self):
-        class MyDoc(Document):
-            pass
-
-        list_items = [True]
-        doc = MyDoc()
-        base_list = BaseList(list_items, instance=doc, name='my_name')
-        self.assertIsInstance(base_list._instance, Document)
-        self.assertEqual(base_list._name, 'my_name')
-        self.assertEqual(base_list, list_items)
-
-    def test___iter__(self):
-        values = [True, False, True, False]
-        base_list = BaseList(values, instance=None, name='my_name')
-        self.assertEqual(values, list(base_list))
-
-    def test___iter___allow_modification_while_iterating_withou_error(self):
-        # regular list allows for this, thus this subclass must comply to that
-        base_list = BaseList([True, False, True, False], instance=None, name='my_name')
-        for idx, val in enumerate(base_list):
-            if val:
-                base_list.pop(idx)
-
-    def test_append_calls_mark_as_changed(self):
-        base_list = self._get_baselist([])
-        self.assertFalse(base_list._instance._changed_fields)
-        base_list.append(True)
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test_subclass_append(self):
-        # Due to the way mark_as_changed_wrapper is implemented
-        # it is good to test subclasses
-        class SubBaseList(BaseList):
-            pass
-
-        base_list = SubBaseList([], instance=None, name='my_name')
-        base_list.append(True)
-
-    def test___getitem__using_simple_index(self):
-        base_list = self._get_baselist([0, 1, 2])
-        self.assertEqual(base_list[0], 0)
-        self.assertEqual(base_list[1], 1)
-        self.assertEqual(base_list[-1], 2)
-
-    def test___getitem__using_slice(self):
-        base_list = self._get_baselist([0, 1, 2])
-        self.assertEqual(base_list[1:3], [1, 2])
-        self.assertEqual(base_list[0:3:2], [0, 2])
-
-    def test___getitem___using_slice_returns_list(self):
-        # Bug: using slice does not properly handles the instance
-        # and mark_as_changed behaviour.
-        base_list = self._get_baselist([0, 1, 2])
-        sliced = base_list[1:3]
-        self.assertEqual(sliced, [1, 2])
-        self.assertIsInstance(sliced, list)
-        self.assertEqual(base_list._instance._changed_fields, [])
-
-    def test___getitem__sublist_returns_BaseList_bound_to_instance(self):
-        base_list = self._get_baselist(
-            [
-                [1, 2],
-                [3, 4]
-            ]
-        )
-        sub_list = base_list[0]
-        self.assertEqual(sub_list, [1, 2])
-        self.assertIsInstance(sub_list, BaseList)
-        self.assertIs(sub_list._instance, base_list._instance)
-        self.assertEqual(sub_list._name, 'my_name.0')
-        self.assertEqual(base_list._instance._changed_fields, [])
-
-        # Challenge mark_as_changed from sublist
-        sub_list[1] = None
-        self.assertEqual(base_list._instance._changed_fields, ['my_name.0.1'])
-
-    def test___getitem__subdict_returns_BaseList_bound_to_instance(self):
-        base_list = self._get_baselist(
-            [
-                {'subk': 'subv'}
-            ]
-        )
-        sub_dict = base_list[0]
-        self.assertEqual(sub_dict, {'subk': 'subv'})
-        self.assertIsInstance(sub_dict, BaseDict)
-        self.assertIs(sub_dict._instance, base_list._instance)
-        self.assertEqual(sub_dict._name, 'my_name.0')
-        self.assertEqual(base_list._instance._changed_fields, [])
-
-        # Challenge mark_as_changed from subdict
-        sub_dict['subk'] = None
-        self.assertEqual(base_list._instance._changed_fields, ['my_name.0.subk'])
-
-    def test_extend_calls_mark_as_changed(self):
-        base_list = self._get_baselist([])
-        base_list.extend([True])
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test_insert_calls_mark_as_changed(self):
-        base_list = self._get_baselist([])
-        base_list.insert(0, True)
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test_remove_calls_mark_as_changed(self):
-        base_list = self._get_baselist([True])
-        base_list.remove(True)
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test_remove_not_mark_as_changed_when_it_fails(self):
-        base_list = self._get_baselist([True])
-        with self.assertRaises(ValueError):
-            base_list.remove(False)
-        self.assertFalse(base_list._instance._changed_fields)
-
-    def test_pop_calls_mark_as_changed(self):
-        base_list = self._get_baselist([True])
-        base_list.pop()
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test_reverse_calls_mark_as_changed(self):
-        base_list = self._get_baselist([True, False])
-        base_list.reverse()
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test___delitem___calls_mark_as_changed(self):
-        base_list = self._get_baselist([True])
-        del base_list[0]
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test___setitem___calls_with_full_slice_mark_as_changed(self):
-        base_list = self._get_baselist([])
-        base_list[:] = [0, 1]      # Will use __setslice__ under py2 and __setitem__ under py3
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-        self.assertEqual(base_list, [0, 1])
-
-    def test___setitem___calls_with_partial_slice_mark_as_changed(self):
-        base_list = self._get_baselist([0, 1, 2])
-        base_list[0:2] = [1, 0]     # Will use __setslice__ under py2 and __setitem__ under py3
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-        self.assertEqual(base_list, [1, 0, 2])
-
-    def test___setitem___calls_with_step_slice_mark_as_changed(self):
-        base_list = self._get_baselist([0, 1, 2])
-        base_list[0:3:2] = [-1, -2]   # uses __setitem__ in both py2 & 3
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-        self.assertEqual(base_list, [-1, 1, -2])
-
-    def test___setitem___with_slice(self):
-        base_list = self._get_baselist([0, 1, 2, 3, 4, 5])
-        base_list[0:6:2] = [None, None, None]
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-        self.assertEqual(base_list, [None, 1, None, 3, None, 5])
-
-    def test___setitem___item_0_calls_mark_as_changed(self):
-        base_list = self._get_baselist([True])
-        base_list[0] = False
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-        self.assertEqual(base_list, [False])
-
-    def test___setitem___item_1_calls_mark_as_changed(self):
-        base_list = self._get_baselist([True, True])
-        base_list[1] = False
-        self.assertEqual(base_list._instance._changed_fields, ['my_name.1'])
-        self.assertEqual(base_list, [True, False])
-
-    def test___delslice___calls_mark_as_changed(self):
-        base_list = self._get_baselist([0, 1])
-        del base_list[0:1]
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-        self.assertEqual(base_list, [1])
-
-    def test___iadd___calls_mark_as_changed(self):
-        base_list = self._get_baselist([True])
-        base_list += [False]
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test___imul___calls_mark_as_changed(self):
-        base_list = self._get_baselist([True])
-        self.assertEqual(base_list._instance._changed_fields, [])
-        base_list *= 2
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test_sort_calls_not_marked_as_changed_when_it_fails(self):
-        base_list = self._get_baselist([True])
-        with self.assertRaises(TypeError):
-            base_list.sort(key=1)
-
-        self.assertEqual(base_list._instance._changed_fields, [])
-
-    def test_sort_calls_mark_as_changed(self):
-        base_list = self._get_baselist([True, False])
-        base_list.sort()
-        self.assertEqual(base_list._instance._changed_fields, ['my_name'])
-
-    def test_sort_calls_with_key(self):
-        base_list = self._get_baselist([1, 2, 11])
-        base_list.sort(key=lambda i: str(i))
-        self.assertEqual(base_list, [1, 11, 2])
+from mongoengine.base.datastructures import StrictDict, SemiStrictDict
 
 
 class TestStrictDict(unittest.TestCase):
@@ -369,20 +14,6 @@ class TestStrictDict(unittest.TestCase):
         d = self.dtype(a=1, b=1, c=1)
         self.assertEqual((d.a, d.b, d.c), (1, 1, 1))
 
-    def test_iterkeys(self):
-        d = self.dtype(a=1)
-        self.assertEqual(list(iterkeys(d)), ['a'])
-
-    def test_len(self):
-        d = self.dtype(a=1)
-        self.assertEqual(len(d), 1)
-
-    def test_pop(self):
-        d = self.dtype(a=1)
-        self.assertIn('a', d)
-        d.pop('a')
-        self.assertNotIn('a', d)
-
     def test_repr(self):
         d = self.dtype(a=1, b=2, c=3)
         self.assertEqual(repr(d), '{"a": 1, "b": 2, "c": 3}')
@@ -441,9 +72,48 @@ class TestStrictDict(unittest.TestCase):
 
     def test_mappings_protocol(self):
         d = self.dtype(a=1, b=2)
-        self.assertEqual(dict(d), {'a': 1, 'b': 2})
-        self.assertEqual(dict(**d), {'a': 1, 'b': 2})
+        assert dict(d) == {'a': 1, 'b': 2}
+        assert dict(**d) == {'a': 1, 'b': 2}
 
 
+class TestSemiSrictDict(TestStrictDict):
+    def strict_dict_class(self, *args, **kwargs):
+        return SemiStrictDict.create(*args, **kwargs)
+
+    def test_init_fails_on_nonexisting_attrs(self):
+        # disable irrelevant test
+        pass
+
+    def test_setattr_raises_on_nonexisting_attr(self):
+        # disable irrelevant test
+        pass
+
+    def test_setattr_getattr_nonexisting_attr_succeeds(self):
+        d = self.dtype()
+        d.x = 1
+        self.assertEqual(d.x, 1)
+
+    def test_init_succeeds_with_nonexisting_attrs(self):
+        d = self.dtype(a=1, b=1, c=1, x=2)
+        self.assertEqual((d.a, d.b, d.c, d.x), (1, 1, 1, 2))
+
+    def test_iter_with_nonexisting_attrs(self):
+        d = self.dtype(a=1, b=1, c=1, x=2)
+        self.assertEqual(list(d), ['a', 'b', 'c', 'x'])
+
+    def test_iteritems_with_nonexisting_attrs(self):
+        d = self.dtype(a=1, b=1, c=1, x=2)
+        self.assertEqual(list(d.iteritems()), [('a', 1), ('b', 1), ('c', 1), ('x', 2)])
+
+    def tets_cmp_with_strict_dicts(self):
+        d = self.dtype(a=1, b=1, c=1)
+        dd = StrictDict.create(("a", "b", "c"))(a=1, b=1, c=1)
+        self.assertEqual(d, dd)
+
+    def test_cmp_with_strict_dict_with_nonexisting_attrs(self):
+        d = self.dtype(a=1, b=1, c=1, x=2)
+        dd = StrictDict.create(("a", "b", "c", "x"))(a=1, b=1, c=1, x=2)
+        self.assertEqual(d, dd)
+
 if __name__ == '__main__':
     unittest.main()

tests/test_dereference.py

@@ -2,7 +2,6 @@
 import unittest
 
 from bson import DBRef, ObjectId
-from six import iteritems
 
 from mongoengine import *
 from mongoengine.connection import get_db
@@ -105,14 +104,6 @@ class FieldTest(unittest.TestCase):
 
             [m for m in group_obj.members]
             self.assertEqual(q, 2)
-            self.assertTrue(group_obj._data['members']._dereferenced)
-
-            # verifies that no additional queries gets executed
-            # if we re-iterate over the ListField once it is
-            # dereferenced
-            [m for m in group_obj.members]
-            self.assertEqual(q, 2)
-            self.assertTrue(group_obj._data['members']._dereferenced)
 
         # Document select_related
         with query_counter() as q:
@@ -133,46 +124,6 @@ class FieldTest(unittest.TestCase):
                 [m for m in group_obj.members]
                 self.assertEqual(q, 2)
 
-    def test_list_item_dereference_orphan_dbref(self):
-        """Ensure that orphan DBRef items in ListFields are dereferenced.
-        """
-        class User(Document):
-            name = StringField()
-
-        class Group(Document):
-            members = ListField(ReferenceField(User, dbref=False))
-
-        User.drop_collection()
-        Group.drop_collection()
-
-        for i in range(1, 51):
-            user = User(name='user %s' % i)
-            user.save()
-
-        group = Group(members=User.objects)
-        group.save()
-        group.reload()  # Confirm reload works
-
-        # Delete one User so one of the references in the
-        # Group.members list is an orphan DBRef
-        User.objects[0].delete()
-        with query_counter() as q:
-            self.assertEqual(q, 0)
-
-            group_obj = Group.objects.first()
-            self.assertEqual(q, 1)
-
-            [m for m in group_obj.members]
-            self.assertEqual(q, 2)
-            self.assertTrue(group_obj._data['members']._dereferenced)
-
-            # verifies that no additional queries gets executed
-            # if we re-iterate over the ListField once it is
-            # dereferenced
-            [m for m in group_obj.members]
-            self.assertEqual(q, 2)
-            self.assertTrue(group_obj._data['members']._dereferenced)
-
         User.drop_collection()
         Group.drop_collection()
 
@@ -249,8 +200,8 @@ class FieldTest(unittest.TestCase):
         group = Group(author=user, members=[user]).save()
 
         raw_data = Group._get_collection().find_one()
-        self.assertIsInstance(raw_data['author'], DBRef)
-        self.assertIsInstance(raw_data['members'][0], DBRef)
+        self.assertTrue(isinstance(raw_data['author'], DBRef))
+        self.assertTrue(isinstance(raw_data['members'][0], DBRef))
         group = Group.objects.first()
 
         self.assertEqual(group.author, user)
@@ -273,8 +224,8 @@ class FieldTest(unittest.TestCase):
         self.assertEqual(group.members, [user])
 
         raw_data = Group._get_collection().find_one()
-        self.assertIsInstance(raw_data['author'], ObjectId)
-        self.assertIsInstance(raw_data['members'][0], ObjectId)
+        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.
@@ -518,7 +469,7 @@ class FieldTest(unittest.TestCase):
             self.assertEqual(q, 4)
 
             for m in group_obj.members:
-                self.assertIn('User', m.__class__.__name__)
+                self.assertTrue('User' in m.__class__.__name__)
 
         # Document select_related
         with query_counter() as q:
@@ -534,7 +485,7 @@ class FieldTest(unittest.TestCase):
             self.assertEqual(q, 4)
 
             for m in group_obj.members:
-                self.assertIn('User', m.__class__.__name__)
+                self.assertTrue('User' in m.__class__.__name__)
 
         # Queryset select_related
         with query_counter() as q:
@@ -551,62 +502,7 @@ class FieldTest(unittest.TestCase):
                 self.assertEqual(q, 4)
 
                 for m in group_obj.members:
-                    self.assertIn('User', m.__class__.__name__)
-
-
-    def test_generic_reference_orphan_dbref(self):
-        """Ensure that generic orphan DBRef items in ListFields are dereferenced.
-        """
-
-        class UserA(Document):
-            name = StringField()
-
-        class UserB(Document):
-            name = StringField()
-
-        class UserC(Document):
-            name = StringField()
-
-        class Group(Document):
-            members = ListField(GenericReferenceField())
-
-        UserA.drop_collection()
-        UserB.drop_collection()
-        UserC.drop_collection()
-        Group.drop_collection()
-
-        members = []
-        for i in range(1, 51):
-            a = UserA(name='User A %s' % i)
-            a.save()
-
-            b = UserB(name='User B %s' % i)
-            b.save()
-
-            c = UserC(name='User C %s' % i)
-            c.save()
-
-            members += [a, b, c]
-
-        group = Group(members=members)
-        group.save()
-
-        # Delete one UserA instance so that there is
-        # an orphan DBRef in the GenericReference ListField
-        UserA.objects[0].delete()
-        with query_counter() as q:
-            self.assertEqual(q, 0)
-
-            group_obj = Group.objects.first()
-            self.assertEqual(q, 1)
-
-            [m for m in group_obj.members]
-            self.assertEqual(q, 4)
-            self.assertTrue(group_obj._data['members']._dereferenced)
-
-            [m for m in group_obj.members]
-            self.assertEqual(q, 4)
-            self.assertTrue(group_obj._data['members']._dereferenced)
+                    self.assertTrue('User' in m.__class__.__name__)
 
         UserA.drop_collection()
         UserB.drop_collection()
@@ -664,7 +560,7 @@ class FieldTest(unittest.TestCase):
             self.assertEqual(q, 4)
 
             for m in group_obj.members:
-                self.assertIn('User', m.__class__.__name__)
+                self.assertTrue('User' in m.__class__.__name__)
 
         # Document select_related
         with query_counter() as q:
@@ -680,7 +576,7 @@ class FieldTest(unittest.TestCase):
             self.assertEqual(q, 4)
 
             for m in group_obj.members:
-                self.assertIn('User', m.__class__.__name__)
+                self.assertTrue('User' in m.__class__.__name__)
 
         # Queryset select_related
         with query_counter() as q:
@@ -697,7 +593,7 @@ class FieldTest(unittest.TestCase):
                 self.assertEqual(q, 4)
 
                 for m in group_obj.members:
-                    self.assertIn('User', m.__class__.__name__)
+                    self.assertTrue('User' in m.__class__.__name__)
 
         UserA.drop_collection()
         UserB.drop_collection()
@@ -736,8 +632,8 @@ class FieldTest(unittest.TestCase):
             [m for m in group_obj.members]
             self.assertEqual(q, 2)
 
-            for k, m in iteritems(group_obj.members):
-                self.assertIsInstance(m, User)
+            for k, m in group_obj.members.iteritems():
+                self.assertTrue(isinstance(m, User))
 
         # Document select_related
         with query_counter() as q:
@@ -749,8 +645,8 @@ class FieldTest(unittest.TestCase):
             [m for m in group_obj.members]
             self.assertEqual(q, 2)
 
-            for k, m in iteritems(group_obj.members):
-                self.assertIsInstance(m, User)
+            for k, m in group_obj.members.iteritems():
+                self.assertTrue(isinstance(m, User))
 
        # Queryset select_related
         with query_counter() as q:
@@ -763,8 +659,8 @@ class FieldTest(unittest.TestCase):
                 [m for m in group_obj.members]
                 self.assertEqual(q, 2)
 
-                for k, m in iteritems(group_obj.members):
-                    self.assertIsInstance(m, User)
+                for k, m in group_obj.members.iteritems():
+                    self.assertTrue(isinstance(m, User))
 
         User.drop_collection()
         Group.drop_collection()
@@ -818,8 +714,8 @@ class FieldTest(unittest.TestCase):
             [m for m in group_obj.members]
             self.assertEqual(q, 4)
 
-            for k, m in iteritems(group_obj.members):
-                self.assertIn('User', m.__class__.__name__)
+            for k, m in group_obj.members.iteritems():
+                self.assertTrue('User' in m.__class__.__name__)
 
         # Document select_related
         with query_counter() as q:
@@ -834,8 +730,8 @@ class FieldTest(unittest.TestCase):
             [m for m in group_obj.members]
             self.assertEqual(q, 4)
 
-            for k, m in iteritems(group_obj.members):
-                self.assertIn('User', m.__class__.__name__)
+            for k, m in group_obj.members.iteritems():
+                self.assertTrue('User' in m.__class__.__name__)
 
         # Queryset select_related
         with query_counter() as q:
@@ -851,8 +747,8 @@ class FieldTest(unittest.TestCase):
                 [m for m in group_obj.members]
                 self.assertEqual(q, 4)
 
-                for k, m in iteritems(group_obj.members):
-                    self.assertIn('User', m.__class__.__name__)
+                for k, m in group_obj.members.iteritems():
+                    self.assertTrue('User' in m.__class__.__name__)
 
         Group.objects.delete()
         Group().save()
@@ -909,8 +805,8 @@ class FieldTest(unittest.TestCase):
             [m for m in group_obj.members]
             self.assertEqual(q, 2)
 
-            for k, m in iteritems(group_obj.members):
-                self.assertIsInstance(m, UserA)
+            for k, m in group_obj.members.iteritems():
+                self.assertTrue(isinstance(m, UserA))
 
         # Document select_related
         with query_counter() as q:
@@ -925,8 +821,8 @@ class FieldTest(unittest.TestCase):
             [m for m in group_obj.members]
             self.assertEqual(q, 2)
 
-            for k, m in iteritems(group_obj.members):
-                self.assertIsInstance(m, UserA)
+            for k, m in group_obj.members.iteritems():
+                self.assertTrue(isinstance(m, UserA))
 
         # Queryset select_related
         with query_counter() as q:
@@ -942,8 +838,8 @@ class FieldTest(unittest.TestCase):
                 [m for m in group_obj.members]
                 self.assertEqual(q, 2)
 
-                for k, m in iteritems(group_obj.members):
-                    self.assertIsInstance(m, UserA)
+                for k, m in group_obj.members.iteritems():
+                    self.assertTrue(isinstance(m, UserA))
 
         UserA.drop_collection()
         Group.drop_collection()
@@ -997,8 +893,8 @@ class FieldTest(unittest.TestCase):
             [m for m in group_obj.members]
             self.assertEqual(q, 4)
 
-            for k, m in iteritems(group_obj.members):
-                self.assertIn('User', m.__class__.__name__)
+            for k, m in group_obj.members.iteritems():
+                self.assertTrue('User' in m.__class__.__name__)
 
         # Document select_related
         with query_counter() as q:
@@ -1013,8 +909,8 @@ class FieldTest(unittest.TestCase):
             [m for m in group_obj.members]
             self.assertEqual(q, 4)
 
-            for k, m in iteritems(group_obj.members):
-                self.assertIn('User', m.__class__.__name__)
+            for k, m in group_obj.members.iteritems():
+                self.assertTrue('User' in m.__class__.__name__)
 
         # Queryset select_related
         with query_counter() as q:
@@ -1030,8 +926,8 @@ class FieldTest(unittest.TestCase):
                 [m for m in group_obj.members]
                 self.assertEqual(q, 4)
 
-                for k, m in iteritems(group_obj.members):
-                    self.assertIn('User', m.__class__.__name__)
+                for k, m in group_obj.members.iteritems():
+                    self.assertTrue('User' in m.__class__.__name__)
 
         Group.objects.delete()
         Group().save()
@@ -1133,6 +1029,7 @@ class FieldTest(unittest.TestCase):
         self.assertEqual(type(foo.bar), Bar)
         self.assertEqual(type(foo.baz), Baz)
 
+
     def test_document_reload_reference_integrity(self):
         """
         Ensure reloading a document with multiple similar id
@@ -1168,6 +1065,7 @@ class FieldTest(unittest.TestCase):
         self.assertEqual(msg.author, user)
         self.assertEqual(msg.author.name, 'new-name')
 
+
     def test_list_lookup_not_checked_in_map(self):
         """Ensure we dereference list data correctly
         """
@@ -1311,10 +1209,10 @@ class FieldTest(unittest.TestCase):
 
         # Can't use query_counter across databases - so test the _data object
         book = Book.objects.first()
-        self.assertNotIsInstance(book._data['author'], User)
+        self.assertFalse(isinstance(book._data['author'], User))
 
         book.select_related()
-        self.assertIsInstance(book._data['author'], User)
+        self.assertTrue(isinstance(book._data['author'], User))
 
     def test_non_ascii_pk(self):
         """
@@ -1389,6 +1287,5 @@ class FieldTest(unittest.TestCase):
 
             self.assertEqual(q, 2)
 
-
 if __name__ == '__main__':
     unittest.main()

tests/test_replicaset_connection.py

@@ -1,16 +1,23 @@
 import unittest
 
 from pymongo import ReadPreference
-from pymongo import MongoClient
+
+from mongoengine.python_support import IS_PYMONGO_3
+
+if IS_PYMONGO_3:
+    from pymongo import MongoClient
+    CONN_CLASS = MongoClient
+    READ_PREF = ReadPreference.SECONDARY
+else:
+    from pymongo import ReplicaSetConnection
+    CONN_CLASS = ReplicaSetConnection
+    READ_PREF = ReadPreference.SECONDARY_ONLY
 
 import mongoengine
+from mongoengine import *
 from mongoengine.connection import MongoEngineConnectionError
 
 
-CONN_CLASS = MongoClient
-READ_PREF = ReadPreference.SECONDARY
-
-
 class ConnectionTest(unittest.TestCase):
 
     def setUp(self):
@@ -28,7 +35,7 @@ class ConnectionTest(unittest.TestCase):
         """
 
         try:
-            conn = mongoengine.connect(db='mongoenginetest',
+            conn = connect(db='mongoenginetest',
                            host="mongodb://localhost/mongoenginetest?replicaSet=rs",
                            read_preference=READ_PREF)
         except MongoEngineConnectionError as e:
@@ -40,6 +47,5 @@ class ConnectionTest(unittest.TestCase):
 
         self.assertEqual(conn.read_preference, READ_PREF)
 
-
 if __name__ == '__main__':
     unittest.main()

tests/test_signals.py

@@ -39,6 +39,7 @@ class SignalTests(unittest.TestCase):
             def post_init(cls, sender, document, **kwargs):
                 signal_output.append('post_init signal, %s, document._created = %s' % (document, document._created))
 
+
             @classmethod
             def pre_save(cls, sender, document, **kwargs):
                 signal_output.append('pre_save signal, %s' % document)
@@ -227,9 +228,6 @@ class SignalTests(unittest.TestCase):
 
         self.ExplicitId.objects.delete()
 
-        # Note that there is a chance that the following assert fails in case
-        # some receivers (eventually created in other tests)
-        # gets garbage collected (https://pythonhosted.org/blinker/#blinker.base.Signal.connect)
         self.assertEqual(self.pre_signals, post_signals)
 
     def test_model_signals(self):
@@ -249,7 +247,7 @@ class SignalTests(unittest.TestCase):
         def load_existing_author():
             a  = self.Author(name='Bill Shakespeare')
             a.save()
-            self.get_signal_output(lambda: None)  # eliminate signal output
+            self.get_signal_output(lambda: None) # eliminate signal output
             a1 = self.Author.objects(name='Bill Shakespeare')[0]
 
         self.assertEqual(self.get_signal_output(create_author), [
@@ -433,6 +431,5 @@ class SignalTests(unittest.TestCase):
             {}
         ])
 
-
 if __name__ == '__main__':
     unittest.main()

tests/test_utils.py

@@ -1,38 +0,0 @@
-import unittest
-import re
-
-from mongoengine.base.utils import LazyRegexCompiler
-
-signal_output = []
-
-
-class LazyRegexCompilerTest(unittest.TestCase):
-
-    def test_lazy_regex_compiler_verify_laziness_of_descriptor(self):
-        class UserEmail(object):
-            EMAIL_REGEX = LazyRegexCompiler('@', flags=32)
-
-        descriptor = UserEmail.__dict__['EMAIL_REGEX']
-        self.assertIsNone(descriptor._compiled_regex)
-
-        regex = UserEmail.EMAIL_REGEX
-        self.assertEqual(regex, re.compile('@', flags=32))
-        self.assertEqual(regex.search('user@domain.com').group(), '@')
-
-        user_email = UserEmail()
-        self.assertIs(user_email.EMAIL_REGEX, UserEmail.EMAIL_REGEX)
-
-    def test_lazy_regex_compiler_verify_cannot_set_descriptor_on_instance(self):
-        class UserEmail(object):
-            EMAIL_REGEX = LazyRegexCompiler('@')
-
-        user_email = UserEmail()
-        with self.assertRaises(AttributeError):
-            user_email.EMAIL_REGEX = re.compile('@')
-
-    def test_lazy_regex_compiler_verify_can_override_class_attr(self):
-        class UserEmail(object):
-            EMAIL_REGEX = LazyRegexCompiler('@')
-
-        UserEmail.EMAIL_REGEX = re.compile('cookies')
-        self.assertEqual(UserEmail.EMAIL_REGEX.search('Cake & cookies').group(), 'cookies')

tests/utils.py

@@ -1,24 +1,22 @@
-import operator
 import unittest
 
 from nose.plugins.skip import SkipTest
 
 from mongoengine import connect
-from mongoengine.connection import get_db, disconnect_all
-from mongoengine.mongodb_support import get_mongodb_version
+from mongoengine.connection import get_db, get_connection
+from mongoengine.python_support import IS_PYMONGO_3
 
 
-MONGO_TEST_DB = 'mongoenginetest'   # standard name for the test database
+MONGO_TEST_DB = 'mongoenginetest'
 
 
 class MongoDBTestCase(unittest.TestCase):
     """Base class for tests that need a mongodb connection
-    It ensures that the db is clean at the beginning and dropped at the end automatically
+    db is being dropped automatically
     """
 
     @classmethod
     def setUpClass(cls):
-        disconnect_all()
         cls._connection = connect(db=MONGO_TEST_DB)
         cls._connection.drop_database(MONGO_TEST_DB)
         cls.db = get_db()
@@ -26,40 +24,55 @@ class MongoDBTestCase(unittest.TestCase):
     @classmethod
     def tearDownClass(cls):
         cls._connection.drop_database(MONGO_TEST_DB)
-        disconnect_all()
 
 
-def get_as_pymongo(doc):
-    """Fetch the pymongo version of a certain Document"""
-    return doc.__class__.objects.as_pymongo().get(id=doc.id)
+def get_mongodb_version():
+    """Return the version tuple of the MongoDB server that the default
+    connection is connected to.
+    """
+    return tuple(get_connection().server_info()['versionArray'])
 
-
-def _decorated_with_ver_requirement(func, mongo_version_req, oper):
-    """Return a MongoDB version requirement decorator.
-
-    The resulting decorator will raise a SkipTest exception if the current
-    MongoDB version doesn't match the provided version/operator.
-
-    For example, if you define a decorator like so:
-
-        def requires_mongodb_gte_36(func):
-            return _decorated_with_ver_requirement(
-                func, (3.6), oper=operator.ge
-            )
-
-    Then tests decorated with @requires_mongodb_gte_36 will be skipped if
-    ran against MongoDB < v3.6.
-
-    :param mongo_version_req: The mongodb version requirement (tuple(int, int))
-    :param oper: The operator to apply (e.g: operator.ge)
+def _decorated_with_ver_requirement(func, ver_tuple):
+    """Return a given function decorated with the version requirement
+    for a particular MongoDB version tuple.
     """
     def _inner(*args, **kwargs):
-        mongodb_v = get_mongodb_version()
-        if oper(mongodb_v, mongo_version_req):
+        mongodb_ver = get_mongodb_version()
+        if mongodb_ver >= ver_tuple:
             return func(*args, **kwargs)
 
-        raise SkipTest('Needs MongoDB v{}+'.format('.'.join(str(n) for n in mongo_version_req)))
+        raise SkipTest('Needs MongoDB v{}+'.format(
+            '.'.join([str(v) for v in ver_tuple])
+        ))
 
     _inner.__name__ = func.__name__
     _inner.__doc__ = func.__doc__
+
     return _inner
+
+def needs_mongodb_v26(func):
+    """Raise a SkipTest exception if we're working with MongoDB version
+    lower than v2.6.
+    """
+    return _decorated_with_ver_requirement(func, (2, 6))
+
+def needs_mongodb_v3(func):
+    """Raise a SkipTest exception if we're working with MongoDB version
+    lower than v3.0.
+    """
+    return _decorated_with_ver_requirement(func, (3, 0))
+
+def skip_pymongo3(f):
+    """Raise a SkipTest exception if we're running a test against
+    PyMongo v3.x.
+    """
+    def _inner(*args, **kwargs):
+        if IS_PYMONGO_3:
+            raise SkipTest("Useless with PyMongo 3+")
+        return f(*args, **kwargs)
+
+    _inner.__name__ = f.__name__
+    _inner.__doc__ = f.__doc__
+
+    return _inner
+

tox.ini

@@ -1,12 +1,13 @@
 [tox]
-envlist = {py27,py35,pypy,pypy3}-{mg35,mg3x}
+envlist = {py27,py35,pypy,pypy3}-{mg27,mg28,mg30}
 
 [testenv]
 commands =
     python setup.py nosetests {posargs}
 deps =
     nose
-    mg34x: PyMongo>=3.4,<3.5
-    mg3x: PyMongo>=3.0,<3.7
+    mg27: PyMongo<2.8
+    mg28: PyMongo>=2.8,<2.9
+    mg30: PyMongo>=3.0
 setenv =
     PYTHON_EGG_CACHE = {envdir}/python-eggs