lsst.pex.config.callStack Namespace Reference

Classes
class	StackFrame

Functions
def	getCallerFrame (relative=0)
def	getStackFrame (relative=0)
def	getCallStack (skip=0)

Function Documentation

getCallerFrame()

def lsst.pex.config.callStack.getCallerFrame

(

relative = 0

)

Retrieve the frame for the caller

By "caller", we mean our user's caller.

Parameters
----------
relative : `int`, non-negative
    Number of frames above the caller to retrieve.

Returns
-------
frame : `__builtin__.Frame`
    Frame for the caller.

Definition at line 33 of file callStack.py.

getCallStack()

def lsst.pex.config.callStack.getCallStack

(

skip = 0

)

Retrieve the call stack for the caller

By "caller", we mean our user's caller - we don't include ourselves
or our caller.

The result is ordered with the most recent frame last.

Parameters
----------
skip : `int`, non-negative
    Number of stack frames above caller to skip.

Returns
-------
output : `list` of `StackFrame`
    The call stack.

Definition at line 157 of file callStack.py.

getStackFrame()

def lsst.pex.config.callStack.getStackFrame

(

relative = 0

)

Retrieve the stack frame for the caller

By "caller", we mean our user's caller.

Parameters
----------
relative : `int`, non-negative
    Number of frames above the caller to retrieve.

Returns
-------
frame : `StackFrame`
    Stack frame for the caller.

Definition at line 54 of file callStack.py.