Merge branch 'master' into transactions-global-session-ver

Author: juannyG

.github/workflows/github-actions.yml

@@ -123,7 +123,7 @@ jobs:
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
-        python-version: 3.7
+        python-version: 3.9
         check-latest: true
     - name: install python dep
       run: |

Dockerfile

@@ -0,0 +1,5 @@
+FROM mongo:5
+
+COPY ./entrypoint.sh entrypoint.sh
+RUN chmod u+x entrypoint.sh
+ENTRYPOINT ./entrypoint.sh

README.rst

@@ -48,7 +48,7 @@ You may also have `setuptools <http://peak.telecommunity.com/DevCenter/setuptool
 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
+download the source from `GitHub <https://github.com/MongoEngine/mongoengine>`_ and
 run ``python setup.py install``.
 
 The support for Python2 was dropped with MongoEngine 0.20.0
@@ -66,7 +66,7 @@ If you utilize a ``DateTimeField``, you might also use a more flexible date pars
 
 If you need to use an ``ImageField`` or ``ImageGridFsProxy``:
 
-- Pillow>=2.0.0
+- Pillow>=7.0.0
 
 If you need to use signals:
 

docker-compose.yml

@@ -0,0 +1,7 @@
+services:
+  mongoengine:
+    build:
+      context: .
+    image: mongoengine:latest
+    ports:
+      - 27017:27017

docs/Makefile

@@ -16,13 +16,10 @@ ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html-readthedocs to simulate an html-build for readthedocs"
 	@echo "  html      to make standalone HTML files"
 	@echo "  dirhtml   to make HTML files named index.html in directories"
-	@echo "  pickle    to make pickle files"
-	@echo "  json      to make JSON files"
 	@echo "  htmlhelp  to make HTML files and a HTML help project"
-	@echo "  qthelp    to make HTML files and a qthelp project"
-	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 	@echo "  changes   to make an overview of all changed/added/deprecated items"
 	@echo "  linkcheck to check all external links for integrity"
 	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
@@ -40,47 +37,20 @@ html:
 
 html-readthedocs:
 	$(SPHINXBUILD) -T -E -b readthedocs $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
+	@echo "Open in browser: file://`realpath $(BUILDDIR)/html/index.html`"
 
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-
 htmlhelp:
 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 	@echo
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MongoEngine.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MongoEngine.qhc"
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-	      "run these through (pdf)latex."
-
 changes:
 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 	@echo

docs/changelog.rst

@@ -7,7 +7,21 @@ Changelog
 Development
 ===========
 - (Fill this out as you fix issues and develop your features).
+
+Changes in 0.29.0
+=================
+- Fix weakref in EmbeddedDocumentListField (causing brief mem leak in certain circumstances) #2827
+- Fix pillow deprecation warning related with LANCZOS filter #2824
+- Allow gt/gte/lt/lte/ne operators to be used with a list as value on ListField #2813
 - Switch tox to use pytest instead of legacy `python setup.py test` #2804
+- Add support for timeseries collection #2661
+- Add support in tests for MongoDB 7.0, pymongo 4.7 and pymongo 4.8 in the CI #2826
+- Add support for `array_filters` in Queryset.modify #2811
+- Integrate a docker-compose setup for local testing #2555
+- improve ReferenceField wrong usage detection
+- Fix no_dereference thread-safetyness #2830
+- BREAKING CHANGE: max_length in ListField is now keyword only on ListField signature
+- BREAKING CHANGE: Force `field` argument of ListField/DictField to be a field instance (e.g ListField(StringField()) instead of ListField(StringField)
 
 Changes in 0.28.2
 =================

docs/django.rst

@@ -3,17 +3,4 @@ Django Support
 ==============
 
 .. note:: Django support has been split from the main MongoEngine
-    repository. The *legacy* Django extension may be found bundled with the
-    0.9 release of MongoEngine.
-
-
-
-Help Wanted!
-------------
-
-The MongoEngine team is looking for help contributing and maintaining a new
-Django extension for MongoEngine! If you have Django experience and would like
-to help contribute to the project, please get in touch on the
-`mailing list <http://groups.google.com/group/mongoengine-users>`_ or by
-simply contributing on
-`GitHub <https://github.com/MongoEngine/django-mongoengine>`_.
+    repository.

docs/faq.rst

@@ -8,5 +8,5 @@ Does MongoEngine support asynchronous drivers (Motor, TxMongo)?
 No, MongoEngine is exclusively based on PyMongo and isn't designed to support other driver.
 If this is a requirement for your project, check the alternative:  `uMongo`_ and `MotorEngine`_.
 
-.. _uMongo: https://umongo.readthedocs.io/
-.. _MotorEngine: https://motorengine.readthedocs.io/
+.. _uMongo: https://umongo.readthedocs.io/en/latest/
+.. _MotorEngine: https://motorengine.readthedocs.io/en/latest/

docs/guide/connecting.rst

@@ -47,7 +47,7 @@ of the MongoDB connection string is for::
     connect(host="mongodb://my_user:[email protected]:27017/my_db?authSource=my_db")
 
 The URI string can also be used to configure advanced parameters like ssl, replicaSet, etc. For more
-information or example about URI string, you can refer to the `official doc <https://docs.mongodb.com/manual/reference/connection-string/>`_::
+information or example about URI string, you can refer to the `official doc <https://www.mongodb.com/docs/manual/reference/connection-string/>`_::
 
     connect(host="mongodb://my_user:[email protected]:27017/my_db?authSource=admin&ssl=true&replicaSet=globaldb")
 

docs/guide/defining-documents.rst

@@ -29,7 +29,7 @@ documents are serialized based on their field order.
 
 .. _dynamic-document-schemas:
 
-Dynamic document schemas
+Dynamic Document Schemas
 ========================
 One of the benefits of MongoDB is dynamic schemas for a collection, whilst data
 should be planned and organised (after all explicit is better than implicit!)
@@ -260,7 +260,7 @@ document class as the first argument::
     comment2 = Comment(content='Nice article!')
     page = Page(comments=[comment1, comment2])
 
-Embedded documents can also leverage the flexibility of :ref:`dynamic-document-schemas:`
+Embedded documents can also leverage the flexibility of :ref:`dynamic-document-schemas`
 by inheriting :class:`~mongoengine.DynamicEmbeddedDocument`.
 
 Dictionary Fields
@@ -325,7 +325,7 @@ as the constructor's argument::
 .. _many-to-many-with-listfields:
 
 Many to Many with ListFields
-'''''''''''''''''''''''''''
+''''''''''''''''''''''''''''
 
 If you are implementing a many to many relationship via a list of references,
 then the references are stored as DBRefs and to query you need to pass an
@@ -491,6 +491,26 @@ The following example shows a :class:`Log` document that will be limited to
         ip_address = StringField()
         meta = {'max_documents': 1000, 'max_size': 2000000}
 
+Timeseries collections
+----------------------
+A :class:`~mongoengine.Document` may use a **Timeseries Collection** by specifying
+:attr:`timeseries` in the :attr:`meta` dictionary. Timeseries collection were added
+in MongoDB 5.0 (`doc <https://www.mongodb.com/docs/v5.3/core/timeseries-collections/>`_).
+The following example shows a Document class with a basic setup::
+
+    class SensorData(Document):
+        timestamp = DateTimeField(required=True)
+        temperature = FloatField()
+
+        meta = {
+            "timeseries": {
+                "timeField": "timestamp",
+                "metaField": "temperature",
+                "granularity": "seconds",
+                "expireAfterSeconds": 5,
+            },
+        }
+
 .. defining-indexes_
 
 Indexes
@@ -579,7 +599,7 @@ There are a few top level defaults for all indexes that can be set::
 
 
 :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>`_
+    Set any default index options - see the `full options list <https://www.mongodb.com/docs/manual/reference/method/db.collection.createIndex/>`_
 
 :attr:`index_background` (Optional)
     Set the default value for if an index should be indexed in the background