fix tests so they test all the methods

Author: juliusgeo

.github/workflows/test-python.yml

@@ -59,7 +59,7 @@ jobs:
           cache-dependency-path: 'setup.py'
       - name: Install dependencies
         run: |
-          python -m pip install -U pip mypy
+          python -m pip install -U pip mypy typing_extensions
           pip install -e ".[zstd, encryption, ocsp]"
       - name: Run mypy
         run: |

doc/examples/type_hints.rst

@@ -92,12 +92,14 @@ Note that when using :class:`~bson.son.SON`, the key and value types must be giv
 Typed Collection
 ----------------
 
-You can use :py:class:`~typing_extensions.TypedDict` (Python 3.8+) when using a well-defined schema for the data in a :class:`~pymongo.collection.Collection`.
-Note that all `schema_validation`_ for inserts and updates is done on the server. This is due to the fact that these methods automatically add
-an "_id" field. In the example below the "_id" field is marked by the :py:class:`~typing_extensions.NotRequired` notation to allow it to be accessed when reading
-from `result`. If it is simply not included in the definition, then it will be automatically added, but it will raise a type-checking error if you attempt to access it.
-Another option would be to generate the "_id" field yourself, and make it a required field. This would give the expected behavior, but would then also prevent you from
-relying on PyMongo to insert the "_id" field.
+You can use :py:class:`~typing_extensions.TypedDict` (Python 3.8+) when using a well-defined schema for the data in a
+:class:`~pymongo.collection.Collection`. Note that all `schema validation`_ for inserts and updates is done on the server.
+These methods automatically add an "_id" field. In the example below the "_id" field is
+marked by the :py:class:`~typing_extensions.NotRequired` notation to allow it to be accessed when reading from
+``result``. If it is simply not included in the definition, then it will be automatically added, but it will raise a
+type-checking error if you attempt to access it. Another option would be to generate the "_id" field yourself, and make
+it a required field. This would give the expected behavior, but would then also prevent you from relying on PyMongo to
+insert the "_id" field.
 
 .. doctest::
 

pymongo/operations.py

@@ -19,15 +19,15 @@
 from pymongo.collation import validate_collation_or_none
 from pymongo.common import validate_boolean, validate_is_mapping, validate_list
 from pymongo.helpers import _gen_index_name, _index_document, _index_list
-from pymongo.typings import _CollationIn, _DocumentIn, _Pipeline
+from pymongo.typings import _CollationIn, _DocumentIn, _DocumentType, _Pipeline
 
 
 class InsertOne(object):
     """Represents an insert_one operation."""
 
     __slots__ = ("_doc",)
 
-    def __init__(self, document: _DocumentIn) -> None:
+    def __init__(self, document: Union[_DocumentIn, _DocumentType]) -> None:
         """Create an InsertOne instance.
 
         For use with :meth:`~pymongo.collection.Collection.bulk_write`.

test/test_mypy.py

@@ -36,7 +36,7 @@ class ImplicitMovie(TypedDict):  # type: ignore[misc]
         name: str
         year: int
 
-    class EmptyMovie(TypedDict):  # type: ignore[misc]
+    class MovieWithoutId(TypedDict):  # type: ignore[misc]
         name: str
         year: int
 
@@ -324,43 +324,61 @@ def test_typeddict_document_type(self) -> None:
         assert retreived["year"] == 1
         assert retreived["name"] == "a"
 
-    # TODO: mypy --install-types --non-interactive test/test_mypy.py
-    # run just this file in CI
     @only_type_check
     def test_typeddict_document_type_insertion(self) -> None:
         client: MongoClient[Movie] = MongoClient()
         coll: Collection[Movie] = client.test.test
-        insert = coll.insert_one(Movie(_id=ObjectId(), name="THX-1138", year=1971))
-        out = coll.find_one({"name": "THX-1138"})
-        assert out is not None
-        # This should fail because the output is a Movie.
-        assert out["foo"]  # type:ignore[typeddict-item]
-        assert type(out["_id"]) == ObjectId
+        mov = Movie(_id=ObjectId(), name="THX-1138", year=1971)
+        for meth, arg in [
+            (coll.insert_many, [mov]),
+            (coll.insert_one, mov),
+            (coll.bulk_write, [InsertOne(mov)]),
+        ]:
+            meth(arg)  # type:ignore[operator]
+            out = coll.find_one({"name": "THX-1138"})
+            assert out is not None
+            # This should fail because the output is a Movie.
+            assert out["foo"]  # type:ignore[typeddict-item]
+            assert type(out["_id"]) == ObjectId
+            coll.drop()
 
     # This should work the same as the test above, but this time using NotRequired to allow
     # automatic insertion of the _id field by insert_one.
     @only_type_check
     def test_typeddict_document_type_not_required(self) -> None:
         client: MongoClient[ImplicitMovie] = MongoClient()
         coll: Collection[ImplicitMovie] = client.test.test
-        insert = coll.insert_one(ImplicitMovie(name="THX-1138", year=1971))
-        out = coll.find_one({"name": "THX-1138"})
-        assert out is not None
-        # This should fail because the output is a Movie.
-        assert out["foo"]  # type:ignore[typeddict-item]
-        assert type(out["_id"]) == ObjectId
+        mov = ImplicitMovie(name="THX-1138", year=1971)
+        for meth, arg in [
+            (coll.insert_many, [mov]),
+            (coll.insert_one, mov),
+            (coll.bulk_write, [InsertOne(mov)]),
+        ]:
+            meth(arg)  # type:ignore[operator]
+            out = coll.find_one({"name": "THX-1138"})
+            assert out is not None
+            # This should fail because the output is a Movie.
+            assert out["foo"]  # type:ignore[typeddict-item]
+            assert type(out["_id"]) == ObjectId
+            coll.drop()
 
     @only_type_check
     def test_typeddict_document_type_empty(self) -> None:
-        client: MongoClient[EmptyMovie] = MongoClient()
-        coll: Collection[EmptyMovie] = client.test.test
-        insert = coll.insert_one(EmptyMovie(name="THX-1138", year=1971))
-        out = coll.find_one({"name": "THX-1138"})
-        assert out is not None
-        # This should fail because the output is a Movie.
-        assert out["foo"]  # type:ignore[typeddict-item]
-        # This should fail because _id is not included in our TypedDict definition.
-        assert type(out["_id"]) == ObjectId  # type:ignore[typeddict-item]
+        client: MongoClient[MovieWithoutId] = MongoClient()
+        coll: Collection[MovieWithoutId] = client.test.test
+        mov = MovieWithoutId(name="THX-1138", year=1971)
+        for meth, arg in [
+            (coll.insert_many, [mov]),
+            (coll.insert_one, mov),
+            (coll.bulk_write, [InsertOne(mov)]),
+        ]:
+            meth(arg)  # type:ignore[operator]
+            out = coll.find_one({"name": "THX-1138"})
+            assert out is not None
+            # This should fail because the output is a Movie.
+            assert out["foo"]  # type:ignore[typeddict-item]
+            # This should fail because _id is not included in our TypedDict definition.
+            assert type(out["_id"]) == ObjectId  # type:ignore[typeddict-item]
 
     @only_type_check
     def test_raw_bson_document_type(self) -> None:

test/utils.py

@@ -602,7 +602,7 @@ def ensure_all_connected(client: MongoClient) -> None:
     Depending on the use-case, the caller may need to clear any event listeners
     that are configured on the client.
     """
-    hello: Any = client.admin.command(HelloCompat.LEGACY_CMD)
+    hello: dict = client.admin.command(HelloCompat.LEGACY_CMD)
     if "setName" not in hello:
         raise ConfigurationError("cluster is not a replica set")
 
@@ -613,7 +613,7 @@ def ensure_all_connected(client: MongoClient) -> None:
     def discover():
         i = 0
         while i < 100 and connected_host_list != target_host_list:
-            hello: Any = client.admin.command(
+            hello: dict = client.admin.command(
                 HelloCompat.LEGACY_CMD, read_preference=ReadPreference.SECONDARY
             )
             connected_host_list.update([hello["me"]])