FEAT: Update print_tree method

doc/changelog.d/804.added.md

@@ -0,0 +1 @@
+FEAT: Update print_tree method

src/ansys/mechanical/core/embedding/app.py

@@ -393,24 +393,28 @@ def _print_tree(self, node, max_lines, lines_count, indentation):
         node_name = node.Name
         if hasattr(node, "Suppressed") and node.Suppressed is True:
             node_name += " (Suppressed)"
-        print(f"{indentation}├── {node.Name}")
+        print(f"{indentation}├── {node_name}")
         lines_count += 1
 
+        if lines_count >= max_lines and max_lines != -1:
+            print(f"... truncating after {max_lines} lines")
+            return lines_count
+
         if hasattr(node, "Children") and node.Children is not None and node.Children.Count > 0:
             for child in node.Children:
-                _lines_count = self._print_tree(child, max_lines, lines_count, indentation + "|  ")
-                if _lines_count >= max_lines and max_lines != -1:
+                lines_count = self._print_tree(child, max_lines, lines_count, indentation + "|  ")
+                if lines_count >= max_lines and max_lines != -1:
                     break
 
         return lines_count
 
-    def print_tree(self, node, max_lines=80, lines_count=0, indentation=""):
+    def print_tree(self, node=None, max_lines=80, lines_count=0, indentation=""):
         """
         Print the hierarchical tree representation of the Mechanical project structure.
 
         Parameters
         ----------
-        node: ExtAPI object
+        node: DataModel object, optional
             The starting object of the tree.
         max_lines: int, optional
             The maximum number of lines to print. Default is 80. If set to -1, no limit is applied.
@@ -425,7 +429,7 @@ def print_tree(self, node, max_lines=80, lines_count=0, indentation=""):
         >>> import ansys.mechanical.core as mech
         >>> app = mech.App()
         >>> app.update_globals(globals())
-        >>> app.print_tree(DataModel.Project)
+        >>> app.print_tree()
         ... ├── Project
         ... |  ├── Model
         ... |  |  ├── Geometry Imports
@@ -436,8 +440,18 @@ def print_tree(self, node, max_lines=80, lines_count=0, indentation=""):
         ... |  |  ├── Remote Points
         ... |  |  ├── Mesh
 
-        >>> app.print_tree(DataModel.Project, 1)
+        >>> app.print_tree(Model, 3)
+        ... ├── Model
+        ... |  ├── Geometry Imports
+        ... |  ├── Geometry
+        ... ... truncating after 3 lines
+
+        >>> app.print_tree(max_lines=2)
         ... ├── Project
-        ... ... truncating after 1 lines
+        ... |  ├── Model
+        ... ... truncating after 2 lines
         """
+        if node is None:
+            node = self.DataModel.Project
+
         self._print_tree(node, max_lines, lines_count, indentation)

tests/embedding/test_app.py

@@ -112,14 +112,17 @@ def test_app_print_tree(embedded_app, capsys, assets):
     geometry_import.Import(geometry_file)
     allbodies = Model.GetChildren(DataModelObjectCategory.Body, True)
     allbodies[0].Suppressed = True
-    embedded_app.print_tree(DataModel.Project, 1)
+    embedded_app.print_tree()
     captured = capsys.readouterr()
     printed_output = captured.out.strip()
     assert "Project" in printed_output
-    embedded_app.print_tree(DataModel.Project, 2)
+    assert "Suppressed" in printed_output
+
+    embedded_app.print_tree(max_lines=2)
     captured = capsys.readouterr()
     printed_output = captured.out.strip()
     assert "Model" in printed_output
+    assert "truncating after" in printed_output
 
     with pytest.raises(AttributeError):
         embedded_app.print_tree(DataModel)