Relative percentage display for Console output

pyinstrument/__main__.py

@@ -162,6 +162,14 @@ def dash_m_callback(option: str, opt: str, value: str, parser: optparse.OptionPa
         help="show everything",
         default=False,
     )
+    parser.add_option(
+        "",
+        "--show-percentage",
+        dest="show_percentage",
+        action="store_true",
+        help="(text renderer only) show relative percentages alongside timings",
+        default=False,
+    )
 
     parser.add_option(
         "",
@@ -299,7 +307,9 @@ def dash_m_callback(option: str, opt: str, value: str, parser: optparse.OptionPa
         unicode: Any = options.unicode if unicode_override else file_supports_unicode(f)
         color: Any = options.color if color_override else file_supports_color(f)
 
-        renderer_kwargs.update({"unicode": unicode, "color": color})
+        renderer_kwargs.update(
+            {"unicode": unicode, "color": color, "show_percentage": options.show_percentage}
+        )
 
     renderer_class = get_renderer_class(options.renderer)
     renderer = renderer_class(**renderer_kwargs)

pyinstrument/frame.py

@@ -65,6 +65,14 @@ def self_time(self, self_time: float):
         self._self_time = self_time
         self._invalidate_time_caches()
 
+    @property
+    def perc(self) -> float | None:
+        return self._perc
+
+    @perc.setter
+    def perc(self, val: float):
+        self._perc = val
+
     # invalidates the cache for the time() function.
     # called whenever self_time or _children is modified.
     def _invalidate_time_caches(self):
@@ -139,6 +147,7 @@ def __init__(
         self._children = []
 
         self._time = None
+        self._perc = None
         self._await_time = None
 
         if children:
@@ -291,11 +300,12 @@ def _invalidate_time_caches(self):
             frame._await_time = None
 
     def __repr__(self):
-        return "Frame(identifier=%s, time=%f, len(children)=%d), group=%r" % (
+        return "Frame(identifier=%s, time=%f, len(children)=%d), group=%r, perc=%r" % (
             self.identifier,
             self.time(),
             len(self.children),
             self.group,
+            self.perc,
         )
 
 

pyinstrument/processors.py

@@ -215,3 +215,32 @@ def remove_irrelevant_nodes(
         remove_irrelevant_nodes(child, options=options, total_time=total_time)
 
     return frame
+
+
+def compute_relative_percentage(
+    frame: BaseFrame | None, options: ProcessorOptions
+) -> BaseFrame | None:
+    """
+    Compute the relative percentage amongst siblings
+    """
+
+    def _compute_layer_percentage(frame: BaseFrame):
+        total_time = frame.time()
+
+        for child in frame.children:
+            child.perc = child.time() / total_time
+            child = _compute_layer_percentage(child)
+
+        if len(frame.children) == 0:
+            frame.perc = 1.0
+
+        return frame
+
+    if frame is None:
+        return None
+
+    frame = _compute_layer_percentage(frame)
+
+    frame.perc = 1.0
+
+    return frame

pyinstrument/profiler.py

@@ -256,8 +256,9 @@ def print(
         color: bool | None = None,
         show_all: bool = False,
         timeline: bool = False,
+        show_percentage: bool = False,
     ):
-        """print(file=sys.stdout, *, unicode=None, color=None, show_all=False, timeline=False)
+        """print(file=sys.stdout, *, unicode=None, color=None, show_all=False, timeline=False, show_percentage=False)
 
         Print the captured profile to the console.
 
@@ -266,6 +267,7 @@ def print(
         :param color: Override ANSI color support detection.
         :param show_all: Sets the ``show_all`` parameter on the renderer.
         :param timeline: Sets the ``timeline`` parameter on the renderer.
+        :param show_percentage: Sets the ``show_percentage`` parameter on the renderer.
         """
         if unicode is None:
             unicode = file_supports_unicode(file)
@@ -278,6 +280,7 @@ def print(
                 color=color,
                 show_all=show_all,
                 timeline=timeline,
+                show_percentage=show_percentage,
             ),
             file=file,
         )
@@ -288,13 +291,18 @@ def output_text(
         color: bool = False,
         show_all: bool = False,
         timeline: bool = False,
+        show_percentage: bool = False,
     ) -> str:
         """
         Return the profile output as text, as rendered by :class:`ConsoleRenderer`
         """
         return self.output(
             renderer=renderers.ConsoleRenderer(
-                unicode=unicode, color=color, show_all=show_all, timeline=timeline
+                unicode=unicode,
+                color=color,
+                show_all=show_all,
+                timeline=timeline,
+                show_percentage=show_percentage,
             )
         )
 

pyinstrument/renderers/console.py

@@ -17,7 +17,13 @@ class ConsoleRenderer(Renderer):
     consoles.
     """
 
-    def __init__(self, unicode: bool = False, color: bool = False, **kwargs: Any):
+    def __init__(
+        self,
+        unicode: bool = False,
+        color: bool = False,
+        show_percentage: bool = False,
+        **kwargs: Any,
+    ):
         """
         :param unicode: Use unicode, like box-drawing characters in the output.
         :param color: Enable color support, using ANSI color sequences.
@@ -27,6 +33,7 @@ def __init__(self, unicode: bool = False, color: bool = False, **kwargs: Any):
         self.unicode = unicode
         self.color = color
         self.colors = self.colors_enabled if color else self.colors_disabled
+        self.show_percentage = show_percentage
 
     def render(self, session: Session):
         result = self.render_preamble(session)
@@ -76,14 +83,26 @@ def render_frame(self, frame: BaseFrame, indent: str = "", child_indent: str = "
         ):
             time_str = self._ansi_color_for_time(frame) + f"{frame.time():.3f}" + self.colors.end
             function_color = self._ansi_color_for_function(frame)
-            result = "{indent}{time_str} {function_color}{function}{c.end}  {c.faint}{code_position}{c.end}\n".format(
-                indent=indent,
-                time_str=time_str,
-                function_color=function_color,
-                function=frame.function,
-                code_position=frame.code_position_short,
-                c=self.colors,
-            )
+            if not self.show_percentage:
+                result = "{indent}{time_str} {function_color}{function}{c.end}  {c.faint}{code_position}{c.end}\n".format(
+                    indent=indent,
+                    time_str=time_str,
+                    function_color=function_color,
+                    function=frame.function,
+                    code_position=frame.code_position_short,
+                    c=self.colors,
+                )
+            else:
+                perc_str = self._ansi_color_for_time(frame) + f"{frame.perc:.2f}" + self.colors.end
+                result = "{indent}{time_str} ({perc_str}) {function_color}{function}{c.end}  {c.faint}{code_position}{c.end}\n".format(
+                    indent=indent,
+                    time_str=time_str,
+                    perc_str=perc_str,
+                    function_color=function_color,
+                    function=frame.function,
+                    code_position=frame.code_position_short,
+                    c=self.colors,
+                )
             if self.unicode:
                 indents = {"├": "├─ ", "│": "│  ", "└": "└─ ", " ": "   "}
             else:
@@ -142,6 +161,7 @@ def default_processors(self) -> ProcessorList:
             processors.group_library_frames_processor,
             processors.remove_unnecessary_self_time_nodes,
             processors.remove_irrelevant_nodes,
+            processors.compute_relative_percentage,
         ]
 
     class colors_enabled: