Adding repr methods (#185)

Author: RobPasMue

src/ansys/geometry/core/designer/body.py

@@ -440,3 +440,12 @@ def plot(self, merge: Optional[bool] = False, **kwargs: Optional[dict]) -> None:
         pl = Plotter()
         pl.add_body(self, merge=merge, **kwargs)
         pl.show()
+
+    def __repr__(self) -> str:
+        """String representation of the body."""
+        lines = [f"ansys.geometry.core.designer.Body {hex(id(self))}"]
+        lines.append(f"  Name                 : {self.name}")
+        lines.append(f"  Exists               : {self.is_alive}")
+        lines.append(f"  Surface body         : {self.is_surface}")
+        lines.append(f"  Parent component     : {self._parent_component.name}")
+        return "\n".join(lines)

src/ansys/geometry/core/designer/component.py

@@ -715,11 +715,13 @@ def plot(
         ...     sketch.circle(Point2D([x, y]), 0.2*u.m)
         ...     mycomp.extrude_sketch(f"body-{x}-{y}", sketch, 1 * u.m)
         >>> mycomp
-        ansys.geometry.core.designer.Component 0x7f45c3396370
-          Exists               : True
-          N Bodies             : 25
-          N Components         : 0
-          N Coordinate Systems : 0
+        ansys.geometry.core.designer.Component 0x2203cc9ec50
+            Name                 : my-comp
+            Exists               : True
+            Parent component     : my-design
+            N Bodies             : 25
+            N Components         : 0
+            N Coordinate Systems : 0
         >>> mycomp.plot(pbr=True, metallic=1.0)
 
         """
@@ -730,11 +732,14 @@ def plot(
         pl.show()
 
     def __repr__(self) -> str:
-        """Representation of the component."""
+        """String representation of the component."""
+        alive_bodies = [1 if body.is_alive else 0 for body in self.bodies]
+        alive_comps = [1 if comp.is_alive else 0 for comp in self.components]
         lines = [f"ansys.geometry.core.designer.Component {hex(id(self))}"]
+        lines.append(f"  Name                 : {self.name}")
         lines.append(f"  Exists               : {self.is_alive}")
-        lines.append(f"  N Bodies             : {len(self.bodies)}")
-        lines.append(f"  N Components         : {len(self.components)}")
+        lines.append(f"  Parent component     : {self.parent_component.name}")
+        lines.append(f"  N Bodies             : {sum(alive_bodies)}")
+        lines.append(f"  N Components         : {sum(alive_comps)}")
         lines.append(f"  N Coordinate Systems : {len(self.coordinate_systems)}")
-
         return "\n".join(lines)

src/ansys/geometry/core/designer/coordinatesystem.py

@@ -98,3 +98,22 @@ def frame(self) -> Frame:
     def parent_component(self) -> "Component":
         """Parent component of the coordinate system."""
         return self._parent_component
+
+    def __repr__(self):
+        """String representation of the coordinate system."""
+        lines = [f"ansys.geometry.core.designer.CoordinateSystem {hex(id(self))}"]
+        lines.append(f"  Name                 : {self.name}")
+        lines.append(f"  Parent component     : {self.parent_component.name}")
+        lines.append(
+            f"  Frame origin         : [{','.join([str(x) for x in self.frame.origin])}] in meters"
+        )
+        lines.append(
+            f"  Frame X-direction    : [{','.join([str(x) for x in self.frame.direction_x])}]"
+        )
+        lines.append(
+            f"  Frame Y-direction    : [{','.join([str(x) for x in self.frame.direction_y])}]"
+        )
+        lines.append(
+            f"  Frame Z-direction    : [{','.join([str(x) for x in self.frame.direction_z])}]"
+        )
+        return "\n".join(lines)

src/ansys/geometry/core/designer/design.py

@@ -303,3 +303,16 @@ def set_shared_topology(self, share_type: SharedTopologyType) -> None:
             Shared topology does not apply on ``Design``.
         """
         raise ValueError("The Design object itself cannot have a shared topology.")
+
+    def __repr__(self):
+        """String representation of the design."""
+        alive_bodies = [1 if body.is_alive else 0 for body in self.bodies]
+        alive_comps = [1 if comp.is_alive else 0 for comp in self.components]
+        lines = [f"ansys.geometry.core.designer.Design {hex(id(self))}"]
+        lines.append(f"  Name                 : {self.name}")
+        lines.append(f"  N Bodies             : {sum(alive_bodies)}")
+        lines.append(f"  N Components         : {sum(alive_comps)}")
+        lines.append(f"  N Coordinate Systems : {len(self.coordinate_systems)}")
+        lines.append(f"  N Named Selections   : {len(self.named_selections)}")
+        lines.append(f"  N Materials          : {len(self.materials)}")
+        return "\n".join(lines)

tests/integration/test_design.py

@@ -408,6 +408,16 @@ def test_coordinate_system_creation(modeler: Modeler):
         assert dir.z == pytest.approx(dir_ref.z, rel=1e-8, abs=1e-14)
     assert nested_comp_cs2.parent_component.id == nested_comp.id
 
+    # Let's check the representation of the coordinate system
+    nested_comp_cs1_str = str(nested_comp_cs1)
+    assert "ansys.geometry.core.designer.CoordinateSystem" in nested_comp_cs1_str
+    assert "  Name                 : CompCS1" in nested_comp_cs1_str
+    assert "  Parent component     : NestedComponent" in nested_comp_cs1_str
+    assert "  Frame origin         : [0.01,0.2,3.0] in meters" in nested_comp_cs1_str
+    assert "  Frame X-direction    : " in nested_comp_cs1_str
+    assert "  Frame Y-direction    : " in nested_comp_cs1_str
+    assert "  Frame Z-direction    : " in nested_comp_cs1_str
+
 
 def test_delete_body_component(modeler: Modeler):
     """Test for verifying the deletion of ``Component`` and ``Body`` objects.
@@ -620,6 +630,32 @@ def test_delete_body_component(modeler: Modeler):
     with pytest.raises(ValueError, match="The Design object itself cannot be deleted."):
         design.delete_component(design)
 
+    # Let's try out the representation methods
+    design_str = str(design)
+    assert "ansys.geometry.core.designer.Design" in design_str
+    assert "Name                 : Deletion_Test" in design_str
+    assert "N Bodies             : 0" in design_str
+    assert "N Components         : 0" in design_str
+    assert "N Coordinate Systems : 0" in design_str
+    assert "N Named Selections   : 0" in design_str
+    assert "N Materials          : 0" in design_str
+
+    comp_1_str = str(comp_1)
+    assert "ansys.geometry.core.designer.Component" in comp_1_str
+    assert "Name                 : Component_1" in comp_1_str
+    assert "Exists               : False" in comp_1_str
+    assert "Parent component     : Deletion_Test" in comp_1_str
+    assert "N Bodies             : 0" in comp_1_str
+    assert "N Components         : 0" in comp_1_str
+    assert "N Coordinate Systems : 0" in comp_1_str
+
+    body_1_str = str(body_1)
+    assert "ansys.geometry.core.designer.Body" in body_1_str
+    assert "Name                 : comp_3_circle" in body_1_str
+    assert "Exists               : False" in body_1_str
+    assert "Surface body         : False" in body_1_str
+    assert "Parent component     : Component_3" in body_1_str
+
 
 def test_shared_topology(modeler: Modeler):
     """Test for checking the correct setting of shared topology on the server.