add mypy test

Author: juliusgeo

doc/examples/type_hints.rst

@@ -93,8 +93,8 @@ Typed Collection
 ----------------
 
 You can use :py:class:`~typing.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. Do not rely on type hints for schema validation, only for providing
-a more ergonomic interface:
+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. Do not rely on TypedDicts for schema validation, only for providing a more ergonomic interface:
 
 .. doctest::
 

test/test_collection.py

@@ -785,7 +785,7 @@ def test_insert_many_invalid(self):
             db.test.insert_many(1)  # type: ignore[arg-type]
 
         with self.assertRaisesRegex(TypeError, "documents must be a non-empty list"):
-            db.test.insert_many(RawBSONDocument(encode({"_id": 2})))  # type: ignore[arg-type]
+            db.test.insert_many(RawBSONDocument(encode({"_id": 2})))
 
     def test_delete_one(self):
         self.db.test.drop()

test/test_mypy.py

@@ -18,7 +18,7 @@
 import os
 import tempfile
 import unittest
-from typing import TYPE_CHECKING, Any, Dict, Iterable, Iterator, List
+from typing import TYPE_CHECKING, Any, Dict, Iterable, Iterator, List, Optional
 
 try:
     from typing import TypedDict  # type: ignore[attr-defined]
@@ -40,7 +40,15 @@ class Movie(TypedDict):  # type: ignore[misc]
 from test import IntegrationTest
 from test.utils import rs_or_single_client
 
-from bson import CodecOptions, decode, decode_all, decode_file_iter, decode_iter, encode
+from bson import (
+    CodecOptions,
+    ObjectId,
+    decode,
+    decode_all,
+    decode_file_iter,
+    decode_iter,
+    encode,
+)
 from bson.raw_bson import RawBSONDocument
 from bson.son import SON
 from pymongo import ASCENDING, MongoClient
@@ -304,6 +312,17 @@ def test_typeddict_document_type(self) -> None:
         assert retreived["year"] == 1
         assert retreived["name"] == "a"
 
+    @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(name="THX-1138", year=1971))
+        out: Optional[Movie] = coll.find_one({"name": "THX-1138"})
+        assert out is not None
+        assert out.name == "THX-1138"
+        assert out.year == "1971"
+        assert out.id == ObjectId()
+
     @only_type_check
     def test_raw_bson_document_type(self) -> None:
         client = MongoClient(document_class=RawBSONDocument)