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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
|
from __future__ import annotations
import inspect
import os
import sys
import time
import types
from pathlib import Path
from time import process_time
from typing import IO, Any
from pyinstrument import renderers
from pyinstrument.frame import AWAIT_FRAME_IDENTIFIER, OUT_OF_CONTEXT_FRAME_IDENTIFIER
from pyinstrument.renderers.console import FlatTimeMode
from pyinstrument.session import Session
from pyinstrument.stack_sampler import AsyncState, StackSampler, build_call_stack, get_stack_sampler
from pyinstrument.typing import LiteralStr, TypeAlias
from pyinstrument.util import file_supports_color, file_supports_unicode
# pyright: strict
class ActiveProfilerSession:
frame_records: list[tuple[list[str], float]]
def __init__(
self,
start_time: float,
start_process_time: float,
start_call_stack: list[str],
target_description: str,
interval: float,
) -> None:
self.start_time = start_time
self.start_process_time = start_process_time
self.start_call_stack = start_call_stack
self.frame_records = []
self.target_description = target_description
self.interval = interval
AsyncMode: TypeAlias = LiteralStr["enabled", "disabled", "strict"]
class Profiler:
"""
The profiler - this is the main way to use pyinstrument.
"""
_last_session: Session | None
_active_session: ActiveProfilerSession | None
_interval: float
_async_mode: AsyncMode
use_timing_thread: bool | None
def __init__(
self,
interval: float = 0.001,
async_mode: AsyncMode = "enabled",
use_timing_thread: bool | None = None,
):
"""
Note the profiling will not start until :func:`start` is called.
:param interval: See :attr:`interval`.
:param async_mode: See :attr:`async_mode`.
:param use_timing_thread: If True, the profiler will use a separate
thread to keep track of time. This is useful if you're on a system
where getting the time has significant overhead.
"""
self._interval = interval
self._last_session = None
self._active_session = None
self._async_mode = async_mode
self.use_timing_thread = use_timing_thread
@property
def interval(self) -> float:
"""
The minimum time, in seconds, between each stack sample. This translates into the
resolution of the sampling.
"""
return self._interval
@property
def async_mode(self) -> AsyncMode:
"""
Configures how this Profiler tracks time in a program that uses
async/await.
``enabled``
When this profiler sees an ``await``, time is logged in the function
that awaited, rather than observing other coroutines or the event
loop.
``disabled``
This profiler doesn't attempt to track ``await``. In a program that
uses async/await, this will interleave other coroutines and event
loop machinery in the profile. Use this option if async support is
causing issues in your use case, or if you want to run multiple
profilers at once.
``strict``
Instructs the profiler to only profile the current
`async context <https://docs.python.org/3/library/contextvars.html>`_.
Frames that are observed in an other context are ignored, tracked
instead as ``<out-of-context>``.
"""
return self._async_mode
@property
def last_session(self) -> Session | None:
"""
The previous session recorded by the Profiler.
"""
return self._last_session
def start(
self, caller_frame: types.FrameType | None = None, target_description: str | None = None
):
"""
Instructs the profiler to start - to begin observing the program's execution and recording
frames.
The normal way to invoke ``start()`` is with a new instance, but you can restart a Profiler
that was previously running, too. The sessions are combined.
:param caller_frame: Set this to override the default behaviour of treating the caller of
``start()`` as the 'start_call_stack' - the instigator of the profile. Most
renderers will trim the 'root' from the call stack up to this frame, to
present a simpler output.
You might want to set this to ``inspect.currentframe().f_back`` if you are
writing a library that wraps pyinstrument.
"""
if caller_frame is None:
caller_frame = inspect.currentframe().f_back # type: ignore
if target_description is None:
if caller_frame is None:
target_description = "Profile at unknown location"
else:
target_description = "Profile at {}:{}".format(
caller_frame.f_code.co_filename, caller_frame.f_lineno
)
try:
self._active_session = ActiveProfilerSession(
start_time=time.time(),
start_process_time=process_time(),
start_call_stack=build_call_stack(caller_frame, "initial", None),
target_description=target_description,
interval=self.interval,
)
use_async_context = self.async_mode != "disabled"
get_stack_sampler().subscribe(
self._sampler_saw_call_stack,
desired_interval=self.interval,
use_async_context=use_async_context,
use_timing_thread=self.use_timing_thread,
)
except:
self._active_session = None
raise
def stop(self) -> Session:
"""
Stops the profiler observing, and sets :attr:`last_session`
to the captured session.
:return: The captured session.
"""
if not self._active_session:
raise RuntimeError("This profiler is not currently running.")
try:
get_stack_sampler().unsubscribe(self._sampler_saw_call_stack)
except StackSampler.SubscriberNotFound:
raise RuntimeError(
"Failed to stop profiling. Make sure that you start/stop profiling on the same thread."
)
cpu_time = process_time() - self._active_session.start_process_time
active_session = self._active_session
self._active_session = None
session = Session(
frame_records=active_session.frame_records,
start_time=active_session.start_time,
duration=time.time() - active_session.start_time,
min_interval=active_session.interval,
max_interval=active_session.interval,
sample_count=len(active_session.frame_records),
target_description=active_session.target_description,
start_call_stack=active_session.start_call_stack,
cpu_time=cpu_time,
sys_path=sys.path,
sys_prefixes=Session.current_sys_prefixes(),
)
if self.last_session is not None:
# include the previous session's data too
session = Session.combine(self.last_session, session)
self._last_session = session
return session
@property
def is_running(self):
"""
Returns `True` if this profiler is running - i.e. observing the program execution.
"""
return self._active_session is not None
def reset(self):
"""
Resets the Profiler, clearing the `last_session`.
"""
if self.is_running:
self.stop()
self._last_session = None
def __enter__(self):
"""
Context manager support.
Profilers can be used in `with` blocks! See this example:
.. code-block:: python
with Profiler() as p:
# your code here...
do_some_work()
# profiling has ended. let's print the output.
p.print()
"""
self.start(caller_frame=inspect.currentframe().f_back) # type: ignore
return self
def __exit__(self, *args: Any):
self.stop()
# pylint: disable=W0613
def _sampler_saw_call_stack(
self,
call_stack: list[str],
time_since_last_sample: float,
async_state: AsyncState | None,
):
if not self._active_session:
raise RuntimeError(
"Received a call stack without an active session. Please file an issue on pyinstrument Github describing how you made this happen!"
)
if (
async_state
and async_state.state == "out_of_context_awaited"
and self._async_mode in ["enabled", "strict"]
):
awaiting_coroutine_stack = async_state.info
self._active_session.frame_records.append(
(
awaiting_coroutine_stack + [AWAIT_FRAME_IDENTIFIER],
time_since_last_sample,
)
)
elif (
async_state
and async_state.state == "out_of_context_unknown"
and self._async_mode == "strict"
):
context_exit_frame = async_state.info
self._active_session.frame_records.append(
(
context_exit_frame + [OUT_OF_CONTEXT_FRAME_IDENTIFIER],
time_since_last_sample,
)
)
else:
# regular sync code
self._active_session.frame_records.append((call_stack, time_since_last_sample))
def print(
self,
file: IO[str] = sys.stdout,
*,
unicode: bool | None = None,
color: bool | None = None,
show_all: bool = False,
timeline: bool = False,
time: LiteralStr["seconds", "percent_of_total"] = "seconds",
flat: bool = False,
flat_time: FlatTimeMode = "self",
short_mode: bool = False,
processor_options: dict[str, Any] | None = None,
):
"""print(file=sys.stdout, *, unicode=None, color=None, show_all=False, timeline=False, time='seconds', flat=False, flat_time='self', short_mode=False, processor_options=None)
Print the captured profile to the console, as rendered by :class:`renderers.ConsoleRenderer`
:param file: the IO stream to write to. Could be a file descriptor or sys.stdout, sys.stderr. Defaults to sys.stdout.
See :class:`renderers.ConsoleRenderer` for the other parameters.
"""
if unicode is None:
unicode = file_supports_unicode(file)
if color is None:
color = file_supports_color(file)
print(
self.output_text(
unicode=unicode,
color=color,
show_all=show_all,
timeline=timeline,
time=time,
flat=flat,
flat_time=flat_time,
short_mode=short_mode,
processor_options=processor_options,
),
file=file,
)
def output_text(
self,
unicode: bool = False,
color: bool = False,
show_all: bool = False,
timeline: bool = False,
time: LiteralStr["seconds", "percent_of_total"] = "seconds",
flat: bool = False,
flat_time: FlatTimeMode = "self",
short_mode: bool = False,
processor_options: dict[str, Any] | None = None,
) -> str:
"""
Return the profile output as text, as rendered by :class:`ConsoleRenderer`
See :class:`renderers.ConsoleRenderer` for parameter description.
"""
return self.output(
renderer=renderers.ConsoleRenderer(
unicode=unicode,
color=color,
show_all=show_all,
timeline=timeline,
time=time,
flat=flat,
flat_time=flat_time,
short_mode=short_mode,
processor_options=processor_options,
)
)
def output_html(
self,
) -> str:
"""
Return the profile output as HTML, as rendered by :class:`HTMLRenderer`
"""
return self.output(renderer=renderers.HTMLRenderer())
def write_html(
self, path: str | os.PathLike[str], timeline: bool = False, show_all: bool = False
):
"""
Writes the profile output as HTML to a file, as rendered by :class:`HTMLRenderer`
"""
file = Path(path)
file.write_text(
self.output(renderer=renderers.HTMLRenderer(timeline=timeline, show_all=show_all)),
encoding="utf-8",
)
def open_in_browser(self, timeline: bool = False):
"""
Opens the last profile session in your web browser.
"""
session = self._get_last_session_or_fail()
return renderers.HTMLRenderer(timeline=timeline).open_in_browser(session)
def output(self, renderer: renderers.Renderer) -> str:
"""
Returns the last profile session, as rendered by ``renderer``.
:param renderer: The renderer to use.
"""
session = self._get_last_session_or_fail()
return renderer.render(session)
def _get_last_session_or_fail(self) -> Session:
if self.is_running:
raise Exception("can't render profile output because this profiler is still running")
if self.last_session is None:
raise Exception(
"can't render profile output because this profiler has not completed a profile session yet"
)
return self.last_session
|