PYTHON-4834 Add __repr__ to IndexModel

Author: aclark4life

pymongo/operations.py

@@ -773,6 +773,19 @@ def document(self) -> dict[str, Any]:
         """
         return self.__document
 
+    def __repr__(self) -> str:
+        return "{}({}{})".format(
+            self.__class__.__name__,
+            self.document["key"],
+            "".join(
+                [
+                    ", {}={!r}".format(key, value)
+                    for key, value in self.document.items()
+                    if not key == "key"
+                ]
+            ),
+        )
+
 
 class SearchIndexModel:
     """Represents a search index to create."""

test/test_collection.py

@@ -2253,6 +2253,35 @@ def afind(*args, **kwargs):
         for helper, args in helpers:
             helper(*args, let={})  # type: ignore
 
+    def assertRepr(self, obj):
+        new_obj = eval(repr(obj))
+        self.assertEqual(type(new_obj), type(obj))
+        self.assertEqual(repr(new_obj), repr(obj))
+
+    def test_index_model_repr(self):
+        self.assertRepr(IndexModel("hello"))
+        self.assertRepr(IndexModel([("hello", DESCENDING), ("world", ASCENDING)]))
+        self.assertRepr(IndexModel([("hello", DESCENDING), ("world", ASCENDING)], name="hello_world"))
+
+        self.assertRepr(IndexModel("name", name="name"))
+        self.assertRepr(IndexModel("unique", unique=False))
+        self.assertRepr(IndexModel("background", background=True))
+        self.assertRepr(IndexModel("sparse", sparse=True))
+        self.assertRepr(IndexModel("bucketSize", bucketSize=1))
+        self.assertRepr(IndexModel("min", min=1))
+        self.assertRepr(IndexModel("max", max=1))
+        self.assertRepr(IndexModel("expireAfterSeconds", expireAfterSeconds=1))
+        self.assertRepr(IndexModel("partialFilterExpression", partialFilterExpression={"hello": "world"}))
+
+        from pymongo.collation import Collation
+        coll = Collation(locale="en_US")
+        self.assertRepr(IndexModel("collation", collation=coll))
+        self.assertRepr(IndexModel("wildcardProjection", wildcardProjection={ "$**": 1}))
+        self.assertRepr(IndexModel("hidden", hidden=False))
+
+        self.assertEqual(repr(IndexModel("hello")), "IndexModel({'hello': 1}, name='hello_1')")
+        self.assertEqual(repr(IndexModel({'hello': 1, 'world': -1})), "IndexModel({'hello': 1, 'world': -1}, name='hello_1_world_-1')")
+
 
 if __name__ == "__main__":
     unittest.main()