nicer imports

mongoengine/base/__init__.py

@@ -0,0 +1,29 @@
+# Base module is split into several files for convenience. Files inside of
+# this module should import from a specific submodule (e.g.
+# `from mongoengine.base.document import BaseDocument`), but all of the
+# other modules should import directly from the top-level module (e.g.
+# `from mongoengine.base import BaseDocument`). This approach is cleaner and
+# also helps with cyclical import errors.
+from mongoengine.base.common import *
+from mongoengine.base.datastructures import *
+from mongoengine.base.document import *
+from mongoengine.base.fields import *
+from mongoengine.base.metaclasses import *
+
+__all__ = (
+    # common
+    'ALLOW_INHERITANCE', 'UPDATE_OPERATORS', '_document_registry',
+    'get_document',
+
+    # datastructures
+    'BaseDict', 'BaseList', 'EmbeddedDocumentList',
+
+    # document
+    'BaseDocument',
+
+    # fields
+    'BaseField', 'ComplexBaseField', 'ObjectIdField', 'GeoJsonBaseField',
+
+    # metaclasses
+    'DocumentMetaclass', 'TopLevelDocumentMetaclass'
+)

mongoengine/base/common.py

@@ -1,9 +1,17 @@
 from mongoengine.errors import NotRegistered
 
-__all__ = ('get_document', '_document_registry')
+__all__ = ('ALLOW_INHERITANCE', 'UPDATE_OPERATORS', 'get_document',
+           '_document_registry')
+
 
 ALLOW_INHERITANCE = False  # TODO is this really necessary?
 
+
+UPDATE_OPERATORS = set(['set', 'unset', 'inc', 'dec', 'pop', 'push',
+                        'push_all', 'pull', 'pull_all', 'add_to_set',
+                        'set_on_insert', 'min', 'max'])
+
+
 _document_registry = {}
 
 

mongoengine/base/datastructures.py

@@ -6,7 +6,7 @@ import six
 from mongoengine.common import _import_class
 from mongoengine.errors import DoesNotExist, MultipleObjectsReturned
 
-__all__ = ("BaseDict", "BaseList", "EmbeddedDocumentList")
+__all__ = ('BaseDict', 'BaseList', 'EmbeddedDocumentList')
 
 
 class BaseDict(dict):

mongoengine/base/document.py

@@ -21,7 +21,7 @@ from mongoengine.errors import (FieldDoesNotExist, InvalidDocumentError,
                                 LookUpError, ValidationError, OperationError)
 from mongoengine.python_support import PY3
 
-__all__ = ('BaseDocument', 'NON_FIELD_ERRORS')
+__all__ = ('BaseDocument',)
 
 NON_FIELD_ERRORS = '__all__'
 

mongoengine/base/fields.py

@@ -6,10 +6,9 @@ from bson import DBRef, ObjectId, SON
 import pymongo
 import six
 
-from mongoengine.base.common import ALLOW_INHERITANCE
-from mongoengine.base.datastructures import (
-    BaseDict, BaseList, EmbeddedDocumentList
-)
+from mongoengine.base.common import ALLOW_INHERITANCE, UPDATE_OPERATORS
+from mongoengine.base.datastructures import (BaseDict, BaseList,
+                                             EmbeddedDocumentList)
 from mongoengine.common import _import_class
 from mongoengine.errors import ValidationError
 
@@ -18,11 +17,6 @@ __all__ = ('BaseField', 'ComplexBaseField', 'ObjectIdField',
            'GeoJsonBaseField')
 
 
-UPDATE_OPERATORS = set(['set', 'unset', 'inc', 'dec', 'pop', 'push',
-                        'push_all', 'pull', 'pull_all', 'add_to_set',
-                        'set_on_insert', 'min', 'max'])
-
-
 class BaseField(object):
     """A base class for fields in a MongoDB document. Instances of this class
     may be added to subclasses of `Document` to define a document's schema.

mongoengine/queryset/base.py

@@ -15,7 +15,7 @@ from pymongo.common import validate_read_preference
 import six
 
 from mongoengine import signals
-from mongoengine.base.common import get_document
+from mongoengine.base import get_document
 from mongoengine.common import _import_class
 from mongoengine.connection import get_db
 from mongoengine.context_managers import switch_db

mongoengine/queryset/transform.py

@@ -4,7 +4,7 @@ from bson import SON
 import pymongo
 import six
 
-from mongoengine.base.fields import UPDATE_OPERATORS
+from mongoengine.base import UPDATE_OPERATORS
 from mongoengine.common import _import_class
 from mongoengine.connection import get_connection
 from mongoengine.errors import InvalidQueryError

tests/document/instance.py

@@ -13,7 +13,7 @@ from tests.fixtures import (PickleEmbedded, PickleTest, PickleSignalsTest,
                             PickleDynamicEmbedded, PickleDynamicTest)
 
 from mongoengine import *
-from mongoengine.base.common import get_document, _document_registry
+from mongoengine.base import get_document, _document_registry
 from mongoengine.connection import get_db
 from mongoengine.errors import (NotRegistered, InvalidDocumentError,
                                 InvalidQueryError, NotUniqueError,

tests/fields/fields.py

@@ -25,9 +25,8 @@ except ImportError:
 
 from mongoengine import *
 from mongoengine.connection import get_db
-from mongoengine.base.common import _document_registry
-from mongoengine.base.datastructures import BaseDict, EmbeddedDocumentList
-from mongoengine.base.fields import BaseField
+from mongoengine.base import (BaseDict, BaseField, EmbeddedDocumentList,
+                              _document_registry)
 from mongoengine.errors import NotRegistered, DoesNotExist
 from mongoengine.python_support import PY3