LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst.pex.config.callStack Namespace Reference

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 _ 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