File: test_processors.py

package info (click to toggle)
python-pyinstrument 5.1.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,624 kB
  • sloc: python: 6,713; ansic: 897; makefile: 46; sh: 26; javascript: 18
file content (362 lines) | stat: -rw-r--r-- 12,987 bytes parent folder | download
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
import os
import sys
from test.util import calculate_frame_tree_times, dummy_session

from pytest import approx

from pyinstrument import processors
from pyinstrument.frame import SELF_TIME_FRAME_IDENTIFIER, Frame

ALL_PROCESSORS = [
    processors.aggregate_repeated_calls,
    processors.group_library_frames_processor,
    processors.merge_consecutive_self_time,
    processors.remove_importlib,
    processors.remove_tracebackhide,
    processors.remove_unnecessary_self_time_nodes,
    processors.remove_irrelevant_nodes,
]


def self_time_frame(time):
    return Frame(SELF_TIME_FRAME_IDENTIFIER, time=time)


def test_frame_passthrough_none():
    for processor in ALL_PROCESSORS:
        assert processor(None, options={}) is None


def test_remove_importlib():
    frame = Frame(
        identifier_or_frame_info="<module>\x00sympy/__init__.py\x0012",
        children=[
            Frame(
                identifier_or_frame_info="_handle_fromlist\x00../<frozen importlib._bootstrap>\x00997",
                children=[
                    self_time_frame(0.15),
                    Frame(
                        identifier_or_frame_info="_find_and_load\x00../<frozen importlib._bootstrap>\x00997",
                        children=[
                            self_time_frame(0.05),
                            Frame(
                                identifier_or_frame_info="<module>\x00sympy/polys/polyfuncs.py\x001",
                                children=[self_time_frame(0.05)],
                            ),
                            Frame(
                                identifier_or_frame_info="<module>\x00sympy/polys/partfrac.py\x001",
                                children=[self_time_frame(0.2)],
                            ),
                        ],
                    ),
                    Frame(
                        identifier_or_frame_info="<module>\x00sympy/polys/numberfields.py\x001",
                        children=[self_time_frame(0.05)],
                    ),
                ],
            )
        ],
    )

    calculate_frame_tree_times(frame)
    frame.self_check()

    assert frame.total_self_time == 0.0
    assert frame.time == approx(0.5)

    frame = processors.remove_importlib(frame, options={})
    assert frame
    frame.self_check()

    assert frame.total_self_time == approx(0.2)  # the root gets the self_time from the importlib
    assert frame.time == approx(0.5)
    assert len(frame.children) == 5
    assert frame.children[0].identifier == SELF_TIME_FRAME_IDENTIFIER
    assert frame.children[0].time == 0.15
    assert frame.children[1].identifier == SELF_TIME_FRAME_IDENTIFIER
    assert frame.children[1].time == 0.05

    assert frame.children[2].file_path == "sympy/polys/polyfuncs.py"
    assert frame.children[3].file_path == "sympy/polys/partfrac.py"
    assert frame.children[4].file_path == "sympy/polys/numberfields.py"


def test_remove_hidden():
    frame = Frame(
        identifier_or_frame_info="<module>\x00sympy/__init__.py\x0012\x01h0",
        children=[
            Frame(
                identifier_or_frame_info="_handle_fromlist\x00../foo.py\x00997\x01h1",
                children=[
                    self_time_frame(0.15),
                    Frame(
                        identifier_or_frame_info="_find_and_load\x00../foo.py\x00997\x01h1",
                        children=[
                            self_time_frame(0.05),
                            Frame(
                                identifier_or_frame_info="<module>\x00sympy/polys/polyfuncs.py\x001\x01h0",
                                children=[self_time_frame(0.05)],
                            ),
                            Frame(
                                identifier_or_frame_info="<module>\x00sympy/polys/partfrac.py\x001\x01h0",
                                children=[self_time_frame(0.2)],
                            ),
                        ],
                    ),
                    Frame(
                        identifier_or_frame_info="<module>\x00sympy/polys/numberfields.py\x001\x01h0",
                        children=[self_time_frame(0.05)],
                    ),
                ],
            )
        ],
    )

    calculate_frame_tree_times(frame)
    frame.self_check()

    assert frame.total_self_time == 0.0
    assert frame.time == approx(0.5)

    frame = processors.remove_tracebackhide(frame, options={})
    assert frame
    frame.self_check()

    assert frame.total_self_time == approx(0.2)  # the root gets the self_time from the importlib
    assert frame.time == approx(0.5)
    assert len(frame.children) == 5
    assert frame.children[0].identifier == SELF_TIME_FRAME_IDENTIFIER
    assert frame.children[0].time == 0.15
    assert frame.children[1].identifier == SELF_TIME_FRAME_IDENTIFIER
    assert frame.children[1].time == 0.05


def test_merge_consecutive_self_time():
    frame = Frame(
        identifier_or_frame_info="<module>\x00cibuildwheel/__init__.py\x0012",
        children=[
            Frame(
                identifier_or_frame_info="strip_newlines\x00cibuildwheel/utils.py\x00997",
                children=[self_time_frame(0.1)],
            ),
            self_time_frame(0.2),
            self_time_frame(0.1),
            Frame(
                identifier_or_frame_info="calculate_metrics\x00cibuildwheel/utils.py\x007",
                children=[self_time_frame(0.1)],
            ),
            self_time_frame(0.05),
        ],
    )

    calculate_frame_tree_times(frame)
    frame.self_check()

    assert frame.time == approx(0.55)

    frame = processors.merge_consecutive_self_time(frame, options={})
    assert frame
    frame.self_check()

    assert frame.time == approx(0.55)
    assert len(frame.children) == 4
    assert frame.children[0].total_self_time == approx(0.1)
    assert frame.children[1].identifier == SELF_TIME_FRAME_IDENTIFIER
    assert frame.children[1].time == approx(0.3)
    assert frame.children[2].time == approx(0.1)
    assert frame.children[3].time == approx(0.05)
    assert frame.children[3].identifier == SELF_TIME_FRAME_IDENTIFIER


def test_aggregate_repeated_calls():
    frame = Frame(
        identifier_or_frame_info="<module>\x00cibuildwheel/__init__.py\x0012",
        children=[
            Frame(
                identifier_or_frame_info="strip_newlines\x00cibuildwheel/utils.py\x00997",
                children=[
                    self_time_frame(0.1),
                    Frame(
                        identifier_or_frame_info="scan_string\x00cibuildwheel/utils.py\x0054",
                        children=[self_time_frame(0.2)],
                    ),
                ],
            ),
            self_time_frame(0.1),
            Frame(
                identifier_or_frame_info="strip_newlines\x00cibuildwheel/utils.py\x00997",
                children=[self_time_frame(0.05)],
            ),
            self_time_frame(0.2),
            Frame(
                identifier_or_frame_info="calculate_metrics\x00cibuildwheel/utils.py\x007",
                children=[self_time_frame(0.1)],
            ),
            self_time_frame(0.05),
        ],
    )

    calculate_frame_tree_times(frame)
    frame.self_check()

    assert frame.time == approx(0.8)

    frame = processors.aggregate_repeated_calls(frame, options={})

    assert frame
    frame.self_check()
    assert frame.time == approx(0.8)
    # children should be sorted by time
    assert len(frame.children) == 3
    assert frame.children[0].function == "strip_newlines"
    assert frame.children[0].time == approx(0.35)
    assert frame.children[0].children[0].function == "scan_string"
    assert frame.children[1].identifier == SELF_TIME_FRAME_IDENTIFIER
    assert frame.children[1].time == approx(0.35)
    assert frame.children[2].function == "calculate_metrics"


def test_remove_irrelevant_nodes():
    frame = Frame(
        identifier_or_frame_info="<module>\x00cibuildwheel/__init__.py\x0012",
        children=[
            Frame(
                identifier_or_frame_info="strip_newlines\x00cibuildwheel/utils.py\x00997",
                children=[
                    Frame(
                        identifier_or_frame_info="scan_string\x00cibuildwheel/utils.py\x0054",
                        children=[self_time_frame(10)],
                    ),
                ],
            ),
            self_time_frame(0.5),
            Frame(
                identifier_or_frame_info="strip_newlines\x00cibuildwheel/utils.py\x00997",
                children=[self_time_frame(0.5)],
            ),
            Frame(
                identifier_or_frame_info="calculate_metrics\x00cibuildwheel/utils.py\x007",
                children=[self_time_frame(0.01)],
            ),
        ],
    )

    calculate_frame_tree_times(frame)
    frame.self_check()

    assert frame.time == approx(11.01)

    frame = processors.remove_irrelevant_nodes(frame, options={})

    assert frame
    frame.self_check()
    assert frame.time == approx(11.01)
    # check the calculate metrics function was deleted
    assert len(frame.children) == 3
    assert "calculate_metrics" not in [f.function for f in frame.children]


def test_remove_unnecessary_self_time_nodes():
    frame = Frame(
        identifier_or_frame_info="<module>\x00cibuildwheel/__init__.py\x0012",
        children=[
            Frame(
                identifier_or_frame_info="strip_newlines\x00cibuildwheel/utils.py\x00997",
                children=[
                    self_time_frame(0.2),
                ],
            ),
            self_time_frame(0.5),
            Frame(
                identifier_or_frame_info="strip_newlines\x00cibuildwheel/utils.py\x00997",
                children=[self_time_frame(0.5)],
            ),
            Frame(
                identifier_or_frame_info="calculate_metrics\x00cibuildwheel/utils.py\x007",
                children=[self_time_frame(0.1)],
            ),
        ],
    )
    calculate_frame_tree_times(frame)
    frame.self_check()

    assert frame.time == approx(1.3)

    frame = processors.remove_unnecessary_self_time_nodes(frame, options={})

    assert frame
    frame.self_check()
    assert frame.time == approx(1.3)
    assert len(frame.children) == 4
    # check the self time node was deleted
    strip_newlines_frame = frame.children[0]
    assert strip_newlines_frame.function == "strip_newlines"
    assert len(strip_newlines_frame.children) == 0
    # check the time was absorbed into the parent
    assert strip_newlines_frame.absorbed_time == 0.2
    assert strip_newlines_frame.time == 0.2


def test_group_library_frames_processor(monkeypatch):
    session = dummy_session()
    session.sys_path = ["env/lib/python3.6"]
    session.sys_prefixes = ["env"]
    frame = Frame(
        identifier_or_frame_info="<module>\x00cibuildwheel/__init__.py\x0012",
        children=[
            Frame(
                identifier_or_frame_info="library_function\x00env/lib/python3.6/django/__init__.py\x00997",
                children=[
                    Frame(
                        identifier_or_frame_info="library_inner\x00env/lib/python3.6/django/http.py\x0054",
                        children=[
                            Frame(
                                identifier_or_frame_info="library_callback\x00env/lib/python3.6/django/views.py\x0054",
                                children=[
                                    Frame(
                                        identifier_or_frame_info="<module>\x00cibuildwheel/views.py\x0012",
                                        children=[self_time_frame(0.3)],
                                    ),
                                ],
                            ),
                        ],
                    ),
                ],
            ),
            self_time_frame(0.5),
            Frame(
                identifier_or_frame_info="strip_newlines\x00cibuildwheel/utils.py\x00997",
                children=[self_time_frame(0.5)],
            ),
            Frame(
                identifier_or_frame_info="calculate_metrics\x00cibuildwheel/utils.py\x007",
                children=[self_time_frame(0.1)],
            ),
        ],
        context=session,
    )

    calculate_frame_tree_times(frame)
    frame.self_check()

    assert frame.time == approx(1.4)

    frame = processors.group_library_frames_processor(frame, options={})

    assert frame
    frame.self_check()
    assert frame.time == approx(1.4)
    group_root = frame.children[0]

    group = group_root.group
    assert group
    assert group.root == group_root

    for frame in group.frames:
        assert frame.group == group

    assert group_root in group.frames
    assert group_root.children[0] in group.frames
    assert group_root.children[0].children[0] in group.frames
    assert group_root.children[0].children[0] in group.exit_frames
    assert group_root.children[0].children[0].children[0] not in group.frames