pex.config.callStack.StackFrame Class Reference

Public Member Functions
def	__init__ (self, filename, lineno, function, content=None)
def	content (self)
def	fromFrame (cls, frame)
def	__repr__ (self)
def	format (self, full=False)

Public Attributes
	filename
	lineno
	function

Detailed Description

A single element of the stack trace.

This differs slightly from the standard system mechanisms for getting a
stack trace by the fact that it does not look up the source code until it
is absolutely necessary, reducing the I/O.

Parameters
----------
filename : `str`
    Name of file containing the code being executed.
lineno : `int`
    Line number of file being executed.
function : `str`
    Function name being executed.
content : `str`, optional
    The actual content being executed. If not provided, it will be loaded
    from the file.

Notes
-----
This differs slightly from the standard system mechanisms for getting a
stack trace by the fact that it does not look up the source code until it
is absolutely necessary, reducing the I/O.

See also
--------
getStackFrame

Member Function Documentation

content()

def pex.config.callStack.StackFrame.content

(

self

)

Content being executed (loaded on demand) (`str`).

format()

def pex.config.callStack.StackFrame.format	(		self,
			full = False
	)

Format for printing.

Parameters
----------
full : `bool`, optional
    If `True`, output includes the conentent (`StackFrame.content`)
    being executed. Default is `False`.

Returns
-------
result : `str`
    Formatted string.

fromFrame()

def pex.config.callStack.StackFrame.fromFrame	(		cls,
			frame
	)

Construct from a Frame object.

Parameters
----------
frame : `Frame`
    Frame object to interpret, such as from `inspect.currentframe`.

Returns
-------
stackFrame : `StackFrame`
    A `StackFrame` instance.

Examples
--------
`inspect.currentframe` provides a Frame object. This is a convenience
constructor to interpret that Frame object:

>>> import inspect
>>> stackFrame = StackFrame.fromFrame(inspect.currentframe())

---

The documentation for this class was generated from the following file:

• python/lsst/pex/config/callStack.py