PYTHON-3311 Module "pymongo" does not explicitly export attribute "MongoClient"; implicit reexport disabled (#994)

Author: blink1073

bson/__init__.py

@@ -86,7 +86,7 @@
     cast,
 )
 
-from bson.binary import (  # noqa: F401
+from bson.binary import (
     ALL_UUID_SUBTYPES,
     CSHARP_LEGACY,
     JAVA_LEGACY,
@@ -128,6 +128,66 @@
 except ImportError:
     _USE_C = False
 
+__all__ = [
+    "ALL_UUID_SUBTYPES",
+    "CSHARP_LEGACY",
+    "JAVA_LEGACY",
+    "OLD_UUID_SUBTYPE",
+    "STANDARD",
+    "UUID_SUBTYPE",
+    "Binary",
+    "UuidRepresentation",
+    "Code",
+    "DEFAULT_CODEC_OPTIONS",
+    "CodecOptions",
+    "DBRef",
+    "Decimal128",
+    "InvalidBSON",
+    "InvalidDocument",
+    "InvalidStringData",
+    "Int64",
+    "MaxKey",
+    "MinKey",
+    "ObjectId",
+    "Regex",
+    "RE_TYPE",
+    "SON",
+    "Timestamp",
+    "utc",
+    "EPOCH_AWARE",
+    "EPOCH_NAIVE",
+    "BSONNUM",
+    "BSONSTR",
+    "BSONOBJ",
+    "BSONARR",
+    "BSONBIN",
+    "BSONUND",
+    "BSONOID",
+    "BSONBOO",
+    "BSONDAT",
+    "BSONNUL",
+    "BSONRGX",
+    "BSONREF",
+    "BSONCOD",
+    "BSONSYM",
+    "BSONCWS",
+    "BSONINT",
+    "BSONTIM",
+    "BSONLON",
+    "BSONDEC",
+    "BSONMIN",
+    "BSONMAX",
+    "get_data_and_view",
+    "gen_list_name",
+    "encode",
+    "decode",
+    "decode_all",
+    "decode_iter",
+    "decode_file_iter",
+    "is_valid",
+    "BSON",
+    "has_c",
+]
 
 EPOCH_AWARE = datetime.datetime.fromtimestamp(0, utc)
 EPOCH_NAIVE = datetime.datetime.utcfromtimestamp(0)

bson/objectid.py

@@ -12,8 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Tools for working with MongoDB `ObjectIds
-<http://dochub.mongodb.org/core/objectids>`_.
+"""Tools for working with MongoDB ObjectIds.
 """
 
 import binascii
@@ -88,7 +87,7 @@ def __init__(self, oid: Optional[Union[str, "ObjectId", bytes]] = None) -> None:
         :Parameters:
           - `oid` (optional): a valid ObjectId.
 
-        .. seealso:: The MongoDB documentation on `ObjectIds`_.
+        .. seealso:: The MongoDB documentation on  `ObjectIds <http://dochub.mongodb.org/core/objectids>`_.
 
         .. versionchanged:: 3.8
            :class:`~bson.objectid.ObjectId` now implements the `ObjectID

gridfs/__init__.py

@@ -42,6 +42,16 @@
 from pymongo.read_preferences import _ServerMode
 from pymongo.write_concern import WriteConcern
 
+__all__ = [
+    "GridFS",
+    "GridFSBucket",
+    "NoFile",
+    "DEFAULT_CHUNK_SIZE",
+    "GridIn",
+    "GridOut",
+    "GridOutCursor",
+]
+
 
 class GridFS(object):
     """An instance of GridFS on top of a single Database."""

pymongo/__init__.py

@@ -16,6 +16,35 @@
 
 from typing import ContextManager, Optional, Tuple, Union
 
+__all__ = [
+    "ASCENDING",
+    "DESCENDING",
+    "GEO2D",
+    "GEOSPHERE",
+    "HASHED",
+    "TEXT",
+    "version_tuple",
+    "get_version_string",
+    "__version__",
+    "version",
+    "ReturnDocument",
+    "MAX_SUPPORTED_WIRE_VERSION",
+    "MIN_SUPPORTED_WIRE_VERSION",
+    "CursorType",
+    "MongoClient",
+    "DeleteMany",
+    "DeleteOne",
+    "IndexModel",
+    "InsertOne",
+    "ReplaceOne",
+    "UpdateMany",
+    "UpdateOne",
+    "ReadPreference",
+    "WriteConcern",
+    "has_c",
+    "timeout",
+]
+
 ASCENDING = 1
 """Ascending sort order."""
 DESCENDING = -1
@@ -70,14 +99,11 @@ def get_version_string() -> str:
 """Current version of PyMongo."""
 
 from pymongo import _csot
-from pymongo.collection import ReturnDocument  # noqa: F401
-from pymongo.common import (  # noqa: F401
-    MAX_SUPPORTED_WIRE_VERSION,
-    MIN_SUPPORTED_WIRE_VERSION,
-)
-from pymongo.cursor import CursorType  # noqa: F401
-from pymongo.mongo_client import MongoClient  # noqa: F401
-from pymongo.operations import (  # noqa: F401
+from pymongo.collection import ReturnDocument
+from pymongo.common import MAX_SUPPORTED_WIRE_VERSION, MIN_SUPPORTED_WIRE_VERSION
+from pymongo.cursor import CursorType
+from pymongo.mongo_client import MongoClient
+from pymongo.operations import (
     DeleteMany,
     DeleteOne,
     IndexModel,
@@ -86,8 +112,8 @@ def get_version_string() -> str:
     UpdateMany,
     UpdateOne,
 )
-from pymongo.read_preferences import ReadPreference  # noqa: F401
-from pymongo.write_concern import WriteConcern  # noqa: F401
+from pymongo.read_preferences import ReadPreference
+from pymongo.write_concern import WriteConcern
 
 
 def has_c() -> bool:

pymongo/database.py

@@ -55,6 +55,7 @@ def _check_name(name):
 
 
 if TYPE_CHECKING:
+    import bson.codec_options
     from pymongo.client_session import ClientSession
     from pymongo.mongo_client import MongoClient
     from pymongo.read_concern import ReadConcern
@@ -699,7 +700,7 @@ def command(
         check: bool = True,
         allowable_errors: Optional[Sequence[Union[str, int]]] = None,
         read_preference: Optional[_ServerMode] = None,
-        codec_options: "Optional[CodecOptions[_CodecDocumentType]]" = None,
+        codec_options: "Optional[bson.codec_options.CodecOptions[_CodecDocumentType]]" = None,
         session: Optional["ClientSession"] = None,
         comment: Optional[Any] = None,
         **kwargs: Any,
@@ -764,7 +765,7 @@ def command(
 
         .. note:: :meth:`command` does **not** obey this Database's
            :attr:`read_preference` or :attr:`codec_options`. You must use the
-           `read_preference` and `codec_options` parameters instead.
+           ``read_preference`` and ``codec_options`` parameters instead.
 
         .. note:: :meth:`command` does **not** apply any custom TypeDecoders
            when decoding the command response.
@@ -785,7 +786,7 @@ def command(
            regular expressions as :class:`~bson.regex.Regex` objects. Use
            :meth:`~bson.regex.Regex.try_compile` to attempt to convert from a
            BSON regular expression to a Python regular expression object.
-           Added the `codec_options` parameter.
+           Added the ``codec_options`` parameter.
 
         .. seealso:: The MongoDB documentation on `commands <https://dochub.mongodb.org/core/commands>`_.
         """

test/test_default_exports.py

@@ -0,0 +1,70 @@
+# Copyright 2022-present MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Test the default exports of the top level packages."""
+import inspect
+import unittest
+
+import bson
+import gridfs
+import pymongo
+
+BSON_IGNORE = []
+GRIDFS_IGNORE = [
+    "ASCENDING",
+    "DESCENDING",
+    "ClientSession",
+    "Collection",
+    "ObjectId",
+    "validate_string",
+    "Database",
+    "ConfigurationError",
+    "WriteConcern",
+]
+PYMONGO_IGNORE = []
+GLOBAL_INGORE = ["TYPE_CHECKING"]
+
+
+class TestDefaultExports(unittest.TestCase):
+    def check_module(self, mod, ignores):
+        names = dir(mod)
+        names.remove("__all__")
+        for name in mod.__all__:
+            if name not in names and name not in ignores:
+                self.fail(f"{name} was included in {mod}.__all__ but is not a valid symbol")
+
+        for name in names:
+            if name not in mod.__all__ and name not in ignores:
+                if name in GLOBAL_INGORE:
+                    continue
+                value = getattr(mod, name)
+                if inspect.ismodule(value):
+                    continue
+                if getattr(value, "__module__", None) == "typing":
+                    continue
+                if not name.startswith("_"):
+                    self.fail(f"{name} was not included in {mod}.__all__")
+
+    def test_pymongo(self):
+        self.check_module(pymongo, PYMONGO_IGNORE)
+
+    def test_gridfs(self):
+        self.check_module(gridfs, GRIDFS_IGNORE)
+
+    def test_bson(self):
+        self.check_module(bson, BSON_IGNORE)
+
+
+if __name__ == "__main__":
+    unittest.main()

test/test_mypy.py

@@ -43,9 +43,8 @@ class Movie(TypedDict):  # type: ignore[misc]
 from bson import CodecOptions, decode, decode_all, decode_file_iter, decode_iter, encode
 from bson.raw_bson import RawBSONDocument
 from bson.son import SON
-from pymongo import ASCENDING
+from pymongo import ASCENDING, MongoClient
 from pymongo.collection import Collection
-from pymongo.mongo_client import MongoClient
 from pymongo.operations import InsertOne
 from pymongo.read_preferences import ReadPreference