Merge branch 'master' into __raw__and_mongoengine

Author: idoshr

.github/workflows/github-actions.yml

@@ -17,6 +17,8 @@ env:
   MONGODB_4_0: 4.0.28
   MONGODB_4_4: 4.4
   MONGODB_5_0: "5.0"
+  MONGODB_6_0: "6.0"
+  MONGODB_7_0: "7.0"
 
   PYMONGO_3_4: 3.4
   PYMONGO_3_6: 3.6
@@ -25,6 +27,8 @@ env:
   PYMONGO_3_12: 3.12
   PYMONGO_4_0: 4.0
   PYMONGO_4_3: 4.3.2
+  PYMONGO_4_4: 4.4.1
+  PYMONGO_4_6: 4.6.0
 
   MAIN_PYTHON_VERSION: 3.7
 
@@ -68,6 +72,12 @@ jobs:
           - python-version: "3.11"
             MONGODB: $MONGODB_5_0
             PYMONGO: $PYMONGO_4_3
+          - python-version: "3.11"
+            MONGODB: $MONGODB_6_0
+            PYMONGO: $PYMONGO_4_4
+          - python-version: "3.11"
+            MONGODB: $MONGODB_7_0
+            PYMONGO: $PYMONGO_4_6
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}

.github/workflows/install_mongo.sh

@@ -11,6 +11,10 @@ elif [[ "$MONGODB" == *"4.4"* ]]; then
   mongo_build=mongodb-linux-x86_64-ubuntu1804-v${MONGODB}-latest
 elif [[ "$MONGODB" == *"5.0"* ]]; then
   mongo_build=mongodb-linux-x86_64-ubuntu1804-v${MONGODB}-latest
+elif [[ "$MONGODB" == *"6.0"* ]]; then
+  mongo_build=mongodb-linux-x86_64-ubuntu1804-v${MONGODB}-latest
+elif [[ "$MONGODB" == *"7.0"* ]]; then
+  mongo_build=mongodb-linux-x86_64-ubuntu2004-v${MONGODB}-latest
 fi
 
 wget http://fastdl.mongodb.org/linux/$mongo_build.tgz

README.rst

@@ -31,7 +31,7 @@ an `API reference <https://mongoengine-odm.readthedocs.io/apireference.html>`_.
 
 Supported MongoDB Versions
 ==========================
-MongoEngine is currently tested against MongoDB v3.6, v4.0, v4.4 and v5.0. Future versions
+MongoEngine is currently tested against MongoDB v3.6, v4.0, v4.4, v5.0, v6.0 and v7.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 a more recent MongoDB versions.

docs/changelog.rst

@@ -9,6 +9,14 @@ Development
 - (Fill this out as you fix issues and develop your features).
 - Fix for uuidRepresentation not read when provided in URI #2741
 - Fix combination of __raw__ and mongoengine syntax.
+- Add tests against MongoDB 6.0 and MongoDB 7.0 in the pipeline
+- Fix validate() not being called when inheritance is used in EmbeddedDocument and validate is overriden #2784
+- Add support for readPreferenceTags in connection parameters #2644
+- Use estimated_documents_count OR documents_count when count is called, based on the query #2529
+- Fix no_dereference context manager which wasn't turning off auto-dereferencing correctly in some cases #2788
+- BREAKING CHANGE: no_dereference context manager no longer returns the class in __enter__ #2788
+    as it was useless and making it look like it was returning a different class although it was the same.
+    Thus, it must be called like `with no_dereference(User):` and no longer `with no_dereference(User) as ...:`
 
 Changes in 0.27.0
 =================

docs/guide/querying.rst

@@ -522,7 +522,7 @@ data. To turn off dereferencing of the results of a query use
 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:
+    with no_dereference(Post):
         post = Post.objects.first()
         assert(isinstance(post.author, DBRef))
 

mongoengine/base/fields.py

@@ -59,11 +59,11 @@ def __init__(
             unique with (Creates an index).
         :param primary_key: Mark this field as the primary key ((Creates an index)). 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
+            field. The callable takes the value as parameter and should raise
             a ValidationError if validation fails
         :param choices: (optional) The valid choices
-        :param null: (optional) If the field value can be null when a default exist. If not set, the default value
-        will be used in case a field with a default value is set to None. Defaults to False.
+        :param null: (optional) If the field value can be null when a default exists. If not set, the default value
+            will be used in case a field with a default value is set to None. Defaults to False.
         :param sparse: (optional) `sparse=True` combined with `unique=True` and `required=False`
             means that uniqueness won't be enforced for `None` values (Creates an index). Defaults to False.
         :param **kwargs: (optional) Arbitrary indirection-free metadata for

mongoengine/connection.py

@@ -164,8 +164,16 @@ def _get_connection_settings(
                         preference.name.lower() == read_pf_mode
                         or preference.mode == read_pf_mode
                     ):
-                        conn_settings["read_preference"] = preference
+                        ReadPrefClass = preference.__class__
                         break
+
+                if "readpreferencetags" in uri_options:
+                    conn_settings["read_preference"] = ReadPrefClass(
+                        tag_sets=uri_options["readpreferencetags"]
+                    )
+                else:
+                    conn_settings["read_preference"] = ReadPrefClass()
+
             if "authmechanismproperties" in uri_options:
                 conn_settings["authmechanismproperties"] = uri_options[
                     "authmechanismproperties"

mongoengine/context_managers.py

@@ -1,3 +1,4 @@
+import threading
 from contextlib import contextmanager
 
 from pymongo.read_concern import ReadConcern
@@ -18,6 +19,25 @@
 )
 
 
+thread_locals = threading.local()
+thread_locals.no_dereferencing_class = {}
+
+
+def no_dereferencing_active_for_class(cls):
+    return cls in thread_locals.no_dereferencing_class
+
+
+def _register_no_dereferencing_for_class(cls):
+    thread_locals.no_dereferencing_class.setdefault(cls, 0)
+    thread_locals.no_dereferencing_class[cls] += 1
+
+
+def _unregister_no_dereferencing_for_class(cls):
+    thread_locals.no_dereferencing_class[cls] -= 1
+    if thread_locals.no_dereferencing_class[cls] == 0:
+        thread_locals.no_dereferencing_class.pop(cls)
+
+
 class switch_db:
     """switch_db alias context manager.
 
@@ -107,7 +127,7 @@ class no_dereference:
     Turns off all dereferencing in Documents for the duration of the context
     manager::
 
-        with no_dereference(Group) as Group:
+        with no_dereference(Group):
             Group.objects.find()
     """
 
@@ -130,15 +150,17 @@ def __init__(self, cls):
 
     def __enter__(self):
         """Change the objects default and _auto_dereference values."""
+        _register_no_dereferencing_for_class(self.cls)
+
         for field in self.deref_fields:
             self.cls._fields[field]._auto_dereference = False
-        return self.cls
 
     def __exit__(self, t, value, traceback):
         """Reset the default and _auto_dereference values."""
+        _unregister_no_dereferencing_for_class(self.cls)
+
         for field in self.deref_fields:
             self.cls._fields[field]._auto_dereference = True
-        return self.cls
 
 
 class no_sub_classes:

mongoengine/fields.py

@@ -761,7 +761,7 @@ def validate(self, value, clean=True):
                 "Invalid embedded document instance provided to an "
                 "EmbeddedDocumentField"
             )
-        self.document_type.validate(value, clean)
+        value.validate(clean=clean)
 
     def lookup_member(self, member_name):
         doc_and_subclasses = [self.document_type] + self.document_type.__subclasses__()

mongoengine/mongodb_support.py

@@ -9,6 +9,9 @@
 MONGODB_36 = (3, 6)
 MONGODB_42 = (4, 2)
 MONGODB_44 = (4, 4)
+MONGODB_50 = (5, 0)
+MONGODB_60 = (6, 0)
+MONGODB_70 = (7, 0)
 
 
 def get_mongodb_version():