Exctract documents to separate file

Author: insspb

docs/api/base.rst

@@ -8,6 +8,21 @@ flask_mongoengine.connection module
 
 .. automodule:: flask_mongoengine.connection
 
+flask_mongoengine.db_fields module
+----------------------------------
+
+.. automodule:: flask_mongoengine.db_fields
+
+flask_mongoengine.decorators module
+-----------------------------------
+
+.. automodule:: flask_mongoengine.decorators
+
+flask_mongoengine.documents module
+----------------------------------
+
+.. automodule:: flask_mongoengine.documents
+
 flask_mongoengine.json module
 -----------------------------
 

docs/api/wtf.rst

@@ -3,11 +3,6 @@ WTF module API
 
 This is the flask_mongoengine.wtf modules API documentation.
 
-flask_mongoengine.wtf.db_fields module
---------------------------------------
-
-.. automodule:: flask_mongoengine.wtf.db_fields
-
 flask_mongoengine.wtf.fields module
 -----------------------------------
 

flask_mongoengine/__init__.py

@@ -1,11 +1,9 @@
 import warnings
 
 import mongoengine
-from flask import Flask, abort, current_app
-from mongoengine.errors import DoesNotExist
-from mongoengine.queryset import QuerySet
+from flask import Flask, current_app
 
-from flask_mongoengine import db_fields
+from flask_mongoengine import db_fields, documents
 from flask_mongoengine.connection import *
 from flask_mongoengine.json import override_json_encoder
 from flask_mongoengine.pagination import *
@@ -80,8 +78,8 @@ def __init__(self, app=None, config=None):
         self.config = config
 
         # Extended documents classes
-        self.Document = Document
-        self.DynamicDocument = DynamicDocument
+        self.Document = documents.Document
+        self.DynamicDocument = documents.DynamicDocument
 
         if app is not None:
             self.init_app(app, config)
@@ -147,81 +145,3 @@ def __getattr__(self, attr_name):
         modified by us, and not mapped directly.
         """
         return getattr(mongoengine, attr_name)
-
-
-class BaseQuerySet(QuerySet):
-    """Extends :class:`~mongoengine.queryset.QuerySet` class with handly methods."""
-
-    def _abort_404(self, _message_404):
-        """Returns 404 error with message, if message provided.
-
-        :param _message_404: Message for 404 comment
-        """
-        abort(404, _message_404) if _message_404 else abort(404)
-
-    def get_or_404(self, *args, _message_404=None, **kwargs):
-        """Get a document and raise a 404 Not Found error if it doesn't exist.
-
-        :param _message_404: Message for 404 comment, not forwarded to
-            :func:`~mongoengine.queryset.QuerySet.get`
-        :param args: args list, silently forwarded to
-            :func:`~mongoengine.queryset.QuerySet.get`
-        :param kwargs: keywords arguments, silently forwarded to
-            :func:`~mongoengine.queryset.QuerySet.get`
-        """
-        try:
-            return self.get(*args, **kwargs)
-        except DoesNotExist:
-            self._abort_404(_message_404)
-
-    def first_or_404(self, _message_404=None):
-        """
-        Same as :func:`~BaseQuerySet.get_or_404`, but uses
-        :func:`~mongoengine.queryset.QuerySet.first`, not
-        :func:`~mongoengine.queryset.QuerySet.get`.
-
-        :param _message_404: Message for 404 comment, not forwarded to
-            :func:`~mongoengine.queryset.QuerySet.get`
-        """
-        return self.first() or self._abort_404(_message_404)
-
-    def paginate(self, page, per_page, **kwargs):
-        """
-        Paginate the QuerySet with a certain number of docs per page
-        and return docs for a given page.
-        """
-        return Pagination(self, page, per_page)
-
-    def paginate_field(self, field_name, doc_id, page, per_page, total=None):
-        """
-        Paginate items within a list field from one document in the
-        QuerySet.
-        """
-        # TODO this doesn't sound useful at all - remove in next release?
-        item = self.get(id=doc_id)
-        count = getattr(item, f"{field_name}_count", "")
-        total = total or count or len(getattr(item, field_name))
-        return ListFieldPagination(
-            self, doc_id, field_name, page, per_page, total=total
-        )
-
-
-class Document(mongoengine.Document):
-    """Abstract document with extra helpers in the queryset class"""
-
-    meta = {"abstract": True, "queryset_class": BaseQuerySet}
-
-    def paginate_field(self, field_name, page, per_page, total=None):
-        """Paginate items within a list field."""
-        # TODO this doesn't sound useful at all - remove in next release?
-        count = getattr(self, f"{field_name}_count", "")
-        total = total or count or len(getattr(self, field_name))
-        return ListFieldPagination(
-            self.__class__.objects, self.pk, field_name, page, per_page, total=total
-        )
-
-
-class DynamicDocument(mongoengine.DynamicDocument):
-    """Abstract Dynamic document with extra helpers in the queryset class"""
-
-    meta = {"abstract": True, "queryset_class": BaseQuerySet}

flask_mongoengine/documents.py

@@ -0,0 +1,85 @@
+"""Extended version of :mod:`mongoengine.document`."""
+import mongoengine
+from flask import abort
+from mongoengine.errors import DoesNotExist
+from mongoengine.queryset import QuerySet
+
+from flask_mongoengine.pagination import ListFieldPagination, Pagination
+
+
+class BaseQuerySet(QuerySet):
+    """Extends :class:`~mongoengine.queryset.QuerySet` class with handly methods."""
+
+    def _abort_404(self, _message_404):
+        """Returns 404 error with message, if message provided.
+
+        :param _message_404: Message for 404 comment
+        """
+        abort(404, _message_404) if _message_404 else abort(404)
+
+    def get_or_404(self, *args, _message_404=None, **kwargs):
+        """Get a document and raise a 404 Not Found error if it doesn't exist.
+
+        :param _message_404: Message for 404 comment, not forwarded to
+            :func:`~mongoengine.queryset.QuerySet.get`
+        :param args: args list, silently forwarded to
+            :func:`~mongoengine.queryset.QuerySet.get`
+        :param kwargs: keywords arguments, silently forwarded to
+            :func:`~mongoengine.queryset.QuerySet.get`
+        """
+        try:
+            return self.get(*args, **kwargs)
+        except DoesNotExist:
+            self._abort_404(_message_404)
+
+    def first_or_404(self, _message_404=None):
+        """
+        Same as :func:`~BaseQuerySet.get_or_404`, but uses
+        :func:`~mongoengine.queryset.QuerySet.first`, not
+        :func:`~mongoengine.queryset.QuerySet.get`.
+
+        :param _message_404: Message for 404 comment, not forwarded to
+            :func:`~mongoengine.queryset.QuerySet.get`
+        """
+        return self.first() or self._abort_404(_message_404)
+
+    def paginate(self, page, per_page, **kwargs):
+        """
+        Paginate the QuerySet with a certain number of docs per page
+        and return docs for a given page.
+        """
+        return Pagination(self, page, per_page)
+
+    def paginate_field(self, field_name, doc_id, page, per_page, total=None):
+        """
+        Paginate items within a list field from one document in the
+        QuerySet.
+        """
+        # TODO this doesn't sound useful at all - remove in next release?
+        item = self.get(id=doc_id)
+        count = getattr(item, f"{field_name}_count", "")
+        total = total or count or len(getattr(item, field_name))
+        return ListFieldPagination(
+            self, doc_id, field_name, page, per_page, total=total
+        )
+
+
+class Document(mongoengine.Document):
+    """Abstract document with extra helpers in the queryset class"""
+
+    meta = {"abstract": True, "queryset_class": BaseQuerySet}
+
+    def paginate_field(self, field_name, page, per_page, total=None):
+        """Paginate items within a list field."""
+        # TODO this doesn't sound useful at all - remove in next release?
+        count = getattr(self, f"{field_name}_count", "")
+        total = total or count or len(getattr(self, field_name))
+        return ListFieldPagination(
+            self.__class__.objects, self.pk, field_name, page, per_page, total=total
+        )
+
+
+class DynamicDocument(mongoengine.DynamicDocument):
+    """Abstract Dynamic document with extra helpers in the queryset class"""
+
+    meta = {"abstract": True, "queryset_class": BaseQuerySet}