lsst.pex.config.callStack.StackFrame Class Reference

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

Public Attributes
	filename
	lineno
	function

Protected Attributes
	_content

Static Protected Attributes
str	_STRIP = "/python/lsst/"

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

Definition at line 75 of file callStack.py.

Constructor & Destructor Documentation

__init__()

lsst.pex.config.callStack.StackFrame.__init__	(		self,
			filename,
			lineno,
			function,
			content = None )

Definition at line 108 of file callStack.py.

    def __init__(self, filename, lineno, function, content=None):
        loc = filename.rfind(self._STRIP)
        if loc > 0:
            filename = filename[loc + len(self._STRIP) :]
        self.filename = filename
        self.lineno = lineno
        self.function = function
        self._content = content
 

Member Function Documentation

__repr__()

lsst.pex.config.callStack.StackFrame.__repr__

(

self

)

Definition at line 151 of file callStack.py.

    def __repr__(self):
        return f"{self.__class__.__name__}({self.filename}, {self.lineno}, {self.function})"
 

content()

lsst.pex.config.callStack.StackFrame.content

(

self

)

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

Definition at line 118 of file callStack.py.

    def content(self):
        """Content being executed (loaded on demand) (`str`)."""
        if self._content is None:
            self._content = linecache.getline(self.filename, self.lineno).strip()
        return self._content
 

format()

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

Definition at line 154 of file callStack.py.

    def 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.
        """
        result = f"  File {self.filename}:{self.lineno} ({self.function})"
        if full:
            result += f"\n    {self.content}"
        return result
 
 

fromFrame()

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

Construct from a Frame object.

Parameters
----------
frame : `types.FrameType`
    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())

Definition at line 125 of file callStack.py.

    def fromFrame(cls, frame):
        """Construct from a Frame object.
 
        Parameters
        ----------
        frame : `types.FrameType`
            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())
        """
        filename = frame.f_code.co_filename
        lineno = frame.f_lineno
        function = frame.f_code.co_name
        return cls(filename, lineno, function)
 

Member Data Documentation

_content

lsst.pex.config.callStack.StackFrame._content

protected

Definition at line 115 of file callStack.py.

_STRIP

str lsst.pex.config.callStack.StackFrame._STRIP = "/python/lsst/"

staticprotected

Definition at line 105 of file callStack.py.

filename

lsst.pex.config.callStack.StackFrame.filename

Definition at line 112 of file callStack.py.

function

lsst.pex.config.callStack.StackFrame.function

Definition at line 114 of file callStack.py.

lineno

lsst.pex.config.callStack.StackFrame.lineno

Definition at line 113 of file callStack.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pex_config/gba4ed39666+9664299f35/python/lsst/pex/config/callStack.py