from __future__ import annotations import time from typing import Any, Dict, List, Tuple import pyinstrument from pyinstrument import processors from pyinstrument.frame import Frame from pyinstrument.renderers.base import FrameRenderer, ProcessorList, Renderer from pyinstrument.session import Session from pyinstrument.typing import LiteralStr from pyinstrument.util import truncate # pyright: strict class ConsoleRenderer(FrameRenderer): """ Produces text-based output, suitable for text files or ANSI-compatible consoles. """ def __init__( self, unicode: bool = False, color: bool = False, flat: bool = False, time: LiteralStr["seconds", "percent_of_total"] = "seconds", **kwargs: Any, ) -> None: """ :param unicode: Use unicode, like box-drawing characters in the output. :param color: Enable color support, using ANSI color sequences. :param flat: Display a flat profile instead of a call graph. :param time: How to display the duration of each frame - ``'seconds'`` or ``'percent_of_total'`` """ super().__init__(**kwargs) self.unicode = unicode self.color = color self.flat = flat self.time = time if self.flat and self.timeline: raise Renderer.MisconfigurationError("Cannot use timeline and flat options together.") self.colors = self.colors_enabled if color else self.colors_disabled def render(self, session: Session) -> str: result = self.render_preamble(session) frame = self.preprocess(session.root_frame()) if frame is None: result += "No samples were recorded.\n\n" return result self.root_frame = frame if self.flat: result += self.render_frame_flat(self.root_frame) else: result += self.render_frame(self.root_frame) result += "\n" return result # pylint: disable=W1401 def render_preamble(self, session: Session) -> str: lines = [ r"", r" _ ._ __/__ _ _ _ _ _/_ ", r" /_//_/// /_\ / //_// / //_'/ // ", r"/ _/ {:>20}".format("v" + pyinstrument.__version__), ] lines[1] += " Recorded: {:<9}".format( time.strftime("%X", time.localtime(session.start_time)) ) lines[2] += f" Duration: {session.duration:<9.3f}" lines[1] += f" Samples: {session.sample_count}" lines[2] += f" CPU time: {session.cpu_time:.3f}" lines.append("") lines.append("Program: %s" % session.program) lines.append("") lines.append("") return "\n".join(lines) def render_frame(self, frame: Frame, indent: str = "", child_indent: str = "") -> str: if not frame.group or ( frame.group.root == frame or frame.total_self_time > 0.2 * self.root_frame.time or frame in frame.group.exit_frames ): result = f"{indent}{self.frame_description(frame)}\n" if self.unicode: indents = {"├": "├─ ", "│": "│ ", "└": "└─ ", " ": " "} else: indents = {"├": "|- ", "│": "| ", "└": "`- ", " ": " "} if frame.group and frame.group.root == frame: result += "{indent}[{count} frames hidden] {c.faint}{libraries}{c.end}\n".format( indent=child_indent + " ", count=len(frame.group.frames), libraries=truncate(", ".join(frame.group.libraries), 40), c=self.colors, ) for key in indents: indents[key] = " " else: result = "" indents = {"├": "", "│": "", "└": "", " ": ""} if frame.children: last_child = frame.children[-1] for child in frame.children: if child is not last_child: c_indent = child_indent + indents["├"] cc_indent = child_indent + indents["│"] else: c_indent = child_indent + indents["└"] cc_indent = child_indent + indents[" "] result += self.render_frame(child, indent=c_indent, child_indent=cc_indent) return result def render_frame_flat(self, frame: Frame) -> str: def walk(frame: Frame): frame_id_to_time[frame.identifier] = ( frame_id_to_time.get(frame.identifier, 0) + frame.total_self_time ) frame_id_to_frame[frame.identifier] = frame for child in frame.children: walk(child) frame_id_to_time: Dict[str, float] = {} frame_id_to_frame: Dict[str, Frame] = {} walk(frame) id_time_pairs: List[Tuple[str, float]] = sorted( frame_id_to_time.items(), key=(lambda item: item[1]), reverse=True ) if not self.show_all: # remove nodes that represent less than 0.1% of the total time id_time_pairs = [ pair for pair in id_time_pairs if pair[1] / self.root_frame.time > 0.001 ] result = "" for frame_id, self_time in id_time_pairs: result += self.frame_description(frame_id_to_frame[frame_id], override_time=self_time) result += "\n" return result def frame_description(self, frame: Frame, *, override_time: float | None = None) -> str: time = override_time if override_time is not None else frame.time time_color = self._ansi_color_for_time(time) if self.time == "percent_of_total": time_str = f"{self.frame_proportion_of_total_time(time) * 100:.1f}%" else: time_str = f"{time:.3f}" value_str = f"{time_color}{time_str}{self.colors.end}" class_name = frame.class_name if class_name: function_name = f"{class_name}.{frame.function}" else: function_name = frame.function function_color = self._ansi_color_for_name(frame) function_str = f"{function_color}{function_name}{self.colors.end}" code_position_str = f"{self.colors.faint}{frame.code_position_short}{self.colors.end}" return f"{value_str} {function_str} {code_position_str}" def frame_proportion_of_total_time(self, time: float) -> float: return time / self.root_frame.time def _ansi_color_for_time(self, time: float) -> str: proportion_of_total = self.frame_proportion_of_total_time(time) if proportion_of_total > 0.6: return self.colors.red elif proportion_of_total > 0.2: return self.colors.yellow elif proportion_of_total > 0.05: return self.colors.green else: return self.colors.bright_green + self.colors.faint def _ansi_color_for_name(self, frame: Frame) -> str: if frame.is_application_code: return self.colors.bg_dark_blue_255 + self.colors.white_255 else: return "" def default_processors(self) -> ProcessorList: return [ processors.remove_importlib, processors.remove_tracebackhide, processors.merge_consecutive_self_time, processors.aggregate_repeated_calls, processors.remove_unnecessary_self_time_nodes, processors.remove_irrelevant_nodes, processors.remove_first_pyinstrument_frames_processor, processors.group_library_frames_processor, ] class colors_enabled: red = "\033[31m" green = "\033[32m" yellow = "\033[33m" blue = "\033[34m" cyan = "\033[36m" bright_green = "\033[92m" white = "\033[37m\033[97m" bg_dark_blue_255 = "\033[48;5;24m" white_255 = "\033[38;5;15m" bold = "\033[1m" faint = "\033[2m" end = "\033[0m" class colors_disabled: red = "" green = "" yellow = "" blue = "" cyan = "" bright_green = "" white = "" bg_dark_blue_255 = "" white_255 = "" bold = "" faint = "" end = ""