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 key != "key"
+                ]
+            ),
+        )
+
 
 class SearchIndexModel:
     """Represents a search index to create."""

test/__init__.py

@@ -69,6 +69,7 @@
 import pymongo
 import pymongo.errors
 from bson.son import SON
+from pymongo import IndexModel  # noqa
 from pymongo.common import partition_node
 from pymongo.hello import HelloCompat
 from pymongo.server_api import ServerApi
@@ -866,6 +867,11 @@ def assertEqualCommand(self, expected, actual, msg=None):
     def assertEqualReply(self, expected, actual, msg=None):
         self.assertEqual(sanitize_reply(expected), sanitize_reply(actual), msg)
 
+    def assertRepr(self, obj):
+        new_obj = eval(repr(obj))
+        self.assertEqual(type(new_obj), type(obj))
+        self.assertEqual(repr(new_obj), repr(obj))
+
     @contextmanager
     def fail_point(self, command_args):
         cmd_on = SON([("configureFailPoint", "failCommand")])

test/test_connection_monitoring.py

@@ -421,11 +421,6 @@ def test_5_check_out_fails_auth_error(self):
     #
     # Extra non-spec tests
     #
-    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_events_repr(self):
         host = ("localhost", 27017)
         self.assertRepr(ConnectionCheckedInEvent(host, 1))

test/test_operations.py

@@ -0,0 +1,66 @@
+# Copyright 2009-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 operations module."""
+
+from test import UnitTest
+from pymongo import ASCENDING, DESCENDING
+from pymongo.operations import IndexModel
+from pymongo.collation import Collation
+
+
+class TestOperations(UnitTest):
+    """Test Operations module including methods:
+    _Op, _DeleteOp, _UpdateOp,
+    DeleteOne, DeleteMany,
+    InsertOne,
+    ReplaceOne,
+    UpdateOne, UpdateMany,
+    IndexModel,
+    SearchIndexModel"""
+
+    def test_index_model_repr(self):
+        # Based on examples in test_collection.py
+        self.assertRepr(IndexModel("hello"))
+        self.assertRepr(IndexModel([("hello", DESCENDING), ("world", ASCENDING)]))
+        self.assertRepr(
+            IndexModel([("hello", DESCENDING), ("world", ASCENDING)], name="hello_world")
+        )
+
+        # Test all the kwargs
+        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"})
+        )
+        self.assertRepr(IndexModel("collation", collation=Collation(locale="en_US")))
+        self.assertRepr(IndexModel("wildcardProjection", wildcardProjection={"$**": 1}))
+        self.assertRepr(IndexModel("hidden", hidden=False))
+
+        # Test string literal
+        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()