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
|
from __future__ import annotations
import asyncio
import html
import threading
import urllib.parse
from ast import parse
from textwrap import dedent
import IPython
from IPython import get_ipython # type: ignore
from IPython.core.magic import Magics, line_cell_magic, magics_class, no_var_expand
from IPython.core.magic_arguments import argument, magic_arguments, parse_argstring
from IPython.display import IFrame, display
from pyinstrument import Profiler, renderers
from pyinstrument.__main__ import compute_render_options
from pyinstrument.frame import Frame
from pyinstrument.frame_ops import delete_frame_from_tree
from pyinstrument.processors import ProcessorOptions
from pyinstrument.renderers.console import ConsoleRenderer
from pyinstrument.renderers.html import HTMLRenderer
_active_profiler = None
_ASYNCIO_HTML_WARNING = """
To enable asyncio mode, use <pre>%%pyinstrument --async_mode=enabled</pre><br>
Note that due to IPython limitations this will run in a separate thread!
""".strip()
_ASYNCIO_TEXT_WARNING = (
_ASYNCIO_HTML_WARNING.replace("<pre>", "`").replace("</pre>", "`").replace("<br>", "\n")
)
def _get_active_profiler():
"""
Allows the code inserted into the cell to access the pyinstrument Profiler
instance, to start/stop it.
"""
return _active_profiler
class InterruptSilently(Exception):
"""Exception used to interrupt execution without showing traceback"""
@magics_class
class PyinstrumentMagic(Magics):
def __init__(self, shell):
super().__init__(shell)
self._transformer = None
def recreate_transformer(self, target_description: str):
if IPython.version_info < (8, 15): # type: ignore
from ._utils import PrePostAstTransformer
# This will leak _get_active_profiler into the users space until we can magle it
pre = parse(
dedent(
f"""
from pyinstrument.magic.magic import _get_active_profiler
_get_active_profiler().start(target_description={target_description!r})
"""
)
)
post = parse("\n_get_active_profiler().stop()")
self._transformer = PrePostAstTransformer(pre, post)
else:
from IPython.core.magics.ast_mod import ReplaceCodeTransformer # type: ignore
self._transformer = ReplaceCodeTransformer.from_string(
dedent(
f"""
from pyinstrument.magic.magic import _get_active_profiler as ___get_prof
___get_prof().start(target_description={target_description!r})
try:
__code__
finally:
___get_prof().stop()
__ret__
"""
)
)
@magic_arguments()
@argument(
"-p",
"--render-option",
dest="render_options",
action="append",
metavar="RENDER_OPTION",
type=str,
help=(
"options to pass to the renderer, in the format 'flag_name' or 'option_name=option_value'. "
"For example, to set the option 'time', pass '-p time=percent_of_total'. To pass multiple "
"options, use the -p option multiple times. You can set processor options using dot-syntax, "
"like '-p processor_options.filter_threshold=0'. option_value is parsed as a JSON value or "
"a string."
),
)
@argument(
"--show-regex",
dest="show_regex",
action="store",
metavar="REGEX",
help=(
"regex matching the file paths whose frames to always show. "
"Useful if --show doesn't give enough control."
),
)
@argument(
"--show",
dest="show_fnmatch",
action="store",
metavar="EXPR",
help=(
"glob-style pattern matching the file paths whose frames to "
"show, regardless of --hide or --hide-regex. For example, use "
"--show '*/<library>/*' to show frames within a library that "
"would otherwise be hidden."
),
)
@argument(
"--interval",
type=float,
default=0.001,
help="The minimum time, in seconds, between each stack sample. See: https://pyinstrument.readthedocs.io/en/latest/reference.html#pyinstrument.Profiler.interval",
)
@argument(
"--show-all",
action="store_true",
help="SHow all frames, including root frames with no time, and Internal IPython frames.",
)
@argument(
"--async_mode",
default="disabled",
help="Configures how this Profiler tracks time in a program that uses async/await. See: https://pyinstrument.readthedocs.io/en/latest/reference.html#pyinstrument.Profiler.async_mode",
)
@argument(
"--height",
"-h",
default=400,
help="Output height",
)
@argument(
"--timeline",
type=bool,
default=False,
help="Show output timeline view",
)
@argument(
"code",
type=str,
nargs="*",
help="When used as a line magic, the code to profile",
)
@argument(
"--hide",
dest="hide_fnmatch",
action="store",
metavar="EXPR",
help=(
"glob-style pattern matching the file paths whose frames to hide. Defaults to "
"hiding non-application code"
),
)
@argument(
"--hide-regex",
dest="hide_regex",
action="store",
metavar="REGEX",
help=(
"regex matching the file paths whose frames to hide. Useful if --hide doesn't give "
"enough control."
),
)
@no_var_expand
@line_cell_magic
def pyinstrument(self, line, cell=None):
"""
Run a cell with the pyinstrument statistical profiler.
Converts the line/cell's AST to something like:
try:
profiler.start()
run_code
finally:
profiler.stop()
profiler.output_html()
"""
global _active_profiler
args = parse_argstring(self.pyinstrument, line)
# 2024, always override this for now in IPython,
# we can make an option later if necessary
args.unicode = True
args.color = True
ip = get_ipython()
if not ip:
raise RuntimeError("couldn't get ipython shell instance")
if cell:
target_description = f"Cell [{ip.execution_count}]"
else:
target_description = f"Line in cell [{ip.execution_count}]"
code = cell or line
if not code:
return
# Turn off the last run (e.g. a user interrupted)
if _active_profiler and _active_profiler.is_running:
_active_profiler.stop()
if self._transformer in ip.ast_transformers:
ip.ast_transformers.remove(self._transformer)
_active_profiler = Profiler(interval=args.interval, async_mode=args.async_mode)
self.recreate_transformer(target_description=target_description)
ip.ast_transformers.append(self._transformer)
if args.async_mode == "disabled":
cell_result = ip.run_cell(code)
else:
cell_result = self.run_cell_async(ip, code)
mangled_keys = [k for k in ip.user_ns.keys() if "-" in k]
for k in mangled_keys:
del ip.user_ns[k]
ip.ast_transformers.remove(self._transformer)
if (
args.async_mode == "disabled"
and cell_result.error_in_exec
and isinstance(cell_result.error_in_exec, RuntimeError)
and "event loop is already running" in str(cell_result.error_in_exec)
):
# if the cell is async, the Magic doesn't work, raising the above
# exception instead. We display a warning and return.
display(
{
"text/plain": _ASYNCIO_TEXT_WARNING,
"text/html": _ASYNCIO_HTML_WARNING,
},
raw=True,
)
return
# If a KeyboardInterrupt occurred during the magic execution,
# raise an exception to prevent further executions.
if isinstance(cell_result.error_in_exec, KeyboardInterrupt):
# The traceback is already shown during the cell execution above, so we
# don't re-raise the exception directly.
old_custom_tb = ip.CustomTB
old_custom_exceptions = ip.custom_exceptions
def _silent_exception_handler(self, etype, value, tb, tb_offset=None):
# restore the original handlers
ip.CustomTB = old_custom_tb
ip.custom_exceptions = old_custom_exceptions
# swallow the InterruptSilently entirely
# install our silent handler
ip.set_custom_exc((InterruptSilently,), _silent_exception_handler)
raise InterruptSilently()
html_config = compute_render_options(
args, renderer_class=HTMLRenderer, unicode_support=True, color_support=True
)
text_config = compute_render_options(
args, renderer_class=HTMLRenderer, unicode_support=True, color_support=True
)
html_renderer = renderers.HTMLRenderer(show_all=args.show_all, timeline=args.timeline)
html_renderer.preprocessors.append(strip_ipython_frames_processor)
html_str = _active_profiler.output(html_renderer)
as_iframe = IFrame(
src="data:text/html, Loading…",
width="100%",
height=args.height,
extras=['style="resize: vertical"', f'srcdoc="{html.escape(html_str)}"'],
)
text_renderer = renderers.ConsoleRenderer(**text_config)
text_renderer.processors.append(strip_ipython_frames_processor)
as_text = _active_profiler.output(text_renderer)
# repr_html may be a bit fragile, but it's been stable for a while
display({"text/html": as_iframe._repr_html_(), "text/plain": as_text}, raw=True) # type: ignore
assert not _active_profiler.is_running
_active_profiler = None
def run_cell_async(self, ip, code):
# This is a bit of a hack, but it's the only way to get the cell to run
# asynchronously. We need to run the cell in a separate thread, and then
# wait for it to finish.
#
# Please keep an eye on this issue to see if there's a better way:
# https://github.com/ipython/ipython/issues/11314
old_loop = asyncio.get_event_loop()
loop = asyncio.new_event_loop()
try:
threading.Thread(target=loop.run_forever).start()
asyncio.set_event_loop(loop)
coro = ip.run_cell_async(code)
future = asyncio.run_coroutine_threadsafe(coro, loop)
return future.result()
finally:
loop.call_soon_threadsafe(loop.stop)
asyncio.set_event_loop(old_loop)
IPYTHON_INTERNAL_FILES = (
"IPython/core/interactiveshell.py",
"IPython/terminal/interactiveshell.py",
"IPython/core/async_helpers.py",
"IPython/terminal/ipapp.py",
"traitlets/config/application.py",
"ipython/IPython/__init__.py",
"ipykernel/zmqshell",
"pyinstrument/magic/magic.py",
)
def strip_ipython_frames_processor(frame: Frame | None, options: ProcessorOptions) -> Frame | None:
"""
A processor function that removes internal IPython nodes.
"""
if frame is None:
return None
for child in frame.children:
strip_ipython_frames_processor(child, options=options)
if child.file_path is not None and any(
f in child.file_path for f in IPYTHON_INTERNAL_FILES
):
delete_frame_from_tree(child, replace_with="children")
break
return frame
|