Classes | |
| class | StackFrame |
Functions | |
| getCallerFrame (relative=0) | |
| getStackFrame (relative=0) | |
| getCallStack (skip=0) | |
Function Documentation
◆ getCallerFrame()
| lsst.pex.config.callStack.getCallerFrame | ( | relative = 0 | ) |
Get the frame for the user's caller.
Parameters
----------
relative : `int`, optional
Number of frames (0 or more) above the caller to retrieve.
Default is 0.
Returns
-------
frame : `types.FrameType`
Frame for the caller.
Notes
-----
This function is excluded from the frame.
Definition at line 34 of file callStack.py.
34def getCallerFrame(relative=0):
35 """Get the frame for the user's caller.
36
37 Parameters
38 ----------
39 relative : `int`, optional
40 Number of frames (0 or more) above the caller to retrieve.
41 Default is 0.
42
43 Returns
44 -------
45 frame : `types.FrameType`
46 Frame for the caller.
47
48 Notes
49 -----
50 This function is excluded from the frame.
51 """
52 frame = inspect.currentframe().f_back.f_back # Our caller's caller
53 for ii in range(relative):
54 frame = frame.f_back
55 return frame
56
57
◆ getCallStack()
| lsst.pex.config.callStack.getCallStack | ( | skip = 0 | ) |
Retrieve the call stack for the caller.
Parameters
----------
skip : `int`, non-negative
Number of stack frames above caller to skip.
Returns
-------
output : `list` of `StackFrame`
The call stack. The `list` is ordered with the most recent frame to
last.
Notes
-----
This function is excluded from the call stack.
Definition at line 174 of file callStack.py.
174def getCallStack(skip=0):
175 """Retrieve the call stack for the caller.
176
177 Parameters
178 ----------
179 skip : `int`, non-negative
180 Number of stack frames above caller to skip.
181
182 Returns
183 -------
184 output : `list` of `StackFrame`
185 The call stack. The `list` is ordered with the most recent frame to
186 last.
187
188 Notes
189 -----
190 This function is excluded from the call stack.
191 """
192 frame = getCallerFrame(skip + 1)
193 stack = []
194 while frame:
195 stack.append(StackFrame.fromFrame(frame))
196 frame = frame.f_back
197 return list(reversed(stack))
◆ getStackFrame()
| lsst.pex.config.callStack.getStackFrame | ( | relative = 0 | ) |
Get the `StackFrame` for the user's caller.
Parameters
----------
relative : `int`, optional
Number of frames (0 or more) above the caller to retrieve.
Returns
-------
frame : `StackFrame`
Stack frame for the caller.
Definition at line 58 of file callStack.py.
58def getStackFrame(relative=0):
59 """Get the `StackFrame` for the user's caller.
60
61 Parameters
62 ----------
63 relative : `int`, optional
64 Number of frames (0 or more) above the caller to retrieve.
65
66 Returns
67 -------
68 frame : `StackFrame`
69 Stack frame for the caller.
70 """
71 frame = getCallerFrame(relative + 1)
72 return StackFrame.fromFrame(frame)
73
74
Generated on Mon Jan 20 2025 08:02:09 for LSST Applications by
1.11.0