lsst.pex.config  13.0-2-g483026c+4
 All Classes Namespaces Files Functions Variables Properties Macros Pages
Classes | Functions | Variables
lsst.pex.config.callStack Namespace Reference

Classes

class  StackFrame
 

Functions

def getCallerFrame
 
def getStackFrame
 
def getCallStack
 

Variables

list __all__ = ['getCallerFrame', 'getStackFrame', 'StackFrame', 'getCallStack']
 

Function Documentation

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 35 of file callStack.py.

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 159 of file callStack.py.

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 56 of file callStack.py.

Variable Documentation

list lsst.pex.config.callStack.__all__ = ['getCallerFrame', 'getStackFrame', 'StackFrame', 'getCallStack']

Definition at line 25 of file callStack.py.