fix test

Author: juliusgeo

doc/examples/type_hints.rst

@@ -92,16 +92,20 @@ Note that when using :class:`~bson.son.SON`, the key and value types must be giv
 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`.
+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. Do not rely on TypedDicts for schema validation, only for providing a more ergonomic interface:
+an "_id" field. The "_id" field is decorated by :py:class:`~typing_extensions.NotRequired` decorator to allow it to be accessed when reading
+from `result` (albeit without type-checking for that specific field, hence why it should not be used for schema validation).
+Another option would be to generate the "_id" field yourself, and make it a required field, which would give the expected behavior.
 
 .. doctest::
 
-  >>> from typing import TypedDict
+  >>> from typing_extensions import TypedDict, NotRequired
   >>> from pymongo import MongoClient
   >>> from pymongo.collection import Collection
+  >>> from bson import ObjectId
   >>> class Movie(TypedDict):
+  ...       _id: NotRequired[ObjectId]
   ...       name: str
   ...       year: int
   ...
@@ -111,6 +115,8 @@ an "_id" field. Do not rely on TypedDicts for schema validation, only for provid
   >>> result = collection.find_one({"name": "Jurassic Park"})
   >>> assert result is not None
   >>> assert result["year"] == 1993
+  >>> # Mypy will not check this because it is NotRequired
+  >>> assert result["_id"] == tuple()
 
 Typed Database
 --------------

test/test_mypy.py

@@ -21,10 +21,14 @@
 from typing import TYPE_CHECKING, Any, Dict, Iterable, Iterator, List, Optional
 
 try:
-    from typing import TypedDict  # type: ignore[attr-defined]
+    from typing_extensions import NotRequired, TypedDict
+
+    from bson import ObjectId
 
     # Not available in Python 3.7
     class Movie(TypedDict):  # type: ignore[misc]
+        _id: ObjectId
+        idiot: ObjectId
         name: str
         year: int
 
@@ -312,16 +316,18 @@ 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(name="THX-1138", year=1971))
-        out: Optional[Movie] = coll.find_one({"name": "THX-1138"})
+        insert = coll.insert_one(Movie(_id=ObjectId(), name="THX-1138", year=1971))
+        out = coll.find_one({"name": "THX-1138"})
         assert out is not None
-        assert out.name == "THX-1138"
-        assert out.year == "1971"
-        assert out.id == ObjectId()
+        # This should fail because the output is a Movie.
+        assert out["foo"]  # type:ignore[typeddict-item]
+        assert type(out["_id"]) == ObjectId
 
     @only_type_check
     def test_raw_bson_document_type(self) -> None: