refactor: public api expose import

Author: arunsureshkumar

mongoengine/__init__.py

@@ -1,39 +1,65 @@
-# Import submodules so that we can expose their __all__
-from mongoengine import (
-    document,
-    errors,
-    fields,
-    signals,
-)
-from mongoengine.synchronous import connection
-from mongoengine.base import queryset
-
-# Import everything from each submodule so that it can be accessed via
-# mongoengine, e.g. instead of `from mongoengine.connection import connect`,
-# users can simply use `from mongoengine import connect`, or even
-# `from mongoengine import *` and then `connect('testdb')`.
-from mongoengine.synchronous.connection import *  # noqa: F401
-from mongoengine.document import *  # noqa: F401
-from mongoengine.errors import *  # noqa: F401
-from mongoengine.fields import *  # noqa: F401
-from mongoengine.signals import *  # noqa: F401
+"""
+MongoEngine top-level public API.
+
+Import submodules and re-export their public symbols so that users can write:
+
+    from mongoengine import connect
+    from mongoengine import async_connect
+    from mongoengine import Document, StringField
+    from mongoengine import QuerySet, AsyncQuerySet
+
+Or simply:
+
+    from mongoengine import *
+
+Instead of importing from internal submodules.
+
+This module exposes both synchronous and asynchronous APIs.
+Asynchronous functionality is backed by PyMongo's native async support
+(PyMongo >= 4.14).
+"""
 
+from mongoengine import document, errors, fields, signals
+
+# ---- private imports (for __all__ only) ----
+from mongoengine.synchronous import connection as _sync_connection
+from mongoengine.asynchronous import connection as _async_connection
+from mongoengine.synchronous import queryset as _sync_queryset
+from mongoengine.asynchronous import queryset as _async_queryset
+
+# ---- public re-exports ----
+from mongoengine.synchronous.connection import *  # noqa: F401,F403
+from mongoengine.asynchronous.connection import *  # noqa: F401,F403
+from mongoengine.synchronous.queryset import *  # noqa: F401,F403
+from mongoengine.asynchronous.queryset import *  # noqa: F401,F403
+
+from mongoengine.document import *  # noqa: F401,F403
+from mongoengine.errors import *  # noqa: F401,F403
+from mongoengine.fields import *  # noqa: F401,F403
+from mongoengine.signals import *  # noqa: F401,F403
+
+# ---- public API surface ----
 __all__ = (
         list(document.__all__)
         + list(fields.__all__)
-        + list(connection.__all__)
+        + list(_sync_connection.__all__)
+        + list(_async_connection.__all__)
+        + list(_sync_queryset.__all__)
+        + list(_async_queryset.__all__)
         + list(signals.__all__)
         + list(errors.__all__)
 )
 
+# ---- hide internals ----
+del _sync_connection
+del _async_connection
+del _sync_queryset
+del _async_queryset
+
 VERSION = (0, 29, 0)
 
 
 def get_version():
-    """Return the VERSION as a string.
-
-    For example, if `VERSION == (0, 10, 7)`, return '0.10.7'.
-    """
     return ".".join(map(str, VERSION))
 
 

mongoengine/asynchronous/queryset/__init__.py

@@ -1,8 +1,18 @@
-from .base import *
-from .queryset import *
-
-# Expose just the public subset of all imported objects and constants.
-__all__ = (
-        list(base.__all__) +
-        list(queryset.__all__)
-)
+"""
+Asynchronous QuerySet public API.
+
+Re-export the public classes/functions from:
+- base.py
+- queryset.py
+"""
+
+from . import base as _base
+from . import queryset as _queryset
+
+from .base import *  # noqa: F401,F403
+from .queryset import *  # noqa: F401,F403
+
+__all__ = tuple(_base.__all__) + tuple(_queryset.__all__)
+
+del _base
+del _queryset

mongoengine/common.py

@@ -1,4 +1,3 @@
-from pymongo import ReadPreference
 from pymongo.database_shared import _check_name
 from pymongo.read_preferences import Secondary, Primary, PrimaryPreferred, SecondaryPreferred, Nearest
 

mongoengine/synchronous/__init__.py

@@ -1,5 +1,7 @@
+from .connection import *
 from .queryset import *
 
 __all__ = [
-    list(queryset.__all__)
+    list(connection.__all__) +
+    list(queryset.__all__),
 ]

mongoengine/synchronous/queryset/__init__.py

@@ -1,8 +1,18 @@
-from .base import *
-from .queryset import *
-
-# Expose just the public subset of all imported objects and constants.
-__all__ = (
-        list(base.__all__) +
-        list(queryset.__all__)
-)
+"""
+Synchronous QuerySet public API.
+
+Re-export the public classes/functions from:
+- base.py
+- queryset.py
+"""
+
+from . import base as _base
+from . import queryset as _queryset
+
+from .base import *  # noqa: F401,F403
+from .queryset import *  # noqa: F401,F403
+
+__all__ = tuple(_base.__all__) + tuple(_queryset.__all__)
+
+del _base
+del _queryset

tests/asynchronous/all_warnings/test_warnings.py

@@ -8,7 +8,7 @@
 import warnings
 
 from mongoengine import *
-from mongoengine.asynchronous import async_connect, async_disconnect_all
+# from mongoengine import async_connect, async_disconnect_all
 from mongoengine.base.common import _document_registry
 from tests.asynchronous.utils import reset_async_connections
 

tests/asynchronous/document/test_class_methods.py

@@ -1,7 +1,6 @@
 import unittest
 
 from mongoengine import *
-from mongoengine.asynchronous import async_connect, async_get_db, async_disconnect
 from mongoengine.pymongo_support import async_list_collection_names
 from mongoengine.base.queryset import NULLIFY, PULL
 from tests.asynchronous.utils import reset_async_connections

tests/asynchronous/document/test_delta.py

@@ -3,7 +3,6 @@
 from bson import SON
 
 from mongoengine import *
-from mongoengine.asynchronous import async_disconnect
 from mongoengine.pymongo_support import list_collection_names, async_list_collection_names
 from tests.asynchronous.utils import MongoDBAsyncTestCase, async_get_as_pymongo, reset_async_connections
 

tests/asynchronous/queryset/test_queryset.py

@@ -11,8 +11,6 @@
 from pymongo.results import UpdateResult
 
 from mongoengine import *
-from mongoengine.asynchronous import async_connect, async_disconnect, AsyncQuerySet, async_get_db, AsyncBaseQuerySet, \
-    AsyncQuerySetNoCache, async_register_connection
 from mongoengine.base import LazyReference
 from mongoengine.context_managers import async_query_counter, switch_db
 from mongoengine.errors import InvalidQueryError

tests/asynchronous/queryset/test_visitor.py

@@ -6,7 +6,6 @@
 from bson import ObjectId
 
 from mongoengine import *
-from mongoengine.asynchronous import async_connect, async_disconnect
 from mongoengine.common import _async_queryset_to_values
 from mongoengine.errors import InvalidQueryError
 from mongoengine.base.queryset import Q