/
stacks.py
303 lines (261 loc) · 10.6 KB
/
stacks.py
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
"""
elasticapm.utils.stacks
~~~~~~~~~~~~~~~~~~~~~~~~~~
:copyright: (c) 2011-2017 Elasticsearch
Large portions are
:copyright: (c) 2010 by the Sentry Team, see AUTHORS for more details.
:license: BSD, see LICENSE for more details.
"""
import fnmatch
import inspect
import itertools
import os
import re
import sys
from elasticapm.utils import compat
from elasticapm.utils.encoding import transform
try:
from functools import lru_cache
except ImportError:
from cachetools.func import lru_cache
_coding_re = re.compile(r'coding[:=]\s*([-\w.]+)')
@lru_cache(512)
def get_lines_from_file(filename, lineno, context_lines, loader=None, module_name=None):
"""
Returns context_lines before and after lineno from file.
Returns (pre_context_lineno, pre_context, context_line, post_context).
"""
lineno = lineno - 1
lower_bound = max(0, lineno - context_lines)
upper_bound = lineno + context_lines
source = None
if loader is not None and hasattr(loader, "get_source"):
result = get_source_lines_from_loader(loader, module_name, lineno, lower_bound, upper_bound)
if result is not None:
return result
if source is None:
try:
with open(filename, 'rb') as file_obj:
encoding = 'utf8'
# try to find encoding of source file by "coding" header
# if none is found, utf8 is used as a fallback
for line in itertools.islice(file_obj, 0, 2):
match = _coding_re.search(line.decode('utf8'))
if match:
encoding = match.group(1)
break
file_obj.seek(0)
lines = [compat.text_type(line, encoding, 'replace')
for line in itertools.islice(file_obj, lower_bound, upper_bound + 1)]
offset = lineno - lower_bound
return (
[l.strip('\r\n') for l in lines[0:offset]],
lines[offset].strip('\r\n'),
[l.strip('\r\n') for l in lines[offset + 1:]] if len(lines) > offset else []
)
except (OSError, IOError, IndexError):
pass
return None, None, None
def get_source_lines_from_loader(loader, module_name, lineno, lower_bound, upper_bound):
try:
source = loader.get_source(module_name)
except ImportError:
# ImportError: Loader for module cProfile cannot handle module __main__
return None
if source is not None:
source = source.splitlines()
try:
pre_context = [line.strip('\r\n') for line in source[lower_bound:lineno]]
context_line = source[lineno].strip('\r\n')
post_context = [line.strip('\r\n') for line in source[(lineno + 1):upper_bound + 1]]
except IndexError:
# the file may have changed since it was loaded into memory
return None, None, None
return pre_context, context_line, post_context
def get_culprit(frames, include_paths=None, exclude_paths=None):
# We iterate through each frame looking for a deterministic culprit
# When one is found, we mark it as last "best guess" (best_guess) and then
# check it against ``exclude_paths``. If it isnt listed, then we
# use this option. If nothing is found, we use the "best guess".
if include_paths is None:
include_paths = []
if exclude_paths is None:
exclude_paths = []
best_guess = None
culprit = None
for frame in frames:
try:
culprit = '.'.join((f or '<unknown>' for f in [frame.get('module'), frame.get('function')]))
except KeyError:
continue
if any((culprit.startswith(k) for k in include_paths)):
if not (best_guess and any((culprit.startswith(k) for k in exclude_paths))):
best_guess = culprit
elif best_guess:
break
# Return either the best guess or the last frames call
return best_guess or culprit
def _getitem_from_frame(f_locals, key, default=None):
"""
f_locals is not guaranteed to have .get(), but it will always
support __getitem__. Even if it doesnt, we return ``default``.
"""
try:
return f_locals[key]
except Exception:
return default
def to_dict(dictish):
"""
Given something that closely resembles a dictionary, we attempt
to coerce it into a propery dictionary.
"""
if hasattr(dictish, 'iterkeys'):
m = dictish.iterkeys
elif hasattr(dictish, 'keys'):
m = dictish.keys
else:
raise ValueError(dictish)
return dict((k, dictish[k]) for k in m())
def iter_traceback_frames(tb, ignore_modules=()):
"""
Given a traceback object, it will iterate over all
frames that do not contain the ``__traceback_hide__``
local variable.
"""
while tb:
# support for __traceback_hide__ which is used by a few libraries
# to hide internal frames.
frame = tb.tb_frame
f_locals = getattr(frame, 'f_locals', {})
f_globals = getattr(frame, 'f_globals', {})
if not (f_globals.get('__name__', '').startswith(ignore_modules)
or _getitem_from_frame(f_locals, '__traceback_hide__')):
yield frame, getattr(tb, 'tb_lineno', None)
tb = tb.tb_next
def iter_stack_frames(frames=None, skip=0, ignore_modules=()):
"""
Given an optional list of frames (defaults to current stack),
iterates over all frames that do not contain the ``__traceback_hide__``
local variable.
"""
if not frames:
frame = inspect.currentframe().f_back
frames = _walk_stack(frame)
for i, frame in enumerate(frames):
if i < skip:
continue
f_locals = getattr(frame, 'f_locals', {})
f_globals = getattr(frame, 'f_globals', {})
if not (f_globals.get('__name__', '').startswith(ignore_modules)
or _getitem_from_frame(f_locals, '__traceback_hide__')):
yield frame, frame.f_lineno
def get_frame_info(frame, lineno, with_locals=True,
library_frame_context_lines=None, in_app_frame_context_lines=None,
include_paths_re=None, exclude_paths_re=None, locals_processor_func=None):
# Support hidden frames
f_locals = getattr(frame, 'f_locals', {})
if _getitem_from_frame(f_locals, '__traceback_hide__'):
return None
f_globals = getattr(frame, 'f_globals', {})
loader = f_globals.get('__loader__')
module_name = f_globals.get('__name__')
f_code = getattr(frame, 'f_code', None)
if f_code:
abs_path = frame.f_code.co_filename
function = frame.f_code.co_name
else:
abs_path = None
function = None
# Try to pull a relative file path
# This changes /foo/site-packages/baz/bar.py into baz/bar.py
try:
base_filename = sys.modules[module_name.split('.', 1)[0]].__file__
filename = abs_path.split(base_filename.rsplit(os.path.sep, 2)[0], 1)[-1][1:]
except Exception:
filename = abs_path
if not filename:
filename = abs_path
frame_result = {
'abs_path': abs_path,
'filename': filename,
'module': module_name,
'function': function,
'lineno': lineno,
'library_frame': is_library_frame(abs_path, include_paths_re, exclude_paths_re)
}
context_lines = library_frame_context_lines if frame_result['library_frame'] else in_app_frame_context_lines
if context_lines and lineno is not None and abs_path:
pre_context, context_line, post_context = get_lines_from_file(
abs_path, lineno, int(context_lines / 2), loader, module_name
)
else:
pre_context, context_line, post_context = [], None, []
if context_line:
frame_result['pre_context'] = pre_context
frame_result['context_line'] = context_line
frame_result['post_context'] = post_context
if with_locals:
if f_locals is not None and not isinstance(f_locals, dict):
# XXX: Genshi (and maybe others) have broken implementations of
# f_locals that are not actually dictionaries
try:
f_locals = to_dict(f_locals)
except Exception:
f_locals = '<invalid local scope>'
if locals_processor_func:
f_locals = {varname: locals_processor_func(var) for varname, var in compat.iteritems(f_locals)}
frame_result['vars'] = transform(f_locals)
return frame_result
def get_stack_info(frames, with_locals=True,
library_frame_context_lines=None, in_app_frame_context_lines=None,
include_paths_re=None, exclude_paths_re=None, locals_processor_func=None):
"""
Given a list of frames, returns a list of stack information
dictionary objects that are JSON-ready.
We have to be careful here as certain implementations of the
_Frame class do not contain the necessary data to lookup all
of the information we want.
:param frames: a list of (Frame, lineno) tuples
:param with_locals: boolean to indicate if local variables should be collected
:param include_paths_re: a regex to determine if a frame is not a library frame
:param exclude_paths_re: a regex to exclude frames from not being library frames
:param locals_processor_func: a function to call on all local variables
:return:
"""
results = []
for frame, lineno in frames:
result = get_frame_info(
frame,
lineno,
library_frame_context_lines=library_frame_context_lines,
in_app_frame_context_lines=in_app_frame_context_lines,
with_locals=with_locals,
include_paths_re=include_paths_re,
exclude_paths_re=exclude_paths_re,
locals_processor_func=locals_processor_func,
)
if result:
results.append(result)
return results
def _walk_stack(frame):
while frame:
yield frame
frame = frame.f_back
@lru_cache(512)
def is_library_frame(abs_file_path, include_paths_re, exclude_paths_re):
if not abs_file_path:
return True
if include_paths_re and include_paths_re.match(abs_file_path):
# frame is in-app, return False
return False
elif exclude_paths_re and exclude_paths_re.match(abs_file_path):
return True
# if neither excluded nor included, assume it's an in-app frame
return False
def get_path_regex(paths):
"""
compiles a list of path globs into a single pattern that matches any of the given paths
:param paths: a list of strings representing fnmatch path globs
:return: a compiled regex
"""
return re.compile('|'.join(map(fnmatch.translate, paths)))