1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
|
from __future__ import annotations
import json
import os
import sys
from collections import deque
from typing import Any
from pyinstrument.frame import Frame
from pyinstrument.frame_info import frame_info_get_identifier
from pyinstrument.frame_ops import FrameRecordType, build_frame_tree
from pyinstrument.typing import PathOrStr
# pyright: strict
ASSERTION_MESSAGE = (
"Please raise an issue at https://github.com/joerick/pyinstrument/issues and "
"let me know how you caused this error!"
)
class Session:
def __init__(
self,
frame_records: list[FrameRecordType],
start_time: float,
duration: float,
min_interval: float,
max_interval: float,
sample_count: int,
start_call_stack: list[str],
target_description: str,
cpu_time: float,
sys_path: list[str],
sys_prefixes: list[str],
):
"""Session()
Represents a profile session, contains the data collected during a profile session.
:meta private:
"""
self.frame_records = frame_records
self.start_time = start_time
self.duration = duration
self.min_interval = min_interval
self.max_interval = max_interval
self.sample_count = sample_count
self.start_call_stack = start_call_stack
self.target_description = target_description
self.cpu_time = cpu_time
self.sys_path = sys_path
self.sys_prefixes = sys_prefixes
self._short_file_path_cache = {}
@staticmethod
def load(filename: PathOrStr) -> Session:
"""
Load a previously saved session from disk.
:param filename: The path to load from.
:rtype: Session
"""
with open(filename) as f:
return Session.from_json(json.load(f))
def save(self, filename: PathOrStr) -> None:
"""
Saves a Session object to disk, in a JSON format.
:param filename: The path to save to. Using the ``.pyisession`` extension is recommended.
"""
with open(filename, "w") as f:
json.dump(self.to_json(), f)
def to_json(self, include_frame_records: bool = True):
result: dict[str, Any] = {
"start_time": self.start_time,
"duration": self.duration,
"min_interval": self.min_interval,
"max_interval": self.max_interval,
"sample_count": self.sample_count,
"start_call_stack": self.start_call_stack,
"target_description": self.target_description,
"cpu_time": self.cpu_time,
"sys_path": self.sys_path,
"sys_prefixes": self.sys_prefixes,
}
if include_frame_records:
result["frame_records"] = self.frame_records
return result
@staticmethod
def from_json(json_dict: dict[str, Any]):
return Session(
frame_records=json_dict["frame_records"],
start_time=json_dict["start_time"],
min_interval=json_dict.get("min_interval", 0.001),
max_interval=json_dict.get("max_interval", 0.001),
duration=json_dict["duration"],
sample_count=json_dict["sample_count"],
start_call_stack=json_dict["start_call_stack"],
target_description=json_dict["target_description"],
cpu_time=json_dict["cpu_time"] or 0,
sys_path=json_dict.get("sys_path", sys.path),
sys_prefixes=json_dict.get("sys_prefixes", Session.current_sys_prefixes()),
)
@staticmethod
def combine(session1: Session, session2: Session) -> Session:
"""
Combines two :class:`Session` objects.
Sessions that are joined in this way probably shouldn't be interpreted
as timelines, because the samples are simply concatenated. But
aggregate views (the default) of this data will work.
:rtype: Session
"""
if session1.start_time > session2.start_time:
# swap them around so that session1 is the first one
session1, session2 = session2, session1
return Session(
frame_records=session1.frame_records + session2.frame_records,
start_time=session1.start_time,
min_interval=min(session1.min_interval, session2.min_interval),
max_interval=max(session1.max_interval, session2.max_interval),
duration=session1.duration + session2.duration,
sample_count=session1.sample_count + session2.sample_count,
start_call_stack=session1.start_call_stack,
target_description=session1.target_description,
cpu_time=session1.cpu_time + session2.cpu_time,
sys_path=(
session1.sys_path + [p for p in session2.sys_path if p not in session1.sys_path]
),
sys_prefixes=list(set([*session1.sys_prefixes, *session2.sys_prefixes])),
)
@staticmethod
def current_sys_prefixes() -> list[str]:
return [sys.prefix, sys.base_prefix, sys.exec_prefix, sys.base_exec_prefix]
def root_frame(self, trim_stem: bool = True) -> Frame | None:
"""
Parses the internal frame records and returns a tree of :class:`Frame`
objects. This object can be rendered using a :class:`Renderer`
object.
:rtype: A :class:`Frame` object, or None if the session is empty.
"""
root_frame = build_frame_tree(self.frame_records, context=self)
if root_frame is None:
return None
if trim_stem:
root_frame = self._trim_stem(root_frame)
return root_frame
def _trim_stem(self, frame: Frame):
# trim the start of the tree before any branches.
# we also don't want to trim beyond the call to profiler.start()
start_stack = deque(frame_info_get_identifier(info) for info in self.start_call_stack)
if start_stack.popleft() != frame.identifier:
# the frame doesn't match where the profiler was started. Don't trim.
return frame
while frame.total_self_time == 0 and len(frame.children) == 1:
# check child matches the start_call_stack, otherwise stop descending
if len(start_stack) == 0 or frame.children[0].identifier != start_stack.popleft():
break
frame = frame.children[0]
frame.remove_from_parent()
return frame
_short_file_path_cache: dict[str, str]
def shorten_path(self, path: str) -> str:
"""
Shorten a path to a more readable form, relative to sys_path. Used by
Frame.short_file_path.
"""
if path in self._short_file_path_cache:
return self._short_file_path_cache[path]
result = path
# if os.sep doesn't appear, probably not a file path at all, more
# likely <built-in> or similar
if len(path.split(os.sep)) > 1:
for sys_path_entry in self.sys_path:
# On Windows, if path and sys_path_entry are on
# different drives, relpath will result in exception,
# because it cannot compute a relpath in this case.
# The root cause is that on Windows, there is no root
# dir like '/' on Linux.
try:
candidate = os.path.relpath(path, sys_path_entry)
except ValueError:
continue
if not result or (len(candidate.split(os.sep)) < len(result.split(os.sep))):
result = candidate
self._short_file_path_cache[path] = result
return result
|