Merge branch 'master' of github.com:MongoEngine/mongoengine

Author: bagerard

.github/workflows/github-actions.yml

@@ -115,7 +115,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [linting, test, build_doc_dryrun]
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v3
     - uses: actions/setup-python@v4
       with:
         python-version: 3.9
@@ -130,7 +130,7 @@ jobs:
     needs: [linting, test, build_doc_dryrun, build-dryrun]
     if: github.event_name == 'create' && startsWith(github.ref, 'refs/tags/v')
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v3
     - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:
@@ -143,6 +143,6 @@ jobs:
         pip install wheel
         python setup.py sdist bdist_wheel
     - name: publish pypi
-      uses: pypa/gh-action-pypi-publish@master
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
         password: ${{ secrets.pypi_token }}

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
   - repo: https://github.com/ambv/black
-    rev: 22.12.0
+    rev: 23.1.0
     hooks:
       - id: black
   - repo: https://github.com/pycqa/flake8
@@ -23,6 +23,6 @@ repos:
       - id: pyupgrade
         args: [--py36-plus]
   - repo: https://github.com/pycqa/isort
-    rev: 5.11.4
+    rev: 5.12.0
     hooks:
       - id: isort

docs/changelog.rst

@@ -7,6 +7,20 @@ Changelog
 Development
 ===========
 - (Fill this out as you fix issues and develop your features).
+- Fix for uuidRepresentation not read when provided in URI #2741
+
+Changes in 0.27.0
+=================
+- Update uuidRepresentation warnings with "unspecified" as the future default (instead of 'standard' previously advertised) #2739
+- Added `mongo_client_class` optional parameter to connect() to allow to use an alternative mongo client than pymongo.MongoClient.
+  Typically to support mock mongo libraries like mongomock, montydb, mongita #2729
+- BREAKING CHANGE: connecting MongoEngine with mongomock should now use the new `mongo_client_class`
+  For more info, check https://docs.mongoengine.org/guide/mongomock.html
+- Fix DictField that always gets marked as changed #2606
+- fix for Queryset.none() that has no effect on update/aggregate / first #2669
+
+Changes in 0.26.0
+=================
 - BREAKING CHANGE: Improved the performance of :meth:`~mongoengine.Document.save()`
   by removing the call to :meth:`~mongoengine.Document.ensure_indexes` unless
   ``meta['auto_create_index_on_save']`` is set to True. With the default settings, Document indexes
@@ -19,6 +33,8 @@ Development
   Although it could work to switch an existing DecimalField to Decimal128Field without applying a migration script,
   it is not recommended to do so (DecimalField uses float/str to store the value, Decimal128Field uses Decimal128).
 - BREAKING CHANGE: When using ListField(EnumField) or DictField(EnumField), the values weren't always cast into the Enum (#2531)
+- BREAKING CHANGE (bugfix) Querying ObjectIdField or ComplexDateTimeField with None no longer raise a ValidationError (#2681)
+- Allow updating a field that has an operator name e.g. "type" with .update(set__type="foo"). It was raising an error previously. #2595
 
 Changes in 0.25.0
 =================

docs/guide/mongomock.rst

@@ -1,23 +1,28 @@
-==============================
+=========================
 Use mongomock for testing
-==============================
+=========================
 
-`mongomock <https://github.com/vmalloc/mongomock/>`_ is a package to do just
-what the name implies, mocking a mongo database.
+Although we recommend running your tests against a regular MongoDB server, it is sometimes useful to plug
+MongoEngine to alternative implementations (mongomock, montydb, mongita, etc).
+
+`mongomock <https://github.com/vmalloc/mongomock/>`_ is historically the one suggested for MongoEngine and is
+a package to do just what the name implies, mocking a mongo database.
 
 To use with mongoengine, simply specify mongomock when connecting with
 mongoengine:
 
 .. code-block:: python
 
-    connect('mongoenginetest', host='mongomock://localhost')
+    import mongomock
+
+    connect('mongoenginetest', host='mongodb://localhost', mongo_client_class=mongomock.MongoClient)
     conn = get_connection()
 
 or with an alias:
 
 .. code-block:: python
 
-    connect('mongoenginetest', host='mongomock://localhost', alias='testdb')
+    connect('mongoenginetest', host='mongodb://localhost', mongo_client_class=mongomock.MongoClient, alias='testdb')
     conn = get_connection('testdb')
 
 Example of test file:
@@ -34,7 +39,7 @@ Example of test file:
 
         @classmethod
         def setUpClass(cls):
-            connect('mongoenginetest', host='mongomock://localhost')
+            connect('mongoenginetest', host='mongodb://localhost', mongo_client_class=mongomock.MongoClient)
 
         @classmethod
         def tearDownClass(cls):

docs/guide/querying.rst

@@ -196,6 +196,10 @@ you could use the following query::
 
     Page.objects(tags__0='db')
 
+The string queries operators can be used as well for querying a list field, e.g.::
+
+    Page.objects(tags__iexact='db')
+
 If you only want to fetch part of a list eg: you want to paginate a list, then
 the `slice` operator is required::
 

mongoengine/__init__.py

@@ -29,7 +29,7 @@
 )
 
 
-VERSION = (0, 25, 0)
+VERSION = (0, 27, 0)
 
 
 def get_version():

mongoengine/base/datastructures.py

@@ -31,9 +31,9 @@ def mark_key_as_changed_wrapper(parent_method):
 
     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
+        if not args or key not in self or self[key] != args[0]:
+            self._mark_as_changed(key)
+        return parent_method(self, key, *args, **kwargs)
 
     return wrapper
 

mongoengine/base/document.py

@@ -161,7 +161,6 @@ def __delattr__(self, *args, **kwargs):
     def __setattr__(self, name, value):
         # Handle dynamic data only if an initialised dynamic document
         if self._dynamic and not self._dynamic_lock:
-
             if name not in self._fields_ordered and not name.startswith("_"):
                 DynamicField = _import_class("DynamicField")
                 field = DynamicField(db_field=name, null=True)
@@ -372,7 +371,7 @@ def to_mongo(self, use_db_field=True, fields=None):
                 value = field.generate()
                 self._data[field_name] = value
 
-            if (value is not None) or (field.null):
+            if value is not None or field.null:
                 if use_db_field:
                     data[field.db_field] = value
                 else:
@@ -451,7 +450,8 @@ def to_json(self, *args, **kwargs):
                 "No 'json_options' are specified! Falling back to "
                 "LEGACY_JSON_OPTIONS with uuid_representation=PYTHON_LEGACY. "
                 "For use with other MongoDB drivers specify the UUID "
-                "representation to use.",
+                "representation to use. This will be changed to "
+                "uuid_representation=UNSPECIFIED in a future release.",
                 DeprecationWarning,
             )
             kwargs["json_options"] = LEGACY_JSON_OPTIONS
@@ -481,7 +481,8 @@ def from_json(cls, json_data, created=False, **kwargs):
                 "No 'json_options' are specified! Falling back to "
                 "LEGACY_JSON_OPTIONS with uuid_representation=PYTHON_LEGACY. "
                 "For use with other MongoDB drivers specify the UUID "
-                "representation to use.",
+                "representation to use. This will be changed to "
+                "uuid_representation=UNSPECIFIED in a future release.",
                 DeprecationWarning,
             )
             kwargs["json_options"] = LEGACY_JSON_OPTIONS
@@ -517,9 +518,6 @@ def __expand_dynamic_values(self, name, value):
 
     def _mark_as_changed(self, key):
         """Mark a key as explicitly changed by the user."""
-        if not key:
-            return
-
         if not hasattr(self, "_changed_fields"):
             return
 

mongoengine/base/fields.py

@@ -52,20 +52,20 @@ def __init__(
         :param required: If the field is required. Whether it has to have a
             value or not. Defaults to False.
         :param default: (optional) The default value for this field if no value
-            has been set (or if the value has been unset).  It can be a
+            has been set, if the value is set to None or has been unset. It can be a
             callable.
-        :param unique: Is the field value unique or not.  Defaults to False.
+        :param unique: Is the field value unique or not (Creates an index).  Defaults to False.
         :param unique_with: (optional) The other field this field should be
-            unique with.
-        :param primary_key: Mark this field as the primary key. Defaults to False.
+            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
             a ValidationError if validation fails
         :param choices: (optional) The valid choices
-        :param null: (optional) If the field value can be null. If no and there is a default value
-            then the default value is set
+        :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 sparse: (optional) `sparse=True` combined with `unique=True` and `required=False`
-            means that uniqueness won't be enforced for `None` values
+            means that uniqueness won't be enforced for `None` values (Creates an index). Defaults to False.
         :param **kwargs: (optional) Arbitrary indirection-free metadata for
             this field can be supplied as additional keyword arguments and
             accessed as attributes of the field. Must not conflict with any
@@ -521,14 +521,17 @@ def to_python(self, value):
         return value
 
     def to_mongo(self, value):
-        if not isinstance(value, ObjectId):
-            try:
-                return ObjectId(str(value))
-            except Exception as e:
-                self.error(str(e))
-        return value
+        if isinstance(value, ObjectId):
+            return value
+
+        try:
+            return ObjectId(str(value))
+        except Exception as e:
+            self.error(str(e))
 
     def prepare_query_value(self, op, value):
+        if value is None:
+            return value
         return self.to_mongo(value)
 
     def validate(self, value):

mongoengine/base/metaclasses.py

@@ -178,7 +178,6 @@ def __new__(mcs, name, bases, attrs):
                 f.owner_document = new_class
             delete_rule = getattr(f, "reverse_delete_rule", DO_NOTHING)
             if isinstance(f, CachedReferenceField):
-
                 if issubclass(new_class, EmbeddedDocument):
                     raise InvalidDocumentError(
                         "CachedReferenceFields is not allowed in EmbeddedDocuments"