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

)

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 : `__builtin__.Frame`
    Frame for the caller.

Notes
-----
This function is excluded from the frame.

Definition at line 34 of file callStack.py.

def 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 : `__builtin__.Frame`
        Frame for the caller.
 
    Notes
    -----
    This function is excluded from the frame.
    """
    frame = inspect.currentframe().f_back.f_back  # Our caller's caller
    for ii in range(relative):
        frame = frame.f_back
    return frame
 
 

getCallStack()

def 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.

def 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.
    """
    frame = getCallerFrame(skip + 1)
    stack = []
    while frame:
        stack.append(StackFrame.fromFrame(frame))
        frame = frame.f_back
    return list(reversed(stack))

getStackFrame()

def 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.

def 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.
    """
    frame = getCallerFrame(relative + 1)
    return StackFrame.fromFrame(frame)