Add egraph.run_report() method to print overall stats

docs/changelog.md

@@ -4,6 +4,7 @@ _This project uses semantic versioning_
 
 ## UNRELEASED
 
+- Add `egraph.run_report()` method to print overall stats [#339](https://github.com/egraphs-good/egglog-python/pull/339)
 - Add `all_function_sizes` and `function_size` EGraph methods [#338](https://github.com/egraphs-good/egglog-python/pull/338)
 - Fix execution of docs [#337](https://github.com/egraphs-good/egglog-python/pull/337)
 - Emit warnings when functions omitted when visualizing [#336](https://github.com/egraphs-good/egglog-python/pull/336)

docs/reference/egglog-translation.md

@@ -522,6 +522,15 @@ egraph.function_size(Math)
 egraph.all_function_sizes()
 ```
 
+## Overall Statistics
+
+The `(print-stats)` command is translated into `egraph.run_report()` to get overall statistics about the EGraph.
+
+```{code-cell} python
+# (print-stats)
+egraph.run_report()
+```
+
 ## Include
 
 The `(include <path>)` command is used to add modularity, by allowing you to pull in the source from another egglog file into the current file.

python/egglog/egraph.py

@@ -909,6 +909,14 @@ def _run_schedule(self, schedule: Schedule) -> bindings.RunReport:
         assert isinstance(command_output, bindings.RunScheduleOutput)
         return command_output.report
 
+    def run_report(self) -> RunReport:
+        """
+        Returns the overall run report for the egraph.
+        """
+        (output,) = self._egraph.run_program(bindings.PrintOverallStatistics())
+        assert isinstance(output, bindings.OverallStatistics)
+        return output.report
+
     def check_bool(self, *facts: FactLike) -> bool:
         """
         Returns true if the facts are true in the egraph.

python/tests/test_high_level.py

@@ -1048,3 +1048,7 @@ def test_all_function_size():
         (C, 1),
         (E.cm, 1),
     }
+
+
+def test_overall_run_report():
+    assert EGraph().run_report()