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
|
from __future__ import annotations
import codecs
import json
import tempfile
import urllib.parse
import warnings
import webbrowser
from pathlib import Path
from pyinstrument.renderers.base import FrameRenderer, ProcessorList, Renderer
from pyinstrument.session import Session
# pyright: strict
class HTMLRenderer(Renderer):
"""
Renders a rich, interactive web page, as a string of HTML.
"""
output_file_extension = "html"
def __init__(
self,
show_all: bool = False,
timeline: bool = False,
):
super().__init__()
if show_all:
warnings.warn(
f"the show_all option is deprecated on the HTML renderer, and has no effect. Use the view options in the webpage instead.",
DeprecationWarning,
stacklevel=3,
)
if timeline:
warnings.warn(
f"timeline is deprecated on the HTML renderer, and has no effect. Use the timeline view in the webpage instead.",
DeprecationWarning,
stacklevel=3,
)
# this is an undocumented option for use by the ipython magic, might
# be removed later
self.preprocessors: ProcessorList = []
def render(self, session: Session):
json_renderer = JSONForHTMLRenderer()
json_renderer.processors = self.preprocessors
session_json = json_renderer.render(session)
resources_dir = Path(__file__).parent / "html_resources"
js_file = resources_dir / "app.js"
css_file = resources_dir / "app.css"
if not js_file.exists() or not css_file.exists():
raise RuntimeError(
"Could not find app.js / app.css. Perhaps you need to run bin/build_js_bundle.py?"
)
js = js_file.read_text(encoding="utf-8")
css = css_file.read_text(encoding="utf-8")
page = f"""<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<div id="app"></div>
<script>{js}</script>
<style>{css}</style>
<script>
const sessionData = {session_json};
pyinstrumentHTMLRenderer.render(document.getElementById('app'), sessionData);
</script>
</body>
</html>
"""
return page
def open_in_browser(self, session: Session, output_filename: str | None = None):
"""
Open the rendered HTML in a webbrowser.
If output_filename=None (the default), a tempfile is used.
The filename of the HTML file is returned.
"""
if output_filename is None:
output_file = tempfile.NamedTemporaryFile(suffix=".html", delete=False)
output_filename = output_file.name
with codecs.getwriter("utf-8")(output_file) as f:
f.write(self.render(session))
else:
with codecs.open(output_filename, "w", "utf-8") as f:
f.write(self.render(session))
url = urllib.parse.urlunparse(("file", "", output_filename, "", "", ""))
webbrowser.open(url)
return output_filename
class JSONForHTMLRenderer(FrameRenderer):
"""
The HTML takes a special form of JSON-encoded session, which includes
an unprocessed frame tree rather than a list of frame records. This
reduces the amount of parsing code that must be included in the
Typescript renderer.
"""
output_file_extension = "json"
def default_processors(self) -> ProcessorList:
return []
def render(self, session: Session) -> str:
session_json = session.to_json(include_frame_records=False)
session_json_str = json.dumps(session_json)
root_frame = session.root_frame()
root_frame = self.preprocess(root_frame)
frame_tree_json_str = root_frame.to_json_str() if root_frame else "null"
return '{"session": %s, "frame_tree": %s}' % (session_json_str, frame_tree_json_str)
|
