py: change str repr to mitigate confusion (kubeflow#1106)

* py: change str repr to mitigate confusion

Signed-off-by: Matteo Mortari <[email protected]>

* linting

Signed-off-by: Matteo Mortari <[email protected]>

---------

Signed-off-by: Matteo Mortari <[email protected]>

Author: tarilabs

clients/python/src/model_registry/types/contexts.py

@@ -82,6 +82,18 @@ def from_basemodel(cls, source: ModelVersionBaseModel) -> ModelVersion:
             else None,
         )
 
+    def __repr_str__(self, join_str: str) -> str:
+        """Overrides pydantic Representation.__repr_str__ to bring name to the front."""
+        result = []
+        for a, v in self.__repr_args__():
+            if a is None:
+                result.append(repr(v))
+            elif a == "name":
+                result.insert(0, f"{a}={v!r}")
+            else:
+                result.append(f"{a}={v!r}")
+        return join_str.join(result)
+
 
 class RegisteredModel(BaseResourceModel):
     """Represents a registered model.
@@ -131,3 +143,15 @@ def from_basemodel(cls, source: RegisteredModelBaseModel) -> RegisteredModel:
             if source.custom_properties
             else None,
         )
+
+    def __repr_str__(self, join_str: str) -> str:
+        """Overrides pydantic Representation.__repr_str__ to bring name to the front."""
+        result = []
+        for a, v in self.__repr_args__():
+            if a is None:
+                result.append(repr(v))
+            elif a == "name":
+                result.insert(0, f"{a}={v!r}")
+            else:
+                result.append(f"{a}={v!r}")
+        return join_str.join(result)

clients/python/tests/types/test_context.py

@@ -0,0 +1,57 @@
+from model_registry.types.contexts import ModelVersion, RegisteredModel
+
+
+def test_model_version_repr():
+    """Test the repr of a ModelVersion, with name to the front, ensuring other fields are also present"""
+    mv = ModelVersion(name="Version 1", id="123", author="test_author", description="test_description")
+    print(mv)
+    assert str(mv).startswith("name='Version 1'")
+    assert "id='123'" in str(mv)
+    assert "author='test_author'" in str(mv)
+    assert "description='test_description'" in str(mv)
+    print(repr(mv))
+    assert repr(mv).startswith("ModelVersion(name='Version 1'")
+    assert "id='123'" in str(mv)
+    assert "author='test_author'" in str(mv)
+    assert "description='test_description'" in str(mv)
+
+    # Test with empty name, not really used in practice but to increase coverage
+    mv = ModelVersion(name="", id="123", author="test_author", description="test_description")
+    print(mv)
+    assert str(mv).startswith("name=''")
+    assert "id='123'" in str(mv)
+    assert "author='test_author'" in str(mv)
+    assert "description='test_description'" in str(mv)
+    print(repr(mv))
+    assert repr(mv).startswith("ModelVersion(name=''")
+    assert "id='123'" in str(mv)
+    assert "author='test_author'" in str(mv)
+    assert "description='test_description'" in str(mv)
+
+
+def test_registered_model_repr():
+    """Test the repr of a RegisteredModel, with name to the front, ensuring other fields are also present"""
+    rm = RegisteredModel(name="Model 1", id="123", owner="test_owner", description="test_description")
+    print(rm)
+    assert str(rm).startswith("name='Model 1'")
+    assert "id='123'" in str(rm)
+    assert "owner='test_owner'" in str(rm)
+    assert "description='test_description'" in str(rm)
+    print(repr(rm))
+    assert repr(rm).startswith("RegisteredModel(name='Model 1'")
+    assert "id='123'" in str(rm)
+    assert "owner='test_owner'" in str(rm)
+    assert "description='test_description'" in str(rm)
+
+    # Test with empty name, not really used in practice but to increase coverage
+    rm = RegisteredModel(name="", id="123", owner="test_owner", description="test_description")
+    print(rm)
+    assert str(rm).startswith("name=''")
+    assert "id='123'" in str(rm)
+    assert "owner='test_owner'" in str(rm)
+    assert "description='test_description'" in str(rm)
+    print(repr(rm))
+    assert repr(rm).startswith("RegisteredModel(name=''")
+    assert "id='123'" in str(rm)
+    assert "owner='test_owner'" in str(rm)
+    assert "description='test_description'" in str(rm)