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
|
"""Caller-source-location capture for :mod:`edify.errors`."""
from __future__ import annotations
import linecache
import os
import sys
from dataclasses import dataclass
_EDIFY_PACKAGE_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
_EDIFY_PACKAGE_PREFIX = _EDIFY_PACKAGE_ROOT + os.sep
@dataclass(frozen=True)
class CallerContext:
"""A source-location snapshot of a specific call in the caller's code.
Attributes:
filename: Absolute path to the file that contains the offending call.
lineno: 1-indexed line number of the offending call.
colno: 1-indexed column at which the offending call starts.
end_colno: 1-indexed column one past where the offending call ends.
source_line: The verbatim source line, trailing whitespace stripped.
"""
filename: str
lineno: int
colno: int
end_colno: int
source_line: str
def capture_caller_context() -> CallerContext | None:
"""Return a :class:`CallerContext` for the first non-``edify`` frame on the stack.
Returns ``None`` when every frame on the stack lives inside the ``edify/``
package tree.
"""
current_frame = sys._getframe(1)
while current_frame is not None:
filename = current_frame.f_code.co_filename
absolute_filename = (
os.path.abspath(filename) if os.path.isabs(filename) is False else filename
)
if not absolute_filename.startswith(_EDIFY_PACKAGE_PREFIX):
return _context_for_frame(current_frame)
current_frame = current_frame.f_back
return None
def _context_for_frame(frame) -> CallerContext:
"""Return a :class:`CallerContext` describing ``frame``'s current instruction."""
filename = frame.f_code.co_filename
positions = list(frame.f_code.co_positions())
instruction_index = frame.f_lasti // 2
if 0 <= instruction_index < len(positions):
raw_position = positions[instruction_index]
else:
raw_position = (frame.f_lineno, frame.f_lineno, None, None)
start_line, end_line, start_col, end_col = raw_position
if start_line is None:
start_line = frame.f_lineno
if end_line is None:
end_line = start_line
if start_col is None:
start_col = 0
if end_col is None:
end_col = start_col
source_line = _read_source_line(filename, start_line)
return CallerContext(
filename=filename,
lineno=start_line,
colno=start_col + 1,
end_colno=end_col + 1,
source_line=source_line,
)
def _read_source_line(filename: str, lineno: int) -> str:
"""Return the verbatim source line at ``lineno``, or an empty string when unreadable."""
raw_line = linecache.getline(filename, lineno)
return raw_line.rstrip()
|
